API:Protect/it
| Azione MediaWiki API |
|---|
| Nozioni di base |
| Autenticazione |
| Account e utenti |
| Pagina Operazioni |
|
| Cerca |
| Utilità per gli sviluppatori |
| Tutorial |
| v · d · e |
POST request to change a page's protection level.
Documentazione API
action=protect
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0-or-later
Change the protection level of a page.
- title
Title of the page to (un)protect. Cannot be used together with pageid.
- pageid
ID of the page to (un)protect. Cannot be used together with title.
- Type: integer
- protections
List of protection levels, formatted action=level (e.g. edit=sysop). A level of all means everyone is allowed to take the action, i.e. no restriction.
Note: Any actions not listed will have restrictions removed.
- This parameter is required.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- expiry
Expiry timestamps. If only one timestamp is set, it'll be used for all protections. Use infinite, indefinite, infinity, or never, for a never-expiring protection.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- Default: infinite
- reason
Reason for (un)protecting.
- Default: (empty)
Change tags to apply to the entry in the protection log.
- Values (separate with | or alternative): AWB, convenient-discussions
- cascade
Enable cascading protection (i.e. protect transcluded templates and images used in this page). Ignored if none of the given protection levels support cascading.
- Type: boolean (details)
- watch
- Deprecated.
If set, add the page being (un)protected to the current user's watchlist.
- Type: boolean (details)
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences (ignored for bot users) or do not change watch.
- One of the following values: nochange, preferences, unwatch, watch
- Default: preferences
- watchlistexpiry
Watchlist expiry timestamp. Omit this parameter entirely to leave the current expiry unchanged.
- Type: expiry (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Protect a page.
- api.php?action=protect&title=MediaWiki&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never [open in sandbox]
- Unprotect a page by setting restrictions to all (i.e. everyone is allowed to take the action).
- api.php?action=protect&title=MediaWiki&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions [open in sandbox]
- Unprotect a page by setting no restrictions.
- api.php?action=protect&title=MediaWiki&token=123ABC&protections=&reason=Lifting%20restrictions [open in sandbox]
Esempio
Protecting a page is a multi-step process:
- Log in using one of the methods described in API:Accesso .
- Get a CSRF token . This token is the same for all pages, but changes at every login.
- Send a POST request with the CSRF token in order to protect the page.
The sample code below covers the third step in detail.
POST request
Response
{ "protect":{ "title":"Main Page", "reason":"", "protections":[ { "edit":"autoconfirmed", "expiry":"infinite" }, { "move":"sysop", "expiry":"infinite" } ] } }
Esempio di codice
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 """ importrequests 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 */ varrequest=require('request').defaults({jar:true}), url="http://dev.wiki.local.wmftest.net:8080/w/api.php"; // Step 1: GET request to fetch login token functiongetLoginToken(){ varparams_0={ action:"query", meta:"tokens", type:"login", format:"json" }; request.get({url:url,qs:params_0},function(error,res,body){ if(error){ return; } vardata=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 functionloginRequest(login_token){ varparams_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 functiongetCsrfToken(){ varparams_2={ action:"query", meta:"tokens", format:"json" }; request.get({url:url,qs:params_2},function(error,res,body){ if(error){ return; } vardata=JSON.parse(body); protect(data.query.tokens.csrftoken); }); } // Step 4: POST request to change edit protection level of a page functionprotect(csrf_token){ varparams_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 */ varparams={ action:'protect', title:'Sandbo2', protections:'edit=autoconfirmed|move=sysop', expiry:'infinite', format:'json' }, api=newmw.Api(); api.postWithToken('csrf',params).done(function(data){ console.log(data); });
Possibili errori
In addition to the standard error messages:
| Codice | Informazione |
|---|---|
| notitle | The title parameter must be set. |
| notoken | The token parameter must be set. |
| noprotections | The protections parameter must be set. |
| invalidexpiry | Invalid expiry time "expiry". This means the expiry timestamp was invalidly formatted or is nonexistent (like November 31 or 24:05). This error will also be thrown when a valid date is before 1970.
|
| pastexpiry | Expiry time "expiry" is in the past. |
| toofewexpiries | number expiry timestamps were provided where number2 were needed. This error is misnamed: it's also thrown when you specify too many expiry times
|
| cantedit | You can't protect this page because you can't edit it |
| create-titleexists | Existing titles can't be protected with create. |
| missingtitle-createonly | Missing titles can only be protected with create. |
| protect-invalidaction | Invalid protection type "type". |
| protect-invalidlevel | Invalid protection level "level". |
Parameter history
- v1.27: Introduced
tags - v1.20: Introduced
pageid - v1.17: Introduced
watchlist. Deprecatedwatch - v1.15: Introduced
watch
Note aggiuntive
- This module requires
protectrights.
- For MediaWiki versions 1.19 and earlier, you can obtain a protect token through API:Info .
- For MediaWiki 1.20-1.23, you can obtain a protect token through API:Tokens_(action) .
Vedi anche
- API:Protectedtitles - Get a list of titles protected from creation.