# 通知設計書 11-circe-notifications

## 概要

本ドキュメントは、Doom EmacsのIRCモジュールにおけるcirce-notifications機能の設計仕様を記述する。この機能は、IRCメッセージ受信時にOSネイティブのデスクトップ通知を送信し、ユーザーがIRCバッファを注視していない場合でも重要なメッセージを見逃さないようにする。

### 本通知の処理概要

circe-notificationsは、IRCクライアントcirceと連携し、特定の条件を満たすメッセージを受信した際にOSのデスクトップ通知機構を通じてユーザーに通知を行う機能である。

**業務上の目的・背景**：IRCはリアルタイムコミュニケーションツールであり、開発チームやコミュニティでの情報共有に広く使用されている。しかし、Emacsで他の作業を行っている間にIRCバッファを常に監視することは困難である。本通知機能により、ユーザーは自分宛のメッセージや重要なキーワードを含むメッセージを見逃すことなく、効率的にコミュニケーションを取ることが可能となる。

**通知の送信タイミング**：IRCサーバーからメッセージを受信し、以下の条件のいずれかを満たした場合に通知が送信される。(1) ユーザーのニックネームがメンションされた場合、(2) `circe-notifications-watch-strings`に設定されたキーワードがメッセージに含まれる場合、(3) プライベートメッセージを受信した場合。Emacsがフォーカスされている場合は通知を抑止する設定も可能。

**通知の受信者**：通知はEmacsを実行しているローカルユーザーのデスクトップに表示される。OSの通知センターを通じて配信されるため、ユーザーが他のアプリケーションを使用中でも視認可能。

**通知内容の概要**：通知には送信者のニックネーム、チャンネル名、メッセージ本文の一部が含まれる。通知のスタイルはOSの通知設定に依存する。

**期待されるアクション**：ユーザーは通知を確認後、必要に応じてEmacsのIRCバッファに切り替え、メッセージへの返信や対応を行うことが期待される。

## 通知種別

デスクトップ通知（OS依存）
- macOS: osx-notifier (terminal-notifier経由)
- Linux: libnotify (notify-send経由)

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | なし |

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

通知はローカルデスクトップに送信される。送信先の決定は不要（常にローカル）。ただし、`circe-notifications-emacs-focused`がnilの場合、Emacsがフォーカスされている状態では通知を抑止する。

## 通知テンプレート

### デスクトップ通知の場合

| 項目 | 内容 |
|-----|------|
| タイトル | {sender} ({channel}) |
| 本文 | {message-body} |
| アイコン | OSデフォルト |
| サウンド | OSデフォルト |

### 本文テンプレート

