Extensão:Filtro de abusos

Manual de extensões do MediaWiki

AbuseFilter Estado da versão: estável
Implementação	User activity , Special page , API
Descrição	Permite inserir restrições baseadas em comportamentos específicos na atividade wiki.
Autor(es)	Andrew Garrett, Daimona Eaytoy Marius Hoch River Tarnell Victor Vasiliev
Política de compatibilidade	branches por lançamento
MediaWiki	1.33+
PHP	5.4+ recomendado
Modifica o banco de dados	Sim
Tabelas	abuse_filter abuse_filter_action abuse_filter_history abuse_filter_log
Licença	GNU General Public License 2.0 or later
Download	Baixar extensão Git [?]: Baixar master do Git navegar pelo repositório (GitHub) histórico de commits revisão de código
Parâmetros $wgAbuseFilterActions $wgAbuseFilterConditionLimit $wgAbuseFilterEmergencyDisableThreshold $wgAbuseFilterEmergencyDisableCount $wgAbuseFilterEmergencyDisableAge $wgAbuseFilterParserClass $wgAbuseFilterRestrictions $wgAbuseFilterNotifications $wgAbuseFilterNotificationsPrivate $wgAbuseFilterCentralDB $wgAbuseFilterIsCentral $wgAbuseFilterDisallowGlobalLocalBlocks $wgAbuseFilterBlockDuration $wgAbuseFilterAnonBlockDuration $wgAbuseFilterCustomActionsHandler $wgAbuseFilterValidGroups $wgAbuseFilterDefaultWarningMessage $wgAbuseFilterIPMaxAge $wgAbuseFilterProfileActionsCap $wgAbuseFilterLogPrivateDetailsAccess $wgAbuseFilterPrivateDetailsForceReason
Direitos adicionados abusefilter-view abusefilter-log abusefilter-log-detail abusefilter-revert abusefilter-privatedetails abusefilter-privatedetails-log abusefilter-view-private abusefilter-log-private abusefilter-hidden-log abusefilter-hide-log abusefilter-modify abusefilter-modify-restricted abusefilter-modify-global
Hooks usados EditFilterMerged GetAutoPromoteGroups AbortMove MovePageCheckPermissions ArticleDelete RecentChange_save ListDefinedTags ChangeTagsListActive LoadExtensionSchemaUpdates ContributionsToolLinks UploadVerifyFile UploadVerifyUpload UploadStashFile MakeGlobalVariablesScript PageContentSaveComplete UserMergeAccountFields ParserOutputStashForEdit UndeletePageToolLinks
Hooks fornecidos AbuseFilter-builder AbuseFilter-deprecatedVariables AbuseFilter-computeVariable AbuseFilter-contentToString AbuseFilter-filterAction AbuseFilterAlterVariables AbuseFilter-generateTitleVars AbuseFilter-generateUserVars AbuseFilter-generateStaticVars AbuseFilter-interceptVariable AbuseFilterShouldFilterAction
Traduzir a extensão AbuseFilter, se estiver disponível no translatewiki.net
Verificar uso e matriz de versões
Problemas	Tarefas em aberto · Relatar um bug

A extensão AbuseFilter permite que usuários com este privilégio definam ações específicas a serem tomadas quando usuários realizam ações, como edições, que correspondam a certos critérios.

Por exemplo, um filtro poderia ser criado para evitar que usuários anônimos adicionassem ligações externas, ou para bloquear um usuários que remova mais de 2 000 caracteres.

Instalação

• Baixe e coloque o(s) arquivo(s) num diretório chamado AbuseFilter na sua pasta extensions/.
• Execute o Composer para instalar as dependências PHP através de composer install --no-dev no diretório da extensão. (Veja T173141 para possíveis complicações.)
• Adicione o seguinte código ao final do seu arquivo LocalSettings.php:

  wfLoadExtension( 'AbuseFilter' );
  

• Execute o script de atualização que criará automaticamente as tabelas de banco de dados necessárias a essa extensão.
• Configure as required.
•  Pronto – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.

Para usuários executando o MediaWiki 1.26 ou anteriores:

As instruções acima descrevem a nova forma de instalar essa extensão utilizando wfLoadExtension(). Se precisar instalar essa extensão em versões antigas (MediaWiki 1.26 e anteriores), em vez de wfLoadExtension( 'AbuseFilter' );, você precisa usar:

require_once "$IP/extensions/AbuseFilter/AbuseFilter.php";

Configuração

Direitos de usuário

Uma vez instalada a extensão, você terá de estabelecer os direitos de usuário no arquivo "LocalSettings.php".

