handlePageUpdate( $wikiPage->getTitle() ); return true; } /** * UserGetDefaultOptions hook handler * @param array &$defaultOptions Array of default preference keys and values * @return bool */ public static function userGetDefaultOptions( &$defaultOptions ) { $gadgets = GadgetRepo::singleton()->getStructuredList(); 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 array &$preferences Preference descriptions * @return bool */ public static function getPreferences( $user, &$preferences ) { $gadgets = GadgetRepo::singleton()->getStructuredList(); if ( !$gadgets ) { return true; } $options = []; $default = []; foreach ( $gadgets as $section => $thisSection ) { $available = []; /** * @var $gadget Gadget */ foreach ( $thisSection as $gadget ) { if ( !$gadget->isHidden() && $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'] = [ 'type' => 'info', 'label' => ' ', 'default' => Xml::tags( 'tr', [], Xml::tags( 'td', [ 'colspan' => 2 ], wfMessage( 'gadgets-prefstext' )->parseAsBlock() ) ), 'section' => 'gadgets', 'raw' => 1, 'rawrow' => 1, 'noglobal' => true, ]; $preferences['gadgets'] = [ 'type' => 'multiselect', 'options' => $options, 'section' => 'gadgets', 'label' => ' ', 'prefix' => 'gadget-', 'default' => $default, 'noglobal' => true, ]; return true; } /** * ResourceLoaderRegisterModules hook handler. * @param ResourceLoader &$resourceLoader * @return bool */ public static function registerModules( &$resourceLoader ) { $repo = GadgetRepo::singleton(); $ids = $repo->getGadgetIds(); foreach ( $ids as $id ) { $resourceLoader->register( Gadget::getModuleName( $id ), [ 'class' => 'GadgetResourceLoaderModule', 'id' => $id, ] ); } return true; } /** * BeforePageDisplay hook handler. * @param OutputPage $out * @return bool */ public static function beforePageDisplay( $out ) { $repo = GadgetRepo::singleton(); $ids = $repo->getGadgetIds(); if ( !$ids ) { return true; } $lb = new LinkBatch(); $lb->setCaller( __METHOD__ ); $enabledLegacyGadgets = []; /** * @var $gadget Gadget */ $user = $out->getUser(); foreach ( $ids as $id ) { try { $gadget = $repo->getGadget( $id ); } catch ( InvalidArgumentException $e ) { continue; } $peers = []; foreach ( $gadget->getPeers() as $peerName ) { try { $peers[] = $repo->getGadget( $peerName ); } catch ( InvalidArgumentException $e ) { // Ignore // @todo: Emit warning for invalid peer? } } if ( $gadget->isEnabled( $user ) && $gadget->isAllowed( $user ) ) { if ( $gadget->hasModule() ) { if ( $gadget->getType() === 'styles' ) { $out->addModuleStyles( Gadget::getModuleName( $gadget->getName() ) ); } else { $out->addModules( Gadget::getModuleName( $gadget->getName() ) ); // Load peer modules foreach ( $peers as $peer ) { if ( $peer->getType() === 'styles' ) { $out->addModuleStyles( Gadget::getModuleName( $peer->getName() ) ); } // Else, if not type=styles: Use dependencies instead. // Note: No need for recursion as styles modules don't support // either of 'dependencies' and 'peers'. } } } if ( $gadget->getLegacyScripts() ) { $enabledLegacyGadgets[] = $id; } } } $strings = []; foreach ( $enabledLegacyGadgets as $id ) { $strings[] = self::makeLegacyWarning( $id ); } $out->addHTML( WrappedString::join( "\n", $strings ) ); return true; } private static function makeLegacyWarning( $id ) { $special = SpecialPage::getTitleFor( 'Gadgets' ); return ResourceLoader::makeInlineScript( Xml::encodeJsCall( 'mw.log.warn', [ "Gadget \"$id\" was not loaded. Please migrate it to use ResourceLoader. " . 'See <' . $special->getCanonicalURL() . '>.' ] ) ); } /** * Valid gadget definition page after content is modified * * @param IContextSource $context * @param Content $content * @param Status $status * @param string $summary * @throws Exception * @return bool * @suppress PhanUndeclaredMethod */ public static function onEditFilterMergedContent( $context, $content, $status, $summary ) { $title = $context->getTitle(); if ( !$title->inNamespace( NS_GADGET_DEFINITION ) ) { return true; } if ( !$content instanceof GadgetDefinitionContent ) { // This should not be possible? throw new Exception( "Tried to save non-GadgetDefinitionContent to {$title->getPrefixedText()}" ); } $status = $content->validate(); if ( !$status->isGood() ) { $status->merge( $status ); return false; } return true; } /** * After a new page is created in the Gadget definition namespace, * invalidate the list of gadget ids * * @param WikiPage $page */ public static function onPageContentInsertComplete( WikiPage $page ) { if ( $page->getTitle()->inNamespace( NS_GADGET_DEFINITION ) ) { GadgetRepo::singleton()->handlePageCreation( $page->getTitle() ); } } /** * Mark the Title as having a content model of javascript or css for pages * in the Gadget namespace based on their file extension * * @param Title $title * @param string &$model * @return bool */ public static function onContentHandlerDefaultModelFor( Title $title, &$model ) { if ( $title->inNamespace( NS_GADGET ) ) { preg_match( '!\.(css|js)$!u', $title->getText(), $ext ); $ext = isset( $ext[1] ) ? $ext[1] : ''; switch ( $ext ) { case 'js': $model = 'javascript'; return false; case 'css': $model = 'css'; return false; } } return true; } /** * Set the CodeEditor language for Gadget definition pages. It already * knows the language for Gadget: namespace pages. * * @param Title $title * @param string &$lang * @return bool */ public static function onCodeEditorGetPageLanguage( Title $title, &$lang ) { if ( $title->hasContentModel( 'GadgetDefinition' ) ) { $lang = 'json'; return false; } return true; } /** * Add the GadgetUsage special page to the list of QueryPages. * @param array &$queryPages * @return bool */ public static function onwgQueryPages( &$queryPages ) { $queryPages[] = [ 'SpecialGadgetUsage', 'GadgetUsage' ]; return true; } /** * Prevent gadget preferences from being deleted. * @link https://www.mediawiki.org/wiki/Manual:Hooks/DeleteUnknownPreferences * @suppress PhanParamTooMany * @param string[] &$where Array of where clause conditions to add to. * @param IDatabase $db */ public static function onDeleteUnknownPreferences( &$where, IDatabase $db ) { $where[] = 'up_property NOT' . $db->buildLike( 'gadget-', $db->anyString() ); } }