Auto 関係のモジュール

エイリアスは基本的にname,userの二つのフィールドから成っており、
それぞれユーザー名、ユーザーマスクを表します。

 エイリアス定義ファイルのパスと、そのエンコーディング。
 このファイルは次のようなフォーマットである。
 1. それぞれの行は「<キー>: <値>」の形式である。
 2. 空の行で、各ユーザーを区切る。
 3. <値>はカンマで区切られて複数の値とされる。

 エイリアス定義ファイルの例:

 name: sample
 user: *!*sample@*.sample.net

 name: sample2,[sample2]
 user: *!sample2@*.sample.net,*!sample2@*.sample2.net

この発言をした人のエイリアスが登録されていれば、それをprivで送る。

「<addで指定したキーワード> user *!*user@*.user.net」のようにして情報を追加。
発言をした人のエイリアスが未登録だった場合は、userのみ受け付けて新規追加とする。

「<removeで指定したキーワード> name ユーザー」のようにして情報を削除。
userを全て削除されたエイリアスは他の情報(name等)も含めて消滅する。

メッセージが追加されたときの反応を指定します。
ランダムなメッセージを発言する際のフォーマットを指定します。
エイリアス置換が有効です。#(nick.now)、#(channel)は
それぞれ相手のnick、チャンネル名に置換されます。
#(key)、#(value)は、追加されたキーと値に置換されます。

メッセージが削除されたときの反応を指定します。
added-formatで指定できるものと同じです。

エイリアスの追加や削除が許されている人。省略された場合は「*!*@*」と見做される。

Auto::Aliasを有効にしていれば、エイリアス置換を行ないます。

 反応する発言と、それに対する返事を定義します。
 エイリアス置換が有効です。#(nick.now)と$(channel)はそれぞれ
 相手の現在のnickとチャンネル名に置換されます。

 コマンド: reply
 書式: <反応する発言のマスク> <それに対する返事>
 例:

 この例では誰かが「こんにちは」で始まる発言をすると、
 発言した人のエイリアスを参照して「こんにちは、○○さん。」のように発言します。

 コマンド: channel-reply
 書式: <反応するチャンネルのマスク> <反応する発言のマスク> <それに対する返事>
 例:

 この例では#あいさつ@ircnetで誰かが「こんにちは」で始まる発言をすると、
 発言した人のエイリアスを参照して「こんにちは、○○さん。」のように発言します。

 コマンド: answer-to-myself
 書式: <真偽値>
 例:

自分の発言にも反応するようになります。
デフォルトは off です。

反応する発言を指定します。

使用を許可する人&チャンネルのマスク。
例はTiarraモード時。 [default: なし]

[plum-mode] mask: +*!*@*

結果が未定義だったときに置き換えられる文字列。省略されると undef 。

正常に計算できたときのフォーマット
method: 計算式, result: 結果, error: エラー, signal: シグナル

エラーが起きたときのフォーマット
method: 計算式, result: 結果, error: エラー, signal: シグナル

シグナルが発生したときのフォーマット

signal-$SIGNALNAME-format 形式。
$SIGNALNAME には現状 alarm/sigfpe があります。
該当がなければ signal-format にフォールバックします。

いくつかの例を挙げます。

タイムアウトする秒数を指定します。 alarm に渡されます。
再帰を止めるのに使えますが、どうもメモリリークしていそうな雰囲気です。

サブルーチン定義を許可するかどうかを指定する。
再帰定義が可能なので、許可する場合はこのモジュール専用の
Tiarra を動かすことをお勧めします。

初期化する発言を指定します。
このモジュールでは現状変数や関数定義などを行えます。
このコマンドが発行されるとそれらをクリアします。

初期化を許可する人&チャンネルのマスク。
例はTiarraモード時。 [default: なし]

[plum-mode] mask: +*!*@*

再初期化したときの発言を指定します。

別の shared-mode な System::WebClient からの発言に対応(yes/no).
自分自身の発言は未対応.
[default: no]

+で始まらない特定のチャンネルで、+aモードでも+rモードでもないのに
誰もチャンネルオペレータ権限を持っていない状態になっている時、
そこに誰かがJOINする度に特定のメッセージを発言するモジュールです。

書式: <チャンネル名> <メッセージ>

リクエストタイムアウトまでの時間(秒).

 有効にするチャンネルとオプションとURLの設定.
 書式: mask: <channel> [<&conf>...] <url>

 mask: #test@ircnet &test http://*
 mask: * http://*

 &test と設定すると conf-test ブロックの中身が使われる.
conf-test {
  auth-test1 {
    url: http://example.com/*
    url: http://example.org/*
    user: test
    #pass: test
    pass: {BASE64}dGVzdAo=
  }
  filter-xx {
    url: http://example.com/*/xx/*
    type: xx
  }
}

お返事の前や後ろにつける字句.

 デバッグフラグ.
debug: 0
debug-mask: #debug-chan your_nick!~you@example.com
debug-dumpfile: fetchtitle.log

NOTE:
 利用するにはCodeReposから
 module/Tools/HTTPClient.pm rev.8220
 main/Tiarra/Socket/Buffered.pm rev.8219
 以降が必要です.

