From d9022f63880ce039446fba8364f68e656b7bf4cb Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Thu, 3 May 2012 13:01:35 +0200 Subject: Update to MediaWiki 1.19.0 --- resources/mediawiki.api/mediawiki.api.js | 224 +++++++++++++++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 resources/mediawiki.api/mediawiki.api.js (limited to 'resources/mediawiki.api/mediawiki.api.js') diff --git a/resources/mediawiki.api/mediawiki.api.js b/resources/mediawiki.api/mediawiki.api.js new file mode 100644 index 00000000..225093b3 --- /dev/null +++ b/resources/mediawiki.api/mediawiki.api.js @@ -0,0 +1,224 @@ +/* mw.Api objects represent the API of a particular MediaWiki server. */ + +( function( $, mw, undefined ) { + + /** + * @var defaultOptions {Object} + * We allow people to omit these default parameters from API requests + * there is very customizable error handling here, on a per-call basis + * wondering, would it be simpler to make it easy to clone the api object, + * change error handling, and use that instead? + */ + var defaultOptions = { + + // Query parameters for API requests + parameters: { + action: 'query', + format: 'json' + }, + + // Ajax options for jQuery.ajax() + ajax: { + url: mw.util.wikiScript( 'api' ), + + ok: function() {}, + + // caller can supply handlers for http transport error or api errors + err: function( code, result ) { + mw.log( 'mw.Api error: ' + code, 'debug' ); + }, + + timeout: 30000, // 30 seconds + + dataType: 'json' + } + }; + + /** + * Constructor to create an object to interact with the API of a particular MediaWiki server. + * + * @todo Share API objects with exact same config. + * @example + * + * var api = new mw.Api(); + * api.get( { + * action: 'query', + * meta: 'userinfo' + * }, { + * ok: function () { console.log( arguments ); } + * } ); + * + * + * @constructor + * @param options {Object} See defaultOptions documentation above. Ajax options can also be + * overridden for each individual request to jQuery.ajax() later on. + */ + mw.Api = function( options ) { + + if ( options === undefined ) { + options = {}; + } + + // Force toString if we got a mw.Uri object + if ( options.ajax && options.ajax.url !== undefined ) { + options.ajax.url = String( options.ajax.url ); + } + + options.parameters = $.extend( {}, defaultOptions.parameters, options.parameters ); + options.ajax = $.extend( {}, defaultOptions.ajax, options.ajax ); + + this.defaults = options; + }; + + mw.Api.prototype = { + + /** + * For api queries, in simple cases the caller just passes a success callback. + * In complex cases they pass an object with a success property as callback and + * probably other options. + * Normalize the argument so that it's always the latter case. + * + * @param {Object|Function} An object contaning one or more of options.ajax, + * or just a success function (options.ajax.ok). + * @return {Object} Normalized ajax options. + */ + normalizeAjaxOptions: function( arg ) { + var opt = arg; + if ( typeof arg === 'function' ) { + opt = { 'ok': arg }; + } + if ( !opt.ok ) { + throw new Error( 'ajax options must include ok callback' ); + } + return opt; + }, + + /** + * Perform API get request + * + * @param {Object} request parameters + * @param {Object|Function} ajax options, or just a success function + * @return {jqXHR} + */ + get: function( parameters, ajaxOptions ) { + ajaxOptions = this.normalizeAjaxOptions( ajaxOptions ); + ajaxOptions.type = 'GET'; + return this.ajax( parameters, ajaxOptions ); + }, + + /** + * Perform API post request + * @todo Post actions for nonlocal will need proxy + * + * @param {Object} request parameters + * @param {Object|Function} ajax options, or just a success function + * @return {jqXHR} + */ + post: function( parameters, ajaxOptions ) { + ajaxOptions = this.normalizeAjaxOptions( ajaxOptions ); + ajaxOptions.type = 'POST'; + return this.ajax( parameters, ajaxOptions ); + }, + + /** + * Perform the API call. + * + * @param {Object} request parameters + * @param {Object} ajax options + * @return {jqXHR} + */ + ajax: function( parameters, ajaxOptions ) { + parameters = $.extend( {}, this.defaults.parameters, parameters ); + ajaxOptions = $.extend( {}, this.defaults.ajax, ajaxOptions ); + + // Some deployed MediaWiki >= 1.17 forbid periods in URLs, due to an IE XSS bug + // So let's escape them here. See bug #28235 + // This works because jQuery accepts data as a query string or as an Object + ajaxOptions.data = $.param( parameters ).replace( /\./g, '%2E' ); + + ajaxOptions.error = function( xhr, textStatus, exception ) { + ajaxOptions.err( 'http', { + xhr: xhr, + textStatus: textStatus, + exception: exception + } ); + }; + + // Success just means 200 OK; also check for output and API errors + ajaxOptions.success = function( result ) { + if ( result === undefined || result === null || result === '' ) { + ajaxOptions.err( 'ok-but-empty', + 'OK response but empty result (check HTTP headers?)' ); + } else if ( result.error ) { + var code = result.error.code === undefined ? 'unknown' : result.error.code; + ajaxOptions.err( code, result ); + } else { + ajaxOptions.ok( result ); + } + }; + + return $.ajax( ajaxOptions ); + } + + }; + + /** + * @var {Array} List of errors we might receive from the API. + * For now, this just documents our expectation that there should be similar messages + * available. + */ + mw.Api.errors = [ + // occurs when POST aborted + // jQuery 1.4 can't distinguish abort or lost connection from 200 OK + empty result + 'ok-but-empty', + + // timeout + 'timeout', + + // really a warning, but we treat it like an error + 'duplicate', + 'duplicate-archive', + + // upload succeeded, but no image info. + // this is probably impossible, but might as well check for it + 'noimageinfo', + // remote errors, defined in API + 'uploaddisabled', + 'nomodule', + 'mustbeposted', + 'badaccess-groups', + 'stashfailed', + 'missingresult', + 'missingparam', + 'invalid-file-key', + 'copyuploaddisabled', + 'mustbeloggedin', + 'empty-file', + 'file-too-large', + 'filetype-missing', + 'filetype-banned', + 'filename-tooshort', + 'illegal-filename', + 'verification-error', + 'hookaborted', + 'unknown-error', + 'internal-error', + 'overwrite', + 'badtoken', + 'fetchfileerror', + 'fileexists-shared-forbidden', + 'invalidtitle', + 'notloggedin' + ]; + + /** + * @var {Array} List of warnings we might receive from the API. + * For now, this just documents our expectation that there should be similar messages + * available. + */ + mw.Api.warnings = [ + 'duplicate', + 'exists' + ]; + +})( jQuery, mediaWiki ); -- cgit v1.2.3-54-g00ecf