Jump to content

Extensión:AbuseFilter/Reglas de formato

From mediawiki.org
This page is a translated version of the page Extension:AbuseFilter/Rules format and the translation is 36% complete.

Las reglas son un lenguaje especial. Tienen un formato similar a los condicionales en lenguajes como C, Java o Perl.

Cadenas

Puedes especificar un literal por colocar él en solo o doble cita (para configuraciones), o escribir en él (para números, ambos flotantes-punto y entero). Puedes obtener saltos de línea con \n, caracteres de tabulación con \t y también puede escapar del carácter de comillas con una barra invertida.

Utilice el símbolo de + (más) para concatenar dos cadenas literales o los valores de dos variables con un valor de cadena.

Ejemplos
"Este es una cadena"
'Esto también es una cadena'
'Esta cadena no deber\ía fallar'
"Esta cadena\nTiene un salto de línea"
1234
1.234
-123

Variables definidas por el usuario

Puede definir variables personalizados para facilitar la comprensión con el símbolo de asignación := en una línea (cerrada por ;) dentro de una condición. Dichas variables pueden usar letras, guiones bajos y números (aparte del primer carácter) y no distinguen entre mayúsculas y minúsculas. Ejemplo (de w:Special:AbuseFilter/79):

(
	line1:="(\{\{(r|R)eflist|\{\{(r|R)efs|<references\s?/>|</references\s?>)";
	rcount(line1, removed_lines)
) > (
	rcount(line1, added_lines)
)

Arrays

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

¡Atención! Atención: Expressions like page_namespace in [14, 15] may not work as expected. This one will evaluate to true also if page_namespace is 1, 4, or 5. For more information and possible workarounds, please see T181024.
my_array := [ 5, 6, 7, 10 ];
my_array[0] == 5
length(my_array) == 4
int( my_array ) === 4 // Same as length
float( my_array ) === 4.0 // Cuenta los elementos
string(my_array) == "5\n6\n7\n10\n" // Note: the last linebreak could be removed in the future
5 in my_array == true
'5' in my_array == true
'5\n6' in my_array == true // Note: this is due to how arrays are casted to string, i.e. by imploding them with linebreaks
1 in my_array == true // Note: this happens because 'in' casts arguments to strings, so the 1 is caught in '10' and returns true.
my_array[] := 57; // This appends an element at the end of the array
my_array === [ 5, 6, 7, 10, 57 ]
my_array[2] := 42; // And this is for changing an element in the array
my_array === [ 5, 6, 42, 10, 57 ]

Comentarios

Puedes añadir comentarios usando la siguiente sintaxis:

/* Esto es un comentario */

Aritmética

Puede hacer aritmética en variables y literales con la siguiente sintaxis:

  • - – Sustraer (restar) el operando de la derecha al de la izquierda.
  • + – Suma el operando de la derecha al de la izquierda.
  • * – Multiplica el operando de la derecha al de la izquierda
  • / – Divide el operando de la derecha al de la izquierda
  • ** – Exponenciación en el operando de la derecha al de la izquierda.
  • % – Devuelve el resto obtenido al dividir el operando de la izquierda al de la derecha.

El tipo del resultado devuelto es el mismo que sería devuelto por PHP, para el cual se puede encontrar mucha documentación en línea. Se pueden encontrar ejemplos más exhaustivos en AF parser.

Ejemplo Resultado
1 + 1 2
2 * 2 4
1 / 2 0.5
9 ** 2 81
6 % 5 1

Operadores booleanos

Se puede igualar si y sólo si todas las condiciones son ciertas, una de varias condiciones es verdad, o una y sólo una de todas las condiciones es verdad.

  • x | y — OR – devuelve verdad si una o más de las condiciones son ciertas.
  • x & y — AND – devuelve verdad si ambas condiciones son ciertas.
  • x ^ y — XOR – devuelve verdadero si una, y sólo una, de las dos condiciones es verdadera.
  • !x — NOT – devuelve verdad si la condición no es verdadera.

Ejemplos

Código Resultado
1 | 1 true
1 | 0 true
0 | 0 false
1 & 1 true
1 & 0 false
0 & 0 false
1 ^ 1 false
1 ^ 0 true
0 ^ 0 false
!1 false
!0 true

Simple comparisons

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

  • <, >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, null < any number === true and null > any number === false.
  • <=, >=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, null <= any number === true and null >= any number === false.
  • == (or =), != – Return true if the left-hand operand is equal to/not equal to the right-hand operand respectively.
  • ===, !==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.
