Extension:AbuseFilter/bg
AbuseFilter Обявен статут: стабилен |
|
---|---|
Реализация | Потребителска активност , Специална страница , API |
Описание | Позволява върху уикидейността да се поставят специфични ограничения на поведението |
Автор(и) |
|
Правило за съвместимост | Snapshots releases along with MediaWiki. Master is not backward compatible. |
MediaWiki | >= 1.43.0 |
Промени в базата данни | Да |
Composer | mediawiki/abuse-filter |
Таблици | abuse_filter abuse_filter_action abuse_filter_history abuse_filter_log |
Лиценз | GNU General Public License 2.0 or later |
Изтегляне | |
|
|
|
|
|
|
|
|
Quarterly downloads | 137 (Ranked 42nd) |
Public wikis using | 2,939 (Ranked 186th) |
Преведете разширението AbuseFilter, ако е налично в translatewiki.net | |
Проблеми | Отворени задачи · Съобщете за грешка |
Разширението Филтър срещу злоупотреби позволява на привилегированите потребители да определят конкретни действия, които да бъдат предприемани при определени действия на потребители, например промени, съответстващи на дадени критерии.
Например, може да бъде създаден филтър, който да предотвратява добавянето на външни връзки от анонимни потребители, или да блокира потребител, който премахва повече от 2 000 знака.
Инсталиране
- Download and move the extracted
AbuseFilter
folder to yourextensions/
directory.
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 task T173141 for potential complications.) - На дъното на вашия $LocalSettings добавете следния код:
wfLoadExtension( 'AbuseFilter' );
- Изпълнете скрипта за поднова, който автоматично ще създаде нужните таблици в базата данни, които използват се от това разширение.
- Configure as required.
- Готово – Отидете на Special:Version в уикито си, за да проверите дали разширението е успешно инсталирано.
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"
]
}
}
}
Конфигуриране
Потребителски права
След като инсталирате разширението, ще трябва да настроите потребителските права в "LocalSettings.php".
Права | Описание | Notes | User groups that have this right by default |
---|---|---|---|
abusefilter-modify | Създаване или промяна на филтрите срещу злоупотреби | Requires the abusefilter-view right
|
sysop |
abusefilter-view | Преглед на филтрите срещу злоупотреби | * | |
abusefilter-log | Преглед на дневника на злоупотребите | * | |
abusefilter-log-detail | Преглед на подробните записи в дневника на злоупотребите | Requires the abusefilter-log right
|
sysop |
abusefilter-privatedetails | Преглед на скритите данни в дневника на злоупотребите | Prior to 1.34 this right was named abusefilter-private - Requires the abusefilter-log-detail right
|
— |
abusefilter-modify-restricted | Промяна на филтрите срещу злоупотреби с ограничени действия | Requires the abusefilter-modify right
|
sysop |
abusefilter-modify-global | Създаване или промяна на глобалните филтри срещу злоупотреби | Requires the abusefilter-modify right
|
— |
abusefilter-revert | Връщане на всички промени, направени от филтъра срещу злоупотреби | sysop | |
abusefilter-view-private | Преглед на означените като скрити филтри срещу злоупотреби | Requires the abusefilter-view right (not needed if the group already has the abusefilter-modify right)
|
sysop |
abusefilter-log-private | Преглед на записите в дневника на означените като скрити филтри срещу злоупотреби | Requires the abusefilter-log right (not needed if the group already has the abusefilter-modify or abusefilter-view-private rights)
|
sysop |
abusefilter-hide-log | Скриване на записи от дневника на злоупотребите | Requires the abusefilter-log right
|
suppress |
abusefilter-hidden-log | Преглед на скритите записи от дневника на злоупотребите | Requires the abusefilter-log right
|
suppress |
abusefilter-privatedetails-log | Преглед на достъп до лични данни от дневника на Филтъра срещу злоупотреби | Prior to 1.34 this right was named abusefilter-private-log
|
— |
abusefilter-modify-blocked-external-domains | Create or modify what external domains are blocked from being linked | sysop | |
abusefilter-bypass-blocked-external-domains | Пренебрегване на блокираните външни домейни | Requires the edit right
|
bot |
abusefilter-access-protected-vars | View and create filters that use protected variables | sysop | |
abusefilter-protected-vars-log | View logs related to accessing protected variable values | sysop |
Например, следната конфигурация ще позволи на системните администратори да правят всичко, което искат с Филтъра срещу злоупотреби и всеки да може да вижда дневника и настройките на публичните филтри:
$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 .Parameters
Име на променливата | Стойност по подразбиране | Описание |
---|---|---|
$wgAbuseFilterActions
|
[
'throttle' => true,
'warn' => true,
'disallow' => true,
'blockautopromote' => true,
'block' => true,
'rangeblock' => false,
'degroup' => false,
'tag' => true
]
|
Възможните действия, които могат да бъдат предприето от филтрите за злоупотреба. 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
|
Максималният брой 'условия', които могат да бъдат използвани всеки път, когато филтрите извършват проверка по отношение на изменението. (По-сложните филтри изискват повече 'условия'). |
$wgAbuseFilterValidGroups
|
[
'default'
]
|
Списъкът с "групи" филтри може да бъде разделен. По подразбиране има само една група. Other extensions may add other groups. |
$wgAbuseFilterEmergencyDisableThreshold
|
[
'default' => 0.05
]
|
Изключване на филтъра, ако той съвпадне с повече от 2 редакции, представляващи повече от 5% от действията, за които е била извършена проверка от групата филтри в "наблюдавания" период (максимум един ден), освен ако филтърът не е бил променен през последните 86 400 секунди (един ден) See 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
]
|
Потребителите трябва да имат "abusefilter-modify-restricted", както и "abusefilter-modify" потребителски права, за да могат да създават или променят филтри, които извършват тези действия. |
$wgAbuseFilterNotifications
|
false
|
Позволява конфигурирането на разширението да изпраща известия при съвпадение на Специални:Последни промени или UDP. Възможни опции: rc, udp, rcandudp
For sending changes to abuse filters to Special:RecentChanges, use
unset($wgLogRestrictions['abusefilter']); . |
$wgAbuseFilterNotificationsPrivate
|
false
|
Активиране на известия за скрити филтри. |
$wgAbuseFilterCentralDB
|
null
|
MW 1.41+ Име на базата данни, в която ще се съхраняват глобалните филтри за злоупотреби (поддържано само в последната, разработена версия). Requires CentralAuth installed otherwise global filters will break on a wikifarm. |
$wgAbuseFilterIsCentral
|
false
|
MW 1.41+ Задайте тази променлива като "true" за уикито, в която се съхраняват глобалните филтри за злоупотреби (поддържано само в последната, разработена версия). 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
]
|
Забранете на централизираните филтри да предприемат действия, зададени като true в тази променлива. |
$wgAbuseFilterBlockDuration
|
'indefinite'
|
Продължителност на блокиранията, направени от Филтъра срещу злоупотреби
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
|
Продължителност на блокиранията, направени от Филтъра срещу злоупотреби, на потребители, които не са регистрирани. Ще бъде използвана стойността на $wgAbuseFilterBlockDuration , ако не е зададена друга.
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'
]
|
Предупредителни съобщения по подразбиране, по филтърни групи |
$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.
|
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 Включен, Висок процент на съвпадения. 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.
Създаване и управление на филтри
След като се инсталира разширението, е възможно създаването/тестването/ промяната/изтриването на филтри, а дневниците са достъпни от страницата за управление на Филтъра срещу злоупотреби на Special:AbuseFilter.
- Форматиране на правила - основите на това как да се напише филтър
- Действия
- Глобални правила
- Наръчник за оптимизиране на употребата на условни лимити
- За да импортирате филтри от Уикипедия: След като сте инсталирали разширението, отидете на w:Special:AbuseFilter, изберете филтър (да речем w:Special:AbuseFilter/3), след това натиснете "Експортирайте този филтър към друго уики", копирайте текста, отидете на "Special:AbuseFilter/import" на вашето уики и поставете текста.
- m:Small wiki toolkits/Starter kit/AbuseFilter - A guide for small wiki communities on metawiki
Приложно-програмен интерфейс (API)
Филтърът срещу злоупотреби добавя два API списъчни модула, един за детайлите на филтрите за злоупотреба ("abusefilters") и един за дневника за злоупотреби, тъй като той е отделен от другите МедияУики дневници ("abuselog"). Не е възможно филтрите за злоупотреба да бъдат създавани или променяни чрез употребата на API.
list = abusefilters
Преглед на информация за филтрите
- Параметри
abfstartid
- Идентификатор на филтъра, от който да се започне изчислениетоabfendid
- Идентификатор на филтъра, при който да се спре изчислениетоabfdir
- Посоката, в която да се извърши изчислението (по-стари, по-нови)abfshow
- Показване само на филтри, които отговарят на тези критерии (enabled|!enabled|deleted|!deleted|private|!private)abflimit
- Максимален брой филтри в списъкаabfprop
- Какви свойства да получат (id|description|pattern|actions|hits|comments|lasteditor|lastedittime|status|private)
Когато филтрите са скрити, някои от свойствата, определени с abfprop
няма да се показват, освен ако нямате съответните потребителски права.
- Примери
Result |
---|
{
"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
Преглед на случаи, при които дадени действия задействат филтър за злоупотреби.
- Parameters
aflstart
- Времевата отметка от която да започне изчислениетоaflend
- Времевата отметка на която да спре изчислениетоafldir
- Посоката, в която да се извърши изчислението (по-стари, по-нови)afluser
- Показване само на записи, в които действието е извършено от определен потребител или IP адресafltitle
- Показване само на записи, в които действието включва дадена страница.aflfilter
- Показване само на записи, които задействат определена филтърна групаafllimit
- Максимален брой записи в списъкаaflprop
- Какви свойства да получат: (ids|filter|user|ip|title|action|details|result|timestamp|hidden|revid|wiki)
- Пример
Result |
---|
{
"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
$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
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
AbuseFilterRunner
object, passing in the name of your group.
Вижте също
- Няколко уикита на Фондация Уикимедия, които използват филтри срещу злаупотреби (и с каква конфигурация)
This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |
This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |
- Extensions bundled with MediaWiki 1.38/bg
- Stable extensions/bg
- User activity extensions/bg
- Special page extensions/bg
- API extensions/bg
- Extensions supporting Composer/bg
- GPL licensed extensions/bg
- Extensions in Wikimedia version control/bg
- ArticleDelete extensions/bg
- BeforeCreateEchoEvent extensions/bg
- ChangeTagsListActive extensions/bg
- CheckUserInsertChangesRow extensions/bg
- CheckUserInsertLogEventRow extensions/bg
- CheckUserInsertPrivateEventRow extensions/bg
- ContributionsToolLinks extensions/bg
- EditFilterMergedContent extensions/bg
- GetAutoPromoteGroups extensions/bg
- GetPreferences extensions/bg
- HistoryPageToolLinks extensions/bg
- JsonValidateSave extensions/bg
- ListDefinedTags extensions/bg
- LoadExtensionSchemaUpdates extensions/bg
- PageSaveComplete extensions/bg
- ParserOutputStashForEdit extensions/bg
- RecentChange save extensions/bg
- SaveUserOptions extensions/bg
- TitleMove extensions/bg
- UndeletePageToolLinks extensions/bg
- UploadStashFile extensions/bg
- UploadVerifyUpload extensions/bg
- UserMergeAccountFields extensions/bg
- GetUserPermissionsErrors extensions/bg
- All extensions/bg
- Extensions requiring Composer with git/bg
- Extensions used on Wikimedia/bg
- Extensions included in Canasta/bg
- Extensions available as Debian packages/bg
- Extensions included in Fandom/bg
- Extensions included in Miraheze/bg
- Extensions included in MyWikis/bg
- Extensions included in ProWiki/bg
- Extensions included in ShoutWiki/bg
- Extensions included in Telepedia/bg
- Extensions included in wiki.gg/bg
- Extensions included in WikiForge/bg
- Spam management extensions/bg