# 通知設計書 15-AlreadyExistsException

## 概要

本ドキュメントは、HH\Lib\OS\AlreadyExistsException例外クラスの設計を記述する。この例外は、リソースが既に存在する場合に発生するエラーを通知するためのものである。

### 本通知の処理概要

AlreadyExistsExceptionは、OSレベルでファイルやディレクトリなどのリソースが既に存在する際に、アプリケーションに対してエラー状態を通知する例外クラスである。POSIX errnoのEEXIST（既存リソース）エラーに対応し、ErrnoExceptionの具象クラスとして実装されている。

**業務上の目的・背景**：ファイルシステム操作において、新規作成を試みた対象が既に存在する場合（例：同名ファイルの作成、ディレクトリの重複作成、排他的作成モードでのopen等）、この状態を明確に識別してハンドリングする必要がある。AlreadyExistsExceptionは、このような重複エラーを型安全に表現し、リソース競合状態を明確に通知する。

**通知の送信タイミング**：この例外は以下のような状況で発生する。(1) O_CREATとO_EXCLフラグでファイルを作成しようとした際にファイルが既存の場合。(2) mkdirで既存のディレクトリを作成しようとした場合。(3) リンク作成時に同名のファイルが既に存在する場合。(4) 一意性が必要な操作で重複が検出された場合。

**通知の受信者**：この例外は、ファイルシステム操作を実行しているコード（呼び出し元）に対してスローされる。具体的には、ファイル・ディレクトリの作成処理を実装しているアプリケーションコードが受信者となる。

**通知内容の概要**：例外オブジェクトには、発生したerrnoコード（EEXIST）とエラーメッセージが含まれる。getErrno()メソッドにより具体的なエラーコードを取得可能である。

**期待されるアクション**：受信者は、この例外をキャッチして適切なエラーハンドリングを行うことが期待される。典型的には、既存リソースの確認・上書き判断、別名での再試行、ユーザーへの確認要求、または既存リソースの使用などを行う。

## 通知種別

例外スロー（Exception Throw）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（例外スロー） |
| 優先度 | 中（条件付きエラー） |
| リトライ | N/A（例外のため） |

### 送信先決定ロジック

例外は、ファイルシステム操作を実行した呼び出し元のコードに対してスローされる。コールスタックに沿って上位に伝播し、適切なtry-catchブロックで捕捉される。

## 通知テンプレート

### 例外メッセージの場合

| 項目 | 内容 |
|-----|------|
| 例外クラス | HH\Lib\OS\AlreadyExistsException |
| 親クラス | HH\Lib\OS\ErrnoException |
| 形式 | 文字列メッセージ |

### 本文テンプレート

```
EEXIST({ERRNO_VALUE}): {ERROR_MESSAGE}
```

例：
- `EEXIST(17): File exists: /tmp/myfile.txt`
- `EEXIST(17): Directory already exists: /home/user/newdir`

### 添付ファイル

該当なし（例外通知のため）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ERRNO_VALUE | エラー番号の数値 | errno.h定義値（17） | Yes |
| ERROR_MESSAGE | エラーの詳細メッセージ | 呼び出し元から提供 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムコール | open(O_CREAT\|O_EXCL) | ファイルが既存 | 排他的作成モードで既存ファイル |
| システムコール | mkdir() | ディレクトリが既存 | 既存ディレクトリの作成試行 |
| システムコール | link()/symlink() | リンク先が既存 | 既存パスへのリンク作成 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| O_EXCLなし | O_CREATのみの場合は既存ファイルを開く |
| 上書きモード | O_TRUNCなどの上書きモードでは例外なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[作成操作実行] --> B{リソース存在確認}
    B -->|存在しない| C[作成成功]
    B -->|存在する| D{排他的作成?}
    D -->|No| E[既存リソースを開く]
    D -->|Yes| F[AlreadyExistsException生成]
    F --> G[メッセージ設定]
    G --> H[例外スロー]
    H --> I[呼び出し元でキャッチ]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（ファイルシステム/OS例外のため）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| EEXIST | リソース既存 | 上書き確認、別名使用、既存利用 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A（同一パスでは無効） |
