API:Rollback/fr

This page is a translated version of the page API:Rollback and the translation is 100% complete.

Cette page fait partie de la documentation de l'API MediaWiki Action.

Version de MediaWiki :

≥ 1.12

Requête POST pour annuler les dernières séries de modifications faites par un utilisateur sur une page donnée.

Cette fonctionnalité est identique à celle apportée par les liens d'annulation présents dans l'interface graphique de la page historique.

Documentation de l'API

La documentation qui suit est le résultat de Special:ApiHelp/rollback, généré automatiquement par la version pre-release de MediaWiki utilisée sur ce site (MediaWiki.org).

action=rollback

(main | rollback)

This module requires read rights.
This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0-or-later

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.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Rollback

Specific parameters:

Other general parameters are available.

title

Title of the page to roll back. Cannot be used together with pageid.

pageid

Page ID of the page to roll back. Cannot be used together with title.

Type: integer

tags

Tags to apply to the rollback.

Values (separate with | or alternative): AWB, convenient-discussions

user

Name of the user whose edits are to be rolled back.

This parameter is required.

Type: user, by any of username, IP, Temporary user, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")

summary

Custom edit summary. If empty, default summary will be used.

Default: (empty)

markbot

Mark the reverted edits and the revert as bot edits.

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 "rollback" token retrieved from action=query&meta=tokens

For compatibility, the token used in the web UI is also accepted.

This parameter is required.

Examples:

Roll back the last edits to page MediaWiki by user Example.: api.php?action=rollback&title=MediaWiki&user=Example&token=123ABC [open in sandbox]
Roll back the last edits to page MediaWiki by IP user 192.0.2.5 with summary Reverting vandalism, and mark those edits and the revert as bot edits.: api.php?action=rollback&title=MediaWiki&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [open in sandbox]

Exemple

Toute requête POST est un processus en plusieurs étapes :

Connectez-vous, via l'une des méthodes décrites dans API:Authentification .
Obtenir un jeton CSRF :
api.php?action=query&format=json&meta=tokens [Essayez !]
Envoyer une requête POST, avec le jeton CSRF, pour faire l'action sur une page et dans ce processus gagner les droits editpage sur la page donnée :
api.php?action=edit&format=json&title=Sandbox&appendtext=Hello&token=sampleCsrfToken123+\ [Essayez !]
GET a rollback token:
- Si votre wiki utilise MediaWiki 1.24+, veuillez suivre ces instructions :
  api.php?action=query&meta=tokens&type=rollback [Essayez !]
- Les jetons d'annulation ne sont pas universels; ils changent à chaque connexion et dépendent également du titre de la page et du nom de l'utilisateur dont les modifications sont révoquées. Pour MediaWiki 1.23 et précédent, suivre ces instructions :
  api.php?action=query&prop=revisions&rvtoken=rollback [Essayez !]

Requête POST

Envoyer une requête POST, avec un jeton d'annulation pour annuler les modifications d'un utilisateur sur la page du bac à sable (sandbox).

Dans cet exemple, tous les paramètres sont passés dans un requête GET dans un souci de simplicité. Cependant, action=rollback nécessite une requête POST ; une requête GET causera une erreur.

api.php?action=rollback&format=json&title=Sandbox&user=41.190.3.231&token=d36a517a732991d5aaafae8bd40eee4a5c7bf75a+\\ [Essayez !]

Réponse

La section Réponse ci-dessous concerne la requête POST finale, pour annuler les modifications sur la page du bac à sable.

{
    "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
    }
}

Les IDs de révision dans la réponse sont :

revid - L'ID de la nouvelle révision créée par l'annulation.
old_revid - L'ID de la révision la plus récente à annuler. Avant l'annulation, c'était la version actuelle.
last_revid - L'ID de la révision à restituer par l'annulation. Ce sera la nouvelle révision restaurée.

Exemple de code

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 );
} );

Permissions

Suivi dans Phabricator
Tâche T212851

La révocation nécessite à la fois que les droits edit et rollback soient assignés sur la page cible; aujourd'hui cela signifie que les clients OAuth, les mots de passe des robots, etc... ont besoin simultanément des droits editpage et rollback – et rollback seul n'est pas suffisant !

Erreurs possibles

En supplément aux erreurs classiques:

Code	Informations
alreadyrolled	La page que vous tentez de révoquer a déjà été révoquée
missingparams	Un des paramètres `title` ou `pageid` est nécessaire;
mustpostparams	Le module de révocation nécessite une requête POST.
notitle	Le paramètre `title` doit être défini.
notoken	Le paramètre `token` doit être défini.
nouser	Le paramètre `user` doit être défini.
onlyauthor	La page que vous tentez de révoquer n'a qu'un seul auteur.
permissiondenied	L'action que vous avez demandée est limitée aux utilisateurs appartenant à l'un des groupes suivants : Administrateurs, Révocateurs

Historique des paramètres

v1.24: pageid ajouté
v1.27: tags ajouté
v1.17: watchlist ajouté

Notes additionnelles

Optionnellement, aussi bien la révocation que les modifications étant révoquées peuvent être marquées comme étant faite par un robot, afin de les masquer des Special:RecentChanges par défaut.

Voir aussi

API:Edit - Modifie une page.
Aide:Contribuer - Contient des liens utiles sur la manière de modifier des articles.
API:Tokens - Comporte davantage de détails sur l'utilisation des jetons pour se connecter ou pour faire des requêtes POST.
API:Tokens (action) - Une API obsolète, différente de API:Tokens , pour demander des jetons dans les anciennes versions de MediaWiki.
API:Filerevert - Révoque les fichiers dans un état antérieur.
API:Revisiondelete - Supprime et restaure les versions d'une page.
API:Compare - Vous permet de faire des diffs entre les modifications d'une page.