API:Stashimageinfo

This page is part of the MediaWiki Action API documentation.

MediaWiki version:

≥ 1.17

GET request to return file information for stashed files.

API documentation

The following documentation is the output of Special:ApiHelp/query+stashimageinfo, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

Special:ApiHelp/query+stashimageinfo

Example

Making any POST request is a multi-step process:

Log in, via one of the methods described on API:Login .
GET an edit/CSRF token as shown here API:Tokens

api.php?action=query&format=json&meta=tokens [try in ApiSandbox]

Send a POST request, with the CSRF token, to return information for a stashed file.

The sample codes below cover these steps.

POST request

Description of script

api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567&format=json [try in ApiSandbox]

Response

{
    "batchcomplete":""
}

Sample code

Python

#!/usr/bin/python3

"""
    stash_image_info.py
    MediaWiki API Demos
    Demo of `Stashimageinfo` module: Return information for a stashed file.
    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 log in. For this login
# method, obtain credentials by first visiting
# https://www.test.wikipedia.org/wiki/Manual:Bot_passwords
# See https://www.mediawiki.org/wiki/API:Login for more
# information on log in methods.
PARAMS_2 = {
    "action": "login",
    "lgname": "user_name",
    "lgpassword": "password",
    "format": "json",
    "lgtoken": LOGIN_TOKEN
}

R = S.post(URL, data=PARAMS_2)
DATA = R.json()

# Step 3: Send a request to return information for a stashed file.
PARAMS_4 = {
    "action": "query",
    "format": "json",
    "prop": "stashimageinfo",
    "siifilekey": "124sd34rsdf567"
}

R = S.post(url=URL, data=PARAMS_4)
DATA = R.text

print(DATA)

PHP

<?php

/*
    stash_image_info.php
    MediaWiki API Demos
    Demo of `Stashimageinfo` module: Return information for a stashed file.
	
    MIT license
*/

$endPoint = "https://test.wikipedia.org/w/api.php";

$login_Token = getLoginToken(); // Step 1
loginRequest( $login_Token ); // Step 2
stashimageinfo(); // 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. 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: Send a request to return information for a stashed file
function stashimageinfo() {
	global $endPoint;

	$params4 = [
		"action" => "query",
		"prop" => "stashimageinfo",
		"siifilekey" => "124sd34rsdf567",
		"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

/*  
    stash_image_info.js
 
    MediaWiki API Demos
    Demo of `Stashimageinfo` module: Return information for a stashed file.
    MIT license
*/

var request = require('request').defaults({jar: true}),
    url = "https://test.wikipedia.org/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;
        }
        stashimageinfo();
    });
}

// Step 3: Return information for a stashed file.
function stashimageinfo() {
    var params_3 = {
        action: "query",
        format: "json",
        prop: "stashimageinfo",
        siifilekey: "124sd34rsdf567"
    };

    request.post({ url: url, form: params_3 }, function (error, res, body) {
        if (error) {
            return;
        }
        console.log(body);
    });
}

// Start From Step 1
getLoginToken();

MediaWiki JS

/*
	stash_image_info.js
	MediaWiki API Demos
	Demo of `Stashimageinfo` module: Return information for a stashed file.
	MIT License
*/

var params = {
		action: "query",
    	format: "json",
    	prop: "stashimageinfo",
    	siifilekey: "124sd34rsdf567"
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	console.log( data );
} );

Possible errors


Code	Info
notloggedin	The upload stash is only available to logged-in users.
stashedfilenotfound	Could not find the file in the stash: key.
stashpathinvalid	File key of improper format or otherwise invalid: key.
uploadstash-bad-path-bad-format	Key "#####" is not in a proper format.

Parameter history

v1.23: Introduced canonicaltitle, commonmetadata, extmetadata
v1.18: Introduced siifilekey, siiurlparam
v1.18: Deprecated siisessionkey

Additional notes

Although it appears under its own key, stashimageinfo, rather than the pages key like other property modules, the output of this module is otherwise identical to that of API:Imageinfo .