확장기능:편집필터
AbuseFilter 출시 상태: 안정 |
|
---|---|
구현 | User activity , 특수 문서 , API |
설명 | Allows specific behavior-based restrictions to be placed on wiki activity |
만든 이 |
|
호환성 정책 | 스냅샷은 미디어위키와 함께 릴리스됩니다. Master is not backward compatible. |
데이터베이스 변경 | 예 |
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 | 126 (Ranked 44th) |
Public wikis using | 2,939 (Ranked 186th) |
AbuseFilter 확장 기능 번역 (translatewiki.net에서 가능한 경우) | |
이슈 | 미해결 작업 · 버그 보고 |
편집필터는 일정 기준에 맞는 편집을 사용자가 했을 때 발생할 행동을 권한을 가진 사용자가 설정할 수 있도록 하는 확장 기능입니다.
For example, a filter could be created to prevent unregistered users from adding external links, or to disallow edits that remove more than 2000 characters.
설치
- 파일을 다운로드하고
AbuseFilter
폴더를extensions/
디렉토리에 넣어 주세요.
개발자와 코딩 기여자는 Git을 이용해 확장기능을 다운받는 것이 좋습니다.cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/AbuseFilter - Git에서 설치할 경우, PHP 의존 기능을 설치하려면 Composer를 실행하여 확장 기능 디렉터리에
composer install --no-dev
를 발행하십시오. (잠재적인 문제에 대해서는 작업 T173141 을 참고하십시오.) - 아래의 코드를 LocalSettings.php 코드의 마지막에 추가합니다.
wfLoadExtension( 'AbuseFilter' );
- 갱신 스크립트를 실행합니다. 이 스크립트는 이 확장기능을 필요로 하는 데이터 베이스 테이블을 자동적으로 작성합니다.
- 필요에 따라 구성
- 완료 – 위키의 ‘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"
]
}
}
}
설정
사용자 권한
Once you installed the extension, you'll have to set up the user rights in "LocalSettings.php".
권한 | 설명 | Notes | User groups that have this right by default | Versions |
---|---|---|---|---|
abusefilter-modify | 편집 필터를 만들거나 수정하기 | Requires the abusefilter-view right
|
sysop | 1.19+ |
abusefilter-view | 편집 필터 보기 | * | 1.19+ | |
abusefilter-log | 편집 필터 기록 보기 | * | 1.19+ | |
abusefilter-log-detail | 편집 필터 기록의 자세한 내용 보기 | Requires the abusefilter-log right
|
sysop | 1.19+ |
abusefilter-privatedetails | 편집 필터 기록의 비공개 정보 보기 | Prior to 1.34 this right was named abusefilter-private - Requires the abusefilter-log-detail right
|
— | 1.19+ |
abusefilter-modify-restricted | 편집 필터의 제한된 기능 설정 바꾸기 | Requires the abusefilter-modify right
|
sysop | 1.19+ |
abusefilter-revert | 주어진 필터에 의한 모든 바뀜을 되돌리기 | sysop | 1.19+ | |
abusefilter-view-private | 비공개된 필터 보기 | Requires the abusefilter-view right (not needed if the group already has the abusefilter-modify right)
|
sysop | 1.19+ |
abusefilter-hide-log | 편집 필터 기록의 항목 숨기기 | Requires the abusefilter-log right
|
suppress | 1.19+ |
abusefilter-hidden-log | 숨겨진 편집 필터 기록 보기 | Requires the abusefilter-log right
|
suppress | 1.19+ |
abusefilter-log-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 | 전역 편집 필터를 만들거나 수정하기 | Requires the abusefilter-modify right
|
— | 1.21+ |
abusefilter-privatedetails-log | 편집 필터 비공개 상세 정보 접근 기록 보기 | Prior to 1.34 this right was named abusefilter-private-log
|
— | 1.31+ |
abusefilter-modify-blocked-external-domains | 링크를 차단할 외부 도메인을 만들거나 수정하기 | sysop | 1.41+ | |
abusefilter-bypass-blocked-external-domains | 차단된 외부 도메인을 우회하기 | Requires the edit right
|
bot | 1.41+ |
abusefilter-access-protected-vars | 보호된 변수를 사용하는 필터 보기 및 생성 | sysop | 1.43+ | |
abusefilter-protected-vars-log | 보호된 변수 값에 접근하는 것과 관련된 기록 보기 | sysop | 1.43+ |
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;
$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 .
변수
변수명 | 기본값 | 설명 |
---|---|---|
$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
|
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. 다른 확장 기능은 다른 권한을 추가할지도 모릅니다. |
$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). 비상 조절을 보세요. |
$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. 가능한 옵션: rc, udp, rcandudp
For sending changes to abuse filters to Special:RecentChanges, use
unset($wgLogRestrictions['abusefilter']); . |
$wgAbuseFilterNotificationsPrivate
|
false
|
비공개 필터에 대한 알림 활성화 |
$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'
|
편집 필터에 의한 차단 기간입니다.
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.
|
비상 조절
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 확장기능: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에서 필터를 만들거나, 시험하거나, 변경/삭제할 수 있습니다.
- 규칙 형식 - 편집 필터를 만드는 방법
- 동작
- 전역 규칙
- Guide to optimizing condition limit usage
- 위키백과에서 필터를 가져오려면 w:Special:AbuseFilter에서 가져오려는 필터(예제: w: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
- 변수
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|protected|!protected)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.
- 예시
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.
- 변수
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)
- 예시
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"
}
]
}
}
|
가능한 오류
- 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)
다른 확장 기능과의 통합
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
맞춤 동작 추가
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 확장기능: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.
같이 보기
- 이 기능이 활성화 되어있는 몇몇 위키미디어 재단의 위키들 (그리고 어떤 구성으로 이루어졌는지)
이 확장 기능은 하나 이상의 위키미디어 프로젝트에서 사용 중입니다. 이것은 아마도 이 확장 기능이 안정적이고 트래픽이 많은 웹 사이트에서 사용할 수 있을 만큼 충분히 잘 작동한다는 것을 의미합니다. 설치된 위치를 확인하려면 위키미디어의 CommonSettings.php 및 InitialiseSettings.php 구성 파일에서 이 확장 기능의 이름을 찾습니다. 특정 위키에 설치된 확장 기능의 전체 목록은 위키의 Special:Version 문서에서 볼 수 있습니다. |
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/ko
- Stable extensions/ko
- User activity extensions/ko
- Special page extensions/ko
- API extensions/ko
- Extensions supporting Composer/ko
- GPL licensed extensions/ko
- Extensions in Wikimedia version control/ko
- BeforeCreateEchoEvent extensions/ko
- ChangeTagsListActive extensions/ko
- CheckUserInsertChangesRow extensions/ko
- CheckUserInsertLogEventRow extensions/ko
- CheckUserInsertPrivateEventRow extensions/ko
- ContributionsToolLinks extensions/ko
- EditFilterMergedContent extensions/ko
- GetAutoPromoteGroups extensions/ko
- GetPreferences extensions/ko
- HistoryPageToolLinks extensions/ko
- JsonValidateSave extensions/ko
- ListDefinedTags extensions/ko
- LoadExtensionSchemaUpdates extensions/ko
- PageDelete extensions/ko
- PageSaveComplete extensions/ko
- ParserOutputStashForEdit extensions/ko
- RecentChange save extensions/ko
- SaveUserOptions extensions/ko
- TitleMove extensions/ko
- UndeletePageToolLinks extensions/ko
- UploadStashFile extensions/ko
- UploadVerifyUpload extensions/ko
- UserMergeAccountFields extensions/ko
- GetUserPermissionsErrors extensions/ko
- All extensions/ko
- Extensions requiring Composer with git/ko
- Extensions used on Wikimedia/ko
- Extensions included in Canasta/ko
- Extensions available as Debian packages/ko
- Extensions included in Fandom/ko
- Extensions included in Miraheze/ko
- Extensions included in MyWikis/ko
- Extensions included in ProWiki/ko
- Extensions included in ShoutWiki/ko
- Extensions included in Telepedia/ko
- Extensions included in wiki.gg/ko
- Extensions included in WikiForge/ko
- Spam management extensions/ko