واجهة برمجة التطبيقات:المنع
| هذه الصفحة جزء من توثيق واجهة برمجة تطبيقات ميدياويكي التي تحمل اسم Action. |
| إصدار ميدياويكي: | ≥ 1.12 |
طلب POST الغرض منه منع مستخدم أو إلغاء منعه.
منع المستخدمين
توثيق واجهة برمجة التطبيقات
مثال
إن تصميم طلب POST هو مسألة متعددة الخطوات:
- سجل الدخول مستخدما واحد من السبل المبينة في واجهة برمجة التطبيقات:تسجيل_الدخول.
- أحصل «مستخدما GET» على رمز. هذا الرمز يساوي رمز التعديل ويتغير في كل مرة تسجل فيها الدخول.
- أرسل طلب POST مستخدما الرمز المقدم كي تمنع أي مستخدم.
طلب POST
مثال على منع المستخدم لمدة يوم واحد فقط، وقف أعمال إنشاء الحسابات وإرسال رسائل بريد إلكتروني
api.php?
النتيجة
{
"block": {
"user": "Example",
"userID": 2,
"expiry": "2015-02-25T07:27:50Z",
"id": "8",
"reason": "Time out",
"nocreate": "",
"noemail": ""
}
}
عينة من الكود البرمجي
Python
#!/usr/bin/python3
"""
block_user.py
MediaWiki API Demos
Demo of `Block` module: sending POST request to block user
MIT license
"""
import requests
S = requests.Session()
URL = "https://test.wikipedia.org/w/api.php"
# Step 1: GET request to fetch login token
PARAMS_0 = {
"action": "query",
"meta": "tokens",
"type": "login",
"format": "json"
}
R = S.get(url=URL, params=PARAMS_0)
DATA = R.json()
LOGIN_TOKEN = DATA['query']['tokens']['logintoken']
# Step 2: POST request to log in. Use of main account for login is not
# supported. Obtain credentials via Special:BotPasswords
# (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
PARAMS_1 = {
"action": "login",
"lgname": "your_bot_username",
"lgpassword": "your_bot_password",
"lgtoken": LOGIN_TOKEN,
"format": "json"
}
R = S.post(URL, data=PARAMS_1)
# Step 3: GET request to fetch CSRF token
PARAMS_2 = {
"action": "query",
"meta": "tokens",
"format": "json"
}
R = S.get(url=URL, params=PARAMS_2)
DATA = R.json()
CSRF_TOKEN = DATA['query']['tokens']['csrftoken']
# Step 4: POST request to block user
PARAMS_3 = {
"action": "block",
"user": "Example",
"expiry": "2015-02-25T07:27:50Z",
"reason": "Time out",
"token": CSRF_TOKEN,
"format": "json"
}
R = S.post(URL, data=PARAMS_3)
DATA = R.json()
print(DATA)
PHP
<?php
/*
block_user.php
MediaWiki API Demos
Demo of `Block` module: sending POST request to block user
MIT license
*/
$endPoint = "http://dev.wiki.local.wmftest.net:8080/w/api.php";
$login_Token = getLoginToken(); // Step 1
loginRequest( $login_Token ); // Step 2
$csrf_Token = getCSRFToken(); // Step 3
block( $csrf_Token ); // Step 4
// Step 1: GET request to fetch login token
function getLoginToken() {
global $endPoint;
$params1 = [
"action" => "query",
"meta" => "tokens",
"type" => "login",
"format" => "json"
];
$url = $endPoint . "?" . http_build_query( $params1 );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
$result = json_decode( $output, true );
return $result["query"]["tokens"]["logintoken"];
}
// Step 2: POST request to log in. Use of main account for login is not
// supported. Obtain credentials via Special:BotPasswords
// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
function loginRequest( $logintoken ) {
global $endPoint;
$params2 = [
"action" => "login",
"lgname" => "bot_user_name",
"lgpassword" => "bot_password",
"lgtoken" => $logintoken,
"format" => "json"
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endPoint );
curl_setopt( $ch, CURLOPT_POST, true );
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query( $params2 ) );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
}
// Step 3: GET request to fetch CSRF token
function getCSRFToken() {
global $endPoint;
$params3 = [
"action" => "query",
"meta" => "tokens",
"format" => "json"
];
$url = $endPoint . "?" . http_build_query( $params3 );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
$result = json_decode( $output, true );
return $result["query"]["tokens"]["csrftoken"];
}
// Step 4: POST request to block user
function block( $csrftoken ) {
global $endPoint;
$params4 = [
"action" => "block",
"user" => "ABCD",
"expiry" => "2020-02-25T07:27:50Z",
"reason" => "API Test",
"token" => $csrftoken,
"format" => "json"
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endPoint );
curl_setopt( $ch, CURLOPT_POST, true );
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query( $params4 ) );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
echo ( $output );
}
JavaScript
/*
block_user.js
MediaWiki API Demos
Demo of `Block` module: sending POST request to block user
MIT license
*/
var request = require('request').defaults({jar: true}),
url = "http://dev.wiki.local.wmftest.net:8080/w/api.php";
// Step 1: GET request to fetch login token
function getLoginToken() {
var params_0 = {
action: "query",
meta: "tokens",
type: "login",
format: "json"
};
request.get({ url: url, qs: params_0 }, function (error, res, body) {
if (error) {
return;
}
var data = JSON.parse(body);
loginRequest(data.query.tokens.logintoken);
});
}
// Step 2: POST request to log in.
// Use of main account for login is not
// supported. Obtain credentials via Special:BotPasswords
// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
function loginRequest(login_token) {
var params_1 = {
action: "login",
lgname: "bot_username",
lgpassword: "bot_password",
lgtoken: login_token,
format: "json"
};
request.post({ url: url, form: params_1 }, function (error, res, body) {
if (error) {
return;
}
getCsrfToken();
});
}
// Step 3: GET request to fetch CSRF token
function getCsrfToken() {
var params_2 = {
action: "query",
meta: "tokens",
format: "json"
};
request.get({ url: url, qs: params_2 }, function(error, res, body) {
if (error) {
return;
}
var data = JSON.parse(body);
block(data.query.tokens.csrftoken);
});
}
// Step 4: POST request to block user
function block(csrf_token) {
var params_3 = {
action: "block",
user: "ABCDEF",
expiry: "2020-02-25T07:27:50Z",
reason: "API Test",
token: csrf_token,
format: "json"
};
request.post({ url: url, form: params_3 }, function (error, res, body) {
if (error) {
return;
}
console.log(body);
});
}
// Start From Step 1
getLoginToken();
MediaWiki JS
/*
block_user.js
MediaWiki API Demos
Demo of `Block` module: sending POST request to block user
MIT License
*/
var params = {
action: 'block',
user: 'ABCD',
expiry: '2020-02-25T07:27:50Z',
reason: 'API Test',
format: 'json'
},
api = new mw.Api();
api.postWithToken( 'csrf', params ).done( function ( data ) {
console.log( data );
} );
إلغاء منع المستخدمين
توثيق واجهة برمجة التطبيقات
مثال
طلب POST
مثال على إلغاء المنع والاعتذار عن المنع
api.php?
النتيجة
{
"id": "16",
"user": "Example",
"userid": 2,
"reason": "Sorry Example"
}
الأخطاء المحتملة
| الكود (المنع) | معلومات |
|---|---|
| alreadyblocked | إن المستخدم الذي حاولت منعه ممنوع بالفعل |
| cantblock | ليس لديك صلاحية لمنع المستخدمين. |
| cantblock-email | ليس لديك صلاحية لمنع المستخدمين من إرسال البريد الإلكتروني من خلال الويكي. |
| canthide | ليس لديك صلاحية إخفاء أسماء المستخدمين من سجل المنع.
يتعين تنشيط هذه السمة مباشرة من ملف LocalSettings.php.
|
| invalidexpiry | زمن انتهاء صلاحية غير صحيح |
| invalidip | عنوان الآي بي المحدد غير صحيح |
| invalidrange | نطاق عناوين آي بي غير صحيح |
| notoken | يجب تعيين الوسيط token. |
| nouser | يجب تعيين الوسيط user. |
| pastexpiry | وقت انتهاء الصلاحية "$1" في الماضي. |
| permissiondenied | ليس لديك صلاحية لمنع المستخدمين.
يحصر أمر منع المستخدمين على أغلب مواقع الويكي على مشغلي النظام، إلا أن مواقع ويكي أخرى ربما تتبع قواعد أكثر صرامة.
|
| rangedisabled | لقد جرى تعطيل منع نطاقات عناوين آي بي |
| الكود (إلغاء المنع) | معلومات |
|---|---|
| notarget | يتعين تحديد إما متغير المعرف أو المستخدم |
| notoken | يجب تعيين الوسيط token. |
| idanduser | لا يجوز استخدام متغيرات المعرف والمستخدم معًا |
| blockedasrange | جرى منع عنوان الآي بي «address» جزءً من نطاق «range». لا يمكنك إلغاء منع عنوان الآي بي وحده، إلا أنه يمكنك إلغاء منع النطاق كاملًا. |
| cantunblock | لم نجد المنع الذي حددته. يجوز أن إلغاء المنع قد نفّذ من قبل |
| permissiondenied | ليس لديك صلاحية لرفع منع المستخدمين.
يحصر أمر إلغاء منع المستخدمين على أغلب مواقع الويكي على مشغلي النظام، إلا أن مواقع ويكي أخرى ربما تتبع قواعد أخرى.
|
تاريخ المتغيرات
- 1.29: إضافة
tags - 1.21: إزالة
gettoken - 1.20:
gettokenمتقادم - 1.18: إضافة
watchuser - 1.14: إضافة
allowusertalk,reblock
انظر أيضا
- API:User group membership - إضافة مستخدمين إلى مجموعة أو إزالتهم منها
- واجهة برمجة التطبيقات:المنع - سرد كافة حالات المنع