Extensie:Misbruikfilter
Met de extensie ÁbuseFiler' kunnen bevoegde gebruikers specifieke acties instellen die gedaan moeten worden als gebruikers bepaalde acties uitvoeren, zoals het doen van wijzigingen aan bepaalde criteria voldoen.
Er kan bijvoorbeeld een filter aangemaakt worden dat voorkomt dat ongeregistreerde gebruikers externe links kunnen toevoegen of die een gebruiker blokkeert die meer dan 2000 tekens in een keer wil verwijderen.
Installatie
- Download en plaats de bestanden in de map
AbuseFilterin de mapextensions/. - Alleen bij installeren vanuit Git, run Composer om PHP afhankelijkheden te installeren, door het publiceren van
composer install --no-devin de extensie-map. (Zie taak T173141 voor potentiële problemen.) - Voeg de volgende code onderaan aan het bestand
LocalSettings.phptoe:wfLoadExtension( 'AbuseFilter' );
- Voer het update script uit, dat automatisch de vereiste database-tabellen creëert die nodig zijn voor de extensie.
- Als verplicht configureren.
Klaar – Navigeer naar Special:Version op de wiki om te controleren dat de extensie geïnstalleerd is.
Dus ga, na de installatie uit Git, naar de map met de extensie bijv. "../extensions/AbuseFilter/" en voer composer install --no-dev uit. Na het updaten moet alleen composer update --no-dev worden uitgevoerd.
Een alternatief dat de voorkeur heeft is het toevoegen van de regel "extensions/AbuseFilter/composer.json" aan het bestand "composer.local.json" in de root map van uw wiki, bijv.
{
"extra": {
"merge-plugin": {
"include": [
"extensions/AbuseFilter/composer.json"
]
}
}
}
Configuratie
Gebruikersrechten
Als de extensie is geïnstalleerd moet in "LocalSettings.php" de benodigde gebruikersrechten worden ingesteld.
| Recht | Beschrijving | Notes | User groups that have this right by default |
|---|---|---|---|
| abusefilter-modify | Filters aanmaken of aanpassen | Requires the abusefilter-view right | sysop |
| abusefilter-view | Filters bekijken | * | |
| abusefilter-log | Het filterlogboek bekijken | * | |
| abusefilter-log-detail | Details van filterlogboekregels bekijken | Requires the abusefilter-log right | sysop |
| abusefilter-privatedetails | Beperkt zichtbare gegevens in het filterlogboek bekijken | Prior to 1.34 this right was named abusefilter-private - Requires the abusefilter-log-detail right | — |
| abusefilter-modify-restricted | Filters met beperkte handelingen wijzigen | Requires the abusefilter-modify right | sysop |
| abusefilter-modify-global | Globale misbruikfilters aanmaken of aanpassen | Requires the abusefilter-view right | — |
| abusefilter-revert | Alle wijzigingen door een filter terugdraaien | sysop | |
| abusefilter-view-private | Als beperkt zichtbaar gemarkeerde filters bekijken | Requires the abusefilter-view right (not needed if the group already has the abusefilter-modify right) | sysop |
| abusefilter-log-private | Logboekvermeldingen bekijken van misbruikfilters die als persoonlijk zijn gemarkeerd | Requires the abusefilter-log right (not needed if the group already has the abusefilter-modify or abusefilter-view-private rights) | sysop |
| abusefilter-hide-log | Meldingen in het filterlogboek verbergen | Requires the abusefilter-log right | suppress |
| abusefilter-hidden-log | Verborgen meldingen in het filterlogboek bekijken | Requires the abusefilter-log right | suppress |
| abusefilter-privatedetails-log | Het toegangslogboek van beperkt zichtbare logboekgegevens van het misbruikfilter bekijken | Prior to 1.34 this right was named abusefilter-private-log | — |
For example, the following sample configuration would allow sysops to do everything they want with AbuseFilter, and everyone to view the log and see public filter settings:
$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;
Parameters
| Variable name | Default value | Description |
|---|---|---|
$wgAbuseFilterActions
|
[
'throttle' => true,
'warn' => true,
'disallow' => true,
'blockautopromote' => true,
'block' => true,
'rangeblock' => false,
'degroup' => false,
'tag' => true
]
|
The possible actions that can be taken by abuse filters. When adding a new action, check if it is restricted in $wgAbuseFilterActionRestrictions and, if it is, don't forget to add the abusefilter-modify-restricted right to the appropriate user groups.
|
$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), unless the filter has been changed in the last 86400 seconds (one day). See emergency throttling. |
$wgAbuseFilterEmergencyDisableCount
|
[
'default' => 2
]
| |
$wgAbuseFilterEmergencyDisableAge
|
[
'default' => 86400
]
| |
$wgAbuseFilterParserClass
|
'AbuseFilterParser'
|
Name of AbuseFilter's parser class. |
$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. Available options: rc, udp, rcandudp |
$wgAbuseFilterNotificationsPrivate
|
false
|
Enable notifications for private filters. |
$wgAbuseFilterCentralDB
|
null
|
Name of a database where global abuse filters will be stored in (only supported in the latest, development version). Requires CentralAuth installed otherwise global filters will break on a wikifarm. |
$wgAbuseFilterIsCentral
|
false
|
Set this variable to true for the wiki where global AbuseFilters are stored in (only supported in the latest, development version). 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'
|
Duration of blocks made by 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. |
$wgAbuseFilterCustomActionsHandlers
|
[]
|
Callback functions for custom actions. (verouderd sinds 1.36) Use the AbuseFilterCustomActions hook instead. |
$wgAbuseFilterDefaultWarningMessage
|
[
'default' => 'abusefilter-warning'
]
|
Default warning messages, per filter group |
$wgAbuseFilterDefaultDisallowMessage
|
[
'default' => 'abusefilter-disallowed'
]
|
Default disallow messages, per filter group |
$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. |
$wgAbuseFilterLogIP
|
true
|
Whether to include IP in the abuse_filter_log |
Emergency throttling
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.$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 Ingeschakeld, Hoog aantal overeenkomsten. 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 (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.
Creating and managing filters
Once the extension has been installed, filters can be created/tested/changed/deleted and the logs can be accessed from the Abuse filter management page Special:AbuseFilter.
- Rules format - The basics of how to write a filter
- 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.
- m:Small wiki toolkits/Starter kit/AbuseFilter - A guide for small wiki communities on metawiki
API
AbuseFilter adds two API list modules, one for details of abuse filters ("abusefilters") and one for the abuse log, since it is separate from other MediaWiki logs ("abuselog"). It is not possible to create or modify abuse filters using the API.
list = abusefilters
List information about filters
- Parameters
abfstartid- The filter id to start enumerating fromabfendid- The filter id to stop enumerating atabfdir- 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 listabfprop- Which properties to get (id|description|pattern|actions|hits|comments|lasteditor|lastedittime|status|private)
When filters are private, some of the properties specified with abfprop will be missing unless you have the appropriate user rights.
- Examples
List non-private abuse filters
| Resultaat |
|---|
{
"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
List instances where actions triggered an abuse filter.
- Parameters
aflstart- The timestamp to start enumerating fromaflend- The timestamp to stop enumerating atafldir- 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 IDafllimit- The maximum number of entries to listaflprop- Which properties to get: (ids|filter|user|ip|title|action|details|result|timestamp|hidden|revid|wiki)
- Example
List instances where the abuse filter was triggered in response to actions from the user "SineBot"
| Resultaat |
|---|
{
"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"
}
]
}
}
|
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
$wgServervalue, 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';, wherevariable_nameis the name of the variable, andi18n-keyis the fragment of an i18n key. The full key will beabusefilter-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'sglobal_user_groups.
- The "direct" way is calling
Adding custom actions
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}'
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 Extension:StructuredDiscussions. 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
AbuseFilterRunnerobject, passing in the name of your group.
See also
- Several WMF wikis where it's enabled (and with which configuration)
| Deze uitbreiding wordt gebruikt op een of meerdere Wikimedia projecten. Dit betekent waarschijnlijk dat de uitbreiding stabiel is en goed werkt op dergelijke vaak bezochte websites. Zoek op de naam van deze uitbreiding in Wikimedia's CommonSettings.php en InitialiseSettings.php om te zien waar deze is geïnstalleerd. Een volledige lijst van de uitbreidingen die geïnstalleerd zijn op een bepaalde wiki kan worden gevonden op de Special:Version pagina van de wiki. |
| Deze uitbreiding is onderdeel van de volgende pakketten en/of beschikbaar op de volgende wiki-families: Er kunnen wiki farms/hosts zijn die deze extension bevatten, maar hier niet genoemd worden. Controleer het altijd bij uw wiki farms/hosts of bundel. |