Ejemplo Resultado
1 == 2 false
1 <= 2 true
1 >= 2 false
1 != 2 true
1 < 2 true
1 > 2 false
2 = 2 true
'' == false true
'' === false false
1 == true true
1 === true false
['1','2','3'] == ['1','2','3'] true
[1,2,3] === [1,2,3] true
['1','2','3'] == [1,2,3] true
['1','2','3'] === [1,2,3] false
[1,1,''] == [true, true, false] true
[] == false & [] == null true
['1'] == '1' false[1]

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.

Variables de AbuseFilter

Variables always available

¡Atención! Atención: User-related variables are always available, except for one case: account creation when the creator is not logged in. All variables starting with user_ are affected, except user_type.
Descripción Nombre Tipo de dato Apuntes
Acción action cadena One of the following: edit, move, createaccount, autocreateaccount, delete, upload[2], stashupload[3]
Unix timestamp of change timestamp cadena int(timestamp) gives you a number with which you can calculate the date, time, day of week, etc.
Nombre de la wiki en la base de datos wiki_name string For instance, this is "enwiki" on the English Wikipedia, and "itwikiquote" on the Italian Wikiquote.
Código de idioma de la wiki wiki_language string For instance, this is "en" on the English Wikipedia, and "it" on the Italian Wikiquote. Multi-lingual wikis like Commons, Meta, and Wikidata will also report as "en".
Contador de ediciones del usuario ($1) user_editcount integer/null Null only for unregistered users.
Nombre de la cuenta de usuario ($1) (IP in case the user is not registered) user_name cadena
For "createaccount" and "autocreateaccount" actions, use accountname if you want the name of the account being created.
Tipo de cuenta de usuario ($1) user_type string The type of the user, which will be one of ip, temp (if the user is using a temporary account ), named, external, or unknown.
Tiempo en que se confirmó la dirección de correo electrónico ($1) user_emailconfirm string/null In the format: YYYYMMDDHHMMSS. Null if the email wasn't confirmed.
Edad de la cuenta de usuario ($1) user_age número entero In seconds. 0 for unregistered users.
Si el usuario está bloqueado ($1) user_blocked booleano True for blocked registered users. Also true for edits from blocked IP addresses, even if the editor is a registered user who is not blocked. False otherwise.
This doesn't differentiate between partial and sitewide blocks.
Grupos (incluidos aquellos implícitos) a los que pertenece el usuario ($1) user_groups variedad de cadenas Véase Special:ListGroupRights.
Derechos que tiene el usuario ($1) user_rights variedad de cadenas Véase Special:ListGroupRights.
ID de la página ($1) article_articleid número entero (desaprobado) Usa page_id en cambio.
ID de la página ($1) (can be seen via "page information" link in sidebar) page_id número entero This is 0 for new pages, but it is unreliable when inspecting past hits. If you need an exact result when inspecting past hits, use "page_age == 0" to identify new page creation. (note that it is slower, though.) This issue has been fixed in 9369d08, merged on September 11th 2023.
Espacio de nombres de la página ($1) article_namespace número entero (desaprobado) Usa page_namespace en cambio.
Espacio de nombres de la página ($1) page_namespace número entero refers to namespace index . Check for namespace(s) using expressions like "page_namespace == 2" or "equals_to_any(page_namespace, 1, 3)"
Edad de la página en segundos ($1) page_age entero the number of seconds since the first edit (or 0 for new pages). This is reliable, but it tends to be slow; consider using page_id if you don't need much precision.
Título de la página sin espacio de nombres ($1) article_text cadena (desaprobado) Usa page_title en cambio.
Título de la página sin espacio de nombres ($1) page_title cadena
Título completo de la página ($1) article_prefixedtext cadena (desaprobado) Usa page_prefixedtitle en cambio.
Título completo de la página ($1) page_prefixedtitle cadena
Nivel de protección para la edición de la página article_restrictions_edit cadena (desaprobado) Usa page_restrictions_edit en cambio.
Nivel de protección para la edición de la página page_restrictions_edit variedad de cadenas
Nivel de protección para el traslado de la página ($1) article_restrictions_move cadena (desaprobado) Usa page_restrictions_move en cambio.
Nivel de protección para el traslado de la página ($1) page_restrictions_move variedad de cadenas
Nivel de protección para la subida del archivo article_restrictions_upload cadena (desaprobado) Usa page_restrictions_upload en cambio.
Nivel de protección para la subida del archivo page_restrictions_upload variedad de cadenas
Nivel de protección para la creación de la página ($1) article_restrictions_create cadena (desaprobado) Usa page_restrictions_create en cambio.
Nivel de protección para la creación de la página ($1) page_restrictions_create variedad de cadenas
Últimos diez usuarios en contribuir en la página article_recent_contributors array of strings (desaprobado) Usa page_recent_contributors en cambio.
Últimos diez usuarios en contribuir en la página page_recent_contributors variedad de cadenas This tends to be slow (see #Performance). Try to put conditions more likely evaluate to false before this one, to avoid unnecessarily running the query. This value is empty if the user is the only contributor to the page(?), and only scans the last 100 revisions
Primer usuario en contribuir en la página article_first_contributor cadena (desaprobado) Usa page_first_contributor en cambio.
Primer usuario en contribuir en la página page_first_contributor cadena This tends to be slow (see #Performance).[4] Try to put conditions more likely evaluate to false before this one, to avoid unnecessarily running the query.

Variables available for some actions

¡Atención! Atención: Always check that the variables you want to use are available for the current action being filtered, e.g. by using the action variable. Failing to do so (for instance using accountname for an edit, or edit_delta for a deletion) will make any code using the variable in question return false.
Edit variables are not available when examining past uploads. (T345896)
Descripción Nombre Tipo de dato Apuntes
Resumen/razón de edición ($1) summary cadena Summaries automatically created by MediaWiki ("New section", "Blanked the page", etc.) are created after the filter checks the edit, so they will never actually catch, even if the debugger shows that they should. The variable contains whatever the user sees in the edit summary window, which may include MediaWiki preloaded section titles.[5]
Si la edición ha sido marcada o no como menor (ya no se utiliza) minor_edit cadena Disabled, and set to false for all entries between 2016 and 2018.[6]
Antiguo wikitexto de la página, antes de la edición ($1) old_wikitext cadena This variable can be very large. Consider using removed_lines if possible to improve performance.
Nuevo wikitexto de la página, después de la edición ($1) new_wikitext cadena This variable can be very large. Consider using added_lines if possible to improve performance.
Diff unificado de cambios realizados por edición ($1) edit_diff cadena
Diff unificado de cambios hecho mediante edición, preguardado transformado ($1) edit_diff_pst cadena This tends to be slow (see #Performance). Checking both added_lines and removed_lines is probably more efficient.[7]
Nuevo tamaño de la página ($1) new_size número entero
Antiguo tamaño de la página ($1) old_size entero
Cambio de tamaño en la edición ($1) edit_delta número entero
Líneas añadidas en la edición, pre-guardado transformados ($1) added_lines_pst variedad de cadenas Use added_lines if possible, which is more efficient.
Líneas añadidas en la edición ($1) added_lines variedad de cadenas includes all lines in the final diff that begin with +
Líneas eliminadas en la edición ($1) removed_lines variedad de cadenas
Todos los enlaces externos en el nuevo texto ($1) all_links array of strings This tends to be slow (see #Performance).
Enlaces en la página, antes de la edición old_links array of strings This tends to be slow (see #Performance).
Todos los enlaces externos agregados en la edición ($1) added_links variedad de cadenas This tends to be slow (see #Performance). Consider checking against added_lines first, then check added_links so that fewer edits are slowed down. This follows MediaWiki's rules for external links . Only unique links are added to the array. Changing a link will count as 1 added and 1 removed link.
Todos los enlaces externos eliminados en la edición ($1) removed_links variedad de cadenas This tends to be slow (see #Performance). Consider checking against removed_lines first, then check removed_links so that fewer edits are slowed down. This follows MediaWiki's rules for external links . Only unique links are added to the array. Changing a link will count as 1 added and 1 removed link.
Nuevo wikitexto de la página, aplicando transformaciones preguardado ($1) new_pst cadena This variable can be very large.
Fuente HTML analizada de la nueva revisión new_html cadena This variable can be very large. Consider using added_lines if possible to improve performance.
Texto nuevo de la página, libre de cualquier elemento de marcado ($1) new_text cadena This variable can be very large. Consider using added_lines if possible to improve performance.
Antiguo wikitexto de la página, analizado en HTML (ya no se usa) old_html cadena Disabled for performance reasons.
Texto antiguo de la página, libre de cualquier elemento de marcado (ya no se usa) old_text cadena Disabled for performance reasons.
Tiempo en segundos desde la última edición de la página ($1) page_last_edit_age integer or null null when the page does not exist
Hash SHA1 del contenido del archivo ($1) file_sha1 cadena [2]
Tamaño del archivo en bytes file_size número entero The file size in bytes[2]
Anchura del archivo en píxeles ($1) file_width número entero The width in pixels[2]
Altura del archivo en píxeles ($1) file_height número entero The height in pixels[2]
Bits por canal de color del archivo file_bits_per_channel número entero The amount of bits per color channel[2]
Tipo MIME del archivo file_mime string The file MIME type.[2]
Tipo del archivo multimedia file_mediatype string The file media type.[8][2]
ID de página de la página de destino a trasladar ($1) moved_to_articleid número entero (desaprobado) Usa moved_to_id en cambio.
ID de página de la página de destino a trasladar ($1) moved_to_id número entero
Título de la página de destino del traslado ($1) moved_to_text cadena (desaprobado) Usa moved_to_title en cambio.
Título de la página de destino del traslado ($1) moved_to_title cadena
Título completo de la página de destino del traslado ($1) moved_to_prefixedtext cadena (desaprobado) Usa moved_to_prefixedtitle en cambio.
Título completo de la página de destino del traslado ($1) moved_to_prefixedtitle cadena
Espacio de nombres de la página de destino del traslado ($1) moved_to_namespace integer
Antigüedad en segundos de la página destino del traslado ($1) moved_to_age número entero
Tiempo desde la última edición de la página de destino a trasladar ($1) moved_to_last_edit_age integer or null null when the target page does not exist
Nivel de protección para la edición de la página destino del traslado moved_to_restrictions_edit array of string Same as page_restrictions_edit, but for the target of the move.
Nivel de protección para el traslado de la página destino del traslado moved_to_restrictions_move array of string Same as page_restrictions_move, but for the target of the move.
Nivel de protección para la subida del archivo destino del traslado moved_to_restrictions_upload array of string Same as page_restrictions_upload, but for the target of the move.
Nivel de protección para el traslado de la página destino del traslado moved_to_restrictions_create array of string Same as page_restrictions_create, but for the target of the move.
Últimos diez usuarios en contribuir en la página destino del traslado moved_to_recent_contributors array of strings Same as page_recent_contributors, but for the target of the move.
Últimos diez usuarios en contribuir en la página original a trasladar moved_to_first_contributor string Same as page_first_contributor, but for the target of the move.
Espacio de nombres de la página de origen a trasladar ($1) moved_from_namespace integer
Título de la página original a trasladar ($1) moved_from_text cadena (desaprobado) Usa moved_from_title en cambio.
Título de la página original a trasladar ($1) moved_from_title cadena
Título completo de la página original a trasladar ($1) moved_from_prefixedtext cadena (desaprobado) Usa moved_from_prefixedtitle en cambio.
Título completo de la página original a trasladar ($1) moved_from_prefixedtitle cadena
ID de la página original a trasladar ($1) moved_from_articleid número entero (desaprobado) Usa moved_from_id en cambio.
ID de la página original a trasladar ($1) moved_from_id número entero
Antigüedad en segundos de la página original a trasladar ($1) moved_from_age número entero
Tiempo desde la última edición de la página original a trasladar ($1) moved_from_last_edit_age integer
Nivel de protección para la edición de la página origen del traslado moved_from_restrictions_edit array of string Same as page_restrictions_edit, but for the page being moved.
Nivel de protección para el traslado de la página origen del traslado ($1) moved_from_restrictions_move array of string Same as page_restrictions_move, but for the page being moved.
Nivel de protección para la subida del archivo origen del traslado moved_from_restrictions_upload array of string Same as page_restrictions_upload, but for the page being moved.
Nivel de protección para la creación de la página origen del traslado moved_from_restrictions_create array of string Same as page_restrictions_create, but for the page being moved.
Últimos diez usuarios en contribuir en la página original a trasladar moved_from_recent_contributors array of strings Same as page_recent_contributors, but for the page being moved.
Primer usuario en contribuir en la página original a trasladar ($1) moved_from_first_contributor string Same as page_first_contributor, but for the page being moved.
Nombre de usuario en la creación de la cuenta ($1) accountname cadena
Content model of the old revision old_content_model cadena See Ayuda:ChangeContentModel for information about content model changes
Content model of the new revision new_content_model cadena See Ayuda:ChangeContentModel for information about content model changes

Protected variables

A variable can be considered protected. For instance, on wikis with temporary accounts enabled, IPs are considered PII and access to them must be restricted. Protected variables and filters that use them are only accessible to maintainers with the abusefilter-access-protected-vars right. Using a protected variable flags the filter as protected as well. The filter subsequently cannot be unprotected, even if it no longer actively uses a protected variable, as its historical logs will remain available.

The default protected variables are defined in AbuseFilterProtectedVariables in extension.json.

Description Name Data type Notes
IP of the user account (for logged-out users and temporary accounts only) ($1) user_unnamed_ip string User IP for anonymous users/temporary accounts
This returns null for registered users.

Variables from other extensions

Most of these variables are always set to false when examinating past edits, and may not reflect their actual value at the time the edit was made. See T102944.
Descripción Nombre Tipo de dato Valores Added by
Grupos globales en los que se encuentra el usuario ($1) global_user_groups array CentralAuth
Recuento de ediciones globales del usuario ($1) global_user_editcount integer CentralAuth
Grupos globales en los que se encuentra el usuario al crear la cuenta ($1) global_account_groups array Available only when action is createaccount (then it is always empty) or autocreateaccount. CentralAuth
Recuento de ediciones globales del usuario al crear la cuenta ($1) global_account_editcount integer Available only when action is createaccount (then it is always zero) or autocreateaccount. CentralAuth
El consumidor de OAuth solía realizar este cambio ($1) oauth_consumer integer OAuth
Identificador de la página del tablero de Discusiones Estructuradas board_articleid número entero (desaprobado) Usa board_id en cambio. StructuredDiscussions
Identificador de la página del tablero de Discusiones Estructuradas board_id número entero StructuredDiscussions
Espacio de nombres del panel de Discusiones estructuradas board_namespace número entero refers to namespace index StructuredDiscussions
Título (sin el espacio de nombres) del panel de Discusiones estructuradas board_text cadena (desaprobado) Usa board_title en cambio. StructuredDiscussions
Título (sin el espacio de nombres) del panel de Discusiones estructuradas board_title cadena StructuredDiscussions
Título completo del panel de Discusiones estructuradas board_prefixedtext cadena (desaprobado) Usa board_prefixedtitle en cambio. StructuredDiscussions
Título completo del panel de Discusiones estructuradas board_prefixedtitle cadena StructuredDiscussions
Texto de origen de la unidad de traducción translate_source_text cadena Traducir
Idioma de destino para la traducción translate_target_language string This is the language code, like en for English. Traducir
Si el cambio fue hecho o no a través de un nodo de salida tor tor_exit_node booleano true if the action comes from a tor exit node. TorBlock
Si un usuario está editando a través de la interfaz móvil user_mobile booleano true for mobile users, false otherwise. MobileFrontend
Si el usuario está editando desde la aplicación móvil ($1) user_app booleano true if the user is editing from the mobile app, false otherwise. MobileApp
Page views[1] article_views número entero (desaprobado) Usa page_views en cambio. HitCounters
Page views[2] page_views número entero the amount of page views HitCounters
Source page views[3] moved_from_views número entero the amount of page views of the source page HitCounters
Target page views[4] moved_to_views número entero the amount of page views of the target page HitCounters
Whether the IP address is blocked using the stopforumspam.com list[5] sfs_blocked booleano Whether the IP address is blocked using the stopforumspam.com list StopForumSpam

Apuntes

When action='move', only the summary, action, timestamp and user_* variables are available. The page_* 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_title and moved_to_title instead of page_title.

Since MediaWiki 1.28 (gerrit: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 allows 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.

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 *_recent_contributors or *_links always need a DB query to be computed, while *_pst 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 added_links variable from a single filter, and halving the cases when another filter would use added_lines_pst brought the average execution time to 50ms. More specifically:

  • Use _links variables when you need high accuracy and checking for "http://..." in other variables (for instance, added_lines) could lead to heavy malfunctioning;
  • Use _pst 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 added_lines 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.

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.

Keywords

Where not specifically stated, keywords cast their operands to strings

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. Nota: empty strings are not contained in, nor contain, any other string (not even the empty string itself).
  • contains works like in, but with the left and right-hand operands switched. Nota: empty strings are not contained in, nor contain, any other string (not even the empty string itself).
  • 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).
  • if ... then ... end
  • if ... then ... else ... end
  • ... ? ... : ...
  • true, false, null

Ejemplos

Código Resultado Comentario
"1234" like "12?4" True
"1234" like "12*" True
"foo" in "foobar" True
"foobar" contains "foo" True
"o" in ["foo", "bar"] True Due to the string cast
"foo" regex "\w+" True
"a\b" regex "a\\\\b" True To look for the escape character backslash using regex you need to use either four backslashes or two \x5C. (Either works fine.)
"a\b" regex "a\x5C\x5Cb" True

Funciones

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.

Nombre Descripción
lcase Returns the argument converted to lower case.
ucase Returns the argument converted to upper case.
length Returns the length of the string given as the argument. If the argument is an array, returns its number of elements.
string Casts to string data type. If the argument is an array, implodes it with linebreaks.
int Casts to integer data type.
float Casts to floating-point data type.
bool Casts to boolean data type.
norm Equivalent to rmwhitespace(rmspecials(rmdoubles(ccnorm(arg1)))).
ccnorm Normalises confusable/similar characters in the argument, and returns a canonical form. A list of characters and their replacements can be found on git, e.g. ccnorm( "Eeèéëēĕėęě3ƐƷ" ) === "EEEEEEEEEEEEE".[9] The output of this function is always uppercase. While not expensive, this function isn't cheap either, and could slow a filter down if called many times.
ccnorm_contains_any Normalises confusable/similar characters in all its arguments, and returns true if the first string contains any string from the following arguments (unlimited number of arguments, logic OR mode). A list of characters and their replacements can be found on git. Due to the usage of ccnorm, this function can be slow if passed too many arguments.
ccnorm_contains_all Normalises confusable/similar characters in all its arguments, and returns true if the first string contains every string from the following arguments (unlimited number of arguments, logic AND mode). A list of characters and their replacements can be found on git. Due to the usage of ccnorm, this function can be slow if passed too many arguments.
specialratio Returns the number of non-alphanumeric characters divided by the total number of characters in the argument.
rmspecials Removes any special characters in the argument, and returns the result. Does not remove whitespace. (Equivalent to s/[^\p{L}\p{N}\s]//g.)
rmdoubles Removes repeated characters in the argument, and returns the result.
rmwhitespace Removes whitespace (spaces, tabs, newlines).
count Returns the number of times the needle (first string) appears in the haystack (second string). If only one argument is given, splits it by commas and returns the number of segments.
rcount Similar to count but the needle uses a regular expression instead. Can be made case-insensitive by letting the regular expression start with "(?i)". Please note that, for plain strings, this function can be up to 50 times slower than count[10], so use that one when possible.
get_matches MW 1.31+ Looks for matches of the regex needle (first string) in the haystack (second string). Returns an array where the 0 element is the whole match and every [n] element is the match of the n'th capturing group of the needle. Can be made case-insensitive by letting the regular expression start with "(?i)". If a capturing group didn't match, that array position will take value of false.
ip_in_range Returns true if user's IP (first string) matches the specified IP range (second string, can be in CIDR notation, explicit notation like "1.1.1.1-2.2.2.2", or a single IP). Only works for anonymous users. Supports both IPv4 and IPv6 addresses.
ip_in_ranges Returns true if user's IP (first string) matches any of the specified IP ranges (following strings in logic OR mode, can be in CIDR notation, explicit notation like "1.1.1.1-2.2.2.2", or a single IP). Only works for anonymous users. Supports both IPv4 and IPv6 addresses.
contains_any Returns true if the first string contains any string from the following arguments (unlimited number of arguments in logic OR mode). If the first argument is an array, it gets casted to string.
contains_all Returns true if the first string contains every string from the following arguments (unlimited number of arguments in logic AND mode). If the first argument is an array, it gets casted to string.
equals_to_any Returns true if the first argument is identical (===) to any of the following ones (unlimited number of arguments). Basically, equals_to_any(a, b, c) is the same as a===b | a===c, but more compact and saves conditions.
substr Returns the portion of the first string, by offset from the second argument (starts at 0) and maximum length from the third argument (optional).
strlen Same as length.
strpos Returns the numeric position of the first occurrence of needle (second string) in the haystack (first string), starting from offset from the third argument (optional, default is 0). This function may return 0 when the needle is found at the beginning of the haystack, so it might be misinterpreted as false value by another comparative operator. The better way is to use === or !== for testing whether it is found. Differently from PHP's strpos(), which returns false when the needle is not found, this function returns -1 when the needle is not found.
str_replace Replaces all occurrences of the search string with the replacement string. The function takes 3 arguments in the following order: text to perform the search on, text to find, replacement text.
str_replace_regexp Replaces all occurrences of the search string with the replacement string using regular expressions. The function takes 3 arguments in the following order: text to perform the search on, regular expression to match, replacement expression.
rescape Returns the argument with some characters preceded with the escape character "\", so that the string can be used in a regular expression without those characters having a special meaning.
set Sets a variable (first string) with a given value (second argument) for further use in the filter. Another syntax: name := value.
set_var Same as set.

Ejemplos

Código Resultado Comentario
length( "Wikipedia" ) 9
lcase( "WikiPedia" ) wikipedia
ccnorm( "w1k1p3d14" ) WIKIPEDIA ccnorm output is always uppercase
ccnorm( "ωɨƙɩᑭƐƉ1α" ) WIKIPEDIA
ccnorm_contains_any( "w1k1p3d14", "wiKiP3D1A", "foo", "bar" ) true
ccnorm_contains_any( "w1k1p3d14", "foo", "bar", "baz" ) false
ccnorm_contains_any( "w1k1p3d14 is 4w3s0me", "bar", "baz", "some" ) true
ccnorm( "ìíîïĩїį!ľ₤ĺľḷĿ" ) IIIIIII!LLLLLL
norm( "!!ω..ɨ..ƙ..ɩ..ᑭᑭ..Ɛ.Ɖ@@1%%α!!" ) WIKIPEDAIA
norm( "F00 B@rr" ) FOBAR norm removes whitespace, special characters and duplicates, then uses ccnorm
rmdoubles( "foobybboo" ) fobybo
specialratio( "Wikipedia!" ) 0.1
count( "foo", "foofooboofoo" ) 3
count( "foo,bar,baz" ) 3
rmspecials( "FOOBAR!!1" ) FOOBAR1
rescape( "abc* (def)" ) abc\* \(def\)
str_replace( "foobarbaz", "bar", "-" ) foo-baz
str_replace_regexp( "foobarbaz", "(.)a(.)", "$2a$1" ) foorabzab
ip_in_range( "127.0.10.0", "127.0.0.0/12" ) true
ip_in_ranges( "127.0.10.0", "10.0.0.0/8", "127.0.0.0/12" ) true
contains_any( "foobar", "x", "y", "f" ) true
get_matches( "(foo?ba+r) is (so+ good)", "fobaaar is soooo good to eat" ) ['fobaaar is soooo good', 'fobaaar', 'soooo good']

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., page_namespace to 0)
  3. Function calls (norm, lcase, etc.)
  4. Unary + and - (defining positive or negative value, e.g. -1234, +1234)
  5. Keywords (in, rlike, etc.)
  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 (&, |, ^)
  12. Ternary operator (... ? ... : ...)
  13. Assignments (:=)

Ejemplos

  • 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.
  • added_lines rlike "foo" + "|bar" is wrong, use added_lines rlike ("foo" + "|bar") 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 Extension:AbuseFilter/Conditions .

Exclusiones

Aunque la función del AbuseFilter identificará las acciones "rollback" como "edit", el AbuseFilter no evaluará las acciones para la coincidencia.[11]

Enlaces útiles

Apuntes

  1. Comparing arrays to other types will always return false, except for the example above
  2. 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 The only variables currently available for file uploads (action='upload') are user_*, page_*, 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').
  3. Desde MediaWiki 1.28 (gerrit:295254)
  4. Several filters (12) that use this variable have showed up in the AbuseFilterSlow Grafana dashboard (requires logstash access to view). Moving this variable to towards the end of the filter seemed to help.
  5. Véase phabricator:T191722.
  6. Deprecated with this commit and disabled with this one.
  7. Some filters using this variable have showed up in the AbuseFilterSlow Grafana dashboard (example, requires logstash access). For instance, instead of using "text" in edit_diff_pst (or even edit_diff), consider something like "text" in added_lines & !("text" in removed_lines)
  8. See the source code for a list of types.
  9. Be aware of phab:T27619. You can use Special:AbuseFilter/tools to evaluate ccnorm( "your string" ) to see which characters are transformed.
  10. https://3v4l.org/S6IGP
  11. T24713 - rollback not matched by AF