Auto::FetchTitle { ... } での設定.
+ Auto::FetchTitle {
    plugins {
      ExtractHeading {
        extra: name1 name2 ...
        extra-name1 {
          url: http://www.example.com/*
          recv_limit: 10*1024
          extract: re:<div id="title">(.*?)</div>
        }
      }
   }
 }

 Auto::FetchTitle { ... } での設定.

 + Auto::FetchTitle {
    mask: #* &mixi http://*
    plugins {
      Mixi {
        mixi-user: xxx
        mixi-pass: yyy
      }
    }
    conf-mixi {
      filter-mixi {
        url: http://mixi.jp/*
        url: http://news.mixi.jp/*
        type: mixi
        timeout: 10
        #閲覧可能なコミュニティの指定.
        #mixi-community: 0
        #閲覧可能なユーザの指定.
        #指定したユーザには足跡踏んで見に行きます.
        #mixi-friend: 0
        #閲覧可能にしていないページを表示したときのメッセージ.
        #要求されたページを #(url) で展開できます.
        #mixi-noperm-msg: not permitted #(url).
      }
    }
  }

 アカウント情報は plugins Mixi に記述.
 mixi-pass には {B}bbbb でBASE64エンコード値も可能.

 newsだけしか使わない場合でも, ログイン処理が必要なので
 mixi.jp 内のいくつかのURLはこのプラグインで処理する必要があります.
   url: http://news.mixi.jp/*
   url: http://mixi.jp/issue_ticket.pl?*
   url: http://mixi.jp/login.pl
   url: http://mixi.jp/check.pl?*
 (それぞれ, ニュースページ, ログイン処理, エラー検出, 途中経路になります.)

反応する人のマスクを指定します。
省略すると全員に反応します。

反応するキーワードを正規表現で指定します。
複数指定したい時は複数行指定してください。

反応するキーワードを指定します。
複数指定したい時は,(コンマ)で区切るか、複数行指定してください。

