Erweiterung:Missbrauchsfilter

MediaWiki-Erweiterungen

AbuseFilter Freigabestatus: stabil
Einbindung	Benutzeraktivität , Spezialseite , API
Beschreibung	Allows specific behavior-based restrictions to be placed on wiki activity
Autor(en)	Andrew Garrett Daimona Eaytoy Marius Hoch River Tarnell Victor Vasiliev
Kompatibilitätspolitik	Snapshots releases along with MediaWiki. Master is not backwards compatible.
MediaWiki	1.33+
PHP	5.4+ benötigt
Datenbankänderungen	Ja
Tabellen	abuse_filter abuse_filter_action abuse_filter_history abuse_filter_log
Lizenz	GNU General Public License 2.0 oder neuer
Herunterladen	Erweiterung herunterladen Git [?]: Git master herunterladen Repository durchsuchen (GitHub) Ergänzungen und Änderungen Repository-Mitwirkende (GitHub) Code-Review
Parameter $wgAbuseFilterConditionLimit $wgAbuseFilterRangeBlockSize $wgAbuseFilterAnonBlockDuration $wgAbuseFilterLogIPMaxAge $wgAbuseFilterCentralDB $wgAbuseFilterDefaultWarningMessage $wgAbuseFilterEmergencyDisableAge $wgAbuseFilterProfileActionsCap $wgAbuseFilterActionRestrictions $wgAbuseFilterActions $wgAbuseFilterAflFilterMigrationStage $wgAbuseFilterLogIP $wgAbuseFilterPrivateDetailsForceReason $wgAbuseFilterEmergencyDisableCount $wgAbuseFilterLogPrivateDetailsAccess $wgAbuseFilterSlowFilterRuntimeLimit $wgAbuseFilterEmergencyDisableThreshold $wgAbuseFilterLocallyDisabledGlobalActions $wgAbuseFilterBlockDuration $wgAbuseFilterDefaultDisallowMessage $wgAbuseFilterValidGroups $wgAbuseFilterNotificationsPrivate $wgAbuseFilterBlockAutopromoteDuration $wgAbuseFilterIsCentral $wgAbuseFilterNotifications
Hinzugefügte Rechte 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
Verwendete Hooks ArticleDelete BeforeCreateEchoEvent ChangeTagsListActive ContributionsToolLinks EditFilterMergedContent GetAutoPromoteGroups HistoryPageToolLinks ListDefinedTags LoadExtensionSchemaUpdates PageSaveComplete ParserOutputStashForEdit RecentChange_save RenameUserSQL TitleMove UndeletePageToolLinks UnitTestsAfterDatabaseSetup UnitTestsBeforeDatabaseTeardown UploadStashFile UploadVerifyUpload UserMergeAccountFields
Bereitgestellte Hooks AbuseFilter-builder AbuseFilter-deprecatedVariables AbuseFilter-computeVariable AbuseFilter-contentToString AbuseFilter-filterAction AbuseFilterAlterVariables AbuseFilter-generateTitleVars AbuseFilter-generateUserVars AbuseFilter-generateStaticVars AbuseFilter-interceptVariable AbuseFilterShouldFilterAction AbuseFilterGetDangerousActions
Übersetze die AbuseFilter-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Prüfe die Benutzungs- und Versionsmatrix.
Probleme	Offene Aufgaben · Einen Fehler melden

AbuseFilter

2020 Coolest Tool
Award Winner

in the category
Quality

Die Missbrauchsfilter-Erweiterung erlaubt privilegierten Benutzern, bestimmte Maßnahmen festzusetzen, die getroffen werden, wenn von Benutzern durchgeführte Handlungen, wie Bearbeitungen, bestimmte Kriterien erfüllen.

Beispielsweise könnte ein Filter erstellt werden, um zu verhindern, dass anonyme Benutzer externe Links hinzufügen, oder um einen Benutzer zu blockieren, der mehr als 2000 Zeichen entfernt.

