Extension:AbuseFilter

이 확장은 미디어위키 1.38과 그 이후 버전과 함께 제공됩니다. 따라서 여러분은 그것을 다시 다운로드할 필요가 없습니다. 어쨌든, 여러분은 여전히 제공된 다른 지침을 따라야 합니다.

AbuseFilter 확장은 편집과 같은 사용자에 의한 동작이 특정 기준과 맞을 때 상술된 동작을 수행하도록 설정하는 것을 허용합니다.

예를 들어, 등록되지 않은 사용자는 외부 링크를 추가하는 것을 방지하거나, 2000 문자 이상을 제거하는 편집을 허용하지 않는 필터를 만들 수 있습니다.

Installation

미디어위키 확장 내려받기 지면에서 해당하는 버전을 다운로드하고 위키의 extensions 디렉토리에 AbuseFilter에 푸십시오.

또는 개발자와 코드 기여자는 대신 다음을 사용하여 Git에서 확장 프로그램을 설치해야 합니다.

cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/AbuseFilter

오직 Git에서 설치할 때, PHP 종속성을 설치하기 위해 Composer를 실행해야 하며, 확장 디렉토리에서 sudo composer install --no-dev를 실행하십시오. (잠재적인 문제에 대해 T173141을 참조하십시오.)

미디어위키 설정 LocalSettings.php에 다음을 추가하십시오:

wfLoadExtension( 'AbuseFilter' );

이 확장에 필요한 필수 데이터베이스 테이블을 자동으로 생성하는 업데이트 스크립트를 실행하십시오:

cd /var/www/html/w
php maintenance/run.php ./maintenance/update.php

필요하다면, 설정하십시오.

Special:Version에 접근해서 확장이 정상적으로 설치가 되었는지 확인하십시오.

Git로부터 설치할 때, 이 확장은 Composer를 요구함을 주목해 주십시오.

따라서, Git로부터 설치 후에, 확장을 포함하는 디렉토리, 예를 들어, "../extensions/AbuseFilter/"로 변경하고 composer install --no-dev를 실행하거나, 업데이트할 때: composer update --no-dev를 실행하십시오.

대안적으로 위키의 루트 디렉토리에 있는 "composer.local.json" 파일에 아래와 같이 "extensions/AbuseFilter/composer.json" 줄을 추가하는 것이 좋습니다:

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

Configuration

User rights

확장 기능을 설치 한 후에는, LocalSettings.php에서 사용자 권한을 설정해야 합니다.

User rights for AbuseFilter
Right	Description	Notes	User groups that have this right by default	Versions
abusefilter-modify	Create or modify abuse filters	Requires the `abusefilter-view` right	sysop	1.19+
abusefilter-view	View abuse filters		*	1.19+
abusefilter-log	View the abuse log		*	1.19+
abusefilter-log-detail	View detailed abuse log entries	Requires the `abusefilter-log` right	sysop	1.19+
abusefilter-privatedetails	View private data in the abuse log	Prior to 1.34 this right was named `abusefilter-private` - Requires the `abusefilter-log-detail` right	—	1.19+
abusefilter-modify-restricted	Modify abuse filters with restricted actions	Requires the `abusefilter-modify` right	sysop	1.19+
abusefilter-revert	Revert all changes by a given abuse filter		sysop	1.19+
abusefilter-view-private	View abuse filters marked as private	Requires the `abusefilter-view` right (not needed if the group already has the `abusefilter-modify` right)	sysop	1.19+
abusefilter-hide-log	Hide entries in the abuse log	Requires the `abusefilter-log` right	suppress	1.19+
abusefilter-hidden-log	View hidden abuse log entries	Requires the `abusefilter-log` right	suppress	1.19+
abusefilter-log-private	View log entries of abuse filters marked as private	Requires the `abusefilter-log` right (not needed if the group already has the `abusefilter-modify` or `abusefilter-view-private` rights)	sysop	1.20+
abusefilter-modify-global	Create or modify global abuse filters	Requires the `abusefilter-modify` right	—	1.21+
abusefilter-privatedetails-log	View the AbuseFilter private details access log	Prior to 1.34 this right was named `abusefilter-private-log`	—	1.31+
abusefilter-modify-blocked-external-domains	Create or modify what external domains are blocked from being linked		sysop	1.41+
abusefilter-bypass-blocked-external-domains	Bypass blocked external domains	Requires the `edit` right	bot	1.41+
abusefilter-access-protected-vars	View and create filters that use protected variables		sysop	1.43+
abusefilter-protected-vars-log	View logs related to accessing protected variable values		sysop	1.43+

예를 들어, 다음 예제 구성은 sysops가 AbuseFilter를 사용하여 원하는 모든 작업을 수행하고, 모든 사람이 로그를 보고 공용 필터 설정을 볼 수 있습니다: 미디어위키 설정 LocalSettings.php에 다음을 추가합니다:

$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-modify 또는 abusefilter-view-private 권한이 있는 사용자만 볼 수 있습니다.

Protected filters can only be created and viewed by users with the 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

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), and the filter has been changed in the last 86400 seconds (one day). 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 ]	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 For sending changes to abuse filters to Special:RecentChanges, use `unset($wgLogRestrictions['abusefilter']);`.
`$wgAbuseFilterNotificationsPrivate`	false	Enable notifications for private filters.
`$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'	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.
`$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.

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 Enabled, High rate of matches. 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.

Creating and managing filters

한번 확장 기능이 설치되면, 필터를 생성/테스트/변경/삭제하고 Abuse filter 관리 페이지 Special:AbuseFilter에서 로그에 접근할 수 있습니다.

Rules format - 필터 작성 방법의 기본 사항
Actions
Global Rules
Guide to optimizing condition limit usage
Wikipedia에서 필터를 가져오기 위해서는: wikipedia:Special:AbuseFilter로 가서, 필터를 선택하고 (예를 들어, wikipedia:Special:AbuseFilter/3), "Export this filter to another wiki"를 클릭하고, 텍스트를 복사 한 다음, 위키에서 "Special:AbuseFilter/import"로 이동하여, 텍스트를 붙여 넣으십시오.
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 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)

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

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

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

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)

Example

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]

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';, 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 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.