Direito	Descrição
abusefilter-modify	Modificar filtros de abusos
abusefilter-view	Ver filtros de abusos
abusefilter-log	Ver o registro de abusos
abusefilter-log-detail	Ver entradas detalhadas do registro de abusos
abusefilter-privatedetails	Ver dados privados no registro de abusos
abusefilter-modify-restricted	Modificar filtros de abusos com ações restritas
abusefilter-modify-global	Criar ou modificar filtros de abuso global
abusefilter-revert	Reverter todas as modificações feitas por um dado filtro de abusos
abusefilter-view-private	Ver filtros de abuso marcados como privados
abusefilter-log-private	Ver registro de entrada do fitro de abusos marcados como privados
abusefilter-hide-log	Ocultar entradas do filtro de abusos
abusefilter-hidden-log	Ver entradas ocultadas do registro de abusos
abusefilter-privatedetails-log	Veja o registro de acesso de detalhes privados no Filtro de abuso

Por exemplo, a configuração de exemplo a seguir permitiria sysops fazerem tudo o que quisessem com o AbuseFilter, e todo mundo visualizaria o registro e as configurações de filtro público:

$wgGroupPermissions['sysop']['abusefilter-modify'] = true;
$wgGroupPermissions['*']['abusefilter-log-detail'] = true;
$wgGroupPermissions['*']['abusefilter-view'] = true;
$wgGroupPermissions['*']['abusefilter-log'] = true;
$wgGroupPermissions['sysop']['abusefilter-privatedetails'] = true;
$wgGroupPermissions['sysop']['abusefilter-modify-restricted'] = true;
$wgGroupPermissions['sysop']['abusefilter-revert'] = true;

Filtros marcados como privados só podem ser vistos por usuários com a permissão “abusefilter-modify” ou a permissão “abusefilter-view-private”.

Parameters

Nome da variável	Valor padrão	Descrição
$wgAbuseFilterActions	[ 'throttle' => true, 'warn' => true, 'disallow' => true, 'blockautopromote' => true, 'block' => true, 'rangeblock' => false, 'degroup' => true, 'tag' => true ]	As ações possíveis que podem ser realizadas pelos filtros de abuso. When adding a new action, check if it is restricted in $wgAbuseFilterRestrictions and, if it is, don't forget to add the abusefilter-modify-restricted right to the appropriate user groups.
$wgAbuseFilterConditionLimit	1000	O número máximo de 'condições' que pode ser usado cada vez que os filtros são aplicadas a uma alteração. (Filtros mais complexos requerem mais 'condições').
$wgAbuseFilterValidGroups	[ 'default' ]	A lista de filtros de "grupos" pode ser dividida. Por padrão, há apenas um grupo. Other extensions may add other groups.
$wgAbuseFilterEmergencyDisableThreshold	[ 'default' => 0.05 ]	Desativar um filtro se corresponder a mais de 2 edições, constituindo mais de 5 % das ações que foram verificadas contra o grupo do filtro no período "observado" (no máximo um dia), a menos que o filtro tenha sido alterado nos últimos 86400 segundos (um dia) See emergency throttling.
$wgAbuseFilterEmergencyDisableCount	[ 'default' => 2 ]
$wgAbuseFilterEmergencyDisableAge	[ 'default' => 86400 ]
$wgAbuseFilterParserClass	'AbuseFilterParser'	Nome da classe do analisador do AbuseFilter.
$wgAbuseFilterRestrictions	[ 'block' => true, 'degroup' => true, 'blockautopromote' => true, 'rangeblock' => true ]	Os usuários devem ter o direito de usuário "abusefilter-modify-restricted" bem como "abusefilter-modify" a fim de criar ou modificar os filtros que realizam essas ações.
$wgAbuseFilterNotifications	false	Permite configurar a extensão para enviar notificações de sucesso para Special:RecentChanges ou UDP. Opções disponíveis: rc, udp, rcandudp
$wgAbuseFilterNotificationsPrivate	false	Habilitar notificações para filtros privados.
$wgAbuseFilterCentralDB	null	Nome de um banco de dados onde os filtros de abuso globais serão armazenados (apenas suportado na última versão de desenvolvimento).
$wgAbuseFilterIsCentral	false	Defina esta variável como true para a wiki onde AbuseFilters globais são armazenados (suportado apenas na última versão em desenvolvimento).
$wgAbuseFilterDisallowGlobalLocalBlocks	false	Não permitir filtros centralizados de tomarem ações que bloqueiam localmente, remover de grupos ou revogar permissões.
$wgAbuseFilterBlockDuration	'indefinite'	Duração dos blocos feita pelo AbuseFilter as of 1.31.0-wmf.25 block durations may be specified for every single filter and will override this variable. This variable is only used when enabling the block in order to preselect a default duration.
$wgAbuseFilterAnonBlockDuration	null	Duração de bloqueios feitos pelo AbuseFilter em usuários que não estão logados. O valor de $wgAbuseFilterBlockDuration será usado se ela não estiver definida. as of 1.31.0-wmf.25 block durations may be specified for every single filter and will override this variable. This variable is only used when enabling the block in order to preselect a default duration.
$wgAbuseFilterCustomActionsHandlers	[ ]	Funções callback para ações customizadas.
$wgAbuseFilterDefaultWarningMessage	[ 'default' => 'abusefilter-warning' ]	Mensagens de aviso padrão, por filtro de grupo
$wgAbuseFilterLogIPMaxAge	3 * 30 * 24 * 3600	Idade utilizada como ponto de corte ao purgar dados de registro de IP antigos. Padrão para 3 meses. Usado pelo script de manutenção purgeOldLogIPData.php.
$wgAbuseFilterProfileActionsCap	10000	Number of action that determines when to reset profiling stats.
$wgAbuseFilterLogPrivateDetailsAccess	false	Whether accessing private information from a filter log entry is logged.
$wgAbuseFilterPrivateDetailsForceReason	false	Whether users are forced to provide a reason for accessing private information from a filter log entry.