Installation

• Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens AbuseFilter im Ordner extensions/ ablegen.
• Wird von git aus installiert, ist Composer auszuführen, um PHP-Abhängigkeiten zu installieren, indem composer install --no-dev im Erweiterungsverzeichnis ausgeführt wird. (Siehe task T173141 für mögliche Komplikationen.)
• Folgenden Code am Ende der LocalSettings.php hinzufügen:

  wfLoadExtension( 'AbuseFilter' );
  

• Führe das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
• Configure as required.
•  Erledigt – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Für Benutzer, die MediaWiki in der Version 1.26 und früher betreiben:

Die oben stehenden Anweisungen beschreiben die neue Installationsanweisung für diese Erweiterung unter der Verwendung von wfLoadExtension(). Wird diese Erweiterung in einer dieser früheren Versionen (MediaWiki 1.26 und früher)  – an Stelle von wfLoadExtension( 'AbuseFilter' ); – installiert, benutze:

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

Konfiguration

Benutzerrechte

Sobald Du die Erweiterung installiert hast, musst Du die Benutzerrechte in "LocalSettings.php" einrichten.

Recht	Beschreibung
abusefilter-modify	Missbrauchsfilter erstellen oder bearbeiten
abusefilter-view	Missbrauchsfilter ansehen
abusefilter-log	Missbrauchsfilter-Logbuch einsehen
abusefilter-log-detail	Erweitertes Missbrauchsfilter-Logbuch einsehen
abusefilter-privatedetails	Private Daten im Missbrauchsfilter-Logbuch einsehen
abusefilter-modify-restricted	Missbrauchsfilter mit privilegierten Aktionen bearbeiten
abusefilter-modify-global	Globale Missbrauchsfilter erstellen oder verändern
abusefilter-revert	Alle Bearbeitungen durch einen bestimmten Missbrauchsfilter rückgängig machen
abusefilter-view-private	Als privat markierten Missbrauchsfilter einsehen
abusefilter-log-private	Als privat markierten Einträge im Missbrauchsfilter einsehen
abusefilter-hide-log	Einträge aus dem Missbrauchsfilter-Logbuch ausblenden
abusefilter-hidden-log	Versteckte Einträge im Missbrauchsfilter-Logbuch einsehen
abusefilter-privatedetails-log	Das Missbrauchsfilter-Private-Einzelheiten-Zugriffs-Logbuch ansehen

Die folgende Beispielkonfiguartion würde zum Beispiel Administratoren erlauben, alles mit den Missbrauchsfiltern zu machen, und jedem, das Logbuch und die Einstellungen öffentlicher Filter einzusehen.

$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;

Filter, die als privat markiert sind, können nur von Benutzern angesehen werden, die entweder das abusefilter-modify oder das abusefilter-view-private-Recht besitzen.

Parameter

