includes/api/ApiTokens.php

   1 <?php
   2 /**
   3  * Copyright © 2011 John Du Hart john@johnduhart.me
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * @deprecated since 1.24
  25  * @ingroup API
  26  */
  27 class ApiTokens extends ApiBase {
  28
  29         public function execute() {
  30                 $this->addDeprecation(
  31                         [ 'apiwarn-deprecation-withreplacement', 'action=tokens', 'action=query&meta=tokens' ],
  32                         'action=tokens'
  33                 );
  34
  35                 $params = $this->extractRequestParams();
  36                 $res = [
  37                         ApiResult::META_TYPE => 'assoc',
  38                 ];
  39
  40                 $types = $this->getTokenTypes();
  41                 foreach ( $params['type'] as $type ) {
  42                         $val = call_user_func( $types[$type], null, null );
  43
  44                         if ( $val === false ) {
  45                                 $this->addWarning( [ 'apiwarn-tokennotallowed', $type ] );
  46                         } else {
  47                                 $res[$type . 'token'] = $val;
  48                         }
  49                 }
  50
  51                 $this->getResult()->addValue( null, $this->getModuleName(), $res );
  52         }
  53
  54         private function getTokenTypes() {
  55                 // If we're in a mode that breaks the same-origin policy, no tokens can
  56                 // be obtained
  57                 if ( $this->lacksSameOriginSecurity() ) {
  58                         return [];
  59                 }
  60
  61                 static $types = null;
  62                 if ( $types ) {
  63                         return $types;
  64                 }
  65                 $types = [ 'patrol' => [ 'ApiQueryRecentChanges', 'getPatrolToken' ] ];
  66                 $names = [ 'edit', 'delete', 'protect', 'move', 'block', 'unblock',
  67                         'email', 'import', 'watch', 'options' ];
  68                 foreach ( $names as $name ) {
  69                         $types[$name] = [ 'ApiQueryInfo', 'get' . ucfirst( $name ) . 'Token' ];
  70                 }
  71                 Hooks::run( 'ApiTokensGetTokenTypes', [ &$types ] );
  72
  73                 // For forwards-compat, copy any token types from ApiQueryTokens that
  74                 // we don't already have something for.
  75                 $user = $this->getUser();
  76                 $request = $this->getRequest();
  77                 foreach ( ApiQueryTokens::getTokenTypeSalts() as $name => $salt ) {
  78                         if ( !isset( $types[$name] ) ) {
  79                                 $types[$name] = function () use ( $salt, $user, $request ) {
  80                                         return ApiQueryTokens::getToken( $user, $request->getSession(), $salt )->toString();
  81                                 };
  82                         }
  83                 }
  84
  85                 ksort( $types );
  86
  87                 return $types;
  88         }
  89
  90         public function isDeprecated() {
  91                 return true;
  92         }
  93
  94         public function getAllowedParams() {
  95                 return [
  96                         'type' => [
  97                                 ApiBase::PARAM_DFLT => 'edit',
  98                                 ApiBase::PARAM_ISMULTI => true,
  99                                 ApiBase::PARAM_TYPE => array_keys( $this->getTokenTypes() ),
 100                         ],
 101                 ];
 102         }
 103
 104         protected function getExamplesMessages() {
 105                 return [
 106                         'action=tokens'
 107                                 => 'apihelp-tokens-example-edit',
 108                         'action=tokens&type=email|move'
 109                                 => 'apihelp-tokens-example-emailmove',
 110                 ];
 111         }
 112 }