jenkins-bot has submitted this change and it was merged.
Change subject: mediawiki.api: Use action=query&meta=tokens instead of
action=tokens
......................................................................
mediawiki.api: Use action=query&meta=tokens instead of action=tokens
api.php?action=query&meta=tokens has different token types.
A mapping keeps the JavaScript API stable.
Bug: 72094
Change-Id: I429b609b626af35ae0abcdf6f1c13e8afb6503b9
---
M includes/resourceloader/ResourceLoaderUserTokensModule.php
M resources/src/mediawiki.api/mediawiki.api.js
M tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js
3 files changed, 29 insertions(+), 16 deletions(-)
Approvals:
Ori.livneh: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/resourceloader/ResourceLoaderUserTokensModule.php
b/includes/resourceloader/ResourceLoaderUserTokensModule.php
index ccd1dfd..9eb6ee9 100644
--- a/includes/resourceloader/ResourceLoaderUserTokensModule.php
+++ b/includes/resourceloader/ResourceLoaderUserTokensModule.php
@@ -47,6 +47,7 @@
'editToken' => $user->getEditToken(),
'patrolToken' => $user->getEditToken( 'patrol' ),
'watchToken' => $user->getEditToken( 'watch' ),
+ 'csrfToken' => $user->getEditToken()
);
}
diff --git a/resources/src/mediawiki.api/mediawiki.api.js
b/resources/src/mediawiki.api/mediawiki.api.js
index 3a19e02..1a9c1b5 100644
--- a/resources/src/mediawiki.api/mediawiki.api.js
+++ b/resources/src/mediawiki.api/mediawiki.api.js
@@ -1,5 +1,11 @@
( function ( mw, $ ) {
+ function getTokenType( action ) {
+ // Token types from `action=tokens` that need to be mapped to
the 'csrf' token type for backward-compatibility.
+ var csrfActions = [ 'block', 'delete', 'edit', 'email',
'import', 'move', 'options', 'protect', 'unblock' ];
+ return $.inArray( action, csrfActions ) === -1 ? action :
'csrf';
+ }
+
// 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,
@@ -271,26 +277,32 @@
* @return {string} return.done.token Received token.
* @since 1.22
*/
- getToken: function ( type, assert ) {
+ getToken: function ( action, assert ) {
var apiPromise,
+ type = getTokenType( action ),
promiseGroup = promises[ this.defaults.ajax.url
],
- d = promiseGroup && promiseGroup[ type +
'Token' ];
+ d = promiseGroup && promiseGroup[ action +
'Token' ];
if ( !d ) {
- apiPromise = this.get( { action: 'tokens',
type: type, assert: assert } );
+ apiPromise = this.get( {
+ action: 'query',
+ meta: 'tokens',
+ type: type,
+ assert: assert
+ } );
d = apiPromise
- .then( function ( data ) {
+ .then( function ( res ) {
// If token type is not
available for this user,
// key '...token' is either
missing or set to boolean false
- if ( data.tokens &&
data.tokens[type + 'token'] ) {
- return data.tokens[type
+ 'token'];
+ if ( res.query &&
res.query.tokens && res.query.tokens[type + 'token'] ) {
+ return
res.query.tokens[type + 'token'];
}
- return $.Deferred().reject(
'token-missing', data );
+ return $.Deferred().reject(
'token-missing', res );
}, function () {
// Clear promise. Do not cache
errors.
- delete promiseGroup[ type +
'Token' ];
+ delete promiseGroup[ action +
'Token' ];
// Pass on to allow the caller
to handle the error
return this;
@@ -302,7 +314,7 @@
if ( !promiseGroup ) {
promiseGroup = promises[
this.defaults.ajax.url ] = {};
}
- promiseGroup[ type + 'Token' ] = d;
+ promiseGroup[ action + 'Token' ] = d;
}
return d;
diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js
b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js
index b89526f..61c9772 100644
--- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js
+++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js
@@ -136,12 +136,12 @@
assert.equal( test.server.requests.length, 3,
'Requests made' );
test.server.requests[2].respond( 200, {
'Content-Type': 'application/json' },
- '{ "tokens": { "testaction2token":
"0123abc" } }'
+ '{ "query": { "tokens": {
"testaction2token": "0123abc" } } }'
);
} );
this.server.requests[0].respond( 200, { 'Content-Type':
'application/json' },
- '{ "tokens": { "testactiontoken": "0123abc" } }'
+ '{ "query": { "tokens": { "testactiontoken": "0123abc"
} } }'
);
this.server.requests[1].respond( 200, { 'Content-Type':
'application/json' },
@@ -162,7 +162,7 @@
} );
this.server.requests[0].respond( 200, { 'Content-Type':
'application/json' },
- '{ "tokens": { "testsimpletokentoken": "a-bad-token" }
}'
+ '{ "query": { "tokens": { "testsimpletokentoken":
"a-bad-token" } } }'
);
this.server.requests[1].respond( 200, { 'Content-Type':
'application/json' },
@@ -245,7 +245,7 @@
} );
this.server.requests[0].respond( 200, { 'Content-Type':
'application/json' },
- '{ "tokens": { "testbadtokentoken": "a-bad-token" } }'
+ '{ "query": { "tokens": { "testbadtokentoken":
"a-bad-token" } } }'
);
this.server.requests[1].respond( 200, { 'Content-Type':
'application/json' },
@@ -253,7 +253,7 @@
);
this.server.requests[2].respond( 200, { 'Content-Type':
'application/json' },
- '{ "tokens": { "testbadtokentoken": "a-good-token" } }'
+ '{ "query": { "tokens": { "testbadtokentoken":
"a-good-token" } } }'
);
this.server.requests[3].respond( 200, { 'Content-Type':
'application/json' },
@@ -284,7 +284,7 @@
} );
this.server.requests[0].respond( 200, { 'Content-Type':
'application/json' },
- '{ "tokens": { "testbadtokencachetoken":
"a-good-token-once" } }'
+ '{ "query": { "tokens": { "testbadtokencachetoken":
"a-good-token-once" } } }'
);
this.server.requests[1].respond( 200, { 'Content-Type':
'application/json' },
@@ -296,7 +296,7 @@
);
this.server.requests[3].respond( 200, { 'Content-Type':
'application/json' },
- '{ "tokens": { "testbadtokencachetoken":
"a-good-new-token" } }'
+ '{ "query": { "tokens": { "testbadtokencachetoken":
"a-good-new-token" } } }'
);
this.server.requests[4].respond( 200, { 'Content-Type':
'application/json' },
--
To view, visit https://gerrit.wikimedia.org/r/166872
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I429b609b626af35ae0abcdf6f1c13e8afb6503b9
Gerrit-PatchSet: 8
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Gerrit Patch Uploader <[email protected]>
Gerrit-Reviewer: Aaron Schulz <[email protected]>
Gerrit-Reviewer: Bartosz Dziewoński <[email protected]>
Gerrit-Reviewer: Fomafix
Gerrit-Reviewer: Gerrit Patch Uploader <[email protected]>
Gerrit-Reviewer: Jack Phoenix <[email protected]>
Gerrit-Reviewer: Krinkle <[email protected]>
Gerrit-Reviewer: Nikerabbit <[email protected]>
Gerrit-Reviewer: Ori.livneh <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