Name der Variablen	Standardwert	Beschreibung
$wgAbuseFilterActions	[ 'throttle' => true, 'warn' => true, 'disallow' => true, 'blockautopromote' => true, 'block' => true, 'rangeblock' => false, 'degroup' => false, 'tag' => true ]	Die möglichen Aktionen, die durch Missbrauchsfilter getätigt werden können. Prüfe beim Hinzufügen einer neuen Aktion, ob sie in $wgAbuseFilterActionRestrictions eingeschränkt ist. Falls das der Fall ist, vergiss nicht das abusefilter-modify-restricted-Recht zu den entsprechenden Benutzergruppen hinzuzufügen.
$wgAbuseFilterConditionLimit	1000	Die maximale Anzahl von 'Bedingungen', die jedes Mal verwendet werden können, wenn die Filter gegen eine Änderung ausgeführt werden. (Komplexere Filter erfordern mehr 'Bedingungen').
$wgAbuseFilterValidGroups	[ 'default' ]	Die Liste der "Gruppen", in die Filter unterteilt werden können. Standardmäßig gibt es nur eine Gruppe. Andere Erweiterungen können weitere Gruppen hinzufügen.
$wgAbuseFilterEmergencyDisableThreshold	[ 'default' => 0.05 ]	Deaktiviere einen Filter, wenn er mit mehr als zwei Bearbeitungen übereinstimmt. Dies entspricht mehr als 5 % der Aktionen, die im "beobachteten" Zeitraum (höchstens einen Tag) gegen die Filtergruppe geprüft wurden, sofern der Filter nicht in den letzten 86400 Sekunden (einem Tag) geändert wurde. See emergency throttling.
$wgAbuseFilterEmergencyDisableCount	[ 'default' => 2 ]
$wgAbuseFilterEmergencyDisableAge	[ 'default' => 86400 ]
$wgAbuseFilterParserClass	'AbuseFilterParser'	Name der Parser-Klasse von AbuseFilter.
$wgAbuseFilterActionRestrictions	[ "throttle" => false, "warn" => false, "disallow" => false, "blockautopromote" => true, "block" => true, "rangeblock" => true, "degroup" => true, "tag" => false ]	Benutzer müssen über das Benutzerrecht "abusefilter-modify-restricted" sowie "abusefilter-modify" verfügen, um Filter erstellen oder ändern zu können, die diese Aktionen ausführen.
$wgAbuseFilterNotifications	false	Ermöglicht die Konfiguration der Erweiterung zum Senden von Trefferbenachrichtigungen an Special:RecentChanges oder UDP. Verfügbare Einstellungen: rc, udp, rcandudp
$wgAbuseFilterNotificationsPrivate	false	Aktiviere Benachrichtigungen für private Filter.
$wgAbuseFilterCentralDB	null	Name einer Datenbank, in der globale Missbrauchsfilter gespeichert werden (nur in der neuesten Entwicklungsversion unterstützt). Requires CentralAuth installed otherwise global filters will break on a wikifarm.
$wgAbuseFilterIsCentral	false	Setze diese Variable für das Wiki, in dem globale AbuseFilters gespeichert sind, auf "true" (nur in der neuesten Entwicklungsversion unterstützt). 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 ]	Verhindern, dass zentralisierte Filter Aktionen ausführen, die lokal blockieren, aus Gruppen entfernen oder Berechtigungen widerrufen.
$wgAbuseFilterBlockDuration	'indefinite'	Dauer der von AbuseFilter erstellten Blöcke. ab 1.31.0-wmf.25 können Blockdauern für jeden einzelnen Filter angegeben werden und überschreiben diese Variable. Diese Variable wird nur verwendet, wenn der Block aktiviert wird, um eine Standarddauer vorzuwählen.
$wgAbuseFilterAnonBlockDuration	null	Dauer der Blöcke, die von AbuseFilter für Benutzer erstellt werden, die nicht angemeldet sind. Der Wert von $wgAbuseFilterBlockDuration wird verwendet, wenn dies nicht festgelegt ist. ab 1.31.0-wmf.25 können Blockdauern für jeden einzelnen Filter angegeben werden und überschreiben diese Variable. Diese Variable wird nur verwendet, wenn der Block aktiviert wird, um eine Standarddauer vorzuwählen.
$wgAbuseFilterBlockAutopromoteDuration	5	Duration, in days, for which users' autopromotion is blocked by filters.
$wgAbuseFilterCustomActionsHandlers	[]	Rückruffunktionen für benutzerdefinierte Aktionen. (veraltet in 1.36) Use the AbuseFilterCustomActions hook instead.
$wgAbuseFilterDefaultWarningMessage	[ 'default' => 'abusefilter-warning' ]	Standard-Warnmeldungen pro Filtergruppe
$wgAbuseFilterDefaultDisallowMessage	[ 'default' => 'abusefilter-disallowed' ]	Default disallow messages, per filter group
$wgAbuseFilterLogIPMaxAge	3 * 30 * 24 * 3600	Alter, das als Abschaltzeit verwendet wird, wenn alte IP-Protokolldaten gelöscht werden. Standardeinstellung 3 Monate. Wird vom Wartungsskript purgeOldLogIPData.php verwendet.
$wgAbuseFilterProfileActionsCap	10000	Anzahl der Aktionen, die bestimmen, wann Statistiken zurückgesetzt werden sollen.
$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 (disable) 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 Aktiviert, gedrosselt. 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 that can prevent the ongoing action), 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 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. 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.

