Extension:مرشح الإساءة

This page is a translated version of the page Extension:AbuseFilter and the translation is 20% complete.
الدليل المرجعي لامتدادات ميدياويكي
OOjs UI icon advanced-invert.svg
AbuseFilter
حالة الإصدار مستقر
AbuseFilter-Management.png
تنفيذ نشاط المستخدم , صفحة خاصة , واجهة برمجة التطبيقات
بيان يسمح بوضع قيود معينة "معتمدة على السلوك" على نشاط wiki
المؤلف/المؤلفون
سياسة التوافق تصدر اللقطات البرمجية مع ميدياويكي. الإصدار الرئيسي لا يتوافق مع الإصدارات السابقة.
MediaWiki 1.33+
PHP 5.4+ مُفضلة
تغييرات قاعدة البيانات نعم
جداول abuse_filter
abuse_filter_action
abuse_filter_history
abuse_filter_log
ترخيص رخصة جنو العمومية 2.0 أو ما بعدها
التنزيل
  • $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
  • 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
ترجم الامتداد AbuseFilter لو كان متوفرا على translatewiki.net

طالع مصفوفة الاستخدام والإصدارات.

المسائل المهام المفتوحة · الإبلاغ عن عطل تقني
Coolest Tool Award 2020 square logo.svg

AbuseFilter

2020 Coolest Tool
Award Winner

in the category
Quality


يسمح ملحق "AbuseFilter" للمستخدمين المتميزين بتعيين إجراءات معينة يتم اتخاذها عندما تتطابق إجراءات المستخدمين -مثل عمليات التحرير- مع معايير معينة.

على سبيل المثال، يمكن إنشاء "مُرشِّح" لمنع المستخدمين المجهولين من إضافة روابط خارجية، أو لحظر مستخدم يزيل أكثر من 2000 حرف.

التثبيت

  • نزّل الملف/الملفات وضعها في دليل يحمل اسم ‎AbuseFilter داخل مجلد ‎extensions/‎ لديك.
  • حينما تثبته مستخدما غت شغّل Composer كي تثبت اعتمادات بي إتش بي، وذلك عن طريق إصدار composer install --no-dev في مجلد الامتداد. (طالع مهمة T173141 لتطلع على التعقيدات المحتملة.)
  • أضف الكود التالي في الجزء الأسفل من LocalSettings.php:
    wfLoadExtension( 'AbuseFilter' );
    
  • شغل نص التحديث البرمجي الذي سوف ينشئ تلقائيا جداول قاعدة البيانات الضرورية التي يحتاج إليها الامتداد.
  • أعدّ الملحق حسب ما هو مطلوب.
  •   تم التنفيذ – اذهب إلى Special:Version على موقع الويكي لديك كي تتحقق من أن الامتداد قد ثبت بنجاح.

للمستخدمين الذي يستخدمون إصدار ميدياويكي 1.26 أو ما قبله:

تبين التعليمات السالفة سبيل جديد لتثبيت الامتداد مستخدما ‎wfLoadExtension()‎. لو كنت تحتاج لتثبيت الامتداد على هذه الإصدارات السابقة (ميدياويكي 1.26 أو ما قبله)، استخدم ما يلي بدلا من wfLoadExtension( 'AbuseFilter' );:

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


When installing from Git, please note that this extension requires Composer .

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

الصلاحية الوصف
abusefilter-modify عدل مرشحات الإساءة
abusefilter-view عرض مرشحات الإساءة
abusefilter-log عرض سجل الإساءة
abusefilter-log-detail عرض مدخلات سجل الإساءة المفصلة
abusefilter-privatedetails عرض البيانات السرية في سجل الإساءة
abusefilter-modify-restricted عدل مرشحات الإساءة مع الأفعال المحظورة
abusefilter-modify-global إنشاء أو تعديل مرشحات الإساءة العالمية
abusefilter-revert استرجع كل التعديلات لمرشح إساءة محدد.
abusefilter-view-private اعرض مرشحات الإساءة المعلّمة كخاصة
abusefilter-log-private عرض إدخالات السجل لمرشحات الإساءة المعلمة كخاصة
abusefilter-hide-log إخفاء إدخالات سجل الإساءة
abusefilter-hidden-log عرض مدخلات سجل الإساءة المخفية
abusefilter-privatedetails-log عرض سجل دخول التفاصيل الخاصة لمرشح الإساءة

