Jump to content

Extensão: AbuseFilter

No rastreador: #AbuseFilter
From mediawiki.org
This page is a translated version of the page Extension:AbuseFilter and the translation is 46% complete.
Languages:
Manual de extensões do MediaWiki
AbuseFilter
Estado de lançamento: estável
Implementação Atividade do utilizador , Página espacial , API
Descrição Permite restrições baseadas em comportamentos específicos para serem colocadas na atividade da wiki
Autor(es)
Política de compatibilidade Lançamentos de capturas de ecrã em conjunto com o MediaWiki. Original não é compatível com as versões anteriores.
Alterações à base de dados Sim
Composer mediawiki/abuse-filter
Tabelas abuse_filter
abuse_filter_action
abuse_filter_history
abuse_filter_log
Licença GNU - Licença Pública Geral 2.0 ou superior
Transferência
Transferir extensão
Git [?]:
Parâmetros
  • $wgAbuseFilterConditionLimit
  • $wgAbuseFilterRangeBlockSize
  • $wgAbuseFilterAnonBlockDuration
  • $wgAbuseFilterLogIPMaxAge
  • $wgAbuseFilterCentralDB
  • $wgAbuseFilterDefaultWarningMessage
  • $wgAbuseFilterLogIP
  • $wgAbuseFilterEmergencyDisableAge
  • $wgAbuseFilterEnableBlockedExternalDomain
  • $wgAbuseFilterActionRestrictions
  • $wgAbuseFilterActions
  • $wgAbuseFilterProtectedVariables
  • $wgAbuseFilterPrivateDetailsForceReason
  • $wgAbuseFilterLogPrivateDetailsAccess
  • $wgAbuseFilterNotifications
  • $wgAbuseFilterLogProtectedVariablesMaxAge
  • $wgAbuseFilterSlowFilterRuntimeLimit
  • $wgAbuseFilterEmergencyDisableThreshold
  • $wgAbuseFilterLocallyDisabledGlobalActions
  • $wgAbuseFilterBlockDuration
  • $wgAbuseFilterDefaultDisallowMessage
  • $wgAbuseFilterIsCentral
  • $wgAbuseFilterNotificationsPrivate
  • $wgAbuseFilterValidGroups
  • $wgAbuseFilterEmergencyDisableCount
  • $wgAbuseFilterBlockAutopromoteDuration
Direitos adicionados
  • abusefilter-modify
  • abusefilter-log-detail
  • abusefilter-view
  • abusefilter-log
  • abusefilter-privatedetails
  • abusefilter-privatedetails-log
  • abusefilter-modify-restricted
  • abusefilter-revert
  • abusefilter-view-private
  • abusefilter-log-private
  • abusefilter-hidden-log
  • abusefilter-hide-log
  • abusefilter-modify-global
  • abusefilter-modify-blocked-external-domains
  • abusefilter-bypass-blocked-external-domains
  • abusefilter-blocked-external-domains-log
  • abusefilter-access-protected-vars
  • abusefilter-protected-vars-log
Hooks utilizados
Hooks fornecidos
Traduza a extensão AbuseFilter se esta estiver disponível em translatewiki.net
Problemas Tarefas em aberto · Reportar um erro

AbuseFilter

2020 Coolest Tool
Award Winner

in the category
Quality


A extensão AbuseFilter permite que os utilizadores privilegiados definam ações específicas para serem realizadas sobre as ações dos utilizadores, tais como edições, corresponder determinados critérios.

Por exemplo, poderia ser criado um filtro para impedir que os utilizadores não registados adicionem hiperligações externas, ou para não permitir edições que removam mais de 2000 carateres.


Instalação

This extension comes with MediaWiki 1.38 and later, so you do not need to download it. The remaining configuration instructions must still be followed.
  • Exporte e coloque o ficheiro, ou ficheiros, num diretório chamado AbuseFilter, na sua pasta extensions/.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/AbuseFilter
  • Only when installing from Git, run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See T173141 for potential complications.)
  • Acrescente o seguinte código ao fundo do ficheiro $LocalSettings: 
    wfLoadExtension( 'AbuseFilter' );
  • Execute o script de atualização que irá criar automaticamente as tabelas da base de dados necessárias para esta extensão.
  • Configure conforme necessário.
  • Yes Pronto – Na página especial Special:Version da sua wiki verifique se a extensão foi instalada.
Quando instala a partir do Git, por favor, note que esta extensão requer Composer .

Assim, depois da instalação do Git, mude para a diretoria que contém a extensão, por exemplo "../extensions/AbuseFilter/" e execute composer install --no-dev, ou quando atualiza: composer update --no-dev.

Em alternativa, bem como preferencialmente, adicione a linha "extensions/AbuseFilter/composer.json" ao ficheiro "composer.local.json" na diretoria raiz da sua wiki, como por exemplo, 

