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 $origin = self::ORIGIN_CORE_INDIVIDUAL;
  30
  31         protected $targets = [ 'desktop', 'mobile' ];
  32
  33         /**
  34          * Fetch the tokens for the current user.
  35          *
  36          * @param ResourceLoaderContext $context
  37          * @return array List of tokens keyed by token type
  38          */
  39         protected function contextUserTokens( ResourceLoaderContext $context ) {
  40                 $user = $context->getUserObj();
  41
  42                 return [
  43                         'editToken' => $user->getEditToken(),
  44                         'patrolToken' => $user->getEditToken( 'patrol' ),
  45                         'watchToken' => $user->getEditToken( 'watch' ),
  46                         'csrfToken' => $user->getEditToken(),
  47                 ];
  48         }
  49
  50         /**
  51          * @param ResourceLoaderContext $context
  52          * @return string JavaScript code
  53          */
  54         public function getScript( ResourceLoaderContext $context ) {
  55                 // Use FILTER_NOMIN annotation to prevent needless minification and caching (T84960).
  56                 return ResourceLoader::FILTER_NOMIN
  57                         . 'mw.user.tokens.set('
  58                         . ResourceLoader::encodeJsonForScript( $this->contextUserTokens( $context ) )
  59                         . ');';
  60         }
  61
  62         /**
  63          * @return bool
  64          */
  65         public function supportsURLLoading() {
  66                 return false;
  67         }
  68
  69         /**
  70          * @return string
  71          */
  72         public function getGroup() {
  73                 return 'private';
  74         }
  75 }