على سبيل المثال، سيسمح النموذج التالي للإداريين sysops بالقيام بكل ما يريدونه باستخدام "مُرَشِّح" AbuseFilter، ويسمح للجميع بعرض السجل ومشاهدة إعدادات المُرشِّح العامة:

$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;
لا يمكن عرض المرشحات التي تم تمييزها على أنها خاصة private إلا من خلال المستخدمين الذين لديهم إذن تعديل مرشح الإساءة أو إذن abusefilter-view-private.

معاملات

اسم المتغير القيمة الافتراضية الوصف
$wgAbuseFilterActions
[
    'throttle' => true,
    'warn' => true,
    'disallow' => true,
    'blockautopromote' => true,
    'block' => true,
    'rangeblock' => false,
    'degroup' => false,
    'tag' => true
]
الإجراءات التي يمكن لمرشح الإساءة القيام بها. عند إضافة إجراء جديد، تحقق مما إذا كان مقيدًا في $wgAbuseFilterActionRestrictions ، وإذا كان كذلك، فلا تنس إضافة صلاحية abusefilter-modify-restricted إلى مجموعات المستخدمين المناسبة.
$wgAbuseFilterConditionLimit
1000
أقصى عدد من "الشروط" التي يمكن استخدامها في كل مرة يعمل فيها المرشح مقابل كل تغيير. (تتطلب المرشحات الأكثر تعقيدًا المزيد من "الشروط").
$wgAbuseFilterValidGroups
[
    'default'
]
قائمة "المجموعات" التي يمكن تقسيم المرشحات إليها. افتراضيا هناك مجموعة واحدة فقط. قد تضيف ملحقات أخرى مجموعات أخرى.
$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), unless the filter has been changed in the last 86400 seconds (one day). See emergency throttling.
$wgAbuseFilterEmergencyDisableCount
[
    'default' => 2
]
$wgAbuseFilterEmergencyDisableAge
[
    'default' => 86400
]
$wgAbuseFilterParserClass
'AbuseFilterParser'
Name of AbuseFilter's parser class.
$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
$wgAbuseFilterNotificationsPrivate
false
Enable notifications for private filters.
$wgAbuseFilterCentralDB
null
Name of a database where global abuse filters will be stored in (only supported in the latest, development version). Requires CentralAuth installed otherwise global filters will break on a wikifarm.
$wgAbuseFilterIsCentral
false
Set this variable to true for the wiki where global AbuseFilters are stored in (only supported in the latest, development version). 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.
$wgAbuseFilterCustomActionsHandlers
[]
Callback functions for custom actions. (متقادم في 1.36) Use the AbuseFilterCustomActions hook instead.
$wgAbuseFilterDefaultWarningMessage
[
    'default' => 'abusefilter-warning'
]
Default warning messages, per filter group
$wgAbuseFilterDefaultDisallowMessage
[
    'default' => 'abusefilter-disallowed'
]
Default disallow messages, per filter group
$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.
$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 مفعل, مخنوق. 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.

إنشاء وإدارة المرشحات

بمجرد تثبيت الملحق، يمكن إنشاء المرشحات /اختبارها /تغييرها /حذفها ويمكن الوصول إلى السجلات من صفحة إدارة مرشحات الإساءة Special:AbuseFilter.

  • To import filters from Wikipedia: When you have installed the extension, go to w:Special:AbuseFilter, choose a filter (say w:Special:AbuseFilter/3), then click "Export this filter to another wiki", copy the text, go to "Special:AbuseFilter/import" on your wiki, paste the text.

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

List instances where the abuse filter was triggered in response to actions from the user "SineBot"

النتيجة
<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>

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.

See also