User:松/Drafts/Extension:AbuseFilter/Rules format
Literals
You can specify a literal by placing it in single or double quotes (for strings), or by typing it in as-is (for numbers, both floating-point and integer). You can get linebreaks with \n, tab characters with \t, and you can also escape the quote character with a backslash.
Examples
"This is a string"
'This is also a string'
'This string shouldn\'t fail'
"This string\nHas a linebreak"
1234
1.234
-123
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.
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):
(
line1:="(\{\{(r|R)eflist|\{\{(r|R)efs|<references\s?/>|</references\s?>)";
rcount(line1, removed_lines)
) > (
rcount(line1, added_lines)
)
Lists:
a_list := [ 5, 6, 7];
All variables
| Description | Name | Data type | Values |
|---|---|---|---|
| Action | action |
string | edit, move, createaccount, autocreateaccount, delete, upload[1], stashupload[2] |
| Edit count of the user | user_editcount |
string | Empty for unregistered users. |
| Name of the user account | user_name |
string | |
| Time email address was confirmed | user_emailconfirm |
string | YYYYMMDDHHMMSS |
| Age of the user account | user_age |
in seconds; 0 for unregistered users. | |
| Whether the user is blocked | user_blocked |
boolean | is 1 for blocked registered users; null for unregistered users. |
| Whether or not a user is editing through the mobile interface | user_mobile |
boolean | is 1 for mobile users. |
| Groups (including implicit) the user is in | user_groups |
||
| Rights that the user has | user_rights |
||
| ⧼abusefilter-edit-builder-vars-article-id⧽ (found in the page's HTML source - search for wgArticleId) | article_articleid |
integer | In theory this is 0 for new pages, but this is unreliable. Instead, use "old_size==0" to identify new page creation. |
| ⧼abusefilter-edit-builder-vars-article-ns⧽ | article_namespace |
integer | refers to namespace index |
| ⧼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 |
||
| Upload protection of the file | article_restrictions_upload |
||
| Create protection of the page | article_restrictions_create |
||
| Last ten users to contribute to the page | article_recent_contributors |
Empty if the user is the only contributor to the page(?), only scans the last 100 revisions | |
| First user to contribute to the page | article_first_contributor |
| Description | Name | Data type | Values |
|---|---|---|---|
| Edit summary/reason | summary |
string | |
| Whether or not the edit is marked as minor (no longer in use) | minor_edit |
string | [3] |
| 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 |
||
| Unified diff of changes made by edit, pre-save transformed | edit_diff_pst |
||
| New page size | new_size |
integer | |
| Old page size | old_size |
integer | |
| Size change in edit | edit_delta |
||
| Lines added in edit, pre-save transformed | added_lines_pst |
string | |
| Lines added in edit | added_lines |
array of strings | includes all lines in the final diff that begin with + |
| 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 |
||
| New page wikitext, pre-save transformed | new_pst |
||
| 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 |
boolean | 0, 1 (only available if TorBlock is installed) |
| Unix timestamp of change | timestamp |
string | int(timestamp) gives you a number with which you can calculate the date, time, day of week, etc. |
| SHA1 hash of file contents | file_sha1 |
[1] | |
| Size of the file in bytes | file_size |
integer | The file size in bytes[1] |
| Page ID of move destination page | moved_to_articleid |
||
| ⧼Abusefilter-edit-builder-vars-movedto-prefixedtext⧽ | moved_to_prefixedtext |
||
| Namespace of move destination page | moved_to_namespace |
||
| Namespace of move source page | moved_from_namespace |
||
| ⧼abusefilter-edit-builder-vars-movedfrom-prefixedtext⧽ | moved_from_prefixedtext |
||
| Page ID of move source page | moved_from_articleid |
||
| Account name (on account creation) | accountname |
||
| Content model of the old revision | old_content_model
|
string | See Help:ChangeContentModel for information about content model changes |
| Content model of the new revision | new_content_model
|
string | See Help:ChangeContentModel for information about content model changes |
| Description | Name | Data type | Values |
|---|---|---|---|
| Global groups that the user is in | global_user_groups
|
| Description | Name | Data type | Values |
|---|---|---|---|
| ⧼abusefilter-edit-builder-vars-board-articleid⧽ | board_articleid |
||
| Namespace of Structured Discussions board | board_namespace
|
refers to namespace index | |
| ⧼abusefilter-edit-builder-vars-board-text⧽ | board_text
|
||
| ⧼abusefilter-edit-builder-vars-board-prefixedtext⧽ | board_prefixedtext
|
Notes
When action='move', only the summary, action, timestamp and user_* variables are available. The article_* variables 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.
Since MediaWiki 1.28 (https://gerrit.wikimedia.org/r/#/c/295254/), action='upload' is only used when publishing an upload, and not for uploads to stash. A new action='stashupload' is introduced, which is used for all uploads, including uploads to stash. This behaves like action='upload' used to, and only provides file metadata variables (file_*). Variables related to the page edit, including summary, new_wikitext and several others, are now available for action='upload'. For every file upload, filters may be called with action='stashupload' (for uploads to stash), and are always called with action='upload'; they are not called with action='edit'.
Filter authors should use action='stashupload' | action='upload' in filter code when a file can be checked based only on the file contents – for example, to reject low-resolution files – and action='upload' only when the wikitext parts of the edit need to be examined too – for example, to reject files with no description. This will allow tools that separate uploading the file and publishing the file (e.g. UploadWizard or upload dialog) to inform the user of the failure before they spend the time filling in the upload details.
- ↑ 1.0 1.1 1.2 The only variables currently available for file uploads (action='upload') are user_*, article_*, file_sha1, file_size, file_mime, file_mediatype, file_width, file_height, file_bits_per_channel (the last five were only added since the release for MediaWiki 1.27, gerrit:281503). All the file_* variables are unavailable for other actions (including action='edit').
- ↑ Since MediaWiki 1.28 (https://gerrit.wikimedia.org/r/#/c/295254/)
- ↑ Always false since https://gerrit.wikimedia.org/r/#/c/296268/