includes/resourceloader/ResourceLoaderUserModule.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @author Trevor Parscal
  20  * @author Roan Kattouw
  21  */
  22
  23 /**
  24  * Module for user customizations scripts
  25  */
  26 class ResourceLoaderUserModule extends ResourceLoaderWikiModule {
  27
  28         protected $origin = self::ORIGIN_USER_INDIVIDUAL;
  29         protected $targets = [ 'desktop', 'mobile' ];
  30
  31         /**
  32          * @param ResourceLoaderContext $context
  33          * @return array List of pages
  34          */
  35         protected function getPages( ResourceLoaderContext $context ) {
  36                 $config = $this->getConfig();
  37                 $user = $context->getUserObj();
  38                 if ( $user->isAnon() ) {
  39                         return [];
  40                 }
  41
  42                 // Use localised/normalised variant to ensure $excludepage matches
  43                 $userPage = $user->getUserPage()->getPrefixedDBkey();
  44                 $pages = [];
  45
  46                 if ( $config->get( 'AllowUserJs' ) ) {
  47                         $pages["$userPage/common.js"] = [ 'type' => 'script' ];
  48                         $pages["$userPage/" . $context->getSkin() . '.js'] = [ 'type' => 'script' ];
  49                 }
  50
  51                 // User group pages are maintained site-wide and enabled with site JS/CSS.
  52                 if ( $config->get( 'UseSiteJs' ) ) {
  53                         foreach ( $user->getEffectiveGroups() as $group ) {
  54                                 if ( $group == '*' ) {
  55                                         continue;
  56                                 }
  57                                 $pages["MediaWiki:Group-$group.js"] = [ 'type' => 'script' ];
  58                         }
  59                 }
  60
  61                 // This is obsolete since 1.32 (T112474). It was formerly used by
  62                 // OutputPage to implement previewing of user CSS and JS.
  63                 // @todo: Remove it once we're sure nothing else is using the parameter
  64                 $excludepage = $context->getRequest()->getVal( 'excludepage' );
  65                 if ( isset( $pages[$excludepage] ) ) {
  66                         unset( $pages[$excludepage] );
  67                 }
  68
  69                 return $pages;
  70         }
  71
  72         /**
  73          * Get group name
  74          *
  75          * @return string
  76          */
  77         public function getGroup() {
  78                 return 'user';
  79         }
  80
  81         /**
  82          * @param ResourceLoaderContext|null $context
  83          * @return array
  84          */
  85         public function getDependencies( ResourceLoaderContext $context = null ) {
  86                 return [ 'user.styles' ];
  87         }
  88 }