. * * @file * @ingroup extensions * @author Mark Holmquist * @copyright Copyright © 2013, Mark Holmquist */ namespace MediaWiki\Extension\MultimediaViewer; use CategoryPage; use Config; use ExtensionRegistry; use MediaWiki\Category\Category; use MediaWiki\Hook\BeforePageDisplayHook; use MediaWiki\Hook\MakeGlobalVariablesScriptHook; use MediaWiki\Hook\ThumbnailBeforeProduceHTMLHook; use MediaWiki\MediaWikiServices; use MediaWiki\Page\Hook\CategoryPageViewHook; use MediaWiki\Preferences\Hook\GetPreferencesHook; use MediaWiki\ResourceLoader\Hook\ResourceLoaderGetConfigVarsHook; use MediaWiki\User\Hook\UserGetDefaultOptionsHook; use MediaWiki\User\UserOptionsLookup; use OutputPage; use Skin; use ThumbnailImage; use User; class Hooks implements MakeGlobalVariablesScriptHook, UserGetDefaultOptionsHook, GetPreferencesHook, BeforePageDisplayHook, CategoryPageViewHook, ResourceLoaderGetConfigVarsHook, ThumbnailBeforeProduceHTMLHook { /** Link to more information about this module */ protected static $infoLink = 'https://mediawiki.org/wiki/Special:MyLanguage/Extension:Media_Viewer/About'; /** Link to a page where this module can be discussed */ protected static $discussionLink = 'https://mediawiki.org/wiki/Special:MyLanguage/Extension_talk:Media_Viewer/About'; /** Link to help about this module */ protected static $helpLink = 'https://mediawiki.org/wiki/Special:MyLanguage/Help:Extension:Media_Viewer'; /** * @var UserOptionsLookup */ private $userOptionsLookup; /** * @param UserOptionsLookup $userOptionsLookup */ public function __construct( UserOptionsLookup $userOptionsLookup ) { $this->userOptionsLookup = $userOptionsLookup; } /** * @see https://www.mediawiki.org/wiki/Manual:Hooks/UserGetDefaultOptions * @param array &$defaultOptions */ public function onUserGetDefaultOptions( &$defaultOptions ) { global $wgMediaViewerEnableByDefault; if ( $wgMediaViewerEnableByDefault ) { $defaultOptions['multimediaviewer-enable'] = 1; } } /** * Checks the context for whether to load the viewer. * @param User $performer * @return bool */ protected function shouldHandleClicks( User $performer ): bool { global $wgMediaViewerEnableByDefaultForAnonymous, $wgMediaViewerEnableByDefault; if ( $performer->isNamed() ) { return (bool)$this->userOptionsLookup->getOption( $performer, 'multimediaviewer-enable' ); } return (bool)( $wgMediaViewerEnableByDefaultForAnonymous ?? $wgMediaViewerEnableByDefault ); } /** * Handler for all places where we add the modules * Could be on article pages or on Category pages * @param OutputPage $out */ protected static function getModules( OutputPage $out ) { // The MobileFrontend extension provides its own implementation of MultimediaViewer. // See https://phabricator.wikimedia.org/T65504 and subtasks for more details. // To avoid loading MMV twice, we check the environment we are running in. $isMobileFrontendView = ExtensionRegistry::getInstance()->isLoaded( 'MobileFrontend' ) && MediaWikiServices::getInstance()->getService( 'MobileFrontend.Context' ) ->shouldDisplayMobileView(); if ( !$isMobileFrontendView ) { $out->addModules( [ 'mmv.head', 'mmv.bootstrap.autostart' ] ); } } /** * @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay * Add JavaScript to the page when an image is on it * and the user has enabled the feature * @param OutputPage $out * @param Skin $skin */ public function onBeforePageDisplay( $out, $skin ): void { $pageHasThumbnails = count( $out->getFileSearchOptions() ) > 0; $pageIsFilePage = $out->getTitle()->inNamespace( NS_FILE ); // TODO: Have Flow work out if there are any images on the page $pageIsFlowPage = ExtensionRegistry::getInstance()->isLoaded( 'Flow' ) && // CONTENT_MODEL_FLOW_BOARD $out->getTitle()->getContentModel() === 'flow-board'; $fileRelatedSpecialPages = [ 'NewFiles', 'ListFiles', 'MostLinkedFiles', 'MostGloballyLinkedFiles', 'UncategorizedFiles', 'UnusedFiles', 'Search' ]; $fileRelatedSpecialPagesLocalNames = array_map( static function ( $name ) { return \Title::newFromText( $name, NS_SPECIAL )->fixSpecialName()->getText(); }, $fileRelatedSpecialPages ); $pageIsFileRelatedSpecialPage = $out->getTitle()->inNamespace( NS_SPECIAL ) && in_array( $out->getTitle()->fixSpecialName()->getText(), $fileRelatedSpecialPagesLocalNames ); if ( $pageHasThumbnails || $pageIsFilePage || $pageIsFileRelatedSpecialPage || $pageIsFlowPage ) { self::getModules( $out ); } } /** * @see https://www.mediawiki.org/wiki/Manual:Hooks/CategoryPageView * Add JavaScript to the page if there are images in the category * @param CategoryPage $catPage */ public function onCategoryPageView( $catPage ) { $title = $catPage->getTitle(); $cat = Category::newFromTitle( $title ); if ( $cat->getFileCount() > 0 ) { $out = $catPage->getContext()->getOutput(); self::getModules( $out ); } } /** * @see https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences * Adds a default-enabled preference to gate the feature * @param User $user * @param array &$prefs */ public function onGetPreferences( $user, &$prefs ) { $prefs['multimediaviewer-enable'] = [ 'type' => 'toggle', 'label-message' => 'multimediaviewer-optin-pref', 'section' => 'rendering/files', ]; } /** * @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderGetConfigVars * Export variables used in both PHP and JS to keep DRY * @param array &$vars * @param string $skin * @param Config $config */ public function onResourceLoaderGetConfigVars( array &$vars, $skin, Config $config ): void { global $wgMediaViewerUseThumbnailGuessing, $wgMediaViewerExtensions, $wgMediaViewerImageQueryParameter, $wgMediaViewerRecordVirtualViewBeaconURI; $vars['wgMultimediaViewer'] = [ 'infoLink' => self::$infoLink, 'discussionLink' => self::$discussionLink, 'helpLink' => self::$helpLink, 'useThumbnailGuessing' => (bool)$wgMediaViewerUseThumbnailGuessing, 'imageQueryParameter' => $wgMediaViewerImageQueryParameter, 'recordVirtualViewBeaconURI' => $wgMediaViewerRecordVirtualViewBeaconURI, 'extensions' => $wgMediaViewerExtensions, ]; $vars['wgMediaViewer'] = true; } /** * @see https://www.mediawiki.org/wiki/Manual:Hooks/MakeGlobalVariablesScript * Export variables which depend on the current user * @param array &$vars * @param OutputPage $out * @return void */ public function onMakeGlobalVariablesScript( &$vars, $out ): void { $isMultimediaViewerEnable = $this->userOptionsLookup->getDefaultOption( 'multimediaviewer-enable' ); $user = $out->getUser(); $vars['wgMediaViewerOnClick'] = $this->shouldHandleClicks( $user ); // needed because of T71942; could be different for anon and logged-in $vars['wgMediaViewerEnabledByDefault'] = (bool)$isMultimediaViewerEnable; } /** * @see https://www.mediawiki.org/wiki/Manual:Hooks/ThumbnailBeforeProduceHTML * Modify thumbnail DOM * @param ThumbnailImage $thumbnail * @param array &$attribs Attributes of the element * @param array|bool &$linkAttribs Attributes of the wrapping element */ public function onThumbnailBeforeProduceHTML( $thumbnail, &$attribs, &$linkAttribs ) { $file = $thumbnail->getFile(); if ( $file ) { $attribs['data-file-width'] = $file->getWidth(); $attribs['data-file-height'] = $file->getHeight(); } } }