From 0ee165bce8296acf973d305d9b0ad4f25e43855b Mon Sep 17 00:00:00 2001 From: Max Semenik Date: Fri, 30 Aug 2013 03:32:32 +0400 Subject: [PATCH] Move hooks to a separate file Change-Id: I2cb53bd4beae247c1b983dc8c4482af682acab64 --- GadgetHooks.php | 252 +++++++++++++++++++++++++++++++++++++++++++++++ Gadgets.php | 2 +- Gadgets_body.php | 229 ------------------------------------------ 3 files changed, 253 insertions(+), 230 deletions(-) create mode 100644 GadgetHooks.php diff --git a/GadgetHooks.php b/GadgetHooks.php new file mode 100644 index 00000000..5dad3377 --- /dev/null +++ b/GadgetHooks.php @@ -0,0 +1,252 @@ +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 = '' . $gadget->getDescription() . ''; + $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; + } +} diff --git a/Gadgets.php b/Gadgets.php index e77fe7c1..b0b455c4 100644 --- a/Gadgets.php +++ b/Gadgets.php @@ -42,7 +42,7 @@ $wgExtensionMessagesFiles['GadgetsAlias'] = $dir . 'Gadgets.alias.php'; $wgAutoloadClasses['ApiQueryGadgetCategories'] = $dir . 'ApiQueryGadgetCategories.php'; $wgAutoloadClasses['ApiQueryGadgets'] = $dir . 'ApiQueryGadgets.php'; $wgAutoloadClasses['Gadget'] = $dir . 'Gadgets_body.php'; -$wgAutoloadClasses['GadgetHooks'] = $dir . 'Gadgets_body.php'; +$wgAutoloadClasses['GadgetHooks'] = $dir . 'GadgetHooks.php'; $wgAutoloadClasses['GadgetResourceLoaderModule'] = $dir . 'Gadgets_body.php'; $wgAutoloadClasses['SpecialGadgets'] = $dir . 'SpecialGadgets.php'; diff --git a/Gadgets_body.php b/Gadgets_body.php index cfc5ab8d..1e043a82 100644 --- a/Gadgets_body.php +++ b/Gadgets_body.php @@ -11,235 +11,6 @@ * @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 = '' . $gadget->getDescription() . ''; - $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.