API:Protect
Outdated translations are marked like this.
Bu sayfa MediaWiki Eylem API'si belgelerinin bir parçasıdır. |
MediaWiki sürümü: | ≥ 1.12 |
Sayfanın koruma seviyesini değiştirmek için POST isteği.
API belgesi
Örnek
Bir sayfayı korumak çok adımlı bir işlemdir:
- API:Oturum aç içinde açıklanan yöntemlerden birini kullanarak oturum açın.
- CSRF anahtarı alın. Bu anahtar tüm sayfalar için aynıdır, ancak her girişte değişir.
- Sayfayı korumak için CSRF anahtarıyla bir POST isteği gönderin.
Aşağıdaki örnek kod, üçüncü adımı ayrıntılı olarak kapsamaktadır.
POST isteği
Anasayfayı yalnızca otomatik olarak onaylanan kullanıcıların düzenlemesine ve yalnızca sistemlerin taşınmasına izin vermek için sonsuz bir süre koruyun.
api.php? action=protect& title=Main_Page& protections=edit=autoconfirmed|move=sysop& expiry=infinite& token=123ABC [ApiSandbox'ta deneyin]
Yanıt
{
"protect": {
"title": "Main Page",
"reason": "",
"protections": [
{
"edit": "autoconfirmed",
"expiry": "infinite"
},
{
"move": "sysop",
"expiry": "infinite"
}
]
}
}
Örnek kod
Python
#!/usr/bin/python3
"""
protect.py
MediaWiki API Demos
Demo of `Protect` module: Demo to change the edit protection
level of 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",
"type": "csrf",
"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 change edit protection level of a page
PARAMS_4 = {
"title": "User:SSethi (WMF)/common.js",
"protections": "edit=autoconfirmed|move=sysop",
"expiry": "infinite",
"token": CSRF_TOKEN,
"action": "protect"
}
R = S.post(URL, data=PARAMS_4)
print(R.text)
PHP
<?php
/*
protect.php
MediaWiki API Demos
Demo of `Protect` module: Demo to change the edit protection
level of a given page.
MIT license
*/
$endPoint = "https://test.wikipedia.org/w/api.php";
$login_Token = getLoginToken(); // Step 1
loginRequest( $login_Token ); // Step 2
$csrf_Token = getCSRFToken(); // Step 3
protect( $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 change edit protection level of a page
function protect( $csrftoken ) {
global $endPoint;
$params4 = [
"action" => "protect",
"title" => "Sandbox",
"protections" => "edit=autoconfirmed|move=sysop",
"expiry" => "infinite",
"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
/*
protect.js
MediaWiki API Demos
Demo of `Protect` module: Demo to change the edit protection
level 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;
}
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);
protect(data.query.tokens.csrftoken);
});
}
// Step 4: POST request to change edit protection level of a page
function protect(csrf_token) {
var params_3 = {
action: "protect",
title: "Sandbox",
protections: "edit=autoconfirmed|move=sysop",
expiry: "infinite",
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
/*
protect.js
MediaWiki API Demos
Demo of `Protect` module: Demo to change the edit protection
level of a given page.
MIT License
*/
var params = {
action: 'protect',
title: 'Sandbo2',
protections: 'edit=autoconfirmed|move=sysop',
expiry: 'infinite',
format: 'json'
},
api = new mw.Api();
api.postWithToken( 'csrf', params ).done( function ( data ) {
console.log( data );
} );
Olası hatalar
Standart hata mesajlarına ek olarak:
Kod | Bilgi |
---|---|
notitle | title parametresi ayarlanmalıdır. |
notoken | token parametresi ayarlanmalıdır. |
noprotections | protections parametresi ayarlanmalıdır. |
invalidexpiry | Geçersiz son kullanma süresi "expiry". Bu, sona erme zaman damgasının geçersiz biçimlendirildiği veya mevcut olmadığı anlamına gelir (31 Kasım veya 24:05 gibi). This error will also be thrown when a valid date is before 1970.
|
pastexpiry | Son kullanma tarihi "expiry" geçmişte kaldı. |
toofewexpiries | number bitiş tarihi zaman damgaları sağlandığında number2 gerekiyordu. Bu hata yanlış adlandırılmış: çok süre sonu belirttiğinizde de atılır
|
cantedit | Bu sayfayı koruyamazsınız çünkü düzenleyemezsiniz |
create-titleexists | Mevcut başlıklar create ile korunamaz. |
missingtitle-createonly | Eksik başlıklar yalnızca create ile korunabilir. |
protect-invalidaction | Geçersiz koruma türü "type". |
protect-invalidlevel | Geçersiz koruma seviyesi "level". |
Parametre geçmişi
- v1.27:
tags
tanıtıldı - v1.20:
pageid
tanıtıldı - v1.17:
watchlist
tanıtıldıwatch
kullanımdan kaldırıldı - v1.15:
watch
tanıtıldı
Ek notlar
- Bu modül için
protect
hakkı gerekir. - MediaWiki sürüm 1.19 ve öncesi için, API:Info koruma anahtarı alabilirsiniz.
- MediaWiki 1.20-1.23 için API:Tokens (eylem) üzerinden bir koruma anahtarı alabilirsiniz.
Ayrıca bakınız
- API:Protectedtitles - Yaratılıştan korunan başlıkların bir listesini alın.