Wikipedia:編集へんしゅうフィルター/作つくり方かた

フィルターを作つくる

この節ふしでは、最近さいきん更新こうしんしたフィルターをあふれさせないように、予備よびテストをしてフィルターを作つくる方法ほうほうを説明せつめいします。

• ルールの書式しょしきを読よみます。
• デバッグツール

  たとえば、'文字もじ列れつ' rlike '正規せいき表現ひょうげん'を入力にゅうりょくします。結果けっかが真しんならば1が表示ひょうじされ、偽にせなら何なにも表示ひょうじされません。

• テストページ

  対象たいしょうにしたい操作そうさを最近さいきん行おこなった利用りよう者しゃを探さがします。

  「変更へんこうした利用りよう者しゃ:」欄らんにそのユーザー名めいを入力にゅうりょくし、「テスト」ボタンをクリックします。

  もし、発動はつどう条件じょうけんが有効ゆうこうにならない場合ばあい、

  「フィルターに一致いっちしない変更へんこうを表示ひょうじする」を有効ゆうこうにし、再度さいどテストします。

  あなたが対象たいしょうとしていた操作そうさを見みつけたら、「(分析ぶんせき)」をクリックし、変数へんすうを確認かくにんしてください。

• 作成さくせいしたいフィルターが有用ゆうようなものに出来できそうであれば、Wikipedia:編集へんしゅうフィルター/提案ていあんで提案ていあんし、作成さくせいに関かんして合意ごうい形成けいせいをしてください。
• 合意ごういがとれたら、特別とくべつ:不正ふせい利用りようフィルター/newから、対処たいしょ操作そうさのない（つまり、ログを取とるだけの）フィルターを作成さくせいし、1週間しゅうかんの試験しけん運用うんようを行おこないます。

  これは、誤作動ごさどう（対象たいしょうではないのに作動さどうする、あるいは対象たいしょうなのに作動さどうしないなど）がないかのテストのために必要ひつようです。

  メモ:の欄らんに「試験しけん運用うんよう中ちゅう -- あなたの利用りよう者しゃ名めい 日付ひづけ」のように、試験しけん運用うんようを開始かいししたことを書かいてください。

• Wikipedia:編集へんしゅうフィルター/提案ていあんにある提案ていあんを試験しけん運用うんよう中ちゅうに変更へんこうし、他たの人ひとがあなたのフィルターを修正しゅうせいしたり警告けいこくを改善かいぜんしたりできるようにしてください。
• 試験しけん期間きかんを経へて問題もんだいが起おきなければ、最後さいごに、作成さくせいしたフィルターに対処たいしょ操作そうさを付与ふよしてください。

既存きそんのフィルターの再さい利用りよう

削除さくじょ/無効むこう化かしてあるフィルターを、中身なかみを全まったく違ちがうものとして書かき直なおして使用しようしたり、フィルターの中身なかみを分離ぶんりし分離ぶんり元もとのフィルターと目的もくてきも中身なかみも全まったく違ちがうものにしたりすると、過去かこのコードや一致いっち記録きろくに複数ふくすう条件じょうけんが混在こんざいしてしまうため、読よみにくく、検索けんさくしにくくなります。可能かのうな限かぎり新規しんきに作成さくせいするようにしましょう。

フィルターを編集へんしゅうする

編集へんしゅうフィルターは、編集へんしゅうフィルター編集へんしゅう者しゃであれば、誰だれでも編集へんしゅうすることができます。

フィルターを編集へんしゅうした際さいには、メモの部分ぶぶんに、その変更へんこうの要約ようやくと署名しょめいを「要約ようやく -- あなたの利用りよう者しゃ名めい 日付ひづけ」のように書かいてください。

性能せいのうを上あげる

これらのフィルターはあらゆる編集へんしゅう時じに働はたらくので、フィルターは編集へんしゅう速度そくどの著いちじるしい低下ていかや、大おおきなページのタイムアウトを引ひき起おこす可能かのう性せいがあります。しかし、発動はつどう条件じょうけんへのほんの小ちいさな修正しゅうせいでフィルターの動作どうさ時間じかんを短縮たんしゅくできるかもしれません。演算えんざんの順序じゅんじょを意識いしきすることでパフォーマンスの差さが生しょうじることがあります。

