API:Rollback/cs
 | Tato stránka je součástí dokumentace k API Action MediaWiki. |
| Verze MediaWiki: | ≥ 1.12 |
Požadavek POST pro vrácení poslední série úprav provedených jedním uživatelem na dané stránce.
Tato funkce je identická s funkcí poskytovanou zpětnými odkazy v grafickém rozhraní na stránce historie.
Dokumentace API
action=rollback(main | rollback)
Undo the last edit to the page. If the last user who edited the page made multiple edits in a row, they will all be rolled back. Specific parameters: Other general parameters are available.
Examples:
|
Příklad
Vytvoření jakéhokoli požadavku POST je proces složený z několika kroků:
- Přihlaste se jedním ze způsobů popsaných v API:Přihlášení.
- GET CSRF token:
- Odešlete požadavek POST s tokenem CSRF, abyste provedli akci na stránce a v tomto procesu získali práva na danou stránku ve výši
editpage:api.php?action=edit& format=json& title=Sandbox& appendtext=Hello& token=sampleCsrfToken123+\ [zkuste v ApiSandbox]
- GET a rollback token:
- Pokud vaše wiki používá MediaWiki 1.24+, postupujte podle těchto pokynů:
- Tokeny vrácení změn nejsou univerzální: Liší se nejen pro každé přihlášení, ale také závisí na názvu stránky a jménu uživatele, jehož úpravy mají být vráceny zpět. Pro MediaWiki 1.23 nebo starší postupujte podle těchto pokynů:
- Pokud vaše wiki používá MediaWiki 1.24+, postupujte podle těchto pokynů:
Požadavek POST
Odešlete požadavek POST s tokenem vrácení pro vrácení úprav uživatele na stránku Sandbox.
V tomto příkladu jsou všechny parametry předány v požadavku GET jen z důvodu jednoduchosti. Action=rollback však vyžaduje požadavky POST, přičemž požadavky GET způsobí chybu.
api.php?
Odpověď
Sekce Odpověď níže je pro poslední požadavek POST pro vrácení úprav na stránku Sandbox.
{
"rollback": {
"title": "Sandbox",
"pageid": 94542,
"summary": "Reverted edits by [[Special:Contributions/41.190.3.231|41.190.3.231]] ([[User talk:41.190.3.231|talk]]) to last revision by [[User:Didicodes|Didicodes]]",
"revid": 381084,
"old_revid": 381083,
"last_revid": 381070
}
}
ID revizí v odpovědi jsou:
revid- ID nové revize vytvořené vrácením zpět.old_revid- ID nejnovější revize, která se vrací zpět. Před rollbackem to byla aktuální revize.last_revid- ID revize obnovované vrácením zpět. Toto je nejnovější revize, která byla vrácena zpět.
Ukázkový kód
Python
#!/usr/bin/python3
"""
rollback.py
MediaWiki API Demos
Demo of `rollback` module: Sending post request to rollback the
last edits made to a given page.
MIT license
"""
import requests
S = requests.Session()
URL = "https://test.wikipedia.org/w/api.php"
# Step 1: Retrieve a login token
PARAMS_1 = {
"action": "query",
"meta": "tokens",
"type": "login",
"format": "json"
}
R = S.get(url=URL, params=PARAMS_1)
DATA = R.json()
LOGIN_TOKEN = DATA['query']['tokens']['logintoken']
# Step 2: Send a post request to login. 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_2 = {
"action": "login",
"lgname": "bot_user_name",
"lgpassword": "bot_password",
"lgtoken": LOGIN_TOKEN,
"format": "json"
}
R = S.post(URL, data=PARAMS_2)
# Step 3: While logged in, retrieve a CSRF token
PARAMS_3 = {
"action": "query",
"meta": "tokens",
"format": "json"
}
R = S.get(url=URL, params=PARAMS_3)
DATA = R.json()
CSRF_TOKEN = DATA["query"]["tokens"]["csrftoken"]
# Step 4: POST request to edit a page
PARAMS_4 = {
"action": "edit",
"title": "Project:Sandbox",
"token": CSRF_TOKEN,
"format": "json",
"appendtext": "Hello"
}
R = S.post(URL, data=PARAMS_4)
# Step 5: Retrieve a rollback token
PARAMS_5 = {
"action": "query",
"meta": "tokens",
"type": "rollback",
"format": "json"
}
R = S.get(url=URL, params=PARAMS_5)
DATA = R.json()
ROLLBACK_TOKEN = DATA['query']['tokens']['rollbacktoken']
# Step 5: POST request to rollback a page
PARAMS_6 = {
"action": "rollback",
"format": "json",
"title": "Project:Sandbox",
"user": "bot_user_name",
"token": ROLLBACK_TOKEN,
}
R = S.post(URL, data=PARAMS_6)
DATA = R.json()
print(DATA)
PHP
<?php
/*
rollback.php
MediaWiki API Demos
Demo of `rollback` module: Sending post request to rollback the
edits of a given page.
MIT license
*/
$endPoint = "http://dev.wiki.local.wmftest.net:8080/w/api.php";
$login_Token = getLoginToken(); // Step 1
loginRequest( $login_Token ); // Step 2
$rollback_Token = getRollbackToken(); // Step 3
rollback( $rollback_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 rollback token
function getRollbackToken() {
global $endPoint;
$params3 = [
"action" => "query",
"meta" => "tokens",
"type" => "rollback",
"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"]["rollbacktoken"];
}
// Step 4: POST request to rollback a page
function rollback( $rollback_Token ) {
global $endPoint;
$params4 = [
"action" => "rollback",
"title" => "Project:Sandbox",
"user" => "10.0.2.2",
"token" => $rollback_Token,
"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
/*
rollback.js
MediaWiki API Demos
Demo of `rollback` module: Sending post request to rollback the
edits of a given page.
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;
}
getRollbackToken();
});
}
// Step 3: GET request to fetch Rollback token
function getRollbackToken() {
var params_2 = {
action: "query",
meta: "tokens",
type: "rollback",
format: "json"
};
request.get({ url: url, qs: params_2 }, function(error, res, body) {
if (error) {
return;
}
var data = JSON.parse(body);
rollback(data.query.tokens.rollbacktoken);
});
}
// Step 4: POST request to rollback a page
function rollback(rollback_token) {
var params_3 = {
action: "rollback",
title: "Project:Sandbox",
user: "10.0.2.2",
token: rollback_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
/*
rollback.js
MediaWiki API Demos
Demo of `rollback` module: Sending post request to rollback the
last edits made to a given page.
MIT License
*/
var params = {
action: 'rollback',
title: 'Sandbox',
user: '10.0.2.2',
format: 'json'
},
api = new mw.Api();
api.postWithToken( 'rollback', params ).done( function ( data ) {
console.log( data );
} );
Práva
Vrácení vyžaduje jak edit, tak rollback přímo na cílové stránce. V současnosti to znamená, že spotřebitelé OAuth, hesla botů atd. vyžadují grant editpage i rollback – samotné rollback nestačí!
Možné chyby
Kromě obvyklých věcí:
| Kód | Popis |
|---|---|
| alreadyrolled | Stránka, kterou jste se pokusili vrátit, již byla vrácena zpět |
| missingparams | Je vyžadován jeden z parametrů title a pageid.
|
| mustpostparams | Modul vrácení zpět vyžaduje požadavek POST. |
| notitle | The title parameter must be set. |
| notoken | The token parameter must be set. |
| nouser | The user parameter must be set. |
| onlyauthor | Stránka, kterou jste se pokusili vrátit, má pouze jednoho autora |
| permissiondenied | Akce, kterou požadujete, je omezena na uživatele v jedné ze skupin: Administrators, Rollbackers |
Historie parametrů
- v1.24: Představeno
pageid - v1.27: Představeno
tags - v1.17: Představeno
watchlist
Další poznámky
- Volitelně lze vrácení i vracené úpravy označit jako robot, což je ve výchozím nastavení skryje před Special:RecentChanges.
Související odkazy
- API:Úpravy - upraví stránku.
- Nápověda:Editace - obsahuje užitečné odkazy na úpravy článků.
- API: Tokeny - obsahuje další podrobnosti o používání tokenů k přihlášení nebo vytváření požadavků POST.
- API:Tokens (action) - zastaralé API, odlišné od API: Tokeny, pro vyžádání tokenů v dřívějších verzích MediaWiki.
- API:Filerevert - vrátí soubory do dřívějšího stavu.
- API:Revisiondelete - odstraní a obnoví revize stránky.
- API:Compare - umožňuje vám rozlišovat mezi úpravami na stránce.