2 * @class mw.Api.plugin.edit
6 // Cache token so we don't have to keep fetching new ones for every single request.
7 var cachedToken = null;
9 $.extend( mw.Api.prototype, {
12 * Post to API with edit token. If we have no token, get one and try to post.
13 * If we have a cached token try using that, and if it fails, blank out the
14 * cached token and start over.
16 * @param {Object} params API parameters
17 * @param {Function} [ok] Success callback (deprecated)
18 * @param {Function} [err] Error callback (deprecated)
19 * @return {jQuery.Promise} See #post
21 postWithEditToken: function ( params, ok, err ) {
22 var useTokenToPost, getTokenIfBad,
24 if ( cachedToken === null ) {
25 // We don't have a valid cached token, so get a fresh one and try posting.
26 // We do not trap any 'badtoken' or 'notoken' errors, because we don't want
27 // an infinite loop. If this fresh token is bad, something else is very wrong.
28 useTokenToPost = function ( token ) {
30 api.post( params, ok, err );
32 return api.getEditToken( useTokenToPost, err );
34 // We do have a token, but it might be expired. So if it is 'bad' then
35 // start over with a new token.
36 params.token = cachedToken;
37 getTokenIfBad = function ( code, result ) {
38 if ( code === 'badtoken' ) {
39 // force a new token, clear any old one
41 api.postWithEditToken( params, ok, err );
46 return api.post( params, { ok : ok, err : getTokenIfBad });
51 * Api helper to grab an edit token.
53 * @param {Function} [ok] Success callback
54 * @param {Function} [err] Error callback
55 * @return {jQuery.Promise}
56 * @return {Function} return.done
57 * @return {string} return.done.token Received token.
59 getEditToken: function ( ok, err ) {
61 // Backwards compatibility (< MW 1.20)
69 // Due to the API assuming we're logged out if we pass the callback-parameter,
70 // we have to disable jQuery's callback system, and instead parse JSON string,
71 // by setting 'jsonp' to false.
72 // TODO: This concern seems genuine but no other module has it. Is it still
73 // needed and/or should we pass this by default?
76 .done( function ( data ) {
78 // If token type is not available for this user,
79 // key 'edittoken' is missing or can contain Boolean false
80 if ( data.tokens && data.tokens.edittoken ) {
81 token = data.tokens.edittoken;
85 d.reject( 'token-missing', data );
94 * Create a new section of the page.
95 * @see #postWithEditToken
96 * @param {mw.Title|String} title Target page
97 * @param {string} header
98 * @param {string} message wikitext message
99 * @param {Function} [ok] Success handler
100 * @param {Function} [err] Error handler
101 * @return {jQuery.Promise}
103 newSection: function ( title, header, message, ok, err ) {
104 return this.postWithEditToken( {
108 title: title.toString(),
118 * @mixins mw.Api.plugin.edit
121 }( mediaWiki, jQuery ) );