User:松/Drafts/Extension:AbuseFilter/Rules format

The rules are formatted much as conditionals in a C/Java/Perl-like language.

Comments

You can specify comments using the following syntax:

/* This is a comment */

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.

Examples

USER_EDITCOUNT
ARTICLE_RECENT_CONTRIBUTORS

Action variable can be 'edit', 'move', 'createaccount', 'autocreateaccount', 'delete' or 'upload'.

You can define more variables for ease of understanding with the assign symbol := in a line (closed by ;) within a condition. Example (from w:en:Special:AbuseFilter/79):

Lists:

All variables

Variables available

Description	Name	Data type
Edit count of the user	user_editcount	string
Name of the user account	user_name	string
Time email address was confirmed	user_emailconfirm	string
Age of the user account	user_age
Groups (including implicit) the user is in	user_groups
Rights that the user has	user_rights
⧼abusefilter-edit-builder-vars-article-ns⧽	article_namespace	integer
⧼abusefilter-edit-builder-vars-article-text⧽	article_text	string
⧼abusefilter-edit-builder-vars-article-prefixedtext⧽	article_prefixedtext	string
Edit protection level of the page	article_restrictions_edit
Move protection level of the page	article_restrictions_move
Last ten users to contribute to the page	article_recent_contributors
Action	action	string
Edit summary/reason	summary	string
Whether or not the edit is marked as minor (no longer in use)	minor_edit	string
Old page text, stripped of any markup (no longer in use)	old_wikitext
New page text, stripped of any markup	new_wikitext
Unified diff of changes made by edit	edit_diff
New page size	new_size	integer
Old page size	old_size	integer
Size change in edit	edit_delta
Lines added in edit	added_lines
Lines removed in edit	removed_lines
All external links in the new text	all_links
Links in the page, before the edit	old_links
All external links added in the edit	added_links
All external links removed in the edit	removed_links
Parsed HTML source of the new revision	new_html
New page text, stripped of any markup	new_text
Disabled	old_html
Disabled	old_text
Whether or not the change was made through a tor exit node	tor_exit_node
Unix timestamp of change	timestamp	string

CentralAuth also provides a global_user_groups variable, like user_groups.

When action is move, only the summary, action and timestamp variables, and variables with a name that starts with "user" are available. Variables with a name that starts with "article_" are also available, but the prefix is replaced by "moved_from_" and "moved_to_", that represent the values of the original article name and the destination one respectively. For example, "moved_from_text" and "moved_to_text" instead of "article_text".

Page/Article namespace

See also Manual:Namespace

English Wikipedia namespaces
Talk namespaces
1
3
5
7
9
11
13
15
101
109
Virtual namespaces
Special
Media

Simple comparisons

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

• < and > — Return true if the left-hand operand is less than/greater than the right-hand operand respectively.
• <= and >= — Return true if the left-hand operand is less than or equal to/greater than or equal to the right-hand operand respectively.
• == (or =) and != — Return true if the left-hand operand is equal to/not equal to the right-hand operand respectively.
• === and !== — 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.

Arithmetic

You can use basic arithmetic symbols to do arithmetic on variables and literals with the following syntax:

• - — Subtract the right-hand operand from the left-hand operand.
• + — Add the right-hand operand to the left-hand operand.
• * — Multiply the left-hand operand by the right-hand operand.
• / — Divide the left-hand operand by the right-hand operand.
• ** — Raise the left-hand operand to the exponential power specified by the right-hand operand.
• % — Return the remainder given when the left-hand operand is divided by the right-hand operand.

String concatenation

You can use the + (plus) symbol to concatenate two literal strings or the values of two vars with a string value.

Keywords

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

• like (or matches) returns true if the left-hand operand matches the glob pattern in the right-hand operand.
• in returns true if the right-hand operand (a string) contains the left-hand operand.
• rlike (or regex) and irlike return true if the left-hand operand matches (contains) the regex pattern in the right-hand operand (irlike is case insensitive). The system uses PCRE. The only PCRE option enabled is PCRE_UTF8 (modifier u in PHP); for irlike both PCRE_CASELESS and PCRE_UTF8 are enabled (modifier iu).
• contains
• if ... then ... else ... end
• ... ? ... : ...
• true, false and null

Examples

Functions

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

Other

• convert returns the second argument converted to variant language specified by the first argument. ONLY apply on wikis with LanguageConverter class. (New func added on rev:49399, need support of MediaWiki after rev:49397)

Examples

Boolean operations

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.

• x | y — OR – returns true if one or more of the conditions is true.
• x & y — AND – returns true if both of the conditions are true.
• x ^ y — XOR – returns true if one, and only one of the two conditions is true.
• !x — NOT – returns true if the condition is not true.

• Examples

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 bug 41693). 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., article_namespace to 0)
3. Function calls (norm, lcase, etc.)
4. Unary + and - (defining positive or negative value, e.g. -1234, +1234)
5. Keywords
6. Boolean inversion (!x)
7. Exponentiation (2**3 → 8)
8. Multiplication-related (multiplication, division, modulo)
9. Addition and subtraction (3-2 → 1)
10. Comparisons. (<, >, ==)
11. Boolean operations. (&, |, ^, in)

Examples

• A & B | C is equivalent to (A & B) | C, not to A & (B | C). In particular, both false & true | true and false & false | true evaluates to true.
• A | B & C is equivalent to (A | B) & C, not to A | (B & C). In particular, both true | true & false and true | false & false evaluates to false.

Useful links

• PCRE pattern syntax.