includes/resourceloader/ResourceLoaderUserTokensModule.php

   1 <?php
   2 /**
   3  * ResourceLoader module for user tokens.
   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  * @author Krinkle
  22  */
  23
  24 /**
  25  * Module for user tokens
  26  */
  27 class ResourceLoaderUserTokensModule extends ResourceLoaderModule {
  28
  29         /* Protected Members */
  30
  31         protected $origin = self::ORIGIN_CORE_INDIVIDUAL;
  32
  33         protected $targets = [ 'desktop', 'mobile' ];
  34
  35         /* Methods */
  36
  37         /**
  38          * Fetch the tokens for the current user.
  39          *
  40          * @param ResourceLoaderContext $context
  41          * @return array List of tokens keyed by token type
  42          */
  43         protected function contextUserTokens( ResourceLoaderContext $context ) {
  44                 $user = $context->getUserObj();
  45
  46                 return [
  47                         'editToken' => $user->getEditToken(),
  48                         'patrolToken' => $user->getEditToken( 'patrol' ),
  49                         'watchToken' => $user->getEditToken( 'watch' ),
  50                         'csrfToken' => $user->getEditToken(),
  51                 ];
  52         }
  53
  54         /**
  55          * Generate the JavaScript content of this module.
  56          *
  57          * Add '@nomin' annotation to prevent the module's contents from getting
  58          * cached (T84960).
  59          *
  60          * @param ResourceLoaderContext $context
  61          * @return string
  62          */
  63         public function getScript( ResourceLoaderContext $context ) {
  64                 return Xml::encodeJsCall(
  65                         'mw.user.tokens.set',
  66                         [ $this->contextUserTokens( $context ) ],
  67                         ResourceLoader::inDebugMode()
  68                 ) . ResourceLoader::FILTER_NOMIN;
  69         }
  70
  71         /**
  72          * @return bool
  73          */
  74         public function supportsURLLoading() {
  75                 return false;
  76         }
  77
  78         /**
  79          * @return string
  80          */
  81         public function getGroup() {
  82                 return 'private';
  83         }
  84 }