im.kayac.com に送るメッセージのフォーマットを指定します。
デフォルト値: [tiarra][#(channel):#(nick.now)] #(text)
#(channel) のかわりに #(raw_channel) を利用するとネットワーク名がつきません。

im.kayac.comで登録したユーザ名を入力します。
im.kayac.comについては http://im.kayac.com/#docs を参考にしてください。

im.kayac.comで秘密鍵認証を選択した場合は設定してください。
省略すると認証なしになります。

im.kayac.comでパスワード認証を選択した場合は設定してください。
省略すると認証なしになります。
secret と両方指定した場合は secret が優先されています。

Auto::Aliasを有効にしていれば、エイリアス置換を行ないます。

 発言を行なうチャンネルと、その内容を定義します。
 #(nick.now)と$(channel)は、それぞれ相手の現在のnickとチャンネル名に置換されます。

 書式: <チャンネル名> <発言内容>

メールアドレスはエイリアスの mail を参照します。

Fromアドレス。[default: OSのユーザ名]

送信用のキーワード [default: mesmail_send]

使用を許可する人&チャンネルのマスク。
例はTiarraモード時。 [default: なし]

[plum-mode] mask: +*!*@*

maskで拒否されたときのメッセージ [default: なし]

一度に送れる宛先の量 [default: 無制限]

宛先を探すエイリアスエントリ [default: なし]

宛先の人を判別出来なかったときのメッセージ [default: なし]

メールの日付形式

エイリアスは見付かったけれどメールアドレスが登録されていなかったときのメッセージ。 [default: なし]

SMTPのホスト [default: localhost]

SMTPのポート [default: smtp(25)]

SMTPで自ホストのFQDN [default: localhost]

SMTPのユーザ。指定されれば SMTP Auth を行う [default: なし]

SMTPのパスワード [default: 空パスワード('')]

送信するメールの既定件名(エイリアス使用不可) [default: Message from IRC]

送信するメールの本文 [default: #(date) << #(from.name|from.nick|from.nick.now) >> #(message)]

送信したときのメッセージ。 [default: なし]

---- POP before SMTP の指定 ----
POP before SMTPを使う。 [default: no]

POP before SMTPのタイムアウト時間(分)。分からない場合は指定しなくて良い。 [default: 0]

POPのホスト。 [default: localhost]

POPのポート。 [default: pop(110)]

POPのユーザ [default: OSのユーザ名]

POPのパスワード [default: 空パスワード('')]

---- エラーメッセージの設定 ----

一般エラー。
error-[state] と言う形式で詳細エラーメッセージを指定できる。
[state]は、
   * mailfrom(メールの送信者を指定しようとしてエラー)
   * rcptto(メールの送信先を指定しようとしてエラー)
   * norcptto(メールの送信先が全部無くなった)
   * data(メールの中身を送信しようとしてエラー)
   * finish(メールの中身を送信したらエラー)
がある。特に欲しくなければerror-[state]は指定しなくても構わない。
メッセージを出したくないなら中身の無いエントリを指定すれば良い。
error-[state]が指定されてない場合は代わりに error を使う。 [default: 未定義]

致命的なエラー。メールに個別なエラーではないので送信者(のprefix)毎に1メッセージ送られる。
fatalerror-[state]
[state]:
   * first(接続エラー)
   * helo(SMTPセッションを開始出来ない)
がある。特に欲しくなければfatalerror-[state]は指定しなくても構わない。
メッセージを出したくないなら中身の無いエントリを指定すれば良い。
fatalerror-[state]が指定されてない場合は代わりに fatalerror を使う。 [default: 未定義]

反応する人のマスクを指定します。
省略すると全員に反応します。

反応するキーワードを正規表現で指定します。
複数指定したい時は複数行指定してください。

反応するキーワードを指定します。
複数指定したい時は,(コンマ)で区切るか、複数行指定してください。

メッセージのフォーマットを指定します。
デフォルト値: [tiarra][#(channel):#(nick.now)] #(text)
#(channel) のかわりに #(raw_channel) を利用するとネットワーク名がつきません。

使用するブロックを指定します

Auto::Aliasを有効にしていれば、エイリアス置換を行ないます。

+oを要求する文字列(マスク)を指定します。

チャンネルオペレータ権限を要求した人と要求されたチャンネルが
ここで指定したマスクに一致しなかった場合は
denyで指定した文字列を発言し、+oをやめます。
省略された場合は誰にも+oしません。
書式は「チャンネル 発言者」です。
マッチングのアルゴリズムは次の通りです。
1. チャンネル名にマッチするmask定義を全て集める
2. 集まった定義の発言者マスクを、定義された順にカンマで結合する
3. そのようにして生成されたマスクで発言者のマッチングを行ない、結果を+o可能性とする。
例1:
mask: *@2ch* *!*@*
mask: #*@ircnet* *!*@*.hoge.jp
この例ではネットワーク 2ch の全てのチャンネルで誰にでも +o し、
ネットワーク ircnet の # で始まる全てのチャンネルでホスト名 *.hoge.jp の人に+oします。
#*@ircnetだと「#hoge@ircnet:*.jp」などにマッチしなくなります。
例2:
mask: #hoge@ircnet -*!*@*,+*!*@*.hoge.jp
mask: * +*!*@*
基本的に全てのチャンネルで誰にでも +o するが、例外的に#hoge@ircnetでは
ホスト名 *.hoge.jp の人にしか +o しない。
この順序を上下逆にすると、全てのチャンネルで全ての人を +o する事になります。
何故なら最初の* +*!*@*が全ての人にマッチするからです。

+oを要求した人を実際に+oする時、ここで指定した発言をしてから+oします。
#(name|nick)のようなエイリアス置換を行います。
エイリアス以外でも、#(nick.now)を相手のnickに、#(channel)を
そのチャンネル名にそれぞれ置換します。

+oを要求されたが+oすべき相手ではなかった場合の発言。
省略されたら何も喋りません。

+oを要求されたが相手は既にチャンネルオペレータ権限を持っていた場合の発言。
省略されたらdenyに設定されたものを使います。

+oを要求されたが自分はチャンネルオペレータ権限を持っていなかった場合の発言。
省略されたらdenyに設定されたものを使います。

チャンネルに対してでなく自分に対して+oの要求を行なった場合の発言。
省略されたらdenyに設定されたものを使います。

チャンネルの外から+oを要求された場合の発言。+nチャンネルでは起こりません。
省略されたらdenyに設定されたものを使います。

復活の呪文。

送信対象にするコマンドの設定。
省略された場合は PRIVMSG 。
パラメータ1が送信先、パラメータ2が本文でなければ動作しないので、
動作するコマンドは PRIVMSG/NOTICE/TOPIC/PART 程度。

各チャンネルのURIの設定。
記述された順序で検索されるので、全てのチャンネルにマッチする"*"などは最後に書かなければならない。
フォーマットは次の通り。
channel: <URI> (<チャンネル名> / 'priv')@<ネットワーク名>
#(channel) はチャンネル名に、 #(channel_short) はネットワークなしの
チャンネル名に、 #(network) はネットワーク名にそれぞれ置き換えられる。
また、危険な文字は自動的にエスケープされる。

Auto::Aliasを有効にしていれば、エイリアス置換を行ないます。

使用するブロックの定義。

Auto::Aliasを有効にしていれば、エイリアス置換を行ないます。

使用するブロックの定義。
省略すると std を使用.
複数個の blocks の指定も可能.

大量の反応データを定義するのに向いています。

データファイルのフォーマット
| pattern: re:^(こん(に)?ちは)
| rate: 90
| mask: * *!*@*
| #plum: mask: *!*@*
| response: こんにちは。
| response: いらっしゃいませ。
|
| pattern: おやすみ
| rate: 20
| response: おやすみなさい。
patternは一行しか書けません。(手抜き
maskもrateも省略できます。省略した場合はmaskは全員、rateは100となります。
responseは複数書いておけばランダムに選択されます。

データファイル

文字コード

使用を許可する人&チャンネルのマスク。

plum: mask: +*!*@*