# バッチ設計書 15-delete_old_notes_images

## 概要

本ドキュメントは、InvenTreeシステムにおける古いメモ画像のクリーンアップバッチ処理について記述します。このバッチは、90日以上経過しかつどのメモからも参照されていない画像ファイルをデータベースおよびファイルシステムから削除し、ストレージの効率的な利用を維持します。

### 本バッチの処理概要

**業務上の目的・背景**：InvenTreeでは、部品やその他のオブジェクトに対してメモ（ノート）を添付でき、そのメモには画像を含めることができます。これらの画像はNotesImageテーブルとファイルシステムに保存されますが、メモから参照されなくなった画像や、存在しない画像ファイルへの参照が残ることがあります。ストレージ容量の節約とデータ整合性の維持のため、これらの孤立した画像データを定期的にクリーンアップする必要があります。

**バッチの実行タイミング**：日次（毎日1回）。Django-Qスケジューラによりスケジュールされ、バックグラウンドワーカーによって実行されます。

**主要な処理内容**：
1. 存在しない画像ファイルへの参照を持つNotesImageレコードを削除
2. 90日以上前に作成され、どのモデルのnotesフィールドからも参照されていないNotesImageレコードを削除
3. notesディレクトリ内でNotesImageレコードに紐づかない孤立画像ファイルを削除

**前後の処理との関連**：本バッチは独立して動作します。メモ機能（InvenTreeNotesMixin）を持つすべてのモデルに影響を与える可能性があります。

**影響範囲**：common_notesimageテーブルおよびMEDIA_ROOT/notesディレクトリ内のファイルに影響します。現在メモから参照されている画像や90日以内の画像には影響しません。

## バッチ種別

データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | Django-Qスケジューラによる自動実行 |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（Django-Qスケジューラ） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django-Qワーカー稼働中 | バックグラウンドワーカーが稼働している必要がある |
| データベース接続可能 | NotesImageテーブルへのアクセスが可能であること |
| ファイルシステムアクセス可能 | MEDIA_ROOT/notesディレクトリへのアクセスが可能であること |
| Appレジストリ準備完了 | Djangoアプリケーションが正常に起動していること |

### 実行可否判定

- スケジューラに登録されたタイミングで自動実行
- AppRegistryNotReady例外発生時はスキップしてログ出力

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチはパラメータを取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| common_notesimage | DB | メモ画像テーブル |
| InvenTreeNotesMixinを持つモデル | DB | メモフィールドを持つ全モデル |
| MEDIA_ROOT/notes | ファイルシステム | 画像ファイルディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| common_notesimage | DB | 不要レコードの削除 |
| MEDIA_ROOT/notes | ファイルシステム | 孤立ファイルの削除 |
| ログ出力 | テキスト | 削除処理のログメッセージ |

### 出力ファイル仕様

ファイル出力なし（削除のみ）

## 処理フロー

### 処理シーケンス

```
1. バッチ開始
   └─ NotesImageモデルのインポート確認
2. Phase 1: 存在しない画像ファイル参照の削除
   └─ 全NotesImageレコードをチェック
      └─ os.path.exists()で画像ファイル存在確認
      └─ 存在しない場合はレコード削除
3. Phase 2: 未参照の古いNotesImage削除
   └─ InvenTreeNotesMixinを持つモデル一覧取得
   └─ 90日以上前のNotesImageレコードを検索
   └─ 各レコードについて参照チェック
      └─ どのモデルのnotesからも参照されていない場合は削除
4. Phase 3: 孤立ファイルの削除
   └─ MEDIA_ROOT/notesディレクトリ内のファイル一覧取得
   └─ NotesImageレコードと照合
      └─ レコードに紐づかないファイルを削除
5. バッチ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{NotesImage<br/>インポート成功?}
    B -->|失敗| C[ログ出力して終了]
    B -->|成功| D[Phase 1: 存在しないファイル参照削除]
    D --> E[全NotesImageをループ]
    E --> F{画像ファイル存在?}
    F -->|いいえ| G[レコード削除]
    F -->|はい| H[次のレコード]
    G --> H
    H --> I{全レコード処理完了?}
    I -->|いいえ| E
    I -->|はい| J[Phase 2: 未参照古画像削除]
    J --> K[NotesMixin持つモデル取得]
    K --> L[90日以上前のNotesImage取得]
    L --> M[各レコードの参照チェック]
    M --> N{どこからも参照なし?}
    N -->|はい| O[レコード削除]
    N -->|いいえ| P[次のレコード]
    O --> P
    P --> Q{全レコード処理完了?}
    Q -->|いいえ| M
    Q -->|はい| R[Phase 3: 孤立ファイル削除]
    R --> S[notesディレクトリのファイル一覧取得]
    S --> T[各ファイルの紐づけチェック]
    T --> U{NotesImageと紐づき?}
    U -->|いいえ| V[ファイル削除]
    U -->|はい| W[次のファイル]
    V --> W
    W --> X{全ファイル処理完了?}
    X -->|いいえ| T
    X -->|はい| Y[バッチ終了]
    C --> Y
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 存在しないファイル参照削除 | common_notesimage | DELETE | ファイルが存在しないレコードの削除 |
| 古い未参照画像削除 | common_notesimage | DELETE | 90日以上前かつ未参照のレコード削除 |
| 参照チェック | *_notes | SELECT | 各モデルのnotesフィールドを検索 |

### テーブル別操作詳細

#### common_notesimage

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | image | 全レコード | ファイル存在チェック用 |
| SELECT | date, image | date <= 90日前 | 古いレコードの検索 |
| DELETE | - | ファイル不存在 or 90日以上前かつ未参照 | レコード削除 |

#### InvenTreeNotesMixinを持つモデル（動的）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | notes | notes__icontains=画像名 | 参照チェック |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | AppRegistryNotReady | Djangoアプリ未起動 | ログ出力後にスキップ |
| - | FileNotFoundError | notesディレクトリ不存在 | 空のリストとして処理継続 |
| - | PermissionError | ファイル削除権限がない | 例外ログを出力して継続 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Django-Qのデフォルト設定に依存 |
| リトライ間隔 | Django-Qのデフォルト設定に依存 |
| リトライ対象エラー | 一時的なファイルシステムエラー |

### 障害時対応

1. ログを確認してエラー原因を特定
2. ファイルシステム権限を確認
3. 必要に応じて手動で再実行

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | レコード単位 |
| コミットタイミング | 各レコード/ファイル削除完了時 |
| ロールバック条件 | 個別操作失敗時（他の操作には影響しない） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十〜数百件/日 |
| 目標処理時間 | 5分以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行は推奨しない（ファイル操作を含むため）
- 通常は日次1回の実行のため同時実行は想定しない

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | App未準備時 | "Could not perform 'delete_old_notes_images' - App registry not ready" |
| 情報ログ | ファイル不存在削除時 | "Deleting note {path} - image file does not exist" |
| 情報ログ | 未参照画像削除時 | "Deleting note {img} - image file not linked to a note" |
| 情報ログ | 孤立ファイル削除時 | "Deleting note {image} - image file not linked to a note" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| タスク失敗 | 1回 | システム管理者 |
| 処理時間 | 10分超過 | システム管理者 |

## 備考

- 保持期間90日はハードコードされており、設定変更不可
- getModelsWithMixin関数を使用してInvenTreeNotesMixinを持つ全モデルを動的に取得
- Phase 3ではnotesディレクトリが存在しない場合はFileNotFoundErrorをキャッチして空リストとして処理
- os.remove()でファイルを削除するため、適切なファイルシステム権限が必要
- OpenTelemetryによるトレーシングに対応
