# 通知設計書 17-IsADirectoryException

## 概要

本ドキュメントは、HH\Lib\OS\IsADirectoryException例外クラスの設計を記述する。この例外は、ファイルとして期待される対象がディレクトリであった場合に発生するエラーを通知するためのものである。

### 本通知の処理概要

IsADirectoryExceptionは、OSレベルでファイル操作対象がディレクトリであった際に、アプリケーションに対してエラー状態を通知する例外クラスである。POSIX errnoのEISDIR（Is a directory）エラーに対応し、ErrnoExceptionの具象クラスとして実装されている。

**業務上の目的・背景**：ファイルシステム操作において、ファイルを期待する操作がディレクトリに対して実行された場合（例：ディレクトリを通常ファイルとしてopen、ディレクトリへの書き込み等）、この状態を明確に識別してハンドリングする必要がある。IsADirectoryExceptionは、このような種別の不一致エラーを型安全に表現し、リソースタイプの誤りを明確に通知する。

**通知の送信タイミング**：この例外は以下のような状況で発生する。(1) ディレクトリを書き込みモードでopen（O_WRONLY/O_RDWR）した場合。(2) ディレクトリに対してunlink()を呼び出した場合（一部システム）。(3) ファイル専用の操作をディレクトリに対して実行した場合。

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

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

**期待されるアクション**：受信者は、この例外をキャッチして適切なエラーハンドリングを行うことが期待される。典型的には、パスの検証、ディレクトリ用の別処理への切り替え、ユーザーへのエラー通知などを行う。

## 通知種別

例外スロー（Exception Throw）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

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

例：
- `EISDIR(21): Is a directory: /home/user`
- `EISDIR(21): Cannot write to directory: /tmp/mydir`

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムコール | open(O_WRONLY) | 対象がディレクトリ | ディレクトリを書き込みオープン |
| システムコール | open(O_RDWR) | 対象がディレクトリ | ディレクトリを読み書きオープン |
| システムコール | unlink() | 対象がディレクトリ | ディレクトリの削除試行 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| O_RDONLY | 読み取り専用でディレクトリを開く場合は許可 |
| O_DIRECTORY | ディレクトリ専用オープン時は許可 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ファイル操作実行] --> B{対象の種別確認}
    B -->|ファイル| C[操作続行]
    B -->|ディレクトリ| D{操作種別}
    D -->|許可された操作| E[操作続行]
    D -->|ファイル専用操作| F[IsADirectoryException生成]
    F --> G[メッセージ設定]
    G --> H[例外スロー]
    H --> I[呼び出し元でキャッチ]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| EISDIR | 対象がディレクトリ | パス検証、処理切り替え |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

該当なし

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

- エラーメッセージでディレクトリ構造を公開する際のセキュリティ考慮

## 備考

- IsADirectoryExceptionはErrnoExceptionを直接継承
- EISDIRのみを処理するため、コンストラクタはメッセージのみを受け取る設計
- _getValidErrno()メソッドでEISDIRを返却
- IsNotADirectoryException（ENOTDIR）と対になる例外

---

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

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

### 推奨読解順序

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

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

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

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

#### 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配列にIsADirectoryExceptionが含まれる（24行目）
2. **45-50行目**: single_codeループで_getValidErrno()を取得しスロー関数を登録
3. **61-67行目**: errno値に基づいて適切な例外をスロー

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

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

**主要処理フロー**:
- **177行目**: final classとしてErrnoExceptionを継承
- **178-180行目**: コンストラクタでメッセージのみを受け取りEISDIRを設定
- **182-184行目**: _getValidErrno()でEISDIRを返却

#### Step 4: 関連例外との比較

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | ErrnoException.php | `src/os/ErrnoException.php` | IsNotADirectoryExceptionとの比較（187-195行目） |

**主要処理フロー**:
- **177-185行目**: IsADirectoryException（EISDIR）- 対象がディレクトリ
- **187-195行目**: IsNotADirectoryException（ENOTDIR）- 対象がディレクトリではない

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

```
アプリケーションコード
    │
    ├─ OS\open(O_WRONLY) on directory
    │      └─ wrap_impl()
    │             └─ throw_errno(EISDIR, ...)
    │                    └─ new IsADirectoryException($msg)
    │
    └─ _Private\_OS\wrap_impl()
           └─ throw_errno()
                  └─ get_throw_errno_impl()
                         └─ throw new IsADirectoryException($msg)
```

### データフロー図

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

ファイル操作 ───▶ OSシステムコール ───▶ 対象種別確認
                        │
                        ▼
                   対象がディレクトリ
                   errno = EISDIR
                        │
                        ▼
               IsADirectoryException生成
                        │
                        ▼
                   例外スロー ───▶ 呼び出し元のcatchブロック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ErrnoException.php | `src/os/ErrnoException.php` | ソース | IsADirectoryExceptionクラス定義（177-185行目） |
| Errno.php | `src/os/Errno.php` | ソース | EISDIR定数定義（59行目） |
| 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` | ソース | ファイルオープン関数 |
