Rozszerzenie:Filtr nadużyć
AbuseFilter Status wydania: stabilne |
|
---|---|
Realizacja | Aktywność użytkownika , Strona specjalna , API |
Opis | Zezwala na umieszczanie określonych ograniczeń w działalności wiki, w oparciu na działania |
Autor(zy) |
|
Polityka zgodności | Snapshots releases along with MediaWiki. Master nie jest kompatybilny wstecznie. |
MediaWiki | >= 1.43.0 |
Zmiany w bazie danych | Tak |
Composer | mediawiki/abuse-filter |
Tabele | abuse_filter abuse_filter_action abuse_filter_history abuse_filter_log |
Licencja | Licencja GNU General Public License 2.0 lub nowsza |
Pobieranie | |
|
|
|
|
|
|
|
|
Quarterly downloads | 139 (Ranked 42nd) |
Public wikis using | 2,939 (Ranked 186th) |
Przetłumacz rozszerzenie AbuseFilter jeżeli jest dostępne na translatewiki.net | |
Problemy | Otwarte zadania · Zgłoś błąd |
Rozszerzenie Filtr nadużyć pozwala uprzywilejowanym użytkownikom określenie konkretnych działań, które mają być podjęte, kiedy działania użytkowników, takie jak edycje, spełniają określone kryteria.
Na przykład można utworzyć filtr blokujący niezalogowanym dodawanie linków lub blokujący konto, jeżeli użytkownik usunie więcej niż 2000 znaków.
Instalacja
- Pobierz i umieść plik(i) w katalogu o nazwie
AbuseFilter
w folderzeextensions/
.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/AbuseFilter - Tylko w przypadku instalacji z repozytorium git należy uruchomić Composer, aby zainstalować zależności PHP, poprzez wywołanie
composer install --no-dev
w katalogu rozszerzenia. (Zobacz zadanie T173141 w celu uzyskania informacji o możliwych komplikacjach.) - Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
wfLoadExtension( 'AbuseFilter' );
- Uruchom skrypt aktualizujący, który automatycznie stworzy potrzebne tabele dla tego rozszerzenia.
- Configure as required.
- Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.
So, after installation from Git change to the directory containing the extension e.g. "../extensions/AbuseFilter/" and run composer install --no-dev
, or when updating: composer update --no-dev
.
Alternatively as well as preferably add the line "extensions/AbuseFilter/composer.json"
to the "composer.local.json" file in the root directory of your wiki like e.g.
{
"extra": {
"merge-plugin": {
"include": [
"extensions/AbuseFilter/composer.json"
]
}
}
}
Konfiguracja
Uprawnienia użytkownika
Po zainstalowaniu rozszerzenia, musisz skonfigurować uprawnienia w "LocalSettings.php".
Uprawnienie | Opis | Uwagi | User groups that have this right by default |
---|---|---|---|
abusefilter-modify | Tworzenie lub modyfikowanie filtrów nadużyć | Requires the abusefilter-view right
|
sysop |
abusefilter-view | Podgląd filtrów nadużyć | * | |
abusefilter-log | Podgląd rejestru nadużyć | * | |
abusefilter-log-detail | Podgląd szczegółów wpisów w rejestrze nadużyć | Requires the abusefilter-log right
|
sysop |
abusefilter-privatedetails | Podgląd prywatnych danych w rejestrze nadużyć | Prior to 1.34 this right was named abusefilter-private - Requires the abusefilter-log-detail right
|
— |
abusefilter-modify-restricted | Modyfikowanie filtrów nadużyć z zastrzeżonymi operacjami | Requires the abusefilter-modify right
|
sysop |
abusefilter-modify-global | Tworzenie lub modyfikowanie globalnych filtrów nadużyć | Requires the abusefilter-modify right
|
— |
abusefilter-revert | Anulowanie wszystkich zmian wykonanych przez podany filtr nadużyć | sysop | |
abusefilter-view-private | Przeglądanie filtrów nadużyć oznaczonych jako prywatne | Requires the abusefilter-view right (not needed if the group already has the abusefilter-modify right)
|
sysop |
abusefilter-log-private | Wyświetlanie wpisów do logów filtrów nadużyć oznaczonych jako prywatne | Requires the abusefilter-log right (not needed if the group already has the abusefilter-modify or abusefilter-view-private rights)
|
sysop |
abusefilter-hide-log | Ukrywanie wpisów w rejestrze nadużyć | Requires the abusefilter-log right
|
suppress |
abusefilter-hidden-log | Podgląd ukrytych wpisów w rejestrze nadużyć | Requires the abusefilter-log right
|
suppress |
abusefilter-privatedetails-log | Podgląd rejestru dostępu do prywatnych szczegółów filtru nadużyć | Prior to 1.34 this right was named abusefilter-private-log
|
— |
abusefilter-modify-blocked-external-domains | Dodawanie oraz modyfikowanie zablokowanych zewnętrznych domen | sysop | |
abusefilter-bypass-blocked-external-domains | Omijanie blokady zewnętrznych domen | Requires the edit right
|
bot |
abusefilter-access-protected-vars | Wyświetlanie i tworzenie filtrów, korzystających z chronionych zmiennych | sysop | |
abusefilter-protected-vars-log | Wyświetlanie rejestrów związanych z dostępem do wartości chronionych zmiennych | sysop |
Dla przykładu, ta konfiguracja pozwala administratorom zrobić wszystko, co chcą z AbuseFilterem, a każdy może zajrzeć w logi i zobaczyć publiczne ustawienia filtru.
$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;
abusefilter-access-protected-vars
permission. Logs pertaining to these filters can only be viewed by users with the abusefilter-protected-vars-log
permission. For more information, see Rules format .
Parametry
Nazwa zmiennej | Domyślna wartość | Opis |
---|---|---|
$wgAbuseFilterActions
|
[
'throttle' => true,
'warn' => true,
'disallow' => true,
'blockautopromote' => true,
'block' => true,
'rangeblock' => false,
'degroup' => false,
'tag' => true
]
|
Prawdopodobne akcje, które mogą być wykonane przez filtry nadużyć. Dodając nową akcję, sprawdź, czy jest ona ograniczona w $wgAbuseFilterActionRestrictions , a jeśli tak, to nie zapomnij dodać uprawnienia abusefilter-modify-restricted do odpowiednich grup użytkowników.
|
$wgAbuseFilterConditionLimit
|
1000
|
Maksymalna liczba 'warunków', które mogą być używane za każdym razem, gdy filtry są uruchamiane względem zmiany. (Bardziej skomplikowane filtry wymagają więcej 'warunków'). |
$wgAbuseFilterValidGroups
|
[
'default'
]
|
Listę filtrów "grup" można podzielić na. Domyślnie jest tylko jedna grupa. Inne rozszerzenia mogą dodać inne grupy. |
$wgAbuseFilterEmergencyDisableThreshold
|
[
'default' => 0.05
]
|
Wyłącz filtr, jeśli pasował do więcej niż 2 edycji, stanowiących ponad 5% akcji, które zostały sprawdzone względem grupy filtra w okresie "obserwowanym" (co najwyżej jeden dzień), chyba że filtr został zmieniony w ciągu ostatnich 86400 sekund (pewnego dnia) Zobacz emergency throttling. |
$wgAbuseFilterEmergencyDisableCount
|
[
'default' => 2
]
| |
$wgAbuseFilterEmergencyDisableAge
|
[
'default' => 86400
]
| |
$wgAbuseFilterActionRestrictions
|
[
"throttle" => false,
"warn" => false,
"disallow" => false,
"blockautopromote" => true,
"block" => true,
"rangeblock" => true,
"degroup" => true,
"tag" => false
]
|
Użytkownicy muszą mieć uprawnienie "abusefilter-modify-restricted" jak równiez "abusefilter-modify" by utworzyć lub zmodyfikować filtry które wykonują te akcje. |
$wgAbuseFilterNotifications
|
false
|
Pozwala skonfigurować rozszerzenie, aby wysyłać powiadomienia o trafieniach na Specjalne:RecentChanges lub UDP. Dostępne ustawienia: rc, udp, rcandudp
For sending changes to abuse filters to Special:RecentChanges, use
unset($wgLogRestrictions['abusefilter']); . |
$wgAbuseFilterNotificationsPrivate
|
false
|
Włącz powiadomienia o filtrach prywatnych. |
$wgAbuseFilterCentralDB
|
null
|
MW 1.41+ Nazwa bazy danych, gdzie globalne filtry nadużyć będą przechowywane (wspierane tylko w ostatniej wersji rozwojowej). Requires CentralAuth installed otherwise global filters will break on a wikifarm. |
$wgAbuseFilterIsCentral
|
false
|
MW 1.41+ Ustaw tej zmiennej wartość "prawda" na wiki, gdzie globalne filtry nadużyć są przechowywane (wspierane tylko w ostatniej wersji rozwojowej). 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
]
|
Nie zezwalaj na scentralizowane filtrowanie działań ustawionych na true w tej zmiennej. |
$wgAbuseFilterBlockDuration
|
'indefinite'
|
Czas trwania blokad tworzonych przez filtr nadużyć.
od 1.31.0-wmf.25 czasy trwania bloku mogą być określone dla każdego pojedynczego filtra i zastąpią tę zmienną. Ta zmienna jest używana tylko przy włączaniu bloku w celu wybrania domyślnego czasu trwania.
|
$wgAbuseFilterAnonBlockDuration
|
null
|
Czas blokowania przez AbuseFilter użytkowników, którzy nie są zalogowani. Wartość $wgAbuseFilterBlockDuration zostanie użyta, jeśli nie jest ustawiona.
od 1.31.0-wmf.25 czasy trwania bloku mogą być określone dla każdego pojedynczego filtra i zastąpią tę zmienną. Ta zmienna jest używana tylko przy włączaniu bloku w celu wybrania domyślnego czasu trwania.
|
$wgAbuseFilterBlockAutopromoteDuration
|
5
|
Duration, in days, for which users' autopromotion is blocked by filters. |
$wgAbuseFilterDefaultWarningMessage
|
[
'default' => 'abusefilter-warning'
]
|
Domyślne komunikaty ostrzegawcze dla każdej grupy filtrów |
$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
|
Wiek używany jako odcięcie podczas usuwania starych danych dziennika IP. Domyślnie 3 miesiące. Używany przez skrypt konserwacyjny purgeOldLogIPData.php. |
$wgAbuseFilterProfileActionsCap
|
10000
|
Liczba akcji określająca, kiedy resetować statystyki profilowania. |
$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.
|
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.
Throttled filters can be identified in the list of filters (Special:AbuseFilter) with the state Włączony, Wysoki współczynnik trafień. Throttling happens silently, and there's no way to see when a filter got throttled, except when Extension: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.
Tworzenie i zarządzanie filtrami
Po zainstalowaniu rozszerzenia, filtry mogą być utworzone/testowane/zmieniane/usuwane na stronie Special:AbuseFilter, tam też można uzyskać dostęp do rejestrów nadużyć.
- Format reguł - Podstawy, jak napisać filtr
- Akcje
- Globalne reguły
- Guide to optimizing condition limit usage
- By zaimportować filtry z Wikipedii: Gdy zainstalowałeś rozszerzenie, wejdź na w:Special:AbuseFilter, wybierz filtr (powiedzmy w:Special:AbuseFilter/3), potem kliknij "Eksportuj filtr do innej wiki", skopiuj tekst, wejdź na "Special:AbuseFilter/import" na Twojej wiki, wklej tekst.
- m:Small wiki toolkits/Starter kit/AbuseFilter - A guide for small wiki communities on metawiki
API
AbuseFilter dodaje dwa moduły listy API, jeden dla szczegółów filtrów nadużycia ("abusefilters") i jeden dla dziennika nadużycia, ponieważ jest oddzielny od innych dzienników MediaWiki ("abuselog"). Nie można tworzyć ani modyfikować filtrów nadużycia za pomocą interfejsu API.
list = abusefilters
Lista informacji o filtrach
- Parametry
abfstartid
- Identyfikator filtra, od którego rozpoczyna się wyliczanieabfendid
- Identyfikator filtra, który przestaje wyliczać wabfdir
- Kierunek wyliczania (starszy, nowszy)abfshow
- Pokaż tylko filtry, które spełniają te kryteria (enabled|!enabled|deleted|!deleted|private|!private)abflimit
- Maksymalna liczba filtrów do wyświetleniaabfprop
- Jakie właściwości uzyskać (id|description|pattern|actions|hits|comments|lasteditor|lastedittime|status|private)
Gdy filtry są prywatne, niektóre właściwości określone za pomocą abfprop
będą niedostępne, chyba że masz odpowiednie prawa użytkownika.
- Przykłady
Wynik |
---|
{
"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
Lista instancji, w których akcje uruchomiły filtr nadużycia.
- Parametery
aflstart
- Znacznik czasu, od którego zaczyna się wyliczanieaflend
- Znacznik czasu, aby zatrzymać wyliczanie wafldir
- Kierunek wyliczania (starszy, nowszy)afluser
- Pokaż tylko wpisy, w których próba została podjęta przez danego użytkownika lub adres IP.afltitle
- Pokaż tylko wpisy, w których akcja dotyczyła danej strony.aflfilter
- Pokaż tylko wpisy, które wyzwoliły dany identyfikator filtraafllimit
- Maksymalna liczba wpisów do listyaflprop
- Jakie właściwości uzyskać: (ids|filter|user|ip|title|action|details|result|timestamp|hidden|revid|wiki)
- Przykład
Wynik |
---|
{
"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"
}
]
}
}
|
Możliwe błędy
- 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';
, wherevariable_name
is the name of the variable, andi18n-key
is 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
Dodawanie niestandardowych akcji
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 . Aby to zrobić, powinieneś:
- 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.
Zobacz też
- WMF wiki, gdzie to rozszerzenie zostało włączone (i z jaką konfiguracją)
To rozszerzenie jest wykorzystywane przez jeden lub więcej projektów Wikimedia. Oznacza to prawdopodobnie, że to rozszerzenie jest stabilne i działa wystarczająco dobrze, aby wykorzystywać je na stronach o dużym natężeniu ruchu. Odnajdź nazwę tego rozszerzenia w plikach konfiguracyjnych Wikimedia CommonSettings.php oraz InitialiseSettings.php, aby zobaczyć gdzie są zainstalowane. Pełną listę rozszerzeń zainstalowanych na określonej wiki można znaleźć na stronie Special:Version na danej wiki. |
To rozszerzenie jest dołączone do następujących farm/hostów wiki lub pakietów: To nie jest pełna lista. Niektóre farmy/hosty wiki lub pakiety mogą zawierać to rozszerzenie nawet jeśli nie są one tutaj wymienione. Zawsze sprawdzaj swoje farmy/hosty wiki, aby to potwierdzić. |