Creating and managing filters

Ist die Erweiterung einmal installiert, können Filter über die Missbrauchsfilter-Verwaltungsseite Spezial:Missbrauchsfilter erstellt, getestet, geändert und gelöscht werden. Dort kann auch auf die Logbücher zugegriffen werden.

• Regelformat - Die Grundlagen zum Schreiben eines Filters
• Aktionen
• Globale Regeln
• Leitfaden zur Optimierung der Verwendung von Bedingungsgrenzen
• So importieren Sie Filter aus Wikipedia: Wenn Sie die Erweiterung installiert haben, gehen Sie zu w:Special:AbuseFilter, wählen Sie einen Filter aus (sagen Sie zu w:Special:AbuseFilter/3) und klicken Sie auf "Diesen Filter in ein anderes Wiki exportieren". Kopieren Sie den Text. Gehe in deinem Wiki auf "Special: AbuseFilter/import" und füge den Text ein.
• m:Small wiki toolkits/Starter kit/AbuseFilter - A guide for small wiki communities on metawiki

Programmierschnittstelle – API

AbuseFilter fügt zwei API-Listenmodule hinzu, eines für Details zu Missbrauchsfiltern ("abusefilters") und eines für das Missbrauchsprotokoll, da es von anderen MediaWiki-Protokollen ("abuselog") getrennt ist. Es ist nicht möglich, Missbrauchsfilter mithilfe der API zu erstellen oder zu ändern.

list = abusefilters

Liste Informationen über die Filter auf

Parameter

• 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)

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

Beispiele

List non-private abuse filters

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

Ergebnis

<api> <query> <abusefilters> <filter id="1" hits="867" /> <filter id="3" hits="66110" /> <filter id="5" hits="464" /> <filter id="6" hits="19" /> <filter id="8" hits="7" /> <filter id="9" hits="24869" /> <filter id="11" hits="10033" /> <filter id="14" hits="63" /> <filter id="15" hits="15" /> <filter id="16" hits="44" /> </abusefilters> </query> <query-continue> <abusefilters abfstartid="18" /> </query-continue> </api>

list = abuselog

List instances where actions triggered an abuse filter.

Parameters

• 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|ip|title|action|details|result|timestamp|hidden|revid|wiki)

Beispiel

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 [try in ApiSandbox]

Ergebnis

<api> <query> <abuselog> <item id="900937" filter_id="211" user="SineBot" result="" /> <item id="888404" filter_id="211" user="SineBot" result="" /> <item id="862751" filter_id="211" user="SineBot" result="" /> <item id="855649" filter_id="211" user="SineBot" result="" /> <item id="842429" filter_id="211" user="SineBot" result="" /> <item id="840958" filter_id="1" user="SineBot" result="" /> <item id="824151" filter_id="211" user="SineBot" result="" /> <item id="804892" filter_id="211" user="SineBot" result="" /> <item id="205254" filter_id="58" user="SineBot" result="disallow" /> <item id="205252" filter_id="58" user="SineBot" result="disallow" /> </abuselog> </query> <query-continue> <abuselog aflstart="2009-04-19T02:07:55Z" /> </query-continue> </api>

Mögliche Fehler

• 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-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.

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 MyConsequence 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 MyConsequence( $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 AbuseFilterRunner object, passing in the name of your group.

Siehe auch

• Liste der WMF-Wikis mit Bearbeitungsfilter (mit der jeweiligen Konfiguration)