Extension:AbuseFilter/Rules format/ru

Правила — это особый язык. Они отформатированы аналогично условным операторам в языках, подобных 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 поддерживает неассоциативные массивы, которые можно использовать как в следующих примерах.

Комментарии
Вы можете добавлять комментарии, используя следующий синтаксис:

Арифметические действия
Вы можете использовать основные арифметические символы для выполнения арифметических действий с переменными и литералами со следующим синтаксисом:


 * — Вычесть правый операнд из левого операнда.
 * — Сложить правый и левый операнды.
 * — Умножить левый операнд на правый операнд.
 * — Разделить левый операнд на правый операнд.
 * — Возвести левый операнд в экспоненциальную степень, заданную правым операндом.
 * — Вернуть остаток от деления левого операнда на правый операнд.

Тип возвращаемого результата такой же, как у PHP, для которого можно найти много различных документаций (например). Более исчерпывающие примеры можно найти в этом тесте парсера AF.



Булевы операции
You can match if and only if all of a number of conditions are true, one of a number of conditions are true, or one and only one of all conditions are true.


 * &mdash; OR – возвращает true, если одно или несколько условий верны.
 * &mdash; AND – возвращает true, если оба условия верны.
 * &mdash; XOR – возвращает true, если одно и только одно из двух условий верно.
 * &mdash; NOT – возвращает true, если одно или несколько условий верны.

Примеры



Простые сравнения
Вы можете сравнить переменные с другими переменными и литералами со следующим синтаксисом:

Watch out: operands are casted to strings and, like it happens in PHP, and.
 * &mdash; возвращает true, если левый операнд меньше/больше правого операнда соответственно. 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.
 * (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.



Встроенные переменные
The abuse filter passes various variables by name into the parser. Доступ к этим переменным можно получить, введя их имя в том месте, где сработал бы литерал. Вы можете просмотреть переменные, связанные с каждым запросом, в журнале фильтра злоупотреблений.



Переменные AbuseFilter


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:

You may also conditionally decide which one to check: if, for instance, you want to examine a signature, check first if  contains  ; In order to achieve this, always put heavy variables as last conditions. 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.
 * In general, when dealing with these variables, it's always much better to consume further conditions but avoid computing heavy stuff.

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. The evaluation order is:


 * 1) Anything surrounded by parentheses (  and  ) is evaluated as a single unit.
 * 2) Turning variables/literals into their respective data. (e.g.,   to 0)
 * 3) Function calls (,  , etc.)
 * 4) Unary   and   (defining positive or negative value, e.g. ,  )
 * 5) Keywords (,  , etc. )
 * 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.
 * is wrong, use  instead.

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 of cross-wiki interest