| リトライ間隔 | N/A |
| リトライ対象エラー | 別名で再試行可能 |

## 配信設定

### レート制限

該当なし（例外スローのため）

### 配信時間帯

該当なし

## セキュリティ考慮事項

- エラーメッセージでファイルパスを公開する際のセキュリティ考慮
- TOCTOU（Time-of-check to time-of-use）攻撃への注意

## 備考

- AlreadyExistsExceptionはErrnoExceptionを直接継承（ConnectionExceptionではない）
- EEXISTのみを処理するため、コンストラクタはメッセージのみを受け取る設計
- _getValidErrno()メソッドでEEXISTを返却
- ファイルロック(flock)関連ではFile\AlreadyLockedExceptionが使用される

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、Errno列挙型とErrnoExceptionの継承階層を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Errno.php | `src/os/Errno.php` | EEXISTの定義（55行目） |
| 1-2 | ErrnoException.php | `src/os/ErrnoException.php` | 例外クラス階層の理解（52-165行目） |

**読解のコツ**: EEXISTは_OS\EEXISTを参照しており、通常は17の値を持つ。

#### Step 2: エントリーポイントを理解する

例外がスローされる起点となるコードを特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Errno.php (private) | `src/os/_Private/Errno.php` | throw_errno関数とget_throw_errno_impl関数（16-68行目） |

**主要処理フロー**:
1. **17-28行目**: single_code配列にAlreadyExistsExceptionが含まれる（22行目）
2. **45-50行目**: single_codeループで_getValidErrno()を取得しスロー関数を登録
3. **61-67行目**: errno値に基づいて適切な例外をスロー

#### Step 3: 例外クラスの実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ErrnoException.php | `src/os/ErrnoException.php` | AlreadyExistsExceptionの実装（157-165行目） |

**主要処理フロー**:
- **157行目**: final classとしてErrnoExceptionを継承
- **158-160行目**: コンストラクタでメッセージのみを受け取りEEXISTを設定
- **162-164行目**: _getValidErrno()でEEXISTを返却

#### Step 4: 使用例を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | MkdtempTest.php | `tests/os/MkdtempTest.php` | ファイルシステム操作のテスト例 |

**主要処理フロー**:
- **17-31行目**: mkdtempの基本的な使用例（成功ケース）
- **33-39行目**: 不正なパターンでのエラー処理例

### プログラム呼び出し階層図

```
アプリケーションコード
    │
    ├─ OS\open(O_CREAT | O_EXCL)
    │      └─ wrap_impl()
    │             └─ throw_errno(EEXIST, ...)
    │                    └─ new AlreadyExistsException($msg)
    │
    ├─ OS\mkdir()
    │      └─ throw_errno(EEXIST, ...)
    │             └─ new AlreadyExistsException($msg)
    │
    └─ _Private\_OS\wrap_impl()
           └─ throw_errno()
                  └─ get_throw_errno_impl()
                         └─ throw new AlreadyExistsException($msg)
```

### データフロー図

```
[入力]                [処理]                           [出力]

作成操作呼び出し ───▶ OSシステムコール実行 ───▶ リソース存在確認
                           │
                           ▼
                      errno判定
                      (EEXIST)
                           │
                           ▼
                 AlreadyExistsException生成
                           │
                           ▼
                      例外スロー ───▶ 呼び出し元のcatchブロック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ErrnoException.php | `src/os/ErrnoException.php` | ソース | AlreadyExistsExceptionクラス定義（157-165行目） |
| Errno.php | `src/os/Errno.php` | ソース | EEXIST定数定義（55行目） |
| Errno.php | `src/os/_Private/Errno.php` | ソース | throw_errno関数実装、single_code配列定義 |
| wrap_impl.php | `src/os/_Private/wrap_impl.php` | ソース | OSエラーラッパー |
| open.php | `src/os/open.php` | ソース | ファイルオープン関数 |
| mkdtemp.php | `src/os/mkdtemp.php` | ソース | 一時ディレクトリ作成関数 |
| MkdtempTest.php | `tests/os/MkdtempTest.php` | テスト | ファイルシステム操作テスト |
