Extension:AbuseFilter/Rules format/zh

zh:Wikipedia:防滥用过滤器/操作指引 規則格式与类C／JAVA／Perl语言的条件式十分相近.

字符串
你可以在单引号或双引号中填写字符串常量，亦可直接填写数字变量（包括整型与浮点型）. 你可以使用 来换行， 為制表符，而且你还可以使用半角反斜杠来转义引号字符.

Use the  (plus) symbol to concatenate two literal strings or the values of two vars with a string value.


 * 示例:

用戶自訂變數
你可以定義自訂的變數，只要在一行中使用賦值符號 （以 結尾）並跟隨一個條件. 這些變數可以使用字母、下劃線和數字（除第一個字符外），並且區分大小寫. 例如（來自w:Special:AbuseFilter/79）：

陣列
AbuseFilter has support for non-associative arrays, which can be used like in the following examples.

注釋
您可以使用以下語法來注釋： /* 這是一條注釋 */

算术
你可以使用基本的算术符号对变量和常量进行算术运算，语法规则如下：


 * — 用左操作数减去右操作数.
 * — 将左、右操作数相加.
 * — 将左、右操作数相乘.
 * — 用右操作数去除左操作数.
 * — 对左操作数求幂，幂次由右操作数指定.
 * — 返回左操作数除以右操作数后的余数.

The type of the returned result is the same that would be returned by PHP, for which a lot of documentation may be found online. More exhaustive examples may be found in this AF parser test.

布尔运算
你可以要求满足所有条件为真，或满足任一条件为真，或只满足任一条件为真.


 * &mdash; OR – 如果两个条件中有一个或多个为真，则返回真值True.
 * &mdash; AND – returns true if both of the conditions are true.
 * &mdash; XOR – returns true if one, and only one of the two conditions is true.
 * &mdash; NOT – returns true if the condition is not true.

Examples

Simple comparisons
You can compare variables with other variables and literals with the following syntax:


 * &mdash; Return true if the left-hand operand is less than/greater than the right-hand operand respectively. Watch out: operands are casted to strings and, like it happens in PHP,  and.
 * &mdash; Return true if the left-hand operand is less than or equal to/greater than or equal to the right-hand operand respectively. Watch out: operands are casted to strings and, like it happens in PHP,  and.
 * (or ),   &mdash; Return true if the left-hand operand is equal to/not equal to the right-hand operand respectively.
 * &mdash; Return true if the left-hand operand is equal to/not equal to the right-hand operand AND the left-hand operand is the same/not the same data type to the right-hand operand respectively.

Built-in variables
The abuse filter passes various variables by name into the parser. These variables can be accessed by typing their name in, in a place where a literal would work. You can view the variables associated with each request in the abuse log.

Performance
As noted in the table above, some of these variables can be very slow. While writing filters, remember that the condition limit is not a good metric of how heavy filters are. For instance, variables like  or   always need a DB query to be computed, while   variables will have to perform parsing of the text, which again is a heavy operation; all these variables should be used very, very carefully. For instance, on Italian Wikipedia it's been observed that, with 135 active filters and an average of 450 used conditions, filters execution time was around 500ms, with peaks reaching 15 seconds. Removing the  variable from a single filter, and halving the cases when another filter would use   brought the average execution time to 50ms. More specifically:

Last but not least, note that whenever a variable is computed for a given filter, it'll be saved and any other filter will immediately retrieve it. This means that one single filter computing this variable counts more or less as dozens of filters using it.
 * Use  variables when you need high accuracy and checking for "http://..." in other variables (for instance,  ) could lead to heavy malfunctioning;
 * Use  variables when you're really sure that non-PST variables aren't enough. You may also conditionally decide which one to check: if, for instance, you want to examine a signature, check first if   contains  ;
 * In general, when dealing with these variables, it's always much better to consume further conditions but avoid computing heavy stuff. In order to achieve this, always put heavy variables as last conditions.

Keywords
The following special keywords are included for often-used functionality:


 * (or ) returns true if the left-hand operand matches the glob pattern in the right-hand operand.
 * returns true if the right-hand operand (a string) contains the left-hand operand. Note: empty strings are not contained in, nor contain, any other string (not even the empty string itself).
 * works like, but with the left and right-hand operands switched. Note: empty strings are not contained in, nor contain, any other string (not even the empty string itself).
 * (or ) and   return true if the left-hand operand matches (contains) the regex pattern in the right-hand operand (  is case insensitive).

The system uses PCRE. The only PCRE option enabled is  (modifier   in PHP); for   both   and   are enabled (modifier  ).



Examples

Functions
A number of built-in functions are included to ease some common issues. They are executed in the general format, and can be used in place of any literal or variable. Its arguments can be given as literals, variables, or even other functions.

Order of operations
Operations are generally done left-to-right, but there is an order to which they are resolved. As soon as the filter fails one of the conditions, it will stop checking the rest of them (due to short-circuit evaluation) and move on to the next filter (except for T43693). The evaluation order is:


 * 1) Anything surrounded by parentheses (  and  ) is evaluated as a single unit.
 * 2) Turning variables/literals into their respective data. (i.e.,   to 0)
 * 3) Function calls (,  , etc.)
 * 4) Unary   and   (defining positive or negative value, e.g. ,  )
 * 5) Keywords
 * 6) Boolean inversion
 * 7) Exponentiation
 * 8) Multiplication-related (multiplication, division, modulo)
 * 9) Addition and subtraction
 * 10) Comparisons.
 * 11) Boolean operations.

Examples

 * is equivalent to, not to  . In particular, both   and   evaluates to.
 * is equivalent to, not to  . In particular, both   and   evaluates to.

Condition counting
The condition limit is (more or less) tracking the number of comparison operators + number of function calls entered.

Further explanation on how to reduce conditions used can be found at.

Exclusions
Although the AbuseFilter examine function will identify "rollback" actions as edits, the AbuseFilter will not evaluate rollback actions for matching.

Useful links

 * PCRE pattern syntax
 * Edit filters benefiting to various local Wikiprojects