# バッチ設計書 8-product_download.media.cleanup

## 概要

本ドキュメントは、Shopwareシステムにおけるダウンロード商品メディアクリーンアップバッチ（product_download.media.cleanup）の設計仕様を定義するものです。

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

このバッチは、使用されていないダウンロード商品のメディアファイルをデータベースおよびストレージから削除し、ストレージの効率的な管理を実現するためのクリーンアップタスクです。

**業務上の目的・背景**：Shopwareでは、デジタルダウンロード商品（PDF、音楽、ソフトウェア等）を販売する機能があります。商品の削除や更新に伴い、product_downloadエンティティに関連付けられていたメディアファイルが孤立することがあります。これらの未使用メディアはストレージを圧迫し、コストの増加やバックアップサイズの肥大化を招きます。本バッチは、UnusedMediaPurgerを使用してproduct_downloadに関連付けられていないメディアを自動的に削除することで、ストレージを効率的に管理します。

**バッチの実行タイミング**：月次実行（2628000秒間隔、約1ヶ月）。システムのスケジュールタスク機能により自動的にトリガーされます。

**主要な処理内容**：
1. UnusedMediaPurgerサービスを呼び出し
2. product_downloadエンティティに関連付けられていないメディアを特定
3. 該当メディアをデータベースおよびストレージから削除

**前後の処理との関連**：本バッチは独立して動作します。商品削除処理の後に未使用メディアが発生する可能性があるため、定期的な実行が推奨されます。

**影響範囲**：mediaテーブルおよび関連する物理ファイルの削除。product_downloadに現在関連付けられているメディアには影響を与えません。

## バッチ種別

データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 月次 |
| 実行時刻 | システムスケジューラーにより決定 |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | cron（ScheduledTask） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| スケジュールタスク登録 | CleanupUnusedDownloadMediaTaskがscheduled_taskテーブルに登録されていること |
| メッセージキュー稼働 | Symfony Messengerのワーカーが稼働していること |

### 実行可否判定

ScheduledTaskHandlerの基本機能によりタスクのステータスが"scheduled"の場合に実行されます。shouldRescheduleOnFailure()がtrueを返すため、失敗時は自動的に再スケジュールされます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | 入力パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| media | DB | メディアファイル情報を格納するテーブル |
| product_download | DB | ダウンロード商品とメディアの関連付けテーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| media | DB | 削除処理の対象テーブル（レコード削除） |

### 出力ファイル仕様

ファイル出力はありません（ファイル削除処理）。

## 処理フロー

### 処理シーケンス

```
1. バッチ開始
   └─ ScheduledTaskHandlerによりrun()メソッドが呼び出される
2. UnusedMediaPurgerの呼び出し
   └─ deleteNotUsedMedia()メソッド実行
3. 対象エンティティの指定
   └─ ProductDownloadDefinition::ENTITY_NAMEを指定
4. 未使用メディアの特定と削除
   └─ UnusedMediaPurgerが内部で処理
5. バッチ終了
   └─ 正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[UnusedMediaPurger呼び出し]
    B --> C[product_downloadを対象エンティティとして指定]
    C --> D[未使用メディアを特定]
    D --> E[メディアレコードと物理ファイルを削除]
    E --> F[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 使用状況確認 | product_download | SELECT | メディアの使用状況確認 |
| 未使用メディア削除 | media | DELETE | 未使用メディアレコードの削除 |

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

#### media

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | product_downloadに関連付けられていないメディア | UnusedMediaPurger経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | データベース接続エラー | DB接続失敗時 | タスク再スケジュール |
| - | ファイル削除エラー | 物理ファイル削除失敗時 | タスク再スケジュール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | ScheduledTaskHandler標準 |
| リトライ間隔 | ScheduledTaskHandler標準 |
| リトライ対象エラー | 一般的な例外 |

### 障害時対応

shouldRescheduleOnFailure()がtrueのため、失敗時は自動的に次回実行がスケジュールされます。繰り返し失敗する場合は、ストレージの権限設定やディスク容量を確認してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | UnusedMediaPurgerの内部処理に依存 |
| コミットタイミング | UnusedMediaPurgerの内部処理に依存 |
| ロールバック条件 | 処理中の例外発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十〜数百件/実行（月次のため） |
| 目標処理時間 | 10分以内 |
| メモリ使用量上限 | 標準PHPメモリ制限内 |

## 排他制御

同時実行は許可されています。UnusedMediaPurgerの内部でフレームワークの排他制御機構が適用されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | タスク開始（ScheduledTaskHandler標準） |
| 終了ログ | バッチ終了時 | タスク完了（ScheduledTaskHandler標準） |
| エラーログ | エラー発生時 | 例外情報（ScheduledTaskHandler標準） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 30分 | システム管理者 |
| 連続失敗回数 | 3回 | システム管理者 |

## 備考

- UnusedMediaPurgerサービスに処理を委譲
- ProductDownloadDefinition::ENTITY_NAME（'product_download'）をターゲットエンティティとして指定
- deleteNotUsedMedia()メソッドの引数：limit=null, offset=null, gracePeriodDays=null, folderEntity='product_download'
- 月次実行のため、大量の未使用メディアが蓄積される可能性があるが、デジタル商品の更新頻度に依存
- 物理ファイルの削除はUnusedMediaPurgerが内部で処理