{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/AbuseFilter/composer.json"
			]
		}
	}
}

Configuração

Direitos do utilizador

Assim que instalar a extensão, terá de configurar os direitos do utilizador nas "LocalSettings.php".

Direitos do Utilizador para o AbuseFilter
Direito Descrição Notas Grupos de utilizadores que têm este direito por predefinição Versions
abusefilter-modify Criar ou modificar filtros de abusos Requer o direito abusefilter-view sysop 1.19+
abusefilter-view Ver filtros de abuso * 1.19+
abusefilter-log Ver o registo de abusos * 1.19+
abusefilter-log-detail Ver entradas detalhadas do registo de abusos Requer o direito abusefilter-log sysop 1.19+
abusefilter-privatedetails Ver dados privados no registo de abusos Antes da versão 1.34, este direito era denominado abusefilter-private - Requer o direito abusefilter-log-detail — 1.19+
abusefilter-modify-restricted Modificar filtros de abuso com ações restritas Requer o direito abusefilter-modify sysop 1.19+
abusefilter-revert Reverter todas as alterações feitas por um dado filtro de abuso sysop 1.19+
abusefilter-view-private Ver filtros de abuso marcados como privados Requer o direito abusefilter-view (não é necessário se o grupo já tem o direito abusefilter-modify) sysop 1.19+
abusefilter-hide-log Ocultar entradas do filtro de abusos Requer o direito abusefilter-log suppress 1.19+
abusefilter-hidden-log Ver entradas ocultadas do registo de abusos Requer o direito abusefilter-log suppress 1.19+
abusefilter-log-private Ver entradas de registo de filtros de abuso marcados como privados Requer o direito abusefilter-log (não é necessário se o grupo já tem os direitos abusefilter-modify ou abusefilter-view-private) sysop 1.20+
abusefilter-modify-global Criar ou modificar os filtros globais de abusos Requer o direito abusefilter-modify — 1.21+
abusefilter-privatedetails-log Ver o registo de consultas dos detalhes privados do filtro de abusos Antes da versão 1.34, este direito era denominado abusefilter-private-log — 1.31+
abusefilter-modify-blocked-external-domains Criar ou modificar que domínios externos estão impedidos de ser destino de hiperligações sysop 1.41+
abusefilter-bypass-blocked-external-domains Contornar os domínios externos bloqueados Requer o direito edit bot 1.41+
abusefilter-access-protected-vars Ver e criar filtros que usam variáveis protegidas sysop 1.43+
abusefilter-protected-vars-log Visualizar os registros relacionados ao acesso a valores de variáveis protegidas sysop 1.43+

Por exemplo, o exemplo de configuração seguinte permitiria que os administradores de sistemas fizessem tudo o que quisessem com o 'AbuseFilter' e que todos visualizassem as definições de registo e 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;
$wgGroupPermissions['sysop']['abusefilter-access-protected-vars'] = true;
$wgGroupPermissions['sysop']['abusefilter-protected-vars-log'] = true;
Os filtros marcados como privados só podem ser visualizados pelos utilizadores com a permissão abusefilter-modify ou abusefilter-view-private.
Os filtros protegidos só podem ser criados e visualizados pelos utilizadora com a permissão abusefilter-access-protected-vars. Os registos relacionados com estes filtros só podem visualizados pelos utilizadores com a permissão abusefilter-protected-vars-log. Para mais informação, consulte o formato das 'Regras' .

Parâmetros

