wiki.techinc.nl/includes/resourceloader/ResourceLoaderUserModule.php
Aryeh Gregor 7b791474a5 Use MainConfigNames instead of string literals, #4
Now largely automated:

VARS=$(grep -o "'[A-Za-z0-9_]*'" includes/MainConfigNames.php | \
  tr "\n" '|' | sed "s/|$/\n/;s/'//g")
sed -i -E "s/'($VARS)'/MainConfigNames::\1/g" \
  $(grep -ERIl "'($VARS)'" includes/)

Then git add -p with lots of error-prone manual checking. Then
semi-manually add all the necessary "use" lines:

vim $(grep -L 'use MediaWiki\\MainConfigNames;' \
  $(git diff --cached --name-only --diff-filter=M HEAD^))

I didn't bother fixing lines that were over 100 characters unless they
were over 120 and triggered phpcs.

Bug: T305805
Change-Id: I74e0ab511abecb276717ad4276a124760a268147
2022-04-26 19:03:37 +03:00

85 lines
2.7 KiB
PHP

<?php
/**
* 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
* @author Trevor Parscal
* @author Roan Kattouw
*/
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
/**
* Module for user customizations scripts.
*
* @ingroup ResourceLoader
* @internal
*/
class ResourceLoaderUserModule extends ResourceLoaderWikiModule {
protected $origin = self::ORIGIN_USER_INDIVIDUAL;
protected $targets = [ 'desktop', 'mobile' ];
/**
* @param ResourceLoaderContext $context
* @return array[]
*/
protected function getPages( ResourceLoaderContext $context ) {
$user = $context->getUserIdentity();
if ( !$user || !$user->isRegistered() ) {
return [];
}
$config = $this->getConfig();
$pages = [];
if ( $config->get( MainConfigNames::AllowUserJs ) ) {
$titleFormatter = MediaWikiServices::getInstance()->getTitleFormatter();
// Use localised/normalised variant to ensure $excludepage matches
$userPage = $titleFormatter->getPrefixedDBkey( new TitleValue( NS_USER, $user->getName() ) );
$pages["$userPage/common.js"] = [ 'type' => 'script' ];
$pages["$userPage/" . $context->getSkin() . '.js'] = [ 'type' => 'script' ];
}
// User group pages are maintained site-wide and enabled with site JS/CSS.
if ( $config->get( MainConfigNames::UseSiteJs ) ) {
$userGroupManager = MediaWikiServices::getInstance()->getUserGroupManager();
foreach ( $userGroupManager->getUserEffectiveGroups( $user ) as $group ) {
if ( $group == '*' ) {
continue;
}
$pages["MediaWiki:Group-$group.js"] = [ 'type' => 'script' ];
}
}
// This is obsolete since 1.32 (T112474). It was formerly used by
// OutputPage to implement previewing of user CSS and JS.
// @todo: Remove it once we're sure nothing else is using the parameter
$excludepage = $context->getRequest()->getVal( 'excludepage' );
unset( $pages[$excludepage] );
return $pages;
}
/**
* Get group name
*
* @return string
*/
public function getGroup() {
return self::GROUP_USER;
}
}