Emergency throttling

AbuseFilter comes with a feature that automatically throttles (disable) filters that have been edited recently and match a certain theresold of the latest actions.

This is done to prevent harmful edits on the filters to block every user that performs an action on the wiki or similar.

The condition to disable the filter depend on those variables:

• $wgAbuseFilterEmergencyDisableThreshold - Percent of matches over the total amount of actions in the observed period.
• $wgAbuseFilterEmergencyDisableCount - Count of matches of the filter in the observed period.
• $wgAbuseFilterEmergencyDisableAge - Age of the filter to take it into account. If the last edit of the filter is older than this number of seconds, the filter won't be throttled, unless it's already throttled.
• $wgAbuseFilterProfileActionsCap - Maximum number of recent actions to count against the threshold. Note that each action increments a counter, and once this counter reaches this configured value, this counter and the number of recent actions that matches all filters are reset to 0.

Throttled filters can be identified in the list of filters (Special:AbuseFilter) with the state Ativo, limitado. Throttling happens silently, and there's no way to see when a filter got throttled.

When a filter gets throttled, it doesn't perform any dangerous action (the ones specified in $wgAbuseFilterRestrictions), and only "safe" actions are allowed. Throttled filters don't get enabled automatically. To disable the throttling, you need to edit the filter. Note that you need to actually change something from the filter: changing somethin from the filter's notes is sufficient.

Note that editing the filter updates its age, and can cause it to be disabled if it reaches again the conditions to be throttled in a short period since the last edit, leading to a unusable filter if your wiki has more abuse edits than legitimate ones. Filters can also get randomly throttled if the action count reaches $wgAbuseFilterProfileActionsCap, causing all filter matches count to reset to 0, and then someone repeatedly makes a filter to hit.

Criando e gerenciando filtros

Uma vez que a extensão foi instalada, filtros podem ser criados/testados/alterados/excluídos e os registros podem ser acessados ​​a partir da página de gerenciamento do AbuseFilter Special:AbuseFilter.

• Formato das regras - Princípios de como desenvolver um filtro
• Ações
• Regras globais
• Guia de otimização do uso limite de condições
• Para importar filtros da Wikipédia: Após instalar a extensão, vá para pt:Especial:Filtro de abusos, escolha um filtro (p. ex. pt:Especial:Filtro de abusos/3) e clique em “Exportar este filtro para outra wiki”. Copie o texto, vá para “Special:AbuseFilter/import” na sua wiki e cole o texto.

API

O AbuseFilter adiciona dois módulos de lista de API, uma para detalhes dos filtros de abuso ("abusefilters") e um para o registro de abusos, uma vez que este é separado de outros registros do MediaWiki ("abuselog"). Não é possível criar ou modificar filtros de abuso usando a API.

list = abusefilters

Lista informações sobre filtros

;Parâmetros

• abfstartid: O ID do filtro de onde inicia-se a enumeração
• abfendid: O ID de filtro onde interrompe-se a enumeração
• abfdir: A direção na qual enumerar (mais antigo, mais recente)
• abfshow: Mostra apenas filtros que atendem a esses critérios (enabled|!enabled|deleted|!deleted|private|!private)
• abflimit: O número máximo de filtros para listar
• abfprop: Quais propriedades para se obter (id|description|pattern|actions|hits|comments|lasteditor|lastedittime|status|private):
• abfstartid - The filter id to start enumerating from
• abfendid - The filter id to stop enumerating at
• abfdir - The direction in which to enumerate (older, newer)
• abfshow - Show only filters which meet these criteria (enabled|!enabled|deleted|!deleted|private|!private)
• abflimit - The maximum number of filters to list
• abfprop - Which properties to get (id|description|pattern|actions|hits|comments|lasteditor|lastedittime|status|private)