Parameters for AbuseFilter
Nome da variável Valor predefinido Descrição
$wgAbuseFilterActions 
[
    'throttle' => true,
    'warn' => true,
    'disallow' => true,
    'blockautopromote' => true,
    'block' => true,
    'rangeblock' => false,
    'degroup' => false,
    'tag' => true
]
As ações possíveis que podem ser realizadas pelos filtros de abuso. Quando adiciona uma nova ação, verifique se esta está restrita em $wgAbuseFilterActionRestrictions e, se estiver, não se esqueça de adicionar o direito abusefilter-modify-restricted aos grupos de utilizadores apropriados.
$wgAbuseFilterConditionLimit 
1000
The maximum number of 'conditions' that can be used each time the filters are run against a change. (More complex filters require more 'conditions').
$wgAbuseFilterValidGroups 
[
    'default'
]
The list of "groups" filters can be divided into. By default there is only one group. Other extensions may add other groups.
$wgAbuseFilterEmergencyDisableThreshold 
[
    'default' => 0.05
]
Disable a filter if it matched more than 2 edits, constituting more than 5 % of the actions which were checked against the filter's group in the "observed" period (at most one day), and the filter has been changed in the last 86400 seconds (one day). Consulte limitação de emergência.
$wgAbuseFilterEmergencyDisableCount 
[
    'default' => 2
]
$wgAbuseFilterEmergencyDisableAge 
[
    'default' => 86400
]
$wgAbuseFilterActionRestrictions 
[
	"throttle" => false,
	"warn" => false,
	"disallow" => false,
	"blockautopromote" => true,
	"block" => true,
	"rangeblock" => true,
	"degroup" => true,
	"tag" => false
]
Users must have the "abusefilter-modify-restricted" user right as well as "abusefilter-modify" in order to create or modify filters which carry out these actions.
$wgAbuseFilterNotifications 
false
Allows to configure the extension to send hit notifications to Special:RecentChanges or UDP. Opções disponíveis: rc, udp, rcandudp
For sending changes to abuse filters to Special:RecentChanges, use $wgExtensionFunctions[] = static function () { global $wgLogRestrictions; unset( $wgLogRestrictions['abusefilter'] ); };.
$wgAbuseFilterNotificationsPrivate 
false
Ative as notificações para os filtros privados.
$wgAbuseFilterCentralDB 
null
MW 1.41+ Name of a database where global abuse filters will be stored in. Requires CentralAuth installed otherwise global filters will break on a wikifarm.
$wgAbuseFilterIsCentral 
false
MW 1.41+ Set this variable to true for the wiki where global AbuseFilters are stored in. Requires CentralAuth installed otherwise global filters will break on a wikifarm.
$wgAbuseFilterLocallyDisabledGlobalActions 
[
	"throttle" => false,
	"warn" => false,
	"disallow" => false,
	"blockautopromote" => false,
	"block" => false,
	"rangeblock" => false,
	"degroup" => false,
	"tag" => false
]
Disallow Centralised filters from taking actions set as true in this variable.
$wgAbuseFilterBlockDuration 
'indefinite'
Duração dos bloqueios efetuados 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
Duration of blocks made by AbuseFilter on users who are not logged in. The value of $wgAbuseFilterBlockDuration will be used if this is not set.
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.
$wgAbuseFilterBlockAutopromoteDuration 
5
Duration, in days, for which users' autopromotion is blocked by filters.
$wgAbuseFilterDefaultWarningMessage 
[
    'default' => 'abusefilter-warning'
]
Default warning messages, per filter group
$wgAbuseFilterDefaultDisallowMessage 
[
    'default' => 'abusefilter-disallowed'
]
Default disallow messages, per filter group
$wgAbuseFilterLogIP 
true
Whether to include IP in the abuse_filter_log
$wgAbuseFilterLogIPMaxAge 
3 * 30 * 24 * 3600
Age used as cutoff when purging old IP log data. Defaults to 3 months. Used by maintenance script 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.
$wgAbuseFilterSlowFilterRuntimeLimit 
500
Runtime in milliseconds before a filter is considered slow.
$wgAbuseFilterRangeBlockSize 
[
    'IPv4' => '16',
    'IPv6' => '19',
]
Size of the range blocked by 'rangeblock' action.
$wgAbuseFilterProtectedVariables 
[ "user_unnamed_ip" ]
Array of variables that are be considered protected (limited access) and require the abusefilter-access-protected-vars right to use/view.

Limitação de emergência

AbuseFilter comes with a feature that automatically throttles (disables) filters that have been edited recently and match a certain threshold 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.

Throttled filters can be identified in the list of filters (Special:AbuseFilter) with the state Ativado, Número elevado de correspondências. Throttling happens silently, and there's no way to see when a filter got throttled, except when Extensão: Echo is installed, then a notification is sent to the user who was last to modify the filter.

When a filter gets throttled, it doesn't perform any dangerous action (actions usually restricted to special rights like blocking the user, or removing it from groups, controlled by $wgAbuseFilterActionRestrictions), and only "safe" actions are allowed (the ones that can warn or prevent the ongoing action). 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 something 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.

Criação e gestão de filtros

Assim que a extensão estiver instalada, os filtros podem ser criados/testados/alterados/eliminados e os registos podem ser acedidos na página de gestão do filtros de 'Abuso' Special:AbuseFilter.

Regras Globais

  • To import filters from Wikipedia: When you have installed the extension, go to w:Special:AbuseFilter, choose a filter (say w:Special:AbuseFilter/3), then click "Export this filter to another wiki", copy the text, go to Special:AbuseFilter/import on your wiki, paste the text.

API

O 'AbuseFilter' adiciona dois módulos de lista da API, um para detalhes de filtros de abuso ("abusefilters") e outro para o registo de abuso, pois é separado dos outros registos do MediaWiki ("abuselog"). Não é possível criar ou modificar filtros de abuso utilizando a API.

list=abusefilters (abf)