```
{sender}: {message-body}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| N/A | - | - | デスクトップ通知のため添付なし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| sender | メッセージ送信者のニックネーム | IRCメッセージ | Yes |
| channel | チャンネル名 | IRCメッセージ | Yes |
| message-body | メッセージ本文 | IRCメッセージ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| イベント | IRCメッセージ受信 | ニックネームメンション | 自分のニックネームが含まれるメッセージ |
| イベント | IRCメッセージ受信 | ウォッチキーワード一致 | circe-notifications-watch-stringsに一致 |
| イベント | プライベートメッセージ受信 | 常時 | プライベートメッセージは常に通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Emacsフォーカス時 | circe-notifications-emacs-focusedがnilの場合、Emacsがフォーカス中は通知を抑止 |
| 遅延タイマー有効時 | +irc-defer-notificationsで設定された期間は通知を遅延 |
| ボット送信 | +irc-bot-listに含まれるニックネームからのメッセージは通知対象外 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[IRCメッセージ受信] --> B{サーバー接続完了?}
    B -->|Yes| C{遅延タイマー有効?}
    B -->|No| Z[終了]
    C -->|Yes| D[タイマー満了まで待機]
    C -->|No| E[enable-circe-notifications実行]
    D --> E
    E --> F{通知条件チェック}
    F -->|メンション/キーワード一致| G{Emacsフォーカス中?}
    F -->|条件不一致| Z
    G -->|フォーカス中 & 抑止設定| Z
    G -->|フォーカス外 or 抑止なし| H[OS通知API呼び出し]
    H --> I[デスクトップ通知表示]
    I --> Z
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | - | データベースは使用しない |

### テーブル別参照項目詳細

本機能はデータベースを使用しない。設定はEmacs Lispの変数として管理される。

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| N/A | - | データベースは使用しない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 通知デーモン未起動 | libnotifyやterminal-notifierが利用不可 | エラーメッセージをログに記録、処理継続 |
| OS非対応 | macOS/Linux以外のOS | デフォルトスタイルにフォールバック |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（OS側の制限に依存） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

配信時間帯の制限なし（24時間配信可能）

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

- IRCメッセージは暗号化されていない場合があり、機密情報を含むメッセージは通知に表示される可能性がある
- デスクトップ通知は他者に見られる可能性があるため、公開の場での使用には注意が必要
- パスワードやトークンを含むメッセージは通知対象から除外することを推奨

## 備考

- ZNCなどのバウンサーを使用する場合、接続時のバッファ再生で大量の通知が発生する可能性がある
- `+irc-defer-notifications`を設定することで、接続直後の通知を一定時間遅延させることができる
- ボットからのメッセージは`+irc-bot-list`に追加することで通知対象外にできる

---

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

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

### 推奨読解順序

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

設定変数と通知システムの構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | config.el | `modules/app/irc/config.el` | +irc-defer-notifications, +irc-bot-list等の設定変数を確認 |

**読解のコツ**: Doom Emacsではdefvarでカスタマイズ可能な変数を定義している。プレフィックス「+」はモジュールローカルな変数を示す。

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

circe-notificationsの初期化と有効化の流れを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | config.el | `modules/app/irc/config.el` | use-package! circe-notificationsブロック（行144-159） |

**主要処理フロー**:
1. **行147-153**: `circe-server-connected-hook`で`+irc-init-circe-notifications-h`を登録
2. **行149-152**: 遅延設定がある場合は`run-at-time`でタイマーを設定
3. **行153**: 遅延なしの場合は即座に`enable-circe-notifications`を呼び出し
4. **行155-159**: OS依存の通知スタイル設定（macOS: osx-notifier, Linux: libnotify）

#### Step 3: サーバー接続とフック処理を理解する

IRC接続時の通知システム初期化を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | config.el | `modules/app/irc/config.el` | circe-server-connected-hookの処理 |

**主要処理フロー**:
- **行147-153**: サーバー接続完了時に通知を有効化

#### Step 4: 通知抑止ロジックを理解する

ボット除外とフォーカス状態による通知制御を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | config.el | `modules/app/irc/config.el` | circe-message-option-functionsのフック（行94-98） |
| 4-2 | config.el | `modules/app/irc/config.el` | circe-notifications-emacs-focused設定（行155） |

**主要処理フロー**:
- **行94-98**: ボットリストに含まれるニックネームは`lui-do-not-track`を設定

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

```
circe-server-connected-hook
    │
    └─ +irc-init-circe-notifications-h
           │
           ├─ [遅延設定あり] run-at-time
           │      └─ enable-circe-notifications
           │
           └─ [遅延設定なし] enable-circe-notifications
                   │
                   └─ circe-notifications (外部パッケージ)
                          │
                          ├─ [macOS] osx-notifier → terminal-notifier
                          │
                          └─ [Linux] libnotify → notify-send
```

### データフロー図

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

IRCメッセージ ───▶ circe ───▶ circe-notifications ───▶ OS通知API
                      │                │
                      │                ├─ メンション判定
                      │                ├─ キーワード判定
                      │                └─ フォーカス状態判定
                      │
                      └─ +irc-bot-list判定（ボット除外）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| config.el | `modules/app/irc/config.el` | ソース | IRCモジュールの設定、circe-notifications初期化 |
| irc.el | `modules/app/irc/autoload/irc.el` | ソース | IRC関連の自動ロード関数 |
| packages.el | `modules/app/irc/packages.el` | 設定 | circe-notificationsパッケージの定義 |
