API:Blokkolás
Outdated translations are marked like this.
 | This page is part of the MediaWiki Action API documentation. |
| MediaWiki-verzió: | ≥ 1.12 |
Egy szerkesztő blokkolására vagy feloldására küldött POST kérés.
Szerkesztők blokkolása
API-dokumentáció
Példa
Bármely POST kérés készítése többlépéses folyamat:
- Jelentkezz be a API:Login lapon szereplő módszerek egyikével.
- Szerezz tokent. Ez a token megegyezik a szerkesztési tokennel, és minden bejelentkezéskor megváltozik.
- Küldd el a POST kérést a tokennel együtt a szerkesztő blokkolásához.
POST-kérés
Példa egy szerkesztő 1 napos blokkolására a fióklétrehozás és e-mail-küldés letiltásával
api.php?
Válasz
{
"block": {
"user": "Example",
"userID": 2,
"expiry": "2015-02-25T07:27:50Z",
"id": "8",
"reason": "Time out",
"nocreate": "",
"noemail": ""
}
}
Mintakód blokkoláshoz
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 );
} );
Szerkesztők feloldása
API-dokumentáció
Példa
POST-kérés
Example feloldása és bocsánatkérés
api.php?
Válasz
{
"id": "16",
"user": "Example",
"userid": 2,
"reason": "Sorry Example"
}
Lehetséges hibák
| Kód Blokkolás | Információ |
|---|---|
| alreadyblocked | Az általad blokkolni kívánt szerkesztő már blokkolva volt |
| cantblock | Nincs jogosultságod felhasználók blokkolásához. |
| cantblock-email | Nincs jogosultságod más felhasználók számára blokkolni a wikin keresztüli e-mail-küldés lehetőségét. |
| canthide | Nincs jogosultságod felhasználónevek elrejtéséhez a blokknaplóból.
E funkciót expliciten engedélyezni kell a LocalSettings.php-ben.
|
| invalidexpiry | Érvénytelen lejárati idő |
| invalidip | A megadott IP-cím érvénytelen |
| invalidrange | Érvénytelen IP-címtartomány |
| notoken | The token parameter must be set. |
| nouser | The user parameter must be set. |
| pastexpiry | Expiry time "$1" is in the past. |
| permissiondenied | Nincs jogosultságod felhasználók blokkolásához.
A legtöbb wikin csak adminisztrátorok blokkolhatnak, de más wikiken szigorúbb szabályok is lehetnek.
|
| rangedisabled | Az IP-tartomány-blokkolás le van tiltva |
| Kód Feloldás | Információ |
|---|---|
| notarget | Az id vagy a user paraméter egyikét be kell állítani |
| notoken | The token parameter must be set. |
| idanduser | Az id és a user paraméterek nem használhatók egyszerre |
| blockedasrange | Az „address” IP-cím a blokkolt „range” tartomány része. Az IP-címet magát nem oldhatod fel, de a teljes tartományt igen. |
| cantunblock | A megadott blokk nem található. Lehet, hogy már fel lett oldva |
| permissiondenied | You don't have permission to unblock users.
A legtöbb wikin csak adminisztrátorok oldhatnak fel szerkesztőket, de más wikik szabályai ettől eltérhetnek.
|
Paramétertörténet
- 1.29: Bevezetve:
tags - 1.21: Eltávolítva:
gettoken. - 1.20: Elavult:
gettoken - 1.18: Bevezetve:
watchuser - 1.14: Bevezetve:
allowusertalk,reblock
Lásd még
- API:User group membership - Szerkesztők hozzáadása vagy eltávolítása csoportból
- API:Blokkolt szerkesztők listája - Minden blokk listája