Listar informação sobre os filtros

Parâmetros
  • 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|protected|!protected
  • abflimit – The maximum number of filters to list
  • abfprop – Which properties to get: id|description|pattern|actions|hits|comments|lasteditor|lastedittime|status|private|protected

When filters are private, some of the properties specified with abfprop will be missing unless you have the appropriate user rights.

Exemplos
List non-private abuse filters
api.php?action=query&list=abusefilters&abfshow=!private&abfprop=id|hits [teste na 'Área de Testes' da API (Sandbox)]
Resultado
{
    "batchcomplete": "",
    "continue": {
        "abfstartid": 18,
        "continue": "-||"
    },
    "query": {
        "abusefilters": [
            {
                "id": 1,
                "hits": 41430
            },
            {
                "id": 3,
                "hits": 957485
            },
            {
                "id": 5,
                "hits": 5931
            },
            {
                "id": 6,
                "hits": 19
            },
            {
                "id": 8,
                "hits": 7
            },
            {
                "id": 9,
                "hits": 41354
            },
            {
                "id": 11,
                "hits": 132971
            },
            {
                "id": 12,
                "hits": 139693
            },
            {
                "id": 14,
                "hits": 63
            },
            {
                "id": 15,
                "hits": 15
            }
        ]
    }
}

list=abuselog (afl)

List instances where actions triggered an abuse filter.

Parâmetros
  • afllogid – A single integer log ID to list.
  • 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|filter|user|title|action|details|result|timestamp|hidden|revid|wiki)

aflprop=wiki is recognized only on central wikis.

Exemplo
List instances where the abuse filter was triggered in response to actions from the user "SineBot"
api.php?action=query&list=abuselog&afluser=SineBot&aflprop=ids [teste na 'Área de Testes' da API (Sandbox)]
Resultado
{
    "batchcomplete": "",
    "continue": {
        "aflstart": "2018-03-06T02:34:18Z",
        "continue": "-||"
    },
    "query": {
        "abuselog": [
            {
                "id": 27219261,
                "filter_id": "1073"
            },
            {
                "id": 26938051,
                "filter_id": ""
            },
            {
                "id": 23388942,
                "filter_id": "1"
            },
            {
                "id": 22044912,
                "filter_id": ""
            },
            {
                "id": 22032235,
                "filter_id": ""
            },
            {
                "id": 22032196,
                "filter_id": ""
            },
            {
                "id": 21983882,
                "filter_id": ""
            },
            {
                "id": 20594818,
                "filter_id": "904"
            },
            {
                "id": 20593489,
                "filter_id": "904"
            },
            {
                "id": 20590442,
                "filter_id": "904"
            }
        ]
    }
}

Erros possíveis

Integração com outras extensões

You can integrate AbuseFilter with other extension in various ways.

Adição de variáveis para a filtragem

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-generateGenericVars hook; this is for variables not bound to a specific page or user;
    • 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.

Adição de ações personalizadas

You can add custom action handlers, so that each filter may perform further actions. To do that, you choose a name for the action ('my-action' from now on), and then:

  • Create a class named e.g. MyAction, that should extend \MediaWiki\Extension\AbuseFilter\Consequence, which can also implement HookAborterConsequence or ConsequencesDisablerConsequence
  • Add a subscriber to the AbuseFilterCustomActions hook; the subscriber should provide a callback as documented in the hook documentation, that returns an instance of the class created above, for instance:
class MyAction extends \MediaWiki\Extension\AbuseFilter\Consequence {
    public function run() {
        throw new \Exception( 'Write me' );
    }
}

public function onAbuseFilterCustomActions( &$actions ) {
    $actions[] = function ( \MediaWiki\Extension\AbuseFilter\Consequence\Parameters $params, array $rawParams ) : MyConsequence {
        return new MyAction( $params, $rawParams );
    };
}

Then you should add the following i18n messages; you can replace 'my_action' with e.g. 'block' to see what the messages are for:

  • 'abusefilter-edit-action-${my_action}'
  • 'abusefilter-action-${my_action}'

Adição de grupos de regra

Também pode adicionar grupos de regras extras, que podem ser utilizados para agrupar os filtros de abuso existentes. Note que, de momento, cada filtro só pode estar num grupo (T116642) sozinho. Atualmente, a única extensão que se conhece que utiliza esta funcionalidade é Extensão: Discussões Estruturadas . Para o fazer, deveria:

  • Anexar o nome do grupo aos $wgAbuseFilterValidGroups.
  • Adicionar algum código para executar os filtros com o seu grupo. Note que 'AbuseFilter' não irá fazer isso por si só. Para o fazer, deveria criar um objeto $objett, passando o nome do seu grupo.

Consultar também

Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:AbuseFilter/pt&oldid=7978154"