API:復元
 | このページは MediaWiki 操作 API の説明文書の一部です。 |
| MediaWiki バージョン: | ≧ 1.12 |
削除されたページの版を復元 (undelete/restore) する POST リクエストです。
APIの説明文書
action=undelete(main | undelete)
Undelete revisions of a deleted page. A list of deleted revisions (including timestamps) can be retrieved through prop=deletedrevisions, and a list of deleted file IDs can be retrieved through list=filearchive. Specific parameters: Other general parameters are available.
|
例
Undeleting the revisions of a page is a multi-step process:
- Log in using one of the methods described in API:ログイン.
- CSRF トークンを取得します。 このトークンはすべてのページで同じ値ですが、ログインするたびに変化します。
- Send a POST request with the CSRF token in order to undelete.
The sample code below covers the third step in detail.
POST リクエスト
Restore two revisions of Sandbox/Test.
api.php?
レスポンス
{
"undelete": {
"fileversions": 0,
"reason": "Test undeleting via the API",
"revisions": 2,
"title": "Sandbox/Test"
}
}
サンプル コード
Python
#!/usr/bin/python3
"""
undelete.py
MediaWiki API Demos
Demo of `Undelete` module: Restore two revisions of a deleted 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.
# Obtain credentials for lgname & lgpassword via Special:BotPasswords
# (https://www.mediawiki.org/wiki/Special:BotPasswords)
PARAMS_2 = {
"action": "login",
"lgname": "username",
"lgpassword": "password",
"lgtoken": LOGIN_TOKEN,
"format": "json"
}
R = S.post(URL, data=PARAMS_2)
# Step 3: While logged in, get an 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: Send a post request to restore two revisions of a deleted page
PARAMS_4 = {
"action": "undelete",
"format": "json",
"token": CSRF_TOKEN,
"title": "Sandbox/Test",
"timestamps":"20190605072148|20190605074313",
"reason": "Test undeleting via the API"
}
R = S.post(URL, data=PARAMS_4)
DATA = R.json()
print(DATA)
PHP
<?php
/*
undelete.php
MediaWiki API Demos
Demo of `Undelete` module: Restore two revisions of a deleted page
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
undelete( $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 restore the deleted page
function undelete( $csrftoken ) {
global $endPoint;
$params4 = [
"action" => "undelete",
"title" => "Sandbox",
"reason" => "Test undeleting via the API",
"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
/*
undelete.js
MediaWiki API Demos
Demo of `Undelete` module: Restore two revisions of a deleted 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;
}
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);
editRequest(data.query.tokens.csrftoken);
});
}
// Step 4: POST request to restore the deleted page
function editRequest(csrf_token) {
var params_3 = {
action: "undelete",
title: "Sandbox",
reason: "Test undeleting via the API",
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
/*
undelete.js
MediaWiki API Demos
Demo of `Undelete` module: Restore two revisions of a deleted page
MIT License
*/
var params = {
action: 'undelete',
title: 'Sandbox',
reason: 'Test undeleting via the API',
format: 'json'
},
api = new mw.Api();
api.postWithToken( 'csrf', params ).done( function ( data ) {
console.log( data );
} );
起こりうるエラー
In addition to the standard error messages:
| コード | 情報 |
|---|---|
| notitle | パラメーター title を設定してください。 |
| notoken | パラメーター token を設定してください。 |
| permissiondenied | ページの復元に必要な権限がありません。 On most wikis, restoring deleted revisions is restricted to sysops, but other wikis may have stricter rules.
|
| cantundelete | Couldn't undelete: the requested revisions may not exist, or may have been undeleted already. |
パラメーターの履歴
- v1.39: Introduced
undeletetalk - v1.25:
tagsを導入しました - v1.24:
fileidsを導入しました - v1.16:
watchlistを導入しました
追加的な注記
- This module cannot be used as a generator.
- This module requires
undeleterights.
- For MediaWiki 1.19 and earlier, you can obtain an undelete token through API:削除された版.
- For MediaWiki 1.20-1.23, you can obtain tokens through API:tokens (操作).
- Timestamps of deleted revisions can be obtained through API:削除された版, API:Alldeletedrevisions or API:Deletedrevisions.
- Pages that have been deleted or restored are logged at Special:Log/delete.
関連項目
- API:削除 - ページを削除します。