SkinTemplate.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
 
class SkinTemplate extends Skin {
    public $template;
 
    public $thispage;
    public $titletxt;
    public $userpage;
    public $thisquery;
    // TODO: Rename this to $isRegistered (but that's a breaking change)
    public $loggedin;
    public $username;
    public $userpageUrlDetails;
 
    protected function setupTemplate( $classname ) {
        return new $classname( $this->getConfig() );
    }
 
    protected function setupTemplateForOutput() {
        $this->setupTemplateContext();
        $template = $this->options['template'] ?? $this->template;
        if ( !$template ) {
            throw new RuntimeException(
                'SkinTemplate skins must define a `template` either as a public'
                    . ' property of by passing in a`template` option to the constructor.'
            );
        }
        $tpl = $this->setupTemplate( $template );
        return $tpl;
    }
 
    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->isRegistered();
        $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 );
        }
    }
 
    public function generateHTML() {
        $tpl = $this->prepareQuickTemplate();
        // execute template
        return $tpl->execute();
    }
 
    public function outputPage() {
        Profiler::instance()->setAllowOutput();
        $out = $this->getOutput();
 
        $this->initPage( $out );
        $out->addJsConfigVars( $this->getJsConfigVars() );
 
        // result may be an error
        echo $this->generateHTML();
    }
 
    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;
                        }
                    }
 
                    // Only output icons which have an image.
                    // For historic reasons this mimics the `icononly` option
                    // for BaseTemplate::getFooterIcons.
                    // In some cases the icon may be an empty array.
                    // Filter these out. (See T269776)
                    if ( is_string( $footerIcon ) || isset( $footerIcon['src'] ) ) {
                        $footericons[$footerIconsKey][] = $footerIcon;
                    }
                }
 
                // If no valid icons with images were added, unset the parent array
                // Should also prevent empty arrays from when no copyright is set.
                if ( !count( $footericons[$footerIconsKey] ) ) {
                    unset( $footericons[$footerIconsKey] );
                }
            }
        }
        return $footericons;
    }
 
    public function getTemplateData() {
        return parent::getTemplateData() + [
            // Data objects
            'data-search-box' => $this->buildSearchProps(),
            'data-logos' => $this->getLogoData(),
        ] + $this->getPortletsTemplateData() + $this->getFooterTemplateData();
    }
 
    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() );
 
        // Deprecated since 1.36
        $searchLink = $this->getSearchPageTitle()->getLocalURL();
        $tpl->set( 'searchaction', $searchLink );
 
        $tpl->set( 'searchtitle', $this->getSearchPageTitle()->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( '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', BaseTemplate::getCopyrightIconHTML( $config, $this ) );
        $poweredBy = BaseTemplate::getPoweredByHTML( $config );
        // Run deprecated hook.
        $this->getHookRunner()->onSkinGetPoweredBy( $poweredBy, $this );
        $tpl->set( 'poweredbyico', $poweredBy );
 
        $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 );
 
        $content_navigation = $this->buildContentNavigationUrls();
        # Personal toolbar
        $tpl->set( 'personal_urls', $this->makeSkinTemplatePersonalUrls( $content_navigation ) );
        // The user-menu, notifications, and user-interface-preferences are new content navigation entries which aren't
        // expected to be part of content_navigation or content_actions. Adding them in there breaks skins that do not
        // expect it.
        unset(
            $content_navigation['user-menu'],
            $content_navigation['notifications'],
            $content_navigation['user-page'],
            $content_navigation['user-interface-preferences']
        );
        $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() ) );
 
        // 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;
    }
 
    public function getPersonalToolsList() {
        wfDeprecated( __METHOD__, '1.35' );
        return $this->makePersonalToolsList();
    }
 
    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;
    }
 
    public function getStructuredPersonalTools() {
        // buildPersonalUrls requires the template context.
        $this->setupTemplateContext();
        return $this->getPersonalToolsForMakeListItem(
            $this->buildPersonalUrls()
        );
    }
 
    protected function buildPersonalUrls( bool $includeNotifications = true ) {
        $title = $this->getTitle();
        $request = $this->getRequest();
        $pageurl = $title->getLocalURL();
        $services = MediaWikiServices::getInstance();
        $authManager = $services->getAuthManager();
        $permissionManager = $services->getPermissionManager();
        $returnto = $this->getReturnToParam();
 
        /* set up the default links for the personal toolbar */
        $personal_urls = [];
 
        if ( $this->loggedin ) {
            $personal_urls['userpage'] = $this->buildPersonalPageItem( 'pt-userpage' );
 
            // Merge notifications into the personal menu for older skins.
            if ( $includeNotifications ) {
                $contentNavigation = $this->buildContentNavigationUrls();
 
                $personal_urls += $contentNavigation['notifications'];
            }
 
            $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 ),
                'icon' => 'userTalk'
            ];
            $href = self::makeSpecialUrl( 'Preferences' );
            $personal_urls['preferences'] = [
                'text' => $this->msg( 'mypreferences' )->text(),
                'href' => $href,
                'active' => ( $href == $pageurl ),
                'icon' => 'settings'
            ];
 
            if ( $this->getAuthority()->isAllowed( 'viewmywatchlist' ) ) {
                $href = self::makeSpecialUrl( 'Watchlist' );
                $personal_urls['watchlist'] = [
                    'text' => $this->msg( 'mywatchlist' )->text(),
                    'href' => $href,
                    'active' => ( $href == $pageurl ),
                    'icon' => 'unStar'
                ];
            }
 
            # 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,
                'icon' => 'userContributions'
            ];
 
            // if we can't set the user, we can't unset it either
            if ( $request->getSession()->canSetUser() ) {
                $personal_urls['logout'] = $this->buildLogoutLinkData();
            }
        } else {
            $useCombinedLoginLink = $this->useCombinedLoginLink();
            $login_url = $this->buildLoginData( $returnto, $useCombinedLoginLink );
            $createaccount_url = $this->buildCreateAccountData( $returnto );
 
            // No need to show Talk and Contributions to anons if they can't contribute!
            // TODO: easy way to get anon authority!
            if ( $permissionManager->groupHasPermission( '*', 'edit' ) ) {
                // Non interactive placeholder for anonymous users.
                // It's unstyled by default (black color). Skin that
                // needs it, can style it using the 'pt-anonuserpage' id.
                // Skin that does not need it should unset it.
                $personal_urls['anonuserpage'] = [
                    'text' => $this->msg( 'notloggedin' )->text(),
                ];
 
                // 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,
                    'icon' => 'userTalk'
                ];
                $personal_urls['anoncontribs'] = [
                    'text' => $this->msg( 'anoncontribs' )->text(),
                    'href' => self::makeSpecialUrlSubpage( 'Mycontributions', false ),
                    'active' => false,
                    'icon' => 'userContributions'
                ];
            }
 
            if (
                $authManager->canCreateAccounts()
                && $this->getAuthority()->isAllowed( 'createaccount' )
                && !$useCombinedLoginLink
            ) {
                $personal_urls['createaccount'] = $createaccount_url;
            }
 
            if ( $authManager->canAuthenticateNow() ) {
                // TODO: easy way to get anon authority
                $key = $permissionManager->groupHasPermission( '*', 'read' )
                    ? 'login'
                    : 'login-private';
                $personal_urls[$key] = $login_url;
            }
        }
 
        $this->getHookRunner()->onPersonalUrls( $personal_urls, $title, $this );
 
        return $personal_urls;
    }
 
    protected function getReturnToParam() {
        $title = $this->getTitle();
        $request = $this->getRequest();
 
        # 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 ( $this->getAuthority()->isAllowed( '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;
            }
        }
 
        return $returnto;
    }
 
    protected function useCombinedLoginLink() {
        $services = MediaWikiServices::getInstance();
        $authManager = $services->getAuthManager();
        $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;
        }
 
        return $useCombinedLoginLink;
    }
 
    protected function buildLoginData( $returnto, $useCombinedLoginLink ) {
        $title = $this->getTitle();
 
        $loginlink = $this->getAuthority()->isAllowed( '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,
            'icon' => 'logIn'
        ];
 
        return $login_url;
    }
 
    protected function getPortletData( $name, array $items ) {
        // Monobook and Vector historically render this portal as an element with ID p-cactions
        // This inconsistency is regretful from a code point of view
        // However this ensures compatibility with gadgets.
        // In future we should port p-#cactions to #p-actions and drop this rename.
        if ( $name === 'actions' ) {
            $name = 'cactions';
        }
 
        // user-menu is the new personal tools, without the notifications.
        // A lot of user code and gadgets relies on it being named personal.
        // This allows it to function as a drop-in replacement.
        if ( $name === 'user-menu' ) {
            $name = 'personal';
        }
 
        $id = Sanitizer::escapeIdForAttribute( "p-$name" );
        $data = [
            'id' => $id,
            'class' => 'mw-portlet ' . Sanitizer::escapeClass( "mw-portlet-$name" ),
            'html-tooltip' => Linker::tooltip( $id ),
            'html-items' => '',
            // Will be populated by SkinAfterPortlet hook.
            'html-after-portal' => '',
            'html-before-portal' => '',
        ];
        // Run the SkinAfterPortlet
        // hook and if content is added appends it to the html-after-portal
        // for output.
        // Currently in production this supports the wikibase 'edit' link.
        $content = $this->getAfterPortlet( $name );
        if ( $content !== '' ) {
            $data['html-after-portal'] = Html::rawElement(
                'div',
                [
                    'class' => [
                        'after-portlet',
                        Sanitizer::escapeClass( "after-portlet-$name" ),
                    ],
                ],
                $content
            );
        }
 
        foreach ( $items as $key => $item ) {
            $data['html-items'] .= $this->makeListItem( $key, $item );
        }
 
        $data['label'] = $this->getPortletLabel( $name );
        $data['class'] .= ( count( $items ) === 0 && $content === '' )
            ? ' emptyPortlet' : '';
        return $data;
    }
 
    private function getPortletLabel( $name ) {
        // For historic reasons for some menu items,
        // there is no language key corresponding with its menu key.
        $mappings = [
            'tb' => 'toolbox',
            'personal' => 'personaltools',
            'lang' => 'otherlanguages',
        ];
        $msgObj = $this->msg( $mappings[ $name ] ?? $name );
        // If no message exists fallback to plain text (T252727)
        $labelText = $msgObj->exists() ? $msgObj->text() : $name;
        return $labelText;
    }
 
    private function getPortletsTemplateData() {
        $portlets = [];
        $contentNavigation = $this->buildContentNavigationUrls();
        $sidebar = [];
        $sidebarData = $this->buildSidebar();
        foreach ( $sidebarData as $name => $items ) {
            if ( is_array( $items ) ) {
                // Numeric strings gets an integer when set as key, cast back - T73639
                $name = (string)$name;
                switch ( $name ) {
                    // ignore search
                    case 'SEARCH':
                        break;
                    // Map toolbox to `tb` id.
                    case 'TOOLBOX':
                        $sidebar[] = $this->getPortletData( 'tb', $items );
                        break;
                    // Languages is no longer be tied to sidebar
                    case 'LANGUAGES':
                        // The language portal will be added provided either
                        // languages exist or there is a value in html-after-portal
                        // for example to show the add language wikidata link (T252800)
                        $portal = $this->getPortletData( 'lang', $items );
                        if ( count( $items ) || $portal['html-after-portal'] ) {
                            $portlets['data-languages'] = $portal;
                        }
                        break;
                    default:
                        $sidebar[] = $this->getPortletData( $name, $items );
                        break;
                }
            }
        }
 
        foreach ( $contentNavigation as $name => $items ) {
            if ( $name === 'user-menu' ) {
                $items = $this->getPersonalToolsForMakeListItem( $items, true );
            }
 
            $portlets['data-' . $name] = $this->getPortletData( $name, $items );
        }
 
        // A menu that includes the notifications. This will be deprecated in future versions
        // of the skin API spec.
        $portlets['data-personal'] = $this->getPortletData(
            'personal',
            $this->getPersonalToolsForMakeListItem(
                $this->injectLegacyMenusIntoPersonalTools( $contentNavigation )
            )
        );
 
        return [
            'data-portlets' => $portlets,
            'data-portlets-sidebar' => [
                'data-portlets-first' => $sidebar[0] ?? null,
                'array-portlets-rest' => array_slice( $sidebar, 1 ),
            ],
        ];
    }
 
    private function getFooterTemplateData(): array {
        $data = [];
        foreach ( $this->getFooterLinks() as $category => $links ) {
            $items = [];
            $rowId = "footer-$category";
 
            foreach ( $links as $key => $link ) {
                // Link may be null. If so don't include it.
                if ( $link ) {
                    $items[] = [
                        // Monobook uses name rather than id.
                        // We may want to change monobook to adhere to the same contract however.
                        'name' => $key,
                        'id' => "$rowId-$key",
                        'html' => $link,
                    ];
                }
            }
 
            $data['data-' . $category] = [
                'id' => $rowId,
                'className' => null,
                'array-items' => $items
            ];
        }
 
        // If footer icons are enabled append to the end of the rows
        $footerIcons = $this->getFooterIcons();
 
        if ( count( $footerIcons ) > 0 ) {
            $icons = [];
            foreach ( $footerIcons as $blockName => $blockIcons ) {
                $html = '';
                foreach ( $blockIcons as $key => $icon ) {
                    $html .= $this->makeFooterIcon( $icon );
                }
                // For historic reasons this mimics the `icononly` option
                // for BaseTemplate::getFooterIcons. Empty rows should not be output.
                if ( $html ) {
                    $block = htmlspecialchars( $blockName );
                    $icons[] = [
                        'name' => $block,
                        'id' => 'footer-' . $block . 'ico',
                        'html' => $html,
                    ];
                }
            }
 
            // Empty rows should not be output.
            // This is how Vector has behaved historically but we can revisit later if necessary.
            if ( count( $icons ) > 0 ) {
                $data['data-icons'] = [
                    'id' => 'footer-icons',
                    'className' => 'noprint',
                    'array-items' => $icons,
                ];
            }
        }
 
        return [
            'data-footer' => $data,
        ];
    }
 
    private function getLogoData(): array {
        $logoData = ResourceLoaderSkinModule::getAvailableLogos( $this->getConfig() );
        // check if the logo supports variants
        $variantsLogos = $logoData['variants'] ?? null;
        if ( $variantsLogos ) {
            $preferred = $this->getOutput()->getTitle()
                ->getPageViewLanguage()->getCode();
            $variantOverrides = $variantsLogos[$preferred] ?? null;
            // Overrides the logo
            if ( $variantOverrides ) {
                foreach ( $variantOverrides as $key => $val ) {
                    $logoData[$key] = $val;
                }
            }
        }
        return $logoData;
    }
 
    private function buildSearchProps(): array {
        $config = $this->getConfig();
        $searchButtonAttributes = [
            'class' => 'searchButton'
        ];
        $fallbackButtonAttributes = [
            'class' => 'searchButton mw-fallbackSearchButton'
        ];
        $buttonAttributes = [
            'type' => 'submit',
        ];
 
        $props = [
            'form-action' => $config->get( 'Script' ),
            'html-button-search-fallback' => $this->makeSearchButton(
                'fulltext',
                $fallbackButtonAttributes + [
                    'id' => 'mw-searchButton',
                ]
            ),
            'html-button-search' => $this->makeSearchButton(
                'go',
                $searchButtonAttributes + [
                    'id' => 'searchButton',
                ]
            ),
            'html-input' => $this->makeSearchInput( [ 'id' => 'searchInput' ] ),
            'msg-search' => $this->msg( 'search' )->text(),
            'page-title' => $this->getSearchPageTitle()->getPrefixedDBkey(),
            // @since 1.38
            'html-button-go-attributes' => Html::expandAttributes(
                $searchButtonAttributes + $buttonAttributes + [
                    'name' => 'go',
                ] + Linker::tooltipAndAccesskeyAttribs( 'search-go' )
            ),
            // @since 1.38
            'html-button-fulltext-attributes' => Html::expandAttributes(
                $fallbackButtonAttributes + $buttonAttributes + [
                    'name' => 'fulltext'
                ] + Linker::tooltipAndAccesskeyAttribs( 'search-fulltext' )
            ),
            // @since 1.38
            'html-input-attributes' => Html::expandAttributes(
                $this->getSearchInputAttributes( [] )
            ),
        ];
 
        return $props;
    }
 
    final protected function buildLogoutLinkData() {
        $title = $this->getTitle();
        $returnto = $this->getReturnToParam();
 
        return [
            '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,
            'icon' => 'logOut'
        ];
    }
 
    protected function buildCreateAccountData( $returnto ) {
        $title = $this->getTitle();
 
        $createaccount_url = [
            'text' => $this->msg( 'pt-createaccount' )->text(),
            'href' => self::makeSpecialUrl( 'CreateAccount', $returnto ),
            'active' => $title->isSpecial( 'CreateAccount' ),
            'icon' => 'userAvatar'
        ];
 
        return $createaccount_url;
    }
 
    protected function buildPersonalPageItem( $id = 'pt-userpage' ): array {
        // Build the personal page link array.
        return [
            'text' => $this->username,
            'id' => $id,
            'href' => &$this->userpageUrlDetails['href'],
            'link-class' => $this->userpageUrlDetails['exists'] ? [] : [ 'new' ],
            'exists' => $this->userpageUrlDetails['exists'],
            'active' => ( $this->userpageUrlDetails['href'] == $this->getTitle()->getLocalURL() ),
            'icon' => 'userAvatar',
            'dir' => 'auto'
        ];
    }
 
    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 );
 
        if ( $message instanceof MessageSpecifier ) {
            $msg = new Message( $message );
            $message = $message->getKey();
        } else {
            // wfMessageFallback will nicely accept $message as an array of fallbacks
            // or just a single key
            $msg = wfMessageFallback( $message );
            if ( is_array( $message ) ) {
                // for hook compatibility just keep the last message name
                $message = end( $message );
            }
        }
        $msg->setContext( $this->getContext() );
        if ( $msg->exists() ) {
            $text = $msg->text();
        } else {
            $text = $services->getLanguageConverterFactory()
                ->getLanguageConverter( $services->getContentLanguage() )
                ->convertNamespace(
                    $services->getNamespaceInfo()
                        ->getSubject( $title->getNamespace() )
                );
        }
 
        $result = [
            'class' => implode( ' ', $classes ),
            'text' => $text,
            'href' => $title->getLocalURL( $query ),
            'exists' => $exists,
            'primary' => true ];
        if ( $linkClass !== '' ) {
            $result['link-class'] = $linkClass;
        }
 
        return $result;
    }
 
    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(),
        ];
    }
 
    private function getWatchLinkAttrs(
        string $mode, Authority $performer, 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' ) &&
            MediaWikiServices::getInstance()->getWatchlistManager()->isTempWatched( $performer, $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',
            ],
        ];
    }
 
    protected function runOnSkinTemplateNavigationHooks( SkinTemplate $skin, &$content_navigation ) {
        $title = $this->getRelevantTitle();
        if ( $title->canExist() ) {
            $this->getHookRunner()->onSkinTemplateNavigation( $skin, $content_navigation );
        } else {
            $this->getHookRunner()->onSkinTemplateNavigation__SpecialPage(
                $skin, $content_navigation );
        }
 
        // Equiv to SkinTemplateContentActions, run
        $this->getHookRunner()->onSkinTemplateNavigation__Universal(
            $skin, $content_navigation );
    }
 
    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();
        $performer = $this->getAuthority();
        $action = $this->getAction();
        $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
 
        $content_navigation = [
            // Modern keys: Please ensure these get unset inside Skin::prepareQuickTemplate
            'user-interface-preferences' => [],
            'user-page' => $this->loggedin ? [
                'userpage' => $this->buildPersonalPageItem( 'pt-userpage-2' )
            ] : [],
            'user-menu' => $this->buildPersonalUrls( false ),
            'notifications' => [],
            // Legacy keys
            'namespaces' => [],
            'views' => [],
            'actions' => [],
            'variants' => []
        ];
 
        $userCanRead = $this->getAuthority()->probablyCan( 'read', $title );
 
        // 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
            if ( $subjectId === 'user' ) {
                $subjectMsg = wfMessage( 'nstab-user', $subjectPage->getRootText() );
            } else {
                $subjectMsg = [ "nstab-$subjectId" ];
            }
            if ( $subjectPage->isMainPage() ) {
                array_unshift( $subjectMsg, 'mainpage-nstab' );
            }
 
            $content_navigation['namespaces'][$subjectId] = $this->tabAction(
                $subjectPage, $subjectMsg, !$isTalk, '', $userCanRead
            );
            $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
            $content_navigation['namespaces'][$talkId] = $this->tabAction(
                $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk, '', $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 ( $this->getAuthority()->probablyCan( 'edit', $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&section=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 ( $this->getAuthority()->probablyCan( 'delete', $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 ( $this->getAuthority()->probablyCan( 'move', $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 ( $this->getAuthority()->probablyCan( 'deletedhistory', $title ) ) {
                        $n = $title->getDeletedEditsCount();
                        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 = $this->getAuthority()->probablyCan( 'undelete', $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 ( $this->getAuthority()->probablyCan( 'protect', $title ) &&
                    $title->getRestrictionTypes() &&
                    $permissionManager->getNamespaceRestrictionLevels(
                        $title->getNamespace(),
                        $performer->getUser()
                    ) !== [ '' ]
                ) {
                    $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 && $this->getAuthority()
                        ->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' )
                ) {
                    $mode = MediaWikiServices::getInstance()->getWatchlistManager()
                        ->isWatched( $performer, $title ) ? 'unwatch' : 'watch';
 
                    // Add the watch/unwatch link.
                    $content_navigation['actions'][$mode] = $this->getWatchLinkAttrs(
                        $mode,
                        $performer,
                        $title,
                        $action,
                        $onPage
                    );
                }
            }
 
            // Add language variants
            $languageConverterFactory = MediaWikiServices::getInstance()->getLanguageConverterFactory();
 
            if ( $userCanRead && !$languageConverterFactory->isConversionDisabled() ) {
                $pageLang = $title->getPageLanguage();
                $converter = $languageConverterFactory
                    ->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 === '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, and a request URL is set it's got to be a special page
            try {
                $url = $request->getRequestURL();
            } catch ( MWException $e ) {
                $url = false;
            }
            $content_navigation['namespaces']['special'] = [
                'class' => 'selected',
                'text' => $this->msg( 'nstab-special' )->text(),
                'href' => $url, // @see: T4457, T4510
                'context' => 'subject'
            ];
        }
        $this->runOnSkinTemplateNavigationHooks( $this, $content_navigation );
 
        // Setup xml ids and tooltip info
        foreach ( $content_navigation as $section => &$links ) {
            foreach ( $links as $key => &$link ) {
                // Allow links to set their own id for backwards compatibility reasons.
                if ( isset( $link['id'] ) ) {
                    continue;
                }
                $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;
    }
 
    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 $navigation => $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;
    }
 
    protected function getNameSpaceKey() {
        return $this->getTitle()->getNamespaceKey();
    }
 
    final protected function injectLegacyMenusIntoPersonalTools(
        array $contentNavigation
    ): array {
        $userMenu = $contentNavigation['user-menu'] ?? [];
        // userpage is only defined for logged-in users, and wfArrayInsertAfter requires the
        // $after parameter to be a known key in the array.
        if ( isset( $contentNavigation['user-menu']['userpage'] ) && isset( $contentNavigation['notifications'] ) ) {
            $userMenu = wfArrayInsertAfter(
                $userMenu,
                $contentNavigation['notifications'],
                'userpage'
            );
        }
        if ( isset( $contentNavigation['user-interface-preferences'] ) ) {
            return array_merge(
                $contentNavigation['user-interface-preferences'],
                $userMenu
            );
        }
        return $userMenu;
    }
 
    private function makeSkinTemplatePersonalUrls(
        array $contentNavigation
    ): array {
        if ( isset( $contentNavigation['user-menu'] ) ) {
            return $this->injectLegacyMenusIntoPersonalTools( $contentNavigation );
        }
        return [];
    }
 
}