mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets
synced 2024-11-15 03:23:51 +00:00
17c820f364
Obviously this should be used sparingly, but it's needed for some initialization stuff like registering plugins with VisualEditor. Change-Id: Ifeed524a53601a47b3a945ca0a324bbbead0f1f5
697 lines
17 KiB
PHP
697 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* Gadgets extension - lets users select custom javascript gadgets
|
|
*
|
|
* For more info see http://mediawiki.org/wiki/Extension:Gadgets
|
|
*
|
|
* @file
|
|
* @ingroup Extensions
|
|
* @author Daniel Kinzler, brightbyte.de
|
|
* @copyright © 2007 Daniel Kinzler
|
|
* @license GNU General Public Licence 2.0 or later
|
|
*/
|
|
|
|
class GadgetHooks {
|
|
/**
|
|
* ArticleSaveComplete hook handler.
|
|
*
|
|
* @param $article Article
|
|
* @param $user User
|
|
* @param $text String: New page text
|
|
* @return bool
|
|
*/
|
|
public static function articleSaveComplete( $article, $user, $text ) {
|
|
// update cache if MediaWiki:Gadgets-definition was edited
|
|
$title = $article->getTitle();
|
|
if ( $title->getNamespace() == NS_MEDIAWIKI && $title->getText() == 'Gadgets-definition' ) {
|
|
Gadget::loadStructuredList( $text );
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* UserGetDefaultOptions hook handler
|
|
* @param $defaultOptions Array of default preference keys and values
|
|
* @return bool
|
|
*/
|
|
public static function userGetDefaultOptions( &$defaultOptions ) {
|
|
$gadgets = Gadget::loadStructuredList();
|
|
if ( !$gadgets ) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @var $gadget Gadget
|
|
*/
|
|
foreach ( $gadgets as $thisSection ) {
|
|
foreach ( $thisSection as $gadgetId => $gadget ) {
|
|
if ( $gadget->isOnByDefault() ) {
|
|
$defaultOptions['gadget-' . $gadgetId] = 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* GetPreferences hook handler.
|
|
* @param $user User
|
|
* @param $preferences Array: Preference descriptions
|
|
* @return bool
|
|
*/
|
|
public static function getPreferences( $user, &$preferences ) {
|
|
$gadgets = Gadget::loadStructuredList();
|
|
if ( !$gadgets ) {
|
|
return true;
|
|
}
|
|
|
|
$options = array();
|
|
$default = array();
|
|
foreach ( $gadgets as $section => $thisSection ) {
|
|
$available = array();
|
|
|
|
/**
|
|
* @var $gadget Gadget
|
|
*/
|
|
foreach ( $thisSection as $gadget ) {
|
|
if ( $gadget->isAllowed( $user ) ) {
|
|
$gname = $gadget->getName();
|
|
# bug 30182: dir="auto" because it's often not translated
|
|
$desc = '<span dir="auto">' . $gadget->getDescription() . '</span>';
|
|
$available[$desc] = $gname;
|
|
if ( $gadget->isEnabled( $user ) ) {
|
|
$default[] = $gname;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $section !== '' ) {
|
|
$section = wfMessage( "gadget-section-$section" )->parse();
|
|
|
|
if ( count ( $available ) ) {
|
|
$options[$section] = $available;
|
|
}
|
|
} else {
|
|
$options = array_merge( $options, $available );
|
|
}
|
|
}
|
|
|
|
$preferences['gadgets-intro'] =
|
|
array(
|
|
'type' => 'info',
|
|
'label' => ' ',
|
|
'default' => Xml::tags( 'tr', array(),
|
|
Xml::tags( 'td', array( 'colspan' => 2 ),
|
|
wfMessage( 'gadgets-prefstext' )->parseAsBlock() ) ),
|
|
'section' => 'gadgets',
|
|
'raw' => 1,
|
|
'rawrow' => 1,
|
|
);
|
|
|
|
$preferences['gadgets'] =
|
|
array(
|
|
'type' => 'multiselect',
|
|
'options' => $options,
|
|
'section' => 'gadgets',
|
|
'label' => ' ',
|
|
'prefix' => 'gadget-',
|
|
'default' => $default,
|
|
);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* ResourceLoaderRegisterModules hook handler.
|
|
* @param $resourceLoader ResourceLoader
|
|
* @return bool
|
|
*/
|
|
public static function registerModules( &$resourceLoader ) {
|
|
$gadgets = Gadget::loadList();
|
|
if ( !$gadgets ) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @var $g Gadget
|
|
*/
|
|
foreach ( $gadgets as $g ) {
|
|
$module = $g->getModule();
|
|
if ( $module ) {
|
|
$resourceLoader->register( $g->getModuleName(), $module );
|
|
}
|
|
}
|
|
return true;
|
|
|
|
}
|
|
|
|
/**
|
|
* BeforePageDisplay hook handler.
|
|
* @param $out OutputPage
|
|
* @return bool
|
|
*/
|
|
public static function beforePageDisplay( $out ) {
|
|
wfProfileIn( __METHOD__ );
|
|
|
|
$gadgets = Gadget::loadList();
|
|
if ( !$gadgets ) {
|
|
wfProfileOut( __METHOD__ );
|
|
return true;
|
|
}
|
|
|
|
$lb = new LinkBatch();
|
|
$lb->setCaller( __METHOD__ );
|
|
$pages = array();
|
|
|
|
/**
|
|
* @var $gadget Gadget
|
|
*/
|
|
$user = $out->getUser();
|
|
foreach ( $gadgets as $gadget ) {
|
|
if ( $gadget->isEnabled( $user ) && $gadget->isAllowed( $user ) ) {
|
|
if ( $gadget->hasModule() ) {
|
|
$out->addModuleStyles( $gadget->getModuleName() );
|
|
$out->addModules( $gadget->getModuleName() );
|
|
}
|
|
|
|
foreach ( $gadget->getLegacyScripts() as $page ) {
|
|
$lb->add( NS_MEDIAWIKI, $page );
|
|
$pages[] = $page;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// Allow other extensions, e.g. MobileFrontend, to disallow legacy gadgets
|
|
if ( wfRunHooks( 'Gadgets::allowLegacy', array( $out->getContext() ) ) ) {
|
|
$lb->execute( __METHOD__ );
|
|
|
|
$done = array();
|
|
|
|
foreach ( $pages as $page ) {
|
|
if ( isset( $done[$page] ) ) {
|
|
continue;
|
|
}
|
|
|
|
$done[$page] = true;
|
|
self::applyScript( $page, $out );
|
|
}
|
|
}
|
|
wfProfileOut( __METHOD__ );
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Adds one legacy script to output.
|
|
*
|
|
* @param string $page Unprefixed page title
|
|
* @param OutputPage $out
|
|
*/
|
|
private static function applyScript( $page, $out ) {
|
|
global $wgJsMimeType;
|
|
|
|
# bug 22929: disable gadgets on sensitive pages. Scripts loaded through the
|
|
# ResourceLoader handle this in OutputPage::getModules()
|
|
# TODO: make this extension load everything via RL, then we don't need to worry
|
|
# about any of this.
|
|
if ( $out->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS ) < ResourceLoaderModule::ORIGIN_USER_SITEWIDE ) {
|
|
return;
|
|
}
|
|
|
|
$t = Title::makeTitleSafe( NS_MEDIAWIKI, $page );
|
|
if ( !$t ) {
|
|
return;
|
|
}
|
|
|
|
$u = $t->getLocalURL( 'action=raw&ctype=' . $wgJsMimeType );
|
|
$out->addScriptFile( $u, $t->getLatestRevID() );
|
|
}
|
|
|
|
/**
|
|
* UnitTestsList hook handler
|
|
* @param array $files
|
|
* @return bool
|
|
*/
|
|
public static function onUnitTestsList( array &$files ) {
|
|
$testDir = __DIR__ . '/tests/';
|
|
$files = array_merge( $files, glob( "$testDir/*Test.php" ) );
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Wrapper for one gadget.
|
|
*/
|
|
class Gadget {
|
|
/**
|
|
* Increment this when changing class structure
|
|
*/
|
|
const GADGET_CLASS_VERSION = 7;
|
|
|
|
private $version = self::GADGET_CLASS_VERSION,
|
|
$scripts = array(),
|
|
$styles = array(),
|
|
$dependencies = array(),
|
|
$name,
|
|
$definition,
|
|
$resourceLoaded = false,
|
|
$requiredRights = array(),
|
|
$requiredSkins = array(),
|
|
$targets = array( 'desktop' ),
|
|
$onByDefault = false,
|
|
$position = 'bottom',
|
|
$category;
|
|
|
|
/**
|
|
* Creates an instance of this class from definition in MediaWiki:Gadgets-definition
|
|
* @param $definition String: Gadget definition
|
|
* @return Gadget|bool Instance of Gadget class or false if $definition is invalid
|
|
*/
|
|
public static function newFromDefinition( $definition ) {
|
|
$m = array();
|
|
if ( !preg_match( '/^\*+ *([a-zA-Z](?:[-_:.\w\d ]*[a-zA-Z0-9])?)(\s*\[.*?\])?\s*((\|[^|]*)+)\s*$/', $definition, $m ) ) {
|
|
return false;
|
|
}
|
|
// NOTE: the gadget name is used as part of the name of a form field,
|
|
// and must follow the rules defined in http://www.w3.org/TR/html4/types.html#type-cdata
|
|
// Also, title-normalization applies.
|
|
$gadget = new Gadget();
|
|
$gadget->name = trim( str_replace( ' ', '_', $m[1] ) );
|
|
$gadget->definition = $definition;
|
|
$options = trim( $m[2], ' []' );
|
|
|
|
foreach ( preg_split( '/\s*\|\s*/', $options, -1, PREG_SPLIT_NO_EMPTY ) as $option ) {
|
|
$arr = preg_split( '/\s*=\s*/', $option, 2 );
|
|
$option = $arr[0];
|
|
if ( isset( $arr[1] ) ) {
|
|
$params = explode( ',', $arr[1] );
|
|
$params = array_map( 'trim', $params );
|
|
} else {
|
|
$params = array();
|
|
}
|
|
|
|
switch ( $option ) {
|
|
case 'ResourceLoader':
|
|
$gadget->resourceLoaded = true;
|
|
break;
|
|
case 'dependencies':
|
|
$gadget->dependencies = $params;
|
|
break;
|
|
case 'rights':
|
|
$gadget->requiredRights = $params;
|
|
break;
|
|
case 'skins':
|
|
$gadget->requiredSkins = $params;
|
|
break;
|
|
case 'default':
|
|
$gadget->onByDefault = true;
|
|
break;
|
|
case 'targets':
|
|
$gadget->targets = $params;
|
|
break;
|
|
case 'top':
|
|
$gadget->position = 'top';
|
|
break;
|
|
}
|
|
}
|
|
|
|
foreach ( preg_split( '/\s*\|\s*/', $m[3], -1, PREG_SPLIT_NO_EMPTY ) as $page ) {
|
|
$page = "Gadget-$page";
|
|
|
|
if ( preg_match( '/\.js/', $page ) ) {
|
|
$gadget->scripts[] = $page;
|
|
} elseif ( preg_match( '/\.css/', $page ) ) {
|
|
$gadget->styles[] = $page;
|
|
}
|
|
}
|
|
|
|
return $gadget;
|
|
}
|
|
|
|
/**
|
|
* @return String: Gadget name
|
|
*/
|
|
public function getName() {
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* @return String: Gadget description parsed into HTML
|
|
*/
|
|
public function getDescription() {
|
|
return wfMessage( "gadget-{$this->getName()}" )->parse();
|
|
}
|
|
|
|
/**
|
|
* @return String: Wikitext of gadget description
|
|
*/
|
|
public function getRawDescription() {
|
|
return wfMessage( "gadget-{$this->getName()}" )->plain();
|
|
}
|
|
|
|
/**
|
|
* @return String: Name of category (aka section) our gadget belongs to. Empty string if none.
|
|
*/
|
|
public function getCategory() {
|
|
return $this->category;
|
|
}
|
|
|
|
/**
|
|
* @return String: Name of ResourceLoader module for this gadget
|
|
*/
|
|
public function getModuleName() {
|
|
return "ext.gadget.{$this->name}";
|
|
}
|
|
|
|
/**
|
|
* Checks whether this is an instance of an older version of this class deserialized from cache
|
|
* @return Boolean
|
|
*/
|
|
public function isOutdated() {
|
|
return $this->version != self::GADGET_CLASS_VERSION;
|
|
}
|
|
|
|
/**
|
|
* Checks whether this gadget is enabled for given user
|
|
*
|
|
* @param $user User: user to check against
|
|
* @return Boolean
|
|
*/
|
|
public function isEnabled( $user ) {
|
|
return (bool)$user->getOption( "gadget-{$this->name}", $this->onByDefault );
|
|
}
|
|
|
|
/**
|
|
* Checks whether given user has permissions to use this gadget
|
|
*
|
|
* @param $user User: user to check against
|
|
* @return Boolean
|
|
*/
|
|
public function isAllowed( $user ) {
|
|
return count( array_intersect( $this->requiredRights, $user->getRights() ) ) == count( $this->requiredRights )
|
|
&& ( !count( $this->requiredSkins ) || in_array( $user->getOption( 'skin' ), $this->requiredSkins ) );
|
|
}
|
|
|
|
/**
|
|
* @return Boolean: Whether this gadget is on by default for everyone (but can be disabled in preferences)
|
|
*/
|
|
public function isOnByDefault() {
|
|
return $this->onByDefault;
|
|
}
|
|
|
|
/**
|
|
* @return Boolean: Whether all of this gadget's JS components support ResourceLoader
|
|
*/
|
|
public function supportsResourceLoader() {
|
|
return $this->resourceLoaded;
|
|
}
|
|
|
|
/**
|
|
* @return Boolean: Whether this gadget has resources that can be loaded via ResourceLoader
|
|
*/
|
|
public function hasModule() {
|
|
return count( $this->styles )
|
|
+ ( $this->supportsResourceLoader() ? count( $this->scripts ) : 0 )
|
|
> 0;
|
|
}
|
|
|
|
/**
|
|
* @return String: Definition for this gadget from MediaWiki:gadgets-definition
|
|
*/
|
|
public function getDefinition() {
|
|
return $this->definition;
|
|
}
|
|
|
|
/**
|
|
* @return Array: Array of pages with JS not prefixed with namespace
|
|
*/
|
|
public function getScripts() {
|
|
return $this->scripts;
|
|
}
|
|
|
|
/**
|
|
* @return Array: Array of pages with CSS not prefixed with namespace
|
|
*/
|
|
public function getStyles() {
|
|
return $this->styles;
|
|
}
|
|
|
|
/**
|
|
* @return Array: Array of all of this gadget's resources
|
|
*/
|
|
public function getScriptsAndStyles() {
|
|
return array_merge( $this->scripts, $this->styles );
|
|
}
|
|
|
|
/**
|
|
* Returns module for ResourceLoader, see getModuleName() for its name.
|
|
* If our gadget has no scripts or styles suitable for RL, false will be returned.
|
|
* @return Mixed: GadgetResourceLoaderModule or false
|
|
*/
|
|
public function getModule() {
|
|
$pages = array();
|
|
|
|
foreach ( $this->styles as $style ) {
|
|
$pages['MediaWiki:' . $style] = array( 'type' => 'style' );
|
|
}
|
|
|
|
if ( $this->supportsResourceLoader() ) {
|
|
foreach ( $this->scripts as $script ) {
|
|
$pages['MediaWiki:' . $script] = array( 'type' => 'script' );
|
|
}
|
|
}
|
|
|
|
if ( !count( $pages ) ) {
|
|
return null;
|
|
}
|
|
|
|
return new GadgetResourceLoaderModule( $pages, $this->dependencies, $this->targets, $this->position );
|
|
}
|
|
|
|
/**
|
|
* Returns list of scripts that don't support ResourceLoader
|
|
* @return Array
|
|
*/
|
|
public function getLegacyScripts() {
|
|
if ( $this->supportsResourceLoader() ) {
|
|
return array();
|
|
}
|
|
return $this->scripts;
|
|
}
|
|
|
|
/**
|
|
* Returns names of resources this gadget depends on
|
|
* @return Array
|
|
*/
|
|
public function getDependencies() {
|
|
return $this->dependencies;
|
|
}
|
|
|
|
/**
|
|
* Returns array of permissions required by this gadget
|
|
* @return Array
|
|
*/
|
|
public function getRequiredRights() {
|
|
return $this->requiredRights;
|
|
}
|
|
|
|
/**
|
|
* Returns array of skins where this gadget works
|
|
* @return Array
|
|
*/
|
|
public function getRequiredSkins() {
|
|
return $this->requiredSkins;
|
|
}
|
|
|
|
/**
|
|
* Returns the position of this Gadget's ResourceLoader module
|
|
* @return String: 'bottom' or 'top'
|
|
*/
|
|
public function getPosition() {
|
|
return $this->position;
|
|
}
|
|
|
|
/**
|
|
* Loads and returns a list of all gadgets
|
|
* @return Mixed: Array of gadgets or false
|
|
*/
|
|
public static function loadList() {
|
|
static $gadgets = null;
|
|
|
|
if ( $gadgets !== null ) {
|
|
return $gadgets;
|
|
}
|
|
|
|
wfProfileIn( __METHOD__ );
|
|
$struct = self::loadStructuredList();
|
|
|
|
if ( !$struct ) {
|
|
$gadgets = $struct;
|
|
wfProfileOut( __METHOD__ );
|
|
return $gadgets;
|
|
}
|
|
|
|
$gadgets = array();
|
|
foreach ( $struct as $entries ) {
|
|
$gadgets = array_merge( $gadgets, $entries );
|
|
}
|
|
wfProfileOut( __METHOD__ );
|
|
|
|
return $gadgets;
|
|
}
|
|
|
|
/**
|
|
* Checks whether gadget list from cache can be used.
|
|
* @param $gadgets array
|
|
* @return Boolean
|
|
*/
|
|
private static function isValidList( $gadgets ) {
|
|
if ( !is_array( $gadgets ) ) {
|
|
return false;
|
|
}
|
|
// Check if we have 1) array of gadgets 2) the gadgets are up to date
|
|
// One check is enough
|
|
/**
|
|
* @var $g Gadget
|
|
*/
|
|
foreach ( $gadgets as $list ) {
|
|
foreach ( $list as $g ) {
|
|
if ( !( $g instanceof Gadget ) || $g->isOutdated() ) {
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return true; // empty array
|
|
}
|
|
|
|
/**
|
|
* Loads list of gadgets and returns it as associative array of sections with gadgets
|
|
* e.g. array( 'sectionnname1' => array( $gadget1, $gadget2),
|
|
* 'sectionnname2' => array( $gadget3 ) );
|
|
* @param $forceNewText String: New text of MediaWiki:gadgets-definition. If specified, will
|
|
* force a purge of cache and recreation of the gadget list.
|
|
* @return Mixed: Array or false
|
|
*/
|
|
public static function loadStructuredList( $forceNewText = null ) {
|
|
global $wgMemc;
|
|
|
|
static $gadgets = null;
|
|
if ( $gadgets !== null && $forceNewText === null ) {
|
|
return $gadgets;
|
|
}
|
|
|
|
wfProfileIn( __METHOD__ );
|
|
$key = wfMemcKey( 'gadgets-definition', self::GADGET_CLASS_VERSION );
|
|
|
|
if ( $forceNewText === null ) {
|
|
// cached?
|
|
$gadgets = $wgMemc->get( $key );
|
|
if ( self::isValidList( $gadgets ) ) {
|
|
wfProfileOut( __METHOD__ );
|
|
return $gadgets;
|
|
}
|
|
|
|
$g = wfMessage( "gadgets-definition" )->inContentLanguage();
|
|
if ( !$g->exists() ) {
|
|
$gadgets = false;
|
|
wfProfileOut( __METHOD__ );
|
|
return $gadgets;
|
|
}
|
|
$g = $g->plain();
|
|
} else {
|
|
$g = $forceNewText;
|
|
}
|
|
|
|
$g = preg_replace( '/<!--.*?-->/s', '', $g );
|
|
$g = preg_split( '/(\r\n|\r|\n)+/', $g );
|
|
|
|
$gadgets = array();
|
|
$section = '';
|
|
|
|
foreach ( $g as $line ) {
|
|
$m = array();
|
|
if ( preg_match( '/^==+ *([^*:\s|]+?)\s*==+\s*$/', $line, $m ) ) {
|
|
$section = $m[1];
|
|
} else {
|
|
$gadget = self::newFromDefinition( $line );
|
|
if ( $gadget ) {
|
|
$gadgets[$section][$gadget->getName()] = $gadget;
|
|
$gadget->category = $section;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( !count( $gadgets ) ) {
|
|
// Don't cache in case we couldn't find any gadgets. Bug 37228
|
|
$gadgets = false;
|
|
wfProfileOut( __METHOD__ );
|
|
return $gadgets;
|
|
}
|
|
|
|
// cache for a while. gets purged automatically when MediaWiki:Gadgets-definition is edited
|
|
$wgMemc->set( $key, $gadgets, 60 * 60 * 24 );
|
|
$source = $forceNewText !== null ? 'input text' : 'MediaWiki:Gadgets-definition';
|
|
wfDebug( __METHOD__ . ": $source parsed, cache entry $key updated\n" );
|
|
wfProfileOut( __METHOD__ );
|
|
|
|
return $gadgets;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Class representing a list of resources for one gadget
|
|
*/
|
|
class GadgetResourceLoaderModule extends ResourceLoaderWikiModule {
|
|
private $pages, $dependencies;
|
|
|
|
/**
|
|
* Creates an instance of this class
|
|
*
|
|
* @param $pages Array: Associative array of pages in ResourceLoaderWikiModule-compatible
|
|
* format, for example:
|
|
* array(
|
|
* 'MediaWiki:Gadget-foo.js' => array( 'type' => 'script' ),
|
|
* 'MediaWiki:Gadget-foo.css' => array( 'type' => 'style' ),
|
|
* )
|
|
* @param $dependencies Array: Names of resources this module depends on
|
|
* @param $targets Array: List of targets this module support
|
|
* @param $position String: 'bottom' or 'top'
|
|
*/
|
|
public function __construct( $pages, $dependencies, $targets, $position ) {
|
|
$this->pages = $pages;
|
|
$this->dependencies = $dependencies;
|
|
$this->targets = $targets;
|
|
$this->position = $position;
|
|
}
|
|
|
|
/**
|
|
* Overrides the abstract function from ResourceLoaderWikiModule class
|
|
* @param $context ResourceLoaderContext
|
|
* @return Array: $pages passed to __construct()
|
|
*/
|
|
protected function getPages( ResourceLoaderContext $context ) {
|
|
return $this->pages;
|
|
}
|
|
|
|
/**
|
|
* Overrides ResourceLoaderModule::getDependencies()
|
|
* @return Array: Names of resources this module depends on
|
|
*/
|
|
public function getDependencies() {
|
|
return $this->dependencies;
|
|
}
|
|
|
|
/**
|
|
* Overrides ResourceLoaderModule::getPosition()
|
|
* @return String: 'bottom' or 'top'
|
|
*/
|
|
public function getPosition() {
|
|
return $this->position;
|
|
}
|
|
}
|