summaryrefslogtreecommitdiff
path: root/www/wiki/includes/api/ApiTokens.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/includes/api/ApiTokens.php')
-rw-r--r--www/wiki/includes/api/ApiTokens.php112
1 files changed, 112 insertions, 0 deletions
diff --git a/www/wiki/includes/api/ApiTokens.php b/www/wiki/includes/api/ApiTokens.php
new file mode 100644
index 00000000..ff1914c8
--- /dev/null
+++ b/www/wiki/includes/api/ApiTokens.php
@@ -0,0 +1,112 @@
+<?php
+/**
+ * Copyright © 2011 John Du Hart john@johnduhart.me
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * @deprecated since 1.24
+ * @ingroup API
+ */
+class ApiTokens extends ApiBase {
+
+ public function execute() {
+ $this->addDeprecation(
+ [ 'apiwarn-deprecation-withreplacement', 'action=tokens', 'action=query&meta=tokens' ],
+ 'action=tokens'
+ );
+
+ $params = $this->extractRequestParams();
+ $res = [
+ ApiResult::META_TYPE => 'assoc',
+ ];
+
+ $types = $this->getTokenTypes();
+ foreach ( $params['type'] as $type ) {
+ $val = call_user_func( $types[$type], null, null );
+
+ if ( $val === false ) {
+ $this->addWarning( [ 'apiwarn-tokennotallowed', $type ] );
+ } else {
+ $res[$type . 'token'] = $val;
+ }
+ }
+
+ $this->getResult()->addValue( null, $this->getModuleName(), $res );
+ }
+
+ private function getTokenTypes() {
+ // If we're in a mode that breaks the same-origin policy, no tokens can
+ // be obtained
+ if ( $this->lacksSameOriginSecurity() ) {
+ return [];
+ }
+
+ static $types = null;
+ if ( $types ) {
+ return $types;
+ }
+ $types = [ 'patrol' => [ ApiQueryRecentChanges::class, 'getPatrolToken' ] ];
+ $names = [ 'edit', 'delete', 'protect', 'move', 'block', 'unblock',
+ 'email', 'import', 'watch', 'options' ];
+ foreach ( $names as $name ) {
+ $types[$name] = [ ApiQueryInfo::class, 'get' . ucfirst( $name ) . 'Token' ];
+ }
+ Hooks::run( 'ApiTokensGetTokenTypes', [ &$types ] );
+
+ // For forwards-compat, copy any token types from ApiQueryTokens that
+ // we don't already have something for.
+ $user = $this->getUser();
+ $request = $this->getRequest();
+ foreach ( ApiQueryTokens::getTokenTypeSalts() as $name => $salt ) {
+ if ( !isset( $types[$name] ) ) {
+ $types[$name] = function () use ( $salt, $user, $request ) {
+ return ApiQueryTokens::getToken( $user, $request->getSession(), $salt )->toString();
+ };
+ }
+ }
+
+ ksort( $types );
+
+ return $types;
+ }
+
+ public function isDeprecated() {
+ return true;
+ }
+
+ public function getAllowedParams() {
+ return [
+ 'type' => [
+ ApiBase::PARAM_DFLT => 'edit',
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => array_keys( $this->getTokenTypes() ),
+ ],
+ ];
+ }
+
+ protected function getExamplesMessages() {
+ return [
+ 'action=tokens'
+ => 'apihelp-tokens-example-edit',
+ 'action=tokens&type=email|move'
+ => 'apihelp-tokens-example-emailmove',
+ ];
+ }
+}