. * * @file * @ingroup extensions */ use MediaWiki\Logger\LoggerFactory; class PopupsHooks { const PREVIEWS_ENABLED = 'enabled'; const PREVIEWS_DISABLED = 'disabled'; const PREVIEWS_OPTIN_PREFERENCE_NAME = 'popups-enable'; const PREVIEWS_PREFERENCES_SECTION = 'rendering/reading'; static function getPreferences( User $user, array &$prefs ) { global $wgExtensionAssetsPath; if ( self::getConfig()->get( 'PopupsBetaFeature' ) !== true ) { return; } $prefs['popups'] = [ 'label-message' => 'popups-message', 'desc-message' => 'popups-desc', 'screenshot' => [ 'ltr' => "$wgExtensionAssetsPath/Popups/images/popups-ltr.svg", 'rtl' => "$wgExtensionAssetsPath/Popups/images/popups-rtl.svg", ], 'info-link' => 'https://www.mediawiki.org/wiki/Beta_Features/Hovercards', 'discussion-link' => 'https://www.mediawiki.org/wiki/Talk:Beta_Features/Hovercards', 'requirements' => [ 'javascript' => true, ], ]; } /** * Add Page Previews options to user Preferences page * * @param User $user * @param array $prefs */ static function onGetPreferences( User $user, array &$prefs ) { $module = new \Popups\Module( self::getConfig() ); if ( !$module->showPreviewsOptInOnPreferencesPage() ) { return; } $prefs[self::PREVIEWS_OPTIN_PREFERENCE_NAME] = [ 'type' => 'radio', 'label-message' => 'popups-prefs-optin-title', 'options' => [ wfMessage( 'popups-prefs-optin-enabled-label' )->text() => self::PREVIEWS_ENABLED, wfMessage( 'popups-prefs-optin-disabled-label' )->text() => self::PREVIEWS_DISABLED ], 'section' => self::PREVIEWS_PREFERENCES_SECTION ]; } /** * @return Config */ public static function getConfig() { static $config; if ( !$config ) { $config = ConfigFactory::getDefaultInstance()->makeConfig( 'popups' ); } return $config; } public static function onBeforePageDisplay( OutputPage &$out, Skin &$skin ) { // Enable only if the user has turned it on in Beta Preferences, or BetaFeatures is not installed. // Will only be loaded if PageImages & TextExtracts extensions are installed. $registry = ExtensionRegistry::getInstance(); if ( !$registry->isLoaded( 'TextExtracts' ) || !class_exists( 'ApiQueryPageImages' ) ) { $logger = LoggerFactory::getInstance( 'popups' ); $logger->error( 'Popups requires the PageImages and TextExtracts extensions.' ); return true; } $config = self::getConfig(); $isExperimentEnabled = $config->get( 'PopupsExperiment' ); if ( // If Popups are enabled as an experiment, then bypass checking whether the user has enabled // it as a beta feature. !$isExperimentEnabled && $config->get( 'PopupsBetaFeature' ) === true ) { if ( !class_exists( 'BetaFeatures' ) ) { $logger = LoggerFactory::getInstance( 'popups' ); $logger->error( 'PopupsMode cannot be used as a beta feature unless ' . 'the BetaFeatures extension is present.' ); return true; } if ( !BetaFeatures::isFeatureEnabled( $skin->getUser(), 'popups' ) ) { return true; } } $out->addModules( [ 'ext.popups' ] ); return true; } /** * @param array &$testModules * @param ResourceLoader $resourceLoader * @return bool */ public static function onResourceLoaderTestModules( array &$testModules, ResourceLoader &$resourceLoader ) { $localBasePath = __DIR__; $scripts = glob( "{$localBasePath}/tests/qunit/ext.popups/{,**/}*.test.js", GLOB_BRACE ); $start = strlen( $localBasePath ) + 1; $scripts = array_map( function ( $script ) use ( $start ) { return substr( $script, $start ); }, $scripts ); $testModules['qunit']['ext.popups.tests.stubs'] = [ 'scripts' => [ 'tests/qunit/ext.popups/stubs/index.js', 'tests/qunit/ext.popups/stubs/user.js', ], 'dependencies' => [ 'ext.popups', // The mw.popups is required. ], 'localBasePath' => __DIR__, 'remoteExtPath' => 'Popups', ]; $testModules['qunit']['ext.popups.tests'] = [ 'scripts' => $scripts, 'dependencies' => [ 'ext.popups', 'ext.popups.tests.stubs', ], 'localBasePath' => __DIR__, 'remoteExtPath' => 'Popups', ]; } /** * @param array $vars */ public static function onResourceLoaderGetConfigVars( array &$vars ) { $conf = self::getConfig(); $vars['wgPopupsSchemaPopupsSamplingRate'] = $conf->get( 'SchemaPopupsSamplingRate' ); if ( $conf->get( 'PopupsExperiment' ) ) { $vars['wgPopupsExperiment'] = true; $vars['wgPopupsExperimentConfig'] = $conf->get( 'PopupsExperimentConfig' ); } } /** * MakeGlobalVariablesScript hook handler. * * @see https://www.mediawiki.org/wiki/Manual:Hooks/MakeGlobalVariablesScript * * @param array $vars * @param OutputPage $out */ public static function onMakeGlobalVariablesScript( array &$vars, OutputPage $out ) { $config = self::getConfig(); $user = $out->getUser(); if ( $config->get( 'PopupsExperiment' ) ) { $vars['wgPopupsExperimentIsBetaFeatureEnabled'] = class_exists( 'BetaFeatures' ) && BetaFeatures::isFeatureEnabled( $user, 'popups' ); } } /** * Register default preferences for popups */ public static function onExtensionRegistration() { global $wgDefaultUserOptions; /** * We use MainConfig because PopupConfig is not available yet. We cannot use * ExtensionFunctions as it's called too late (see T153280) * * @todo Use ConfigFactory() - when T153280 gets fixed switch it to ExtensionFunctions hook * or when ConfigRegistry gets populated before calling `callback` ExtensionRegistry hook */ $config = \MediaWiki\MediaWikiServices::getInstance()->getMainConfig(); $wgDefaultUserOptions[ self::PREVIEWS_OPTIN_PREFERENCE_NAME ] = $config->get( 'PopupsOptInDefaultState' ); } }