Quando os filtros são private, algumas das propriedades especificadas com abfprop estarão ausentes, a menos que você tenha os direitos de usuário apropriados.

;Exemplos

Lista filtros de abuso não-privados

api.php?action=query&list=abusefilters&abfshow=!private&abfprop=id|hits [tente no ApiSandbox]

list = abuselog

Lista casos em que as ações desencadearam um filtro de abuso.

;Parâmetros

• aflstart: O timestamp de onde se inicia a enumeração
• aflend: O timestamp onde se para a enumeração
• afldir: A direção na qual se realiza a enumeração (mais antigo, mais recente)
• afluser: Mostra apenas as entradas onde a ação foi tentada por um determinado usuário ou endereço IP.
• afltitle: Mostra apenas as entradas onde a ação envolveu uma determinada página.
• aflfilter: Mostra apenas as entradas que desencadearam um determinado ID de filtro
• afllimit: O número máximo de entradas para listar
• aflprop: Quais propriedades a serem obtidas (ids|user|title|action|result|timestamp|details):
• aflstart - The timestamp to start enumerating from
• aflend - The timestamp to stop enumerating at
• afldir - The direction in which to enumerate (older, newer)
• afluser - Show only entries where the action was attempted by a given user or IP address.
• afltitle - Show only entries where the action involved a given page.
• aflfilter - Show only entries that triggered a given filter ID
• afllimit - The maximum number of entries to list
• aflprop - Which properties to get (ids|user|title|action|result|timestamp|details)

;Exemplo

Lista de casos em que o filtro de abuso foi desencadeado em resposta às ações do usuário "SineBot"

api.php?action=query&list=abuselog&afluser=SineBot&aflprop=ids [tente no ApiSandbox]

Possible errors

• Some users might experience that creating new filters or modifying old filters fail and the user just gets redirected to the original page. If the Wiki is using SSL certificates, this error could possibly be because of the $wgServer value, which might be using "http://" instead of "https://". An indication of this error will be, the browser giving https warning for Special:AbuseFilter pages. (Topic:T23dyyih0ofjada5)

Integration with other extensions

You can integrate AbuseFilter with other extension in various ways.

Adding variables for filtering

It is possible to add new variables, to be used in abuse filters. A list of examples is available . To do that, you should:

• Add a handler for the AbuseFilter-builder hook. To add a variable, you should use $builder['vars']['variable_name'] = 'i18n-key';, where variable_name is the name of the variable, and i18n-key is the fragment of an i18n key. The full key will be abusefilter-edit-builder-vars-{$your_key}.
• Add the i18n messages you chose at the previous point.
• Choose a hook handler where the variable will be computed. Depending on your use case, you could:
  • Implement the AbuseFilter-generateTitleVars hook; this is specifically thought for page-related variables;
  • Implement the AbuseFilter-generateUserVars hook; this is specifically thought for user-related variables;
  • Implement the AbuseFilter-generateStaticVars hook; this is specifically thought for "static" variables, i.e. variables whose value shouldn't depend on the context. This is rarely useful;
  • Implement the AbuseFilterAlterVariables hook; this is a bit more flexible than the other hooks, but it has a downside: your variable will not be available when examining past RecentChanges entries. If you want to implement that feature (and it's recommended to do so), you should use one of the hooks listed above, and use its third parameter ($RCRow).
• Inside the hook handler, there are two ways to add a variable:
  • The "direct" way is calling $vars->setVar( 'var_name', var_value );. This is ideal only when the value is easy and quick to compute: the value is computed even if no active filter will use it.
  • The "lazy" way is calling $vars->setLazyLoadVar( 'var_name', 'method_name', $params );. Here, 'method_name' is a (unique) identifier that will be used to compute the variable (it's recommended to prefix it with the name of your extension). To register the method, you should add a handler for the AbuseFilter-computeVariable hook; therein, you should check if the $method passed matches your 'method_name', and if so, compute the variable. Lastly, $params is an array of parameters that you'll need to compute the variable; these are passed to the computeVariable hook handler. For an example of this, you can check out CentralAuth's global_user_groups.

Adding rule groups

You can also add extra rule groups, which can be used to group existing abuse filters. Note that, at the moment, each filter can only be in a single group (T116642). Currently, the only known consumer of this feature is Flow. To do that, you should:

• Append the name of the group to $wgAbuseFilterValidGroups
• Add some code to run the filters with your group. Note that AbuseFilter won't do that on its own. To do that, you should construct an AbuseFilterRunner object, passing in the name of your group.

Ver também

• Várias wikis da WMF onde ela está habilitada (e com qual configuração)