演算えんざん順序じゅんじょ

演算えんざんは原則げんそくとして左ひだりから右みぎに向むかいますが、それ以外いがいの順序じゅんじょもありえます。フィルターが条件じょうけんの一ひとつに引ひっかかると、残のこりの条件じょうけんチェックは中止ちゅうしされ（短絡たんらく評価ひょうか）、次つぎのフィルターに移うつります。評価ひょうか順序じゅんじょは次つぎの通とおりです。

1. 括弧かっこの中なか ((Expression))
2. 数値すうち、文字もじ列れつ、変数へんすう (123, "abc", user_name, …)
3. 関数かんすう (norm ,lcase, …)
4. 符号ふごう (+, -)
5. キーワード
6. 論理ろんり否定ひてい (!x)
7. 累乗るいじょう (2**3)
8. 乗算じょうざん、除算じょざん、剰余じょうよ(*, /, %)
9. 比較ひかく演算えんざん子こ (<, >, ==)
10. 論理ろんり演算えんざん子こ (&, |, ^, in)

フィルターの負荷ふかを軽かるくする

rlike, inやcontainsのようなキーワードを使つかう場合ばあい、フィルターは文字もじ列れつ全体ぜんたいから検索けんさくしなければなりません。old_wikitext のような変数へんすうはとても大おおきくなりがちです。そういった場合ばあい、added_lines や removed_linesのような変数へんすうで、それに近ちかい、または同等どうとうの効果こうかを得えられ、かつ何なん倍ばいにも高速こうそくにすることができます。また、old_size にチェックを入いれることで、テキスト全体ぜんたいをチェックしようとしているのではないと確認かくにんすることができます。

もっとも当あてはまりやすいような条件じょうけんが最初さいしょに来くるようにフィルターを順序じゅんじょづけるべきです。おおむね、利用りよう者しゃグループや利用りよう者しゃの編集へんしゅう回数かいすうのチェックがこれに当あたります。原則げんそくとして、あなたがターゲットにしている種類しゅるいの荒あらしを探さがす正規せいき表現ひょうげんを最終さいしゅう条件じょうけんとすべきです。

発動はつどう条件じょうけんにはコメントを書かく

発動はつどう条件じょうけん式しきは「式しき」であるので、一般いっぱん的てきに、人間にんげんにとってそのまま理解りかいしやすい形式けいしきではありません。 特とくに、条件じょうけんが複雑ふくざつになってくると、その式しき（1行ぎょう）が何なにを目的もくてきとした式しきなのかを理解りかいすることは難むずかしくなります。

ですから、発動はつどう条件じょうけんには、なるべく詳くわしくコメントを書かくようにしてください。 コメントは/* コメント */のように、「/*」と「*/」で挟はさんでください。

メモを活用かつようする

各かく編集へんしゅうフィルターには、発動はつどう条件じょうけんのみではなく、公開こうかいフィルターであれば誰だれでも、非公開ひこうかいフィルターであれば編集へんしゅうフィルター編集へんしゅう者しゃが閲覧えつらんすることができる「メモ」があります。

このメモは通常つうじょう、フィルターの簡単かんたんな説明せつめいと変更へんこう要約ようやくの保存ほぞんに使つかわれており、概おおむね以下いかのような形式けいしきが推奨すいしょうされます。

このフィルターは、こういう条件じょうけんのもとでこういう動作どうさを実行じっこうします。
:[[Wikipedia:編集へんしゅうフィルター/一覧いちらん/フィルター名めい]]

== 変更へんこう要約ようやく ==
変更へんこうしたことA -- 編集へんしゅう者しゃ名めい （変更へんこう日び）
: 変更へんこうしたことAa -- ウィキすけ 2011-01-01
: 変更へんこうしたことAb -- ウィキさん 2011-01-02
:: 変更へんこうしたことAba -- ウィキすけ 2011-02-01

変更へんこうしたことB -- ウィキくん 2011-01-15
: 変更へんこうしたことBa -- ウィキくん 2011-01-16

