genderCache = $genderCache; $this->linkRenderer = $linkRenderer; $this->namespaceInfo = $namespaceInfo; $this->revisionLookup = $revisionLookup; $this->userOptionsManager = $userOptionsManager; } /** * @return SkinOptions */ private function getSkinOptions() { if ( !$this->skinOptions ) { $this->skinOptions = MediaWikiServices::getInstance()->getService( 'Minerva.SkinOptions' ); } return $this->skinOptions; } /** * @return bool */ private function hasPageActions() { $title = $this->getTitle(); return !$title->isSpecialPage() && !$title->isMainPage() && $this->getContext()->getActionName() === 'view'; } /** * @return bool */ private function hasSecondaryActions() { return !$this->getUserPageHelper()->isUserPage(); } /** * @return bool */ private function isFallbackEditor() { $action = $this->getContext()->getActionName(); return $action === 'edit'; } /** * Returns available page actions if the page has any. * * @param array $nav result of SkinTemplate::buildContentNavigationUrls * @return array|null */ private function getPageActions( array $nav ) { if ( $this->isFallbackEditor() || !$this->hasPageActions() ) { return null; } $services = MediaWikiServices::getInstance(); /** @var PageActionsDirector $pageActionsDirector */ $pageActionsDirector = $services->getService( 'Minerva.Menu.PageActionsDirector' ); $sidebar = $this->buildSidebar(); $actions = $nav['actions'] ?? []; $views = $nav['views'] ?? []; return $pageActionsDirector->buildMenu( $sidebar['TOOLBOX'], $actions, $views ); } /** * A notification icon that links to Special:Mytalk when Echo is not installed. * Consider upstreaming this to core or removing at a future date. * * @return array */ private function getNotificationFallbackButton() { return [ 'icon' => 'bellOutline-base20', 'href' => SpecialPage::getTitleFor( 'Mytalk' )->getLocalURL( [ 'returnto' => $this->getTitle()->getPrefixedText() ] ), ]; } /** * @param array $alert * @param array $notice * @return array */ private function getCombinedNotificationButton( array $alert, array $notice ) { // Sum the notifications from the two original buttons $notifCount = ( $alert['data']['counter-num'] ?? 0 ) + ( $notice['data']['counter-num'] ?? 0 ); $alert['data']['counter-num'] = $notifCount; // @phan-suppress-next-line PhanUndeclaredClassReference if ( class_exists( NotificationController::class ) ) { // @phan-suppress-next-line PhanUndeclaredClassMethod $alert['data']['counter-text'] = NotificationController::formatNotificationCount( $notifCount ); } else { $alert['data']['counter-text'] = $notifCount; } $linkClassAlert = $alert['link-class'] ?? []; $hasUnseenAlerts = is_array( $linkClassAlert ) && in_array( 'mw-echo-unseen-notifications', $linkClassAlert ); // The circle should only appear if there are unseen notifications. // Once the notifications are seen (by opening the notification drawer) // then the icon reverts to a gray circle, but on page refresh // it should revert back to a bell icon. // If you try and change this behaviour, at time of writing // (December 2022) JavaScript will correct it. if ( $notifCount > 0 && $hasUnseenAlerts ) { $linkClass = $notice['link-class'] ?? []; $hasUnseenNotices = is_array( $linkClass ) && in_array( 'mw-echo-unseen-notifications', $linkClass ); return $this->getNotificationCircleButton( $alert, $hasUnseenNotices ); } else { return $this->getNotificationButton( $alert ); } } /** * Minerva differs from other skins in that for users with unread notifications * instead of a bell with a small square indicating the number of notifications * it shows a red circle with a number inside. Ideally Vector and Minerva would * be treated the same but we'd need to talk to a designer about consolidating these * before making such a decision. * * @param array $alert * @param bool $hasUnseenNotices does the user have unseen notices? * @return array */ private function getNotificationCircleButton( array $alert, bool $hasUnseenNotices ) { $alertCount = $alert['data']['counter-num'] ?? 0; $linkClass = $alert['link-class'] ?? []; $hasSeenAlerts = is_array( $linkClass ) && in_array( 'mw-echo-unseen-notifications', $linkClass ); $alertText = $alert['data']['counter-text'] ?? $alertCount; $alert['icon'] = 'circle'; $alert['class'] = 'notification-count'; if ( $hasSeenAlerts || $hasUnseenNotices ) { $alert['class'] .= ' notification-unseen mw-echo-unseen-notifications'; } return $alert; } /** * Removes the OOUI icon class and adds Minerva notification classes. * * @param array $alert * @return array */ private function getNotificationButton( array $alert ) { $linkClass = $alert['link-class']; $alert['link-class'] = array_filter( $linkClass, static function ( $class ) { return $class !== 'oo-ui-icon-bellOutline'; } ); $alert['icon'] = 'bellOutline-base20'; return $alert; } /** * Caches content navigation urls locally for use inside getTemplateData * * @inheritDoc */ protected function runOnSkinTemplateNavigationHooks( SkinTemplate $skin, &$contentNavigationUrls ) { parent::runOnSkinTemplateNavigationHooks( $skin, $contentNavigationUrls ); // There are some SkinTemplate modifications that occur after the execution of this hook // to add rel attributes and ID attributes. // The only one Minerva needs is this one so we manually add it. foreach ( array_keys( $contentNavigationUrls['associated-pages'] ) as $id ) { if ( in_array( $id, [ 'user_talk', 'talk' ] ) ) { $contentNavigationUrls['associated-pages'][ $id ]['rel'] = 'discussion'; } } $skinOptions = $this->getSkinOptions(); $this->contentNavigationUrls = $contentNavigationUrls; // // Echo Technical debt!! // * Convert the Echo button into a single button // * Switch out the icon. // if ( $this->getUser()->isRegistered() ) { if ( count( $contentNavigationUrls['notifications'] ) === 0 ) { // Shown to logged in users when Echo is not installed: $contentNavigationUrls['notifications']['mytalks'] = $this->getNotificationFallbackButton(); } elseif ( $skinOptions->get( SkinOptions::SINGLE_ECHO_BUTTON ) ) { // Combine notification icons. Minerva only shows one entry point to notifications. // This can be reconsidered with a solution to https://phabricator.wikimedia.org/T142981 $alert = $contentNavigationUrls['notifications']['notifications-alert'] ?? null; $notice = $contentNavigationUrls['notifications']['notifications-notice'] ?? null; if ( $alert && $notice ) { unset( $contentNavigationUrls['notifications']['notifications-notice'] ); $contentNavigationUrls['notifications']['notifications-alert'] = $this->getCombinedNotificationButton( $alert, $notice ); } } else { // Show desktop alert icon. $alert = $contentNavigationUrls['notifications']['notifications-alert'] ?? null; if ( $alert ) { // Correct the icon to be the bell filled rather than the outline to match // Echo's badge. $linkClass = $alert['link-class'] ?? []; $alert['link-class'] = array_filter( $linkClass, static function ( $class ) { return $class !== 'oo-ui-icon-bellOutline'; } ); $contentNavigationUrls['notifications']['notifications-alert'] = $alert; } } } } /** * @inheritDoc */ public function getTemplateData(): array { $data = parent::getTemplateData(); $skinOptions = $this->getSkinOptions(); // FIXME: Can we use $data instead of calling buildContentNavigationUrls ? $nav = $this->contentNavigationUrls; if ( $nav === null ) { throw new RuntimeException( 'contentNavigationUrls was not set as expected.' ); } if ( !$this->hasCategoryLinks() ) { unset( $data['html-categories'] ); } // Special handling for certain pages. // This is technical debt that should be upstreamed to core. $isUserPage = $this->getUserPageHelper()->isUserPage(); $isUserPageAccessible = $this->getUserPageHelper()->isUserPageAccessibleToCurrentUser(); if ( $isUserPage && $isUserPageAccessible ) { $data['html-title-heading'] = $this->getUserPageHeadingHtml( $data['html-title-heading' ] ); } $usermessage = $data['html-user-message'] ?? ''; if ( $usermessage ) { $data['html-user-message'] = Html::warningBox( ' ' . $usermessage, 'minerva-anon-talk-message' ); } $allLanguages = $data['data-portlets']['data-languages']['array-items'] ?? []; $allVariants = $data['data-portlets']['data-variants']['array-items'] ?? []; $notifications = $data['data-portlets']['data-notifications']['array-items'] ?? []; $associatedPages = $data['data-portlets']['data-associated-pages'] ?? []; return $data + [ 'has-minerva-languages' => $allLanguages || $allVariants, 'array-minerva-banners' => $this->prepareBanners( $data['html-site-notice'] ), 'data-minerva-search-box' => $data['data-search-box'] + [ 'data-btn' => [ 'data-icon' => [ 'icon' => 'search-base20', ], 'label' => $this->msg( 'searchbutton' )->escaped(), 'classes' => 'skin-minerva-search-trigger', 'array-attributes' => [ [ 'key' => 'id', 'value' => 'searchIcon', ] ] ], ], 'data-minerva-main-menu-btn' => [ 'data-icon' => [ 'icon' => 'menu-base20', ], 'tag-name' => 'label', 'classes' => 'toggle-list__toggle', 'array-attributes' => [ [ 'key' => 'for', 'value' => 'main-menu-input', ], [ 'key' => 'id', 'value' => 'mw-mf-main-menu-button', ], [ 'key' => 'aria-hidden', 'value' => 'true', ], [ 'key' => 'data-event-name', 'value' => 'ui.mainmenu', ], ], 'text' => $this->msg( 'mobile-frontend-main-menu-button-tooltip' )->escaped(), ], 'data-minerva-main-menu' => $this->getMainMenu()->getMenuData( $nav, $this->buildSidebar() )['items'], 'html-minerva-tagline' => $this->getTaglineHtml(), 'html-minerva-user-menu' => $this->getPersonalToolsMenu( $nav['user-menu'] ), 'is-minerva-beta' => $this->getSkinOptions()->get( SkinOptions::BETA_MODE ), 'data-minerva-notifications' => $notifications ? [ 'array-buttons' => $this->getNotificationButtons( $notifications ), ] : null, 'data-minerva-tabs' => $this->getTabsData( $nav, $associatedPages ), 'data-minerva-page-actions' => $this->getPageActions( $nav ), 'data-minerva-secondary-actions' => $this->getSecondaryActions( $nav ), 'html-minerva-subject-link' => $this->getSubjectPage(), 'data-minerva-history-link' => $this->getHistoryLink( $this->getTitle() ), ]; } /** * Prepares the notification badges for the Button template. * * @internal * @param array $notifications * @return array */ public static function getNotificationButtons( array $notifications ) { $btns = []; foreach ( $notifications as $notification ) { $linkData = $notification['array-links'][ 0 ] ?? []; $icon = $linkData['icon'] ?? null; if ( !$icon ) { continue; } $id = $notification['id'] ?? null; $classes = ''; $attributes = []; // We don't want to output multiple attributes. // Iterate through the attributes and pull out ID and class which // will be defined separately. foreach ( $linkData[ 'array-attributes' ] as $keyValuePair ) { if ( $keyValuePair['key'] === 'class' ) { $classes = $keyValuePair['value']; } elseif ( $keyValuePair['key'] === 'id' ) { // ignore. We want to use the LI `id` instead. } else { $attributes[] = $keyValuePair; } } // add LI ID to end for use on the button. if ( $id ) { $attributes[] = [ 'key' => 'id', 'value' => $id, ]; } $btns[] = [ 'tag-name' => 'a', // FIXME: Move preg_replace when Echo no longer provides this class. 'classes' => preg_replace( '/oo-ui-icon-(bellOutline|tray)/', '', $classes ), 'array-attributes' => $attributes, 'data-icon' => [ 'icon' => $icon, ], 'label' => $linkData['text'] ?? '', ]; } return $btns; } private function isHistoryPage() { return $this->getRequest()->getText( 'action' ) === 'history'; } /** * Tabs are available if a page has page actions but is not the talk page of * the main page. * * Special pages have tabs if SkinOptions::TABS_ON_SPECIALS is enabled. * This is used by Extension:GrowthExperiments * * @return bool */ private function hasPageTabs() { $title = $this->getTitle(); $skinOptions = $this->getSkinOptions(); $isSpecialPageOrHistory = $title->isSpecialPage() || $this->isHistoryPage(); $subjectPage = $this->namespaceInfo->getSubjectPage( $title ); $isMainPageTalk = Title::newFromLinkTarget( $subjectPage )->isMainPage(); return ( $this->hasPageActions() && !$isMainPageTalk && $skinOptions->get( SkinOptions::TALK_AT_TOP ) ) || ( $isSpecialPageOrHistory && $skinOptions->get( SkinOptions::TABS_ON_SPECIALS ) ); } /** * @param array $contentNavigationUrls * @param array $associatedPages - data-associated-pages from template data, currently only used for ID * @return array */ private function getTabsData( array $contentNavigationUrls, array $associatedPages ) { $hasPageTabs = $this->hasPageTabs(); if ( !$hasPageTabs ) { return []; } return $contentNavigationUrls ? [ 'items' => array_values( $contentNavigationUrls['associated-pages'] ), 'id' => $associatedPages['id'] ?? null, ] : []; } /** * Lazy load the permissions object. We don't want to initialize it as it requires many * dependencies, sometimes some of those dependencies cannot be fulfilled (like missing Title * object) * @return IMinervaPagePermissions */ private function getPermissions(): IMinervaPagePermissions { if ( $this->permissions === null ) { $this->permissions = MediaWikiServices::getInstance() ->getService( 'Minerva.Permissions' ) ->setContext( $this->getContext() ); } return $this->permissions; } /** * Initalized main menu. Please use getter. * @var MainMenuDirector */ private $mainMenu; /** * Build the Main Menu Director by passing the skin options * * @return MainMenuDirector */ protected function getMainMenu(): MainMenuDirector { if ( !$this->mainMenu ) { $this->mainMenu = MediaWikiServices::getInstance()->getService( 'Minerva.Menu.MainDirector' ); } return $this->mainMenu; } /** * Prepare all Minerva menus * * @param array $personalUrls result of SkinTemplate::buildPersonalUrls * @return string|null */ private function getPersonalToolsMenu( array $personalUrls ) { $services = MediaWikiServices::getInstance(); /** @var UserMenuDirector $userMenuDirector */ $userMenuDirector = $services->getService( 'Minerva.Menu.UserMenuDirector' ); return $userMenuDirector->renderMenuData( $personalUrls ); } /** * @return string */ protected function getSubjectPage() { $title = $this->getTitle(); $skinOptions = $this->getSkinOptions(); // If it's a talk page, add a link to the main namespace page // In AMC we do not need to do this as there is an easy way back to the article page // via the talk/article tabs. if ( $title->isTalkPage() && !$skinOptions->get( SkinOptions::TALK_AT_TOP ) ) { // if it's a talk page for which we have a special message, use it switch ( $title->getNamespace() ) { case NS_USER_TALK: $msg = 'mobile-frontend-talk-back-to-userpage'; break; case NS_PROJECT_TALK: $msg = 'mobile-frontend-talk-back-to-projectpage'; break; case NS_FILE_TALK: $msg = 'mobile-frontend-talk-back-to-filepage'; break; default: // generic (all other NS) $msg = 'mobile-frontend-talk-back-to-page'; } $subjectPage = $this->namespaceInfo->getSubjectPage( $title ); return $this->linkRenderer->makeLink( $subjectPage, $this->msg( $msg, $title->getText() )->text(), [ 'data-event-name' => 'talk.returnto', 'class' => 'return-link' ] ); } else { return ''; } } /** * Modifies the template data before parsing in SkinMustache. * * @inheritDoc */ final protected function doEditSectionLinksHTML( array $links, Language $lang ) { $transformedLinks = []; foreach ( $links as $key => $link ) { $transformedLinks[] = $link + [ 'data-icon' => [ 'icon' => $link['icon'], ], ]; } return parent::doEditSectionLinksHTML( $transformedLinks, $lang ); } /** * Takes a title and returns classes to apply to the body tag * @param Title $title * @return string */ public function getPageClasses( $title ) { $skinOptions = $this->getSkinOptions(); $className = parent::getPageClasses( $title ); $className .= ' ' . ( $skinOptions->get( SkinOptions::BETA_MODE ) ? 'beta' : 'stable' ); if ( $title->isMainPage() ) { $className .= ' page-Main_Page '; } if ( $this->getUser()->isRegistered() ) { $className .= ' is-authenticated'; } // The new treatment should only apply to the main namespace if ( $title->getNamespace() === NS_MAIN && $skinOptions->get( SkinOptions::PAGE_ISSUES ) ) { $className .= ' issues-group-B'; } return $className; } /** * Provides skin-specific modifications to the HTML element attributes * * Currently only used for adding the night mode class * * @return array */ public function getHtmlElementAttributes() { $attributes = parent::getHtmlElementAttributes(); $skinOptions = $this->getSkinOptions(); // check to see if night mode is enabled via query params or by config $webRequest = $this->getContext()->getRequest(); $forceNightMode = $webRequest->getIntOrNull( 'minervanightmode' ); // get skin config of night mode to check what is execluded $nightModeConfig = $this->getConfig()->get( 'MinervaNightModeOptions' ); $featuresHelper = new FeaturesHelper(); $shouldDisableNightMode = $featuresHelper->shouldDisableNightMode( $nightModeConfig, $webRequest, $this->getContext()->getTitle() ); if ( $skinOptions->get( SkinOptions::NIGHT_MODE ) || $forceNightMode !== null ) { $user = $this->getUser(); $value = $this->userOptionsManager->getOption( $user, 'minerva-night-mode' ); // if forcing a (valid) setting via query params, take priority over the user option if ( $forceNightMode !== null && in_array( $forceNightMode, [ 0, 1, 2 ] ) ) { $value = $forceNightMode; } // For T356653 add a class to the page to allow the client to detect we've // intentionally disabled night mode. if ( $shouldDisableNightMode ) { $attributes[ 'class' ] .= ' skin-night-mode-page-disabled'; return $attributes; } $attributes[ 'class' ] .= " skin-night-mode-clientpref-$value"; } return $attributes; } /** * Whether the output page contains category links and the category feature is enabled. * @return bool */ private function hasCategoryLinks() { $skinOptions = $this->getSkinOptions(); if ( !$skinOptions->get( SkinOptions::CATEGORIES ) ) { return false; } $categoryLinks = $this->getOutput()->getCategoryLinks(); if ( !count( $categoryLinks ) ) { return false; } return !empty( $categoryLinks['normal'] ) || !empty( $categoryLinks['hidden'] ); } /** * @return SkinUserPageHelper */ public function getUserPageHelper() { return MediaWikiServices::getInstance()->getService( 'Minerva.SkinUserPageHelper' ); } /** * Get a history link which describes author and relative time of last edit * @param Title $title The Title object of the page being viewed * @param string $timestamp * @return array */ protected function getRelativeHistoryLink( Title $title, $timestamp ) { $user = $this->getUser(); $userDate = $this->getLanguage()->userDate( $timestamp, $user ); $text = $this->msg( 'minerva-last-modified-date', $userDate, $this->getLanguage()->userTime( $timestamp, $user ) )->parse(); return [ // Use $edit['timestamp'] (Unix format) instead of $timestamp (MW format) 'data-timestamp' => wfTimestamp( TS_UNIX, $timestamp ), 'href' => $this->getHistoryUrl( $title ), 'text' => $text, ] + $this->getRevisionEditorData( $title ); } /** * Get a history link which makes no reference to user or last edited time * @param Title $title The Title object of the page being viewed * @return array */ protected function getGenericHistoryLink( Title $title ) { $text = $this->msg( 'mobile-frontend-history' )->plain(); return [ 'href' => $this->getHistoryUrl( $title ), 'text' => $text, ]; } /** * Checks if the Special:History page is being used. * @param Title $title The Title object of the page being viewed * @return bool */ private function shouldUseSpecialHistory( Title $title ) { return ExtensionRegistry::getInstance()->isLoaded( 'MobileFrontend' ) && SpecialMobileHistory::shouldUseSpecialHistory( $title, $this->getUser() ); } /** * Get the URL for the history page for the given title using Special:History * when available. * @param Title $title The Title object of the page being viewed * @return string */ protected function getHistoryUrl( Title $title ) { return $this->shouldUseSpecialHistory( $title ) ? SpecialPage::getTitleFor( 'History', $title )->getLocalURL() : $title->getLocalURL( [ 'action' => 'history' ] ); } /** * Prepare the content for the 'last edited' message, e.g. 'Last edited on 30 August * 2013, at 23:31'. This message is different for the main page since main page * content is typically transcluded rather than edited directly. * * The relative time is only rendered on the latest revision. * For older revisions the last modified information will not render with a relative time * nor will it show the name of the editor. * @param Title $title The Title object of the page being viewed * @return array|null */ protected function getHistoryLink( Title $title ) { if ( !$title->exists() || $this->getContext()->getActionName() !== 'view' ) { return null; } // Do not show the last modified bar on diff pages [T350515] $request = $this->getRequest(); if ( $request->getText( 'diff' ) ) { return null; } $out = $this->getOutput(); if ( !$out->getRevisionId() || !$out->isRevisionCurrent() || $title->isMainPage() ) { $historyLink = $this->getGenericHistoryLink( $title ); } else { // Get rev_timestamp of current revision (preloaded by MediaWiki core) $timestamp = $out->getRevisionTimestamp(); if ( !$timestamp ) { # No cached timestamp, load it from the database $timestamp = $this->revisionLookup->getTimestampFromId( $out->getRevisionId() ); } $historyLink = $this->getRelativeHistoryLink( $title, $timestamp ); } return $historyLink + [ 'historyIcon' => [ 'icon' => 'modified-history', 'size' => 'medium' ], 'arrowIcon' => [ 'icon' => 'expand', 'size' => 'small' ] ]; } /** * Returns data attributes representing the editor for the current revision. * @param LinkTarget $title The Title object of the page being viewed * @return array representing user with name and gender fields. Empty if the editor no longer * exists in the database or is hidden from public view. */ private function getRevisionEditorData( LinkTarget $title ) { $rev = $this->revisionLookup->getRevisionByTitle( $title ); $result = []; if ( $rev ) { $revUser = $rev->getUser(); // Note the user will only be returned if that information is public if ( $revUser ) { $editorName = $revUser->getName(); $editorGender = $this->genderCache->getGenderOf( $revUser, __METHOD__ ); $result += [ 'data-user-name' => $editorName, 'data-user-gender' => $editorGender, ]; } } return $result; } /** * Returns the HTML representing the tagline * @return string HTML for tagline */ protected function getTaglineHtml() { $tagline = ''; if ( $this->getUserPageHelper()->isUserPage() ) { $pageUser = $this->getUserPageHelper()->getPageUser(); $fromDate = $pageUser->getRegistration(); if ( $this->getUserPageHelper()->isUserPageAccessibleToCurrentUser() && is_string( $fromDate ) ) { $fromDateTs = wfTimestamp( TS_UNIX, $fromDate ); // This is shown when js is disabled. js enhancement made due to caching $tagline = $this->msg( 'mobile-frontend-user-page-member-since', $this->getLanguage()->userDate( new MWTimestamp( $fromDateTs ), $this->getUser() ), $pageUser )->text(); // Define html attributes for usage with js enhancement (unix timestamp, gender) $attrs = [ 'id' => 'tagline-userpage', 'data-userpage-registration-date' => $fromDateTs, 'data-userpage-gender' => $this->genderCache->getGenderOf( $pageUser, __METHOD__ ) ]; } } else { $title = $this->getTitle(); if ( $title ) { $out = $this->getOutput(); $tagline = $out->getProperty( 'wgMFDescription' ); } } $attrs[ 'class' ] = 'tagline'; return Html::element( 'div', $attrs, $tagline ); } /** * Returns the HTML representing the heading. * * @param string $heading The heading suggested by core. * @return string HTML for header */ private function getUserPageHeadingHtml( $heading ) { // The heading is just the username without namespace // This is escaped as a precaution (user name should be safe). return Html::rawElement( 'h1', // These IDs and classes should match Skin::getTemplateData [ 'id' => 'firstHeading', 'class' => 'firstHeading mw-first-heading mw-minerva-user-heading', ], htmlspecialchars( $this->getUserPageHelper()->getPageUser()->getName() ) ); } /** * Load internal banner content to show in pre content in template * Beware of HTML caching when using this function. * Content set as "internalbanner" * @param string $siteNotice HTML fragment * @return array */ protected function prepareBanners( $siteNotice ) { $banners = []; if ( $siteNotice && $this->getConfig()->get( 'MinervaEnableSiteNotice' ) ) { $banners[] = '