getConfig() ); } /** * @return QuickTemplate */ protected function setupTemplateForOutput() { $this->setupTemplateContext(); $tpl = $this->setupTemplate( $this->template ); return $tpl; } /** * Setup class properties that are necessary prior to calling * setupTemplateForOutput. It must be called inside * prepareQuickTemplate. * This function may set local class properties that will be used * by other methods, but should not make assumptions about the * implementation of setupTemplateForOutput * @since 1.35 */ final protected function setupTemplateContext() { $request = $this->getRequest(); $user = $this->getUser(); $title = $this->getTitle(); $this->thispage = $title->getPrefixedDBkey(); $this->titletxt = $title->getPrefixedText(); $this->userpage = $user->getUserPage()->getPrefixedText(); $query = []; if ( !$request->wasPosted() ) { $query = $request->getValues(); unset( $query['title'] ); unset( $query['returnto'] ); unset( $query['returntoquery'] ); } $this->thisquery = wfArrayToCgi( $query ); $this->loggedin = $user->isLoggedIn(); $this->username = $user->getName(); if ( $this->loggedin ) { $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage ); } else { # This won't be used in the standard skins, but we define it to preserve the interface # To save time, we check for existence $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage ); } } /** * Subclasses not wishing to use the QuickTemplate * render method can rewrite this method, for example to use * TemplateParser::processTemplate * @since 1.35 * @return string of complete document HTML to output to the page * which includes `` and opening and closing html tags. */ public function generateHTML() { $tpl = $this->prepareQuickTemplate(); // execute template return $tpl->execute(); } /** * Initialize various variables and generate the template * @stable to override */ public function outputPage() { Profiler::instance()->setAllowOutput(); $out = $this->getOutput(); $this->initPage( $out ); $out->addJsConfigVars( $this->getJsConfigVars() ); // result may be an error echo $this->generateHTML(); } /** * Returns array of config variables that should be added only to this skin * for use in JavaScript. * Skins can override this to add variables to the page. * @since 1.35 * @return array */ protected function getJsConfigVars() : array { return []; } /** * Wrap the body text with language information and identifiable element * * @param Title $title * @param string $html body text * @return string html */ protected function wrapHTML( $title, $html ) { # An ID that includes the actual body text; without categories, contentSub, ... $realBodyAttribs = [ 'id' => 'mw-content-text' ]; # Add a mw-content-ltr/rtl class to be able to style based on text # direction when the content is different from the UI language (only # when viewing) # Most information on special pages and file pages is in user language, # rather than content language, so those will not get this if ( Action::getActionName( $this ) === 'view' && ( !$title->inNamespaces( NS_SPECIAL, NS_FILE ) || $title->isRedirect() ) ) { $pageLang = $title->getPageViewLanguage(); $realBodyAttribs['lang'] = $pageLang->getHtmlCode(); $realBodyAttribs['dir'] = $pageLang->getDir(); $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir(); } return Html::rawElement( 'div', $realBodyAttribs, $html ); } /** * Prepare the subtitle of the page for output in the skin if one has been set. * @since 1.35 * @return string HTML */ final protected function prepareSubtitle() { $out = $this->getOutput(); $subpagestr = $this->subPageSubtitle(); if ( $subpagestr !== '' ) { $subpagestr = '' . $subpagestr . ''; } return $subpagestr . $out->getSubtitle(); } /** * Prepare user language attribute links * @since 1.35 * @return string HTML attributes */ final protected function prepareUserLanguageAttributes() { $userLang = $this->getLanguage(); $userLangCode = $userLang->getHtmlCode(); $userLangDir = $userLang->getDir(); $contLang = MediaWikiServices::getInstance()->getContentLanguage(); if ( $userLangCode !== $contLang->getHtmlCode() || $userLangDir !== $contLang->getDir() ) { $escUserlang = htmlspecialchars( $userLangCode ); $escUserdir = htmlspecialchars( $userLangDir ); // Attributes must be in double quotes because htmlspecialchars() doesn't // escape single quotes return " lang=\"$escUserlang\" dir=\"$escUserdir\""; } return ''; } /** * Get template representation of the footer. * @since 1.35 * @return array */ protected function getFooterIcons() { $config = $this->getConfig(); $footericons = []; foreach ( $config->get( 'FooterIcons' ) as $footerIconsKey => &$footerIconsBlock ) { if ( count( $footerIconsBlock ) > 0 ) { $footericons[$footerIconsKey] = []; foreach ( $footerIconsBlock as &$footerIcon ) { if ( isset( $footerIcon['src'] ) ) { if ( !isset( $footerIcon['width'] ) ) { $footerIcon['width'] = 88; } if ( !isset( $footerIcon['height'] ) ) { $footerIcon['height'] = 31; } } $footericons[$footerIconsKey][] = $footerIcon; } } } return $footericons; } /** * Get template representation of the footer containing site footer * links as well as standard footer links. * All values are resolved and can be added to by the * SkinAddFooterLinks hook. * @since 1.35 * @internal * @return array */ protected function getFooterLinks() { $out = $this->getOutput(); $title = $out->getTitle(); $titleExists = $title->exists(); $config = $this->getConfig(); $wgMaxCredits = $config->get( 'MaxCredits' ); $wgShowCreditsIfMax = $config->get( 'ShowCreditsIfMax' ); $useCredits = $titleExists && $out->isArticle() && $out->isRevisionCurrent() && $wgMaxCredits !== 0; /** @var CreditsAction $action */ if ( $titleExists ) { $action = Action::factory( 'credits', Article::newFromWikiPage( $this->getWikiPage(), $this->getContext() ), $this->getContext() ); } '@phan-var CreditsAction $action'; $data = [ 'info' => [ 'lastmod' => !$useCredits ? $this->lastModified() : null, 'numberofwatchingusers' => null, 'credits' => $useCredits ? $action->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) : null, 'copyright' => $titleExists && $out->showsCopyright() ? $this->getCopyright() : null, ], 'places' => $this->getSiteFooterLinks(), ]; foreach ( $data as $key => $existingItems ) { $newItems = []; $this->getHookRunner()->onSkinAddFooterLinks( $this->getSkin(), $key, $newItems ); $data[$key] = $existingItems + $newItems; } return $data; } /** * Prepare undelete link for output in page. * @since 1.35 * @return null|string HTML, or null if there is no undelete link. */ final protected function prepareUndeleteLink() { $undelete = $this->getUndeleteLink(); return $undelete === '' ? null : '' . $undelete . ''; } /** * initialize various variables and generate the template * * @since 1.23 * @return QuickTemplate The template to be executed by outputPage */ protected function prepareQuickTemplate() { $title = $this->getTitle(); $request = $this->getRequest(); $out = $this->getOutput(); $config = $this->getConfig(); $tpl = $this->setupTemplateForOutput(); $tpl->set( 'title', $out->getPageTitle() ); $tpl->set( 'pagetitle', $out->getHTMLTitle() ); $tpl->set( 'displaytitle', $out->mPageLinkTitle ); $tpl->set( 'thispage', $this->thispage ); $tpl->set( 'titleprefixeddbkey', $this->thispage ); $tpl->set( 'titletext', $title->getText() ); $tpl->set( 'articleid', $title->getArticleID() ); $tpl->set( 'isarticle', $out->isArticle() ); $tpl->set( 'subtitle', $this->prepareSubtitle() ); $tpl->set( 'undelete', $this->prepareUndeleteLink() ); $tpl->set( 'catlinks', $this->getCategories() ); $feeds = $this->buildFeedUrls(); $tpl->set( 'feeds', count( $feeds ) ? $feeds : false ); $tpl->set( 'mimetype', $config->get( 'MimeType' ) ); $tpl->set( 'charset', 'UTF-8' ); $tpl->set( 'wgScript', $config->get( 'Script' ) ); $tpl->set( 'skinname', $this->skinname ); $tpl->set( 'skinclass', static::class ); $tpl->set( 'skin', $this ); $tpl->set( 'stylename', $this->stylename ); $tpl->set( 'printable', $out->isPrintable() ); $tpl->set( 'handheld', $request->getBool( 'handheld' ) ); $tpl->set( 'loggedin', $this->loggedin ); $tpl->set( 'notspecialpage', !$title->isSpecialPage() ); $tpl->set( 'searchaction', $this->getSearchLink() ); $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() ); $tpl->set( 'search', trim( $request->getVal( 'search' ) ) ); $tpl->set( 'stylepath', $config->get( 'StylePath' ) ); $tpl->set( 'articlepath', $config->get( 'ArticlePath' ) ); $tpl->set( 'scriptpath', $config->get( 'ScriptPath' ) ); $tpl->set( 'serverurl', $config->get( 'Server' ) ); $logos = ResourceLoaderSkinModule::getAvailableLogos( $config ); $tpl->set( 'logopath', $logos['1x'] ); $tpl->set( 'sitename', $config->get( 'Sitename' ) ); $userLang = $this->getLanguage(); $userLangCode = $userLang->getHtmlCode(); $userLangDir = $userLang->getDir(); $tpl->set( 'lang', $userLangCode ); $tpl->set( 'dir', $userLangDir ); $tpl->set( 'rtl', $userLang->isRTL() ); $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' ); $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed $tpl->set( 'username', $this->loggedin ? $this->username : null ); $tpl->set( 'userpage', $this->userpage ); $tpl->set( 'userpageurl', $this->userpageUrlDetails['href'] ); $tpl->set( 'userlang', $userLangCode ); // Users can have their language set differently than the // content of the wiki. For these users, tell the web browser // that interface elements are in a different language. $tpl->set( 'userlangattributes', $this->prepareUserLanguageAttributes() ); $tpl->set( 'specialpageattributes', '' ); # obsolete // Used by VectorBeta to insert HTML before content but after the // heading for the page title. Defaults to empty string. $tpl->set( 'prebodyhtml', '' ); $tpl->set( 'newtalk', $this->getNewtalks() ); $tpl->set( 'logo', $this->logoText() ); $footerData = $this->getFooterLinks(); $tpl->set( 'copyright', $footerData['info']['copyright'] ?? false ); // No longer used $tpl->set( 'viewcount', false ); $tpl->set( 'lastmod', $footerData['info']['lastmod'] ?? false ); $tpl->set( 'credits', $footerData['info']['credits'] ?? false ); $tpl->set( 'numberofwatchingusers', false ); $tpl->set( 'copyrightico', $this->getCopyrightIcon() ); $tpl->set( 'poweredbyico', $this->getPoweredBy() ); $tpl->set( 'disclaimer', $footerData['places']['disclaimer'] ?? false ); $tpl->set( 'privacy', $footerData['places']['privacy'] ?? false ); $tpl->set( 'about', $footerData['places']['about'] ?? false ); // Flatten for compat with the 'footerlinks' key in QuickTemplate-based skins. $flattenedfooterlinks = []; foreach ( $footerData as $category => $links ) { $flattenedfooterlinks[$category] = array_keys( $links ); foreach ( $links as $key => $value ) { // For full support with BaseTemplate we also need to // copy over the keys. $tpl->set( $key, $value ); } } $tpl->set( 'footerlinks', $flattenedfooterlinks ); $tpl->set( 'footericons', $this->getFooterIcons() ); $tpl->set( 'indicators', $out->getIndicators() ); $tpl->set( 'sitenotice', $this->getSiteNotice() ); $tpl->set( 'printfooter', $this->printSource() ); // Wrap the bodyText with #mw-content-text element $tpl->set( 'bodytext', $this->wrapHTML( $title, $out->getHTML() ) ); $tpl->set( 'language_urls', $this->getLanguages() ?: false ); # Personal toolbar $tpl->set( 'personal_urls', $this->buildPersonalUrls() ); $content_navigation = $this->buildContentNavigationUrls(); $content_actions = $this->buildContentActionUrls( $content_navigation ); $tpl->set( 'content_navigation', $content_navigation ); $tpl->set( 'content_actions', $content_actions ); $tpl->set( 'sidebar', $this->buildSidebar() ); $tpl->set( 'nav_urls', $this->buildNavUrls() ); // Do this last in case hooks above add bottom scripts $tpl->set( 'bottomscripts', $this->bottomScripts() ); // Set the head scripts near the end, in case the above actions resulted in added scripts $tpl->set( 'headelement', $out->headElement( $this ) ); $tpl->set( 'debug', '' ); $tpl->set( 'debughtml', MWDebug::getHTMLDebugLog() ); $tpl->set( 'reporttime', wfReportTime( $out->getCSP()->getNonce() ) ); // original version by hansm // See T60137 for information on deprecation. if ( !$this->getHookRunner()->onSkinTemplateOutputPageBeforeExec( $this, $tpl ) ) { wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!" ); } // Set the bodytext to another key so that skins can just output it on its own // and output printfooter and debughtml separately $tpl->set( 'bodycontent', $tpl->data['bodytext'] ); // Append printfooter and debughtml onto bodytext so that skins that // were already using bodytext before they were split out don't suddenly // start not outputting information. $tpl->data['bodytext'] .= Html::rawElement( 'div', [ 'class' => 'printfooter' ], "\n{$tpl->data['printfooter']}" ) . "\n"; $tpl->data['bodytext'] .= $tpl->data['debughtml']; // allow extensions adding stuff after the page content. // See Skin::afterContentHook() for further documentation. $tpl->set( 'dataAfterContent', $this->afterContentHook() ); return $tpl; } /** * Get the HTML for the p-personal list * @deprecated since 1.35, use SkinTemplate::makePersonalToolsList() * @return string */ public function getPersonalToolsList() { return $this->makePersonalToolsList(); } /** * Get the HTML for the personal tools list * Please ensure setupTemplateContext is called before calling this method. * * @since 1.31 * * @param array|null $personalTools * @param array $options * @return string */ public function makePersonalToolsList( $personalTools = null, $options = [] ) { $this->setupTemplateContext(); $html = ''; if ( $personalTools === null ) { $personalTools = $this->getPersonalToolsForMakeListItem( $this->buildPersonalUrls() ); } foreach ( $personalTools as $key => $item ) { $html .= $this->makeListItem( $key, $item, $options ); } return $html; } /** * Get personal tools for the user * * @since 1.31 * * @return array Array of personal tools */ public function getStructuredPersonalTools() { // buildPersonalUrls requires the template context. $this->setupTemplateContext(); return $this->getPersonalToolsForMakeListItem( $this->buildPersonalUrls() ); } /** * build array of urls for personal toolbar * Please ensure setupTemplateContext is called before calling * this method. * @return array */ protected function buildPersonalUrls() { $title = $this->getTitle(); $request = $this->getRequest(); $pageurl = $title->getLocalURL(); $services = MediaWikiServices::getInstance(); $authManager = $services->getAuthManager(); $permissionManager = $services->getPermissionManager(); /* set up the default links for the personal toolbar */ $personal_urls = []; # Due to T34276, if a user does not have read permissions, # $this->getTitle() will just give Special:Badtitle, which is # not especially useful as a returnto parameter. Use the title # from the request instead, if there was one. if ( $permissionManager->userHasRight( $this->getUser(), 'read' ) ) { $page = $title; } else { $page = Title::newFromText( $request->getVal( 'title', '' ) ); } $page = $request->getVal( 'returnto', $page ); $returnto = []; if ( strval( $page ) !== '' ) { $returnto['returnto'] = $page; $query = $request->getVal( 'returntoquery', $this->thisquery ); $paramsArray = wfCgiToArray( $query ); $query = wfArrayToCgi( $paramsArray ); if ( $query != '' ) { $returnto['returntoquery'] = $query; } } if ( $this->loggedin ) { $personal_urls['userpage'] = [ 'text' => $this->username, 'href' => &$this->userpageUrlDetails['href'], 'class' => $this->userpageUrlDetails['exists'] ? false : 'new', 'exists' => $this->userpageUrlDetails['exists'], 'active' => ( $this->userpageUrlDetails['href'] == $pageurl ), 'dir' => 'auto' ]; $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage ); $personal_urls['mytalk'] = [ 'text' => $this->msg( 'mytalk' )->text(), 'href' => &$usertalkUrlDetails['href'], 'class' => $usertalkUrlDetails['exists'] ? false : 'new', 'exists' => $usertalkUrlDetails['exists'], 'active' => ( $usertalkUrlDetails['href'] == $pageurl ) ]; $href = self::makeSpecialUrl( 'Preferences' ); $personal_urls['preferences'] = [ 'text' => $this->msg( 'mypreferences' )->text(), 'href' => $href, 'active' => ( $href == $pageurl ) ]; if ( $permissionManager->userHasRight( $this->getUser(), 'viewmywatchlist' ) ) { $href = self::makeSpecialUrl( 'Watchlist' ); $personal_urls['watchlist'] = [ 'text' => $this->msg( 'mywatchlist' )->text(), 'href' => $href, 'active' => ( $href == $pageurl ) ]; } # We need to do an explicit check for Special:Contributions, as we # have to match both the title, and the target, which could come # from request values (Special:Contributions?target=Jimbo_Wales) # or be specified in "sub page" form # (Special:Contributions/Jimbo_Wales). The plot # thickens, because the Title object is altered for special pages, # so it doesn't contain the original alias-with-subpage. $origTitle = Title::newFromText( $request->getText( 'title' ) ); if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) { list( $spName, $spPar ) = MediaWikiServices::getInstance()->getSpecialPageFactory()-> resolveAlias( $origTitle->getText() ); $active = $spName == 'Contributions' && ( ( $spPar && $spPar == $this->username ) || $request->getText( 'target' ) == $this->username ); } else { $active = false; } $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username ); $personal_urls['mycontris'] = [ 'text' => $this->msg( 'mycontris' )->text(), 'href' => $href, 'active' => $active ]; // if we can't set the user, we can't unset it either if ( $request->getSession()->canSetUser() ) { $personal_urls['logout'] = [ 'text' => $this->msg( 'pt-userlogout' )->text(), 'data-mw' => 'interface', 'href' => self::makeSpecialUrl( 'Userlogout', // Note: userlogout link must always contain an & character, otherwise we might not be able // to detect a buggy precaching proxy (T19790) ( $title->isSpecial( 'Preferences' ) ? [] : $returnto ) ), 'active' => false ]; } } else { $useCombinedLoginLink = $this->getConfig()->get( 'UseCombinedLoginLink' ); if ( !$authManager->canCreateAccounts() || !$authManager->canAuthenticateNow() ) { // don't show combined login/signup link if one of those is actually not available $useCombinedLoginLink = false; } $loginlink = $permissionManager->userHasRight( $this->getUser(), 'createaccount' ) && $useCombinedLoginLink ? 'nav-login-createaccount' : 'pt-login'; $login_url = [ 'text' => $this->msg( $loginlink )->text(), 'href' => self::makeSpecialUrl( 'Userlogin', $returnto ), 'active' => $title->isSpecial( 'Userlogin' ) || $title->isSpecial( 'CreateAccount' ) && $useCombinedLoginLink, ]; $createaccount_url = [ 'text' => $this->msg( 'pt-createaccount' )->text(), 'href' => self::makeSpecialUrl( 'CreateAccount', $returnto ), 'active' => $title->isSpecial( 'CreateAccount' ), ]; // No need to show Talk and Contributions to anons if they can't contribute! if ( $permissionManager->groupHasPermission( '*', 'edit' ) ) { // Because of caching, we can't link directly to the IP talk and // contributions pages. Instead we use the special page shortcuts // (which work correctly regardless of caching). This means we can't // determine whether these links are active or not, but since major // skins (MonoBook, Vector) don't use this information, it's not a // huge loss. $personal_urls['anontalk'] = [ 'text' => $this->msg( 'anontalk' )->text(), 'href' => self::makeSpecialUrlSubpage( 'Mytalk', false ), 'active' => false ]; $personal_urls['anoncontribs'] = [ 'text' => $this->msg( 'anoncontribs' )->text(), 'href' => self::makeSpecialUrlSubpage( 'Mycontributions', false ), 'active' => false ]; } if ( $authManager->canCreateAccounts() && $permissionManager->userHasRight( $this->getUser(), 'createaccount' ) && !$useCombinedLoginLink ) { $personal_urls['createaccount'] = $createaccount_url; } if ( $authManager->canAuthenticateNow() ) { $key = $permissionManager->groupHasPermission( '*', 'read' ) ? 'login' : 'login-private'; $personal_urls[$key] = $login_url; } } $this->getHookRunner()->onPersonalUrls( $personal_urls, $title, $this ); return $personal_urls; } /** * Builds an array with tab definition * * @param Title $title Page Where the tab links to * @param string|array $message Message key or an array of message keys (will fall back) * @param bool $selected Display the tab as selected * @param string $query Query string attached to tab URL * @param bool $checkEdit Check if $title exists and mark with .new if one doesn't * * @return array */ public function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) { $classes = []; if ( $selected ) { $classes[] = 'selected'; } $exists = true; if ( $checkEdit && !$title->isKnown() ) { $classes[] = 'new'; $exists = false; if ( $query !== '' ) { $query = 'action=edit&redlink=1&' . $query; } else { $query = 'action=edit&redlink=1'; } } $services = MediaWikiServices::getInstance(); $linkClass = $services->getLinkRenderer()->getLinkClasses( $title ); // wfMessageFallback will nicely accept $message as an array of fallbacks // or just a single key $msg = wfMessageFallback( $message )->setContext( $this->getContext() ); if ( is_array( $message ) ) { // for hook compatibility just keep the last message name $message = end( $message ); } if ( $msg->exists() ) { $text = $msg->text(); } else { $text = $services->getLanguageConverterFactory() ->getLanguageConverter( $services->getContentLanguage() ) ->convertNamespace( $services->getNamespaceInfo() ->getSubject( $title->getNamespace() ) ); } $result = []; if ( !$this->getHookRunner()->onSkinTemplateTabAction( $this, $title, $message, $selected, $checkEdit, $classes, $query, $text, $result ) ) { return $result; } $result = [ 'class' => implode( ' ', $classes ), 'text' => $text, 'href' => $title->getLocalURL( $query ), 'exists' => $exists, 'primary' => true ]; if ( $linkClass !== '' ) { $result['link-class'] = $linkClass; } return $result; } /** * @param string $name * @param string|array $urlaction * @return array */ private function makeTalkUrlDetails( $name, $urlaction = '' ) { $title = Title::newFromText( $name ); if ( !is_object( $title ) ) { throw new MWException( __METHOD__ . " given invalid pagename $name" ); } $title = $title->getTalkPage(); self::checkTitle( $title, $name ); return [ 'href' => $title->getLocalURL( $urlaction ), 'exists' => $title->isKnown(), ]; } /** * @deprecated since 1.35, no longer used * @param string $name * @param string|array $urlaction * @return array */ public function makeArticleUrlDetails( $name, $urlaction = '' ) { wfDeprecated( __METHOD__, '1.35' ); $title = Title::newFromText( $name ); $title = $title->getSubjectPage(); self::checkTitle( $title, $name ); return [ 'href' => $title->getLocalURL( $urlaction ), 'exists' => $title->exists(), ]; } /** * Get the attributes for the watch link. * @param string $mode Either 'watch' or 'unwatch' * @param User $user * @param Title $title * @param string|null $action * @param bool $onPage * @return array */ private function getWatchLinkAttrs( string $mode, User $user, Title $title, ?string $action, bool $onPage ): array { $class = 'mw-watchlink ' . ( $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : '' ); // Add class identifying the page is temporarily watched, if applicable. if ( $this->getConfig()->get( 'WatchlistExpiry' ) && $user->isTempWatched( $title ) ) { $class .= ' mw-watchlink-temp'; } return [ 'class' => $class, // uses 'watch' or 'unwatch' message 'text' => $this->msg( $mode )->text(), 'href' => $title->getLocalURL( [ 'action' => $mode ] ), // Set a data-mw=interface attribute, which the mediawiki.page.ajax // module will look for to make sure it's a trusted link 'data' => [ 'mw' => 'interface', ], ]; } /** * a structured array of links usually used for the tabs in a skin * * There are 4 standard sections * namespaces: Used for namespace tabs like special, page, and talk namespaces * views: Used for primary page views like read, edit, history * actions: Used for most extra page actions like deletion, protection, etc... * variants: Used to list the language variants for the page * * Each section's value is a key/value array of links for that section. * The links themselves have these common keys: * - class: The css classes to apply to the tab * - text: The text to display on the tab * - href: The href for the tab to point to * - rel: An optional rel= for the tab's link * - redundant: If true the tab will be dropped in skins using content_actions * this is useful for tabs like "Read" which only have meaning in skins that * take special meaning from the grouped structure of content_navigation * * Views also have an extra key which can be used: * - primary: If this is not true skins like vector may try to hide the tab * when the user has limited space in their browser window * * content_navigation using code also expects these ids to be present on the * links, however these are usually automatically generated by SkinTemplate * itself and are not necessary when using a hook. The only things these may * matter to are people modifying content_navigation after it's initial creation: * - id: A "preferred" id, most skins are best off outputting this preferred * id for best compatibility. * - tooltiponly: This is set to true for some tabs in cases where the system * believes that the accesskey should not be added to the tab. * * @return array */ protected function buildContentNavigationUrls() { // Display tabs for the relevant title rather than always the title itself $title = $this->getRelevantTitle(); $onPage = $title->equals( $this->getTitle() ); $out = $this->getOutput(); $request = $this->getRequest(); $user = $this->getUser(); $permissionManager = MediaWikiServices::getInstance()->getPermissionManager(); $content_navigation = [ 'namespaces' => [], 'views' => [], 'actions' => [], 'variants' => [] ]; // parameters $action = $request->getVal( 'action', 'view' ); $userCanRead = $permissionManager->quickUserCan( 'read', $user, $title ); $preventActiveTabs = false; $this->getHookRunner()->onSkinTemplatePreventOtherActiveTabs( $this, $preventActiveTabs ); // Checks if page is some kind of content if ( $title->canExist() ) { // Gets page objects for the related namespaces $subjectPage = $title->getSubjectPage(); $talkPage = $title->getTalkPage(); // Determines if this is a talk page $isTalk = $title->isTalkPage(); // Generates XML IDs from namespace names $subjectId = $title->getNamespaceKey( '' ); if ( $subjectId == 'main' ) { $talkId = 'talk'; } else { $talkId = "{$subjectId}_talk"; } $skname = $this->skinname; // Adds namespace links $subjectMsg = [ "nstab-$subjectId" ]; if ( $subjectPage->isMainPage() ) { array_unshift( $subjectMsg, 'mainpage-nstab' ); } $content_navigation['namespaces'][$subjectId] = $this->tabAction( $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead ); $content_navigation['namespaces'][$subjectId]['context'] = 'subject'; $content_navigation['namespaces'][$talkId] = $this->tabAction( $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead ); $content_navigation['namespaces'][$talkId]['context'] = 'talk'; if ( $userCanRead ) { // Adds "view" view link if ( $title->isKnown() ) { $content_navigation['views']['view'] = $this->tabAction( $isTalk ? $talkPage : $subjectPage, [ "$skname-view-view", 'view' ], ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true ); // signal to hide this from simple content_actions $content_navigation['views']['view']['redundant'] = true; } $page = $this->canUseWikiPage() ? $this->getWikiPage() : false; $isRemoteContent = $page && !$page->isLocal(); // If it is a non-local file, show a link to the file in its own repository // @todo abstract this for remote content that isn't a file if ( $isRemoteContent ) { $content_navigation['views']['view-foreign'] = [ 'class' => '', 'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )-> setContext( $this->getContext() )-> params( $page->getWikiDisplayName() )->text(), 'href' => $page->getSourceURL(), 'primary' => false, ]; } // Checks if user can edit the current page if it exists or create it otherwise if ( $permissionManager->quickUserCan( 'edit', $user, $title ) && ( $title->exists() || $permissionManager->quickUserCan( 'create', $user, $title ) ) ) { // Builds CSS class for talk page links $isTalkClass = $isTalk ? ' istalk' : ''; // Whether the user is editing the page $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' ); // Whether to show the "Add a new section" tab // Checks if this is a current rev of talk page and is not forced to be hidden $showNewSection = !$out->forceHideNewSectionLink() && ( ( $isTalk && $out->isRevisionCurrent() ) || $out->showNewSectionLink() ); $section = $request->getVal( 'section' ); if ( $title->exists() || ( $title->inNamespace( NS_MEDIAWIKI ) && $title->getDefaultMessageText() !== false ) ) { $msgKey = $isRemoteContent ? 'edit-local' : 'edit'; } else { $msgKey = $isRemoteContent ? 'create-local' : 'create'; } $content_navigation['views']['edit'] = [ 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection ) ? 'selected' : '' ) . $isTalkClass, 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey ) ->setContext( $this->getContext() )->text(), 'href' => $title->getLocalURL( $this->editUrlOptions() ), 'primary' => !$isRemoteContent, // don't collapse this in vector ]; // section link if ( $showNewSection ) { // Adds new section link // $content_navigation['actions']['addsection'] $content_navigation['views']['addsection'] = [ 'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false, 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' ) ->setContext( $this->getContext() )->text(), 'href' => $title->getLocalURL( 'action=edit§ion=new' ) ]; } // Checks if the page has some kind of viewable source content } elseif ( $title->hasSourceText() ) { // Adds view source view link $content_navigation['views']['viewsource'] = [ 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false, 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' ) ->setContext( $this->getContext() )->text(), 'href' => $title->getLocalURL( $this->editUrlOptions() ), 'primary' => true, // don't collapse this in vector ]; } // Checks if the page exists if ( $title->exists() ) { // Adds history view link $content_navigation['views']['history'] = [ 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false, 'text' => wfMessageFallback( "$skname-view-history", 'history_short' ) ->setContext( $this->getContext() )->text(), 'href' => $title->getLocalURL( 'action=history' ), ]; if ( $permissionManager->quickUserCan( 'delete', $user, $title ) ) { $content_navigation['actions']['delete'] = [ 'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false, 'text' => wfMessageFallback( "$skname-action-delete", 'delete' ) ->setContext( $this->getContext() )->text(), 'href' => $title->getLocalURL( 'action=delete' ) ]; } if ( $permissionManager->quickUserCan( 'move', $user, $title ) ) { $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() ); $content_navigation['actions']['move'] = [ 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false, 'text' => wfMessageFallback( "$skname-action-move", 'move' ) ->setContext( $this->getContext() )->text(), 'href' => $moveTitle->getLocalURL() ]; } } else { // article doesn't exist or is deleted if ( $permissionManager->quickUserCan( 'deletedhistory', $user, $title ) ) { $n = $title->isDeleted(); if ( $n ) { $undelTitle = SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedDBkey() ); // If the user can't undelete but can view deleted // history show them a "View .. deleted" tab instead. $msgKey = $permissionManager->quickUserCan( 'undelete', $user, $title ) ? 'undelete' : 'viewdeleted'; $content_navigation['actions']['undelete'] = [ 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false, 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" ) ->setContext( $this->getContext() )->numParams( $n )->text(), 'href' => $undelTitle->getLocalURL() ]; } } } if ( $permissionManager->quickUserCan( 'protect', $user, $title ) && $title->getRestrictionTypes() && $permissionManager->getNamespaceRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ] ) { $mode = $title->isProtected() ? 'unprotect' : 'protect'; $content_navigation['actions'][$mode] = [ 'class' => ( $onPage && $action == $mode ) ? 'selected' : false, 'text' => wfMessageFallback( "$skname-action-$mode", $mode ) ->setContext( $this->getContext() )->text(), 'href' => $title->getLocalURL( "action=$mode" ) ]; } // Checks if the user is logged in if ( $this->loggedin && $permissionManager->userHasAllRights( $user, 'viewmywatchlist', 'editmywatchlist' ) ) { /** * The following actions use messages which, if made particular to * the any specific skins, would break the Ajax code which makes this * action happen entirely inline. OutputPage::getJSVars * defines a set of messages in a javascript object - and these * messages are assumed to be global for all skins. Without making * a change to that procedure these messages will have to remain as * the global versions. */ $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch'; // Add the watch/unwatch link. $content_navigation['actions'][$mode] = $this->getWatchLinkAttrs( $mode, $user, $title, $action, $onPage ); } } $this->getHookRunner()->onSkinTemplateNavigation( $this, $content_navigation ); if ( $userCanRead && !$this->getConfig()->get( 'DisableLangConversion' ) ) { $pageLang = $title->getPageLanguage(); $converter = MediaWikiServices::getInstance() ->getLanguageConverterFactory() ->getLanguageConverter( $pageLang ); // Checks that language conversion is enabled and variants exist // And if it is not in the special namespace if ( $converter->hasVariants() ) { // Gets list of language variants $variants = $converter->getVariants(); // Gets preferred variant (note that user preference is // only possible for wiki content language variant) $preferred = $converter->getPreferredVariant(); if ( Action::getActionName( $this ) === 'view' ) { $params = $request->getQueryValues(); unset( $params['title'] ); } else { $params = []; } // Loops over each variant foreach ( $variants as $code ) { // Gets variant name from language code $varname = $pageLang->getVariantname( $code ); // Appends variant link $content_navigation['variants'][] = [ 'class' => ( $code == $preferred ) ? 'selected' : false, 'text' => $varname, 'href' => $title->getLocalURL( [ 'variant' => $code ] + $params ), 'lang' => LanguageCode::bcp47( $code ), 'hreflang' => LanguageCode::bcp47( $code ), ]; } } } } else { // If it's not content, it's got to be a special page $content_navigation['namespaces']['special'] = [ 'class' => 'selected', 'text' => $this->msg( 'nstab-special' )->text(), 'href' => $request->getRequestURL(), // @see: T4457, T4510 'context' => 'subject' ]; $this->getHookRunner()->onSkinTemplateNavigation__SpecialPage( $this, $content_navigation ); } // Equiv to SkinTemplateContentActions $this->getHookRunner()->onSkinTemplateNavigation__Universal( $this, $content_navigation ); // Setup xml ids and tooltip info foreach ( $content_navigation as $section => &$links ) { foreach ( $links as $key => &$link ) { $xmlID = $key; if ( isset( $link['context'] ) && $link['context'] == 'subject' ) { $xmlID = 'ca-nstab-' . $xmlID; } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) { $xmlID = 'ca-talk'; $link['rel'] = 'discussion'; } elseif ( $section == 'variants' ) { $xmlID = 'ca-varlang-' . $xmlID; } else { $xmlID = 'ca-' . $xmlID; } $link['id'] = $xmlID; } } # We don't want to give the watch tab an accesskey if the # page is being edited, because that conflicts with the # accesskey on the watch checkbox. We also don't want to # give the edit tab an accesskey, because that's fairly # superfluous and conflicts with an accesskey (Ctrl-E) often # used for editing in Safari. if ( in_array( $action, [ 'edit', 'submit' ] ) ) { if ( isset( $content_navigation['views']['edit'] ) ) { $content_navigation['views']['edit']['tooltiponly'] = true; } if ( isset( $content_navigation['actions']['watch'] ) ) { $content_navigation['actions']['watch']['tooltiponly'] = true; } if ( isset( $content_navigation['actions']['unwatch'] ) ) { $content_navigation['actions']['unwatch']['tooltiponly'] = true; } } return $content_navigation; } /** * an array of edit links by default used for the tabs * @param array $content_navigation * @return array */ private function buildContentActionUrls( $content_navigation ) { // content_actions has been replaced with content_navigation for backwards // compatibility and also for skins that just want simple tabs content_actions // is now built by flattening the content_navigation arrays into one $content_actions = []; foreach ( $content_navigation as $links ) { foreach ( $links as $key => $value ) { if ( isset( $value['redundant'] ) && $value['redundant'] ) { // Redundant tabs are dropped from content_actions continue; } // content_actions used to have ids built using the "ca-$key" pattern // so the xmlID based id is much closer to the actual $key that we want // for that reason we'll just strip out the ca- if present and use // the latter potion of the "id" as the $key if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) { $key = substr( $value['id'], 3 ); } if ( isset( $content_actions[$key] ) ) { wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " . "content_navigation into content_actions." ); continue; } $content_actions[$key] = $value; } } return $content_actions; } /** * build array of common navigation links and run * the SkinTemplateBuildNavUrlsNav_urlsAfterPermalink hook. * @inheritDoc * @return array */ protected function buildNavUrls() { $navUrls = parent::buildNavUrls(); $out = $this->getOutput(); if ( !$out->isArticle() ) { return $navUrls; } $modifiedNavUrls = []; foreach ( $navUrls as $key => $url ) { $modifiedNavUrls[$key] = $url; if ( $key === 'permalink' ) { $revid = $out->getRevisionId(); // Use the copy of revision ID in case this undocumented, // shady hook tries to mess with internals. $this->getHookRunner()->onSkinTemplateBuildNavUrlsNav_urlsAfterPermalink( $this, $modifiedNavUrls, $revid, $revid ); } } return $modifiedNavUrls; } /** * Generate strings used for xml 'id' names * @deprecated since 1.35, use Title::getNamespaceKey() instead * @return string */ protected function getNameSpaceKey() { return $this->getTitle()->getNamespaceKey(); } }