1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/**
* Additional mw.Api methods to assist with API calls related to editing wiki pages.
*/
( function ( mw, $ ) {
// Cache token so we don't have to keep fetching new ones for every single request.
var cachedToken = null;
$.extend( mw.Api.prototype, {
/**
* Post to API with edit token. If we have no token, get one and try to post.
* If we have a cached token try using that, and if it fails, blank out the
* cached token and start over.
*
* @param params {Object} API parameters
* @param ok {Function} callback for success
* @param err {Function} [optional] error callback
* @return {jqXHR}
*/
postWithEditToken: function ( params, ok, err ) {
var useTokenToPost, getTokenIfBad,
api = this;
if ( cachedToken === null ) {
// We don't have a valid cached token, so get a fresh one and try posting.
// We do not trap any 'badtoken' or 'notoken' errors, because we don't want
// an infinite loop. If this fresh token is bad, something else is very wrong.
useTokenToPost = function ( token ) {
params.token = token;
api.post( params, ok, err );
};
return api.getEditToken( useTokenToPost, err );
} else {
// We do have a token, but it might be expired. So if it is 'bad' then
// start over with a new token.
params.token = cachedToken;
getTokenIfBad = function ( code, result ) {
if ( code === 'badtoken' ) {
// force a new token, clear any old one
cachedToken = null;
api.postWithEditToken( params, ok, err );
} else {
err( code, result );
}
};
return api.post( params, { ok : ok, err : getTokenIfBad });
}
},
/**
* Api helper to grab an edit token
*
* token callback has signature ( String token )
* error callback has signature ( String code, Object results, XmlHttpRequest xhr, Exception exception )
* Note that xhr and exception are only available for 'http_*' errors
* code may be any http_* error code (see mw.Api), or 'token_missing'
*
* @param tokenCallback {Function} received token callback
* @param err {Function} error callback
* @return {jqXHR}
*/
getEditToken: function ( tokenCallback, err ) {
var parameters = {
action: 'tokens',
type: 'edit'
},
ok = function ( data ) {
var token;
// If token type is not available for this user,
// key 'edittoken' is missing or can contain Boolean false
if ( data.tokens && data.tokens.edittoken ) {
token = data.tokens.edittoken;
cachedToken = token;
tokenCallback( token );
} else {
err( 'token-missing', data );
}
},
ajaxOptions = {
ok: ok,
err: err,
// Due to the API assuming we're logged out if we pass the callback-parameter,
// we have to disable jQuery's callback system, and instead parse JSON string,
// by setting 'jsonp' to false.
jsonp: false
};
return this.get( parameters, ajaxOptions );
},
/**
* Create a new section of the page.
* @param title {mw.Title|String} target page
* @param header {String}
* @param message {String} wikitext message
* @param ok {Function} success handler
* @param err {Function} error handler
* @return {jqXHR}
*/
newSection: function ( title, header, message, ok, err ) {
var params = {
action: 'edit',
section: 'new',
format: 'json',
title: title.toString(),
summary: header,
text: message
};
return this.postWithEditToken( params, ok, err );
}
} );
}( mediaWiki, jQuery ) );
|