他たのフィルター編集へんしゅう者しゃまたは利用りよう者しゃのためにも、メモは面倒臭めんどうくさがらず丁寧ていねいに作成さくせいし残のこすようにしてください。

誤動作ごどうさを防ふせぐ工夫くふうをする

以下いかのような構文こうぶん上じょうの工夫くふうをすることで、誤動作ごどうさを防ふせぐことができる場合ばあいがあります。

「追加ついか除去じょきょキーワード一致いっち」系けいの編集へんしゅうフィルター

特定とくていのキーワードが追加ついか除去じょきょされた場合ばあいに発動はつどうするフィルターを作つくる場合ばあい、利用りよう者しゃがそのキーワードを追加ついか除去じょきょしていない場合ばあいには発動はつどうしないように正ただしく設定せっていする必要ひつようがあります。具体ぐたい的てきには、Aというキーワードに反応はんのうしたいフィルターがあった場合ばあい

contains_any(added_lines, A) /* よくない例れいです! */

というような式しきにすると問題もんだいが発生はっせいする場合ばあいがあります。なぜなら(added|removed)_lines変数へんすうは名前なまえにlinesと書かかれている通とおり行ぎょう単位たんいなので、利用りよう者しゃがそのキーワードを追加ついか除去じょきょしていない場合ばあいにも、元もとの行くだりにそのキーワードが含ふくまれていると発動はつどうしてしまうからです。その場合ばあい、次つぎのようにすれば正ただしく設定せっていできます。

/* 追加ついか系けいの場合ばあい */
contains_any(added_lines, A) & !contains_any(removed_lines, A)
/* 除去じょきょ系けいの場合ばあい */
contains_any(removed_lines, A) & !contains_any(added_lines, A)

具体ぐたい的てきには、例たとえば次つぎのようにすることができます。

& contains_any(rmwhitespace(lcase(added_lines)),
    "ほげほげ",
    "ほげっほげ",
    "ふがふが"
)
& !contains_any(rmwhitespace(lcase(removed_lines)),
    "ほげほげ",
    "ほげっほげ",
    "ふがふが"
)
/* 除外じょがいワード */
& !contains_any(rmwhitespace(lcase(added_lines)),
    "ほげほげ山やま",
    "ふがふが高原こうげん"
)

編集へんしゅうフィルターは変数へんすうが使用しようできるので、場合ばあいによっては、例たとえば

& (
 keywords := "(ほげ(|っ)ほげ|ふがふが)";
 !(removed_lines regex keywords)
 &(  added_lines regex keywords)
)

とすれば、NGワードを1回かいずつ記載きさいするだけで上記じょうきの動作どうさをさせることができます（上うえの例れいでは「ほげほげ」「ほげっほげ」「ふがふが」が含ふくまれている文ぶんを投稿とうこうしようとしたら発動はつどうします）。

ただし、contains_any関数かんすうを使つかう場合ばあいは、配列はいれつ変数へんすうに対応たいおうしているのは第だい1引数ひきすう（通常つうじょうadded_linesやremoved_linesなどを書かきます）だけで、第だい2引数ひきすう以降いこうは対応たいおうしていないので、例たとえば、

keywords := ["A", "B", "C"];
contains_any(added_lines, keywords) & !contains_any(removed_lines, keywords) /* よくない例れいです */

の様ようなコードを書かいても正常せいじょう動作どうさしませんので、複雑ふくざつな条件じょうけん付づけをする場合ばあいには、最初さいしょの例れいのように第だい2引数ひきすう以降いこうに列挙れっきょするのがよいでしょう。

既存きそんのフィルターを真似まねる

もし初はじめてフィルターを作成さくせいまたは編集へんしゅうする場合ばあい、力ちからをつける最良さいりょうの方法ほうほうは既存きそんの運用うんよう中ちゅうのフィルターを真似まねることです。

発動はつどう条件じょうけんはもちろん、メモや通知つうち文ぶんの作つくり方かたなど、他たのフィルターを参考さんこうにすることが何なによりの近道ちかみちです。