Skin.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use Wikimedia\WrappedString;
use Wikimedia\WrappedStringList;

abstract class Skin extends ContextSource {
    protected $skinname = null;

    protected $mRelevantTitle = null;
    protected $mRelevantUser = null;

    public $stylename = null;

    static function getSkinNames() {
        return SkinFactory::getDefaultInstance()->getSkinNames();
    }

    static function getSkinNameMessages() {
        $messages = [];
        foreach ( self::getSkinNames() as $skinKey => $skinName ) {
            $messages[] = "skinname-$skinKey";
        }
        return $messages;
    }

    public static function getAllowedSkins() {
        global $wgSkipSkins;

        $allowedSkins = self::getSkinNames();

        foreach ( $wgSkipSkins as $skip ) {
            unset( $allowedSkins[$skip] );
        }

        return $allowedSkins;
    }

    static function normalizeKey( $key ) {
        global $wgDefaultSkin, $wgFallbackSkin;

        $skinNames = self::getSkinNames();

        // Make keys lowercase for case-insensitive matching.
        $skinNames = array_change_key_case( $skinNames, CASE_LOWER );
        $key = strtolower( $key );
        $defaultSkin = strtolower( $wgDefaultSkin );
        $fallbackSkin = strtolower( $wgFallbackSkin );

        if ( $key == '' || $key == 'default' ) {
            // Don't return the default immediately;
            // in a misconfiguration we need to fall back.
            $key = $defaultSkin;
        }

        if ( isset( $skinNames[$key] ) ) {
            return $key;
        }

        // Older versions of the software used a numeric setting
        // in the user preferences.
        $fallback = [
            0 => $defaultSkin,
            2 => 'cologneblue'
        ];

        if ( isset( $fallback[$key] ) ) {
            $key = $fallback[$key];
        }

        if ( isset( $skinNames[$key] ) ) {
            return $key;
        } elseif ( isset( $skinNames[$defaultSkin] ) ) {
            return $defaultSkin;
        } else {
            return $fallbackSkin;
        }
    }

    public function __construct( $skinname = null ) {
        if ( is_string( $skinname ) ) {
            $this->skinname = $skinname;
        }
    }

    public function getSkinName() {
        return $this->skinname;
    }

    public function initPage( OutputPage $out ) {
        $this->preloadExistence();
    }

    public function getDefaultModules() {
        $out = $this->getOutput();
        $config = $this->getConfig();
        $user = $this->getUser();

        // Modules declared in the $modules literal are loaded
        // for ALL users, on ALL pages, in ALL skins.
        // Keep this list as small as possible!
        $modules = [
            'styles' => [
                // The 'styles' key sets render-blocking style modules
                // Unlike other keys in $modules, this is an associative array
                // where each key is its own group pointing to a list of modules
                'core' => [
                    'mediawiki.legacy.shared',
                    'mediawiki.legacy.commonPrint',
                ],
                'content' => [],
                'syndicate' => [],
            ],
            'core' => [
                'site',
                'mediawiki.page.startup',
                'mediawiki.user',
            ],
            // modules that enhance the content in some way
            'content' => [
                'mediawiki.page.ready',
            ],
            // modules relating to search functionality
            'search' => [],
            // modules relating to functionality relating to watching an article
            'watch' => [],
            // modules which relate to the current users preferences
            'user' => [],
            // modules relating to RSS/Atom Feeds
            'syndicate' => [],
        ];

        // Preload jquery.tablesorter for mediawiki.page.ready
        if ( strpos( $out->getHTML(), 'sortable' ) !== false ) {
            $modules['content'][] = 'jquery.tablesorter';
        }

        // Preload jquery.makeCollapsible for mediawiki.page.ready
        if ( strpos( $out->getHTML(), 'mw-collapsible' ) !== false ) {
            $modules['content'][] = 'jquery.makeCollapsible';
            $modules['styles']['content'][] = 'jquery.makeCollapsible.styles';
        }

        // Deprecated since 1.26: Unconditional loading of mediawiki.ui.button
        // on every page is deprecated. Express a dependency instead.
        if ( strpos( $out->getHTML(), 'mw-ui-button' ) !== false ) {
            $modules['styles']['content'][] = 'mediawiki.ui.button';
        }

        if ( $out->isTOCEnabled() ) {
            $modules['content'][] = 'mediawiki.toc';
            $modules['styles']['content'][] = 'mediawiki.toc.styles';
        }

        // Add various resources if required
        if ( $user->isLoggedIn()
            && $user->isAllowedAll( 'writeapi', 'viewmywatchlist', 'editmywatchlist' )
            && $this->getRelevantTitle()->canExist()
        ) {
            $modules['watch'][] = 'mediawiki.page.watch.ajax';
        }

        $modules['search'][] = 'mediawiki.searchSuggest';

        if ( $user->getBoolOption( 'editsectiononrightclick' ) ) {
            $modules['user'][] = 'mediawiki.action.view.rightClickEdit';
        }

        // Crazy edit-on-double-click stuff
        if ( $out->isArticle() && $user->getOption( 'editondblclick' ) ) {
            $modules['user'][] = 'mediawiki.action.view.dblClickEdit';
        }

        if ( $out->isSyndicated() ) {
            $modules['styles']['syndicate'][] = 'mediawiki.feedlink';
        }

        return $modules;
    }

    protected function preloadExistence() {
        $titles = [];

        // User/talk link
        $user = $this->getUser();
        if ( $user->isLoggedIn() ) {
            $titles[] = $user->getUserPage();
            $titles[] = $user->getTalkPage();
        }

        // Check, if the page can hold some kind of content, otherwise do nothing
        $title = $this->getRelevantTitle();
        if ( $title->canExist() ) {
            if ( $title->isTalkPage() ) {
                $titles[] = $title->getSubjectPage();
            } else {
                $titles[] = $title->getTalkPage();
            }
        }

        // Footer links (used by SkinTemplate::prepareQuickTemplate)
        foreach ( [
            $this->footerLinkTitle( 'privacy', 'privacypage' ),
            $this->footerLinkTitle( 'aboutsite', 'aboutpage' ),
            $this->footerLinkTitle( 'disclaimers', 'disclaimerpage' ),
        ] as $title ) {
            if ( $title ) {
                $titles[] = $title;
            }
        }

        Hooks::run( 'SkinPreloadExistence', [ &$titles, $this ] );

        if ( $titles ) {
            $lb = new LinkBatch( $titles );
            $lb->setCaller( __METHOD__ );
            $lb->execute();
        }
    }

    public function getRevisionId() {
        return $this->getOutput()->getRevisionId();
    }

    public function isRevisionCurrent() {
        $revID = $this->getRevisionId();
        return $revID == 0 || $revID == $this->getTitle()->getLatestRevID();
    }

    public function setRelevantTitle( $t ) {
        $this->mRelevantTitle = $t;
    }

    public function getRelevantTitle() {
        if ( isset( $this->mRelevantTitle ) ) {
            return $this->mRelevantTitle;
        }
        return $this->getTitle();
    }

    public function setRelevantUser( $u ) {
        $this->mRelevantUser = $u;
    }

    public function getRelevantUser() {
        if ( isset( $this->mRelevantUser ) ) {
            return $this->mRelevantUser;
        }
        $title = $this->getRelevantTitle();
        if ( $title->hasSubjectNamespace( NS_USER ) ) {
            $rootUser = $title->getRootText();
            if ( User::isIP( $rootUser ) ) {
                $this->mRelevantUser = User::newFromName( $rootUser, false );
            } else {
                $user = User::newFromName( $rootUser, false );

                if ( $user ) {
                    $user->load( User::READ_NORMAL );

                    if ( $user->isLoggedIn() ) {
                        $this->mRelevantUser = $user;
                    }
                }
            }
            return $this->mRelevantUser;
        }
        return null;
    }

    abstract function outputPage( OutputPage $out = null );

    public static function makeVariablesScript( $data, $nonce = null ) {
        if ( $data ) {
            return ResourceLoader::makeInlineScript(
                ResourceLoader::makeConfigSetScript( $data ),
                $nonce
            );
        }
        return '';
    }

    public static function getDynamicStylesheetQuery() {
        return [
                'action' => 'raw',
                'ctype' => 'text/css',
            ];
    }

    public function setupSkinUserCss( OutputPage $out ) {
        // Stub.
    }

    function getPageClasses( $title ) {
        $numeric = 'ns-' . $title->getNamespace();

        if ( $title->isSpecialPage() ) {
            $type = 'ns-special';
            // T25315: provide a class based on the canonical special page name without subpages
            list( $canonicalName ) = MediaWikiServices::getInstance()->getSpecialPageFactory()->
                resolveAlias( $title->getDBkey() );
            if ( $canonicalName ) {
                $type .= ' ' . Sanitizer::escapeClass( "mw-special-$canonicalName" );
            } else {
                $type .= ' mw-invalidspecialpage';
            }
        } elseif ( $title->isTalkPage() ) {
            $type = 'ns-talk';
        } else {
            $type = 'ns-subject';
        }

        $name = Sanitizer::escapeClass( 'page-' . $title->getPrefixedText() );
        $root = Sanitizer::escapeClass( 'rootpage-' . $title->getRootTitle()->getPrefixedText() );

        return "$numeric $type $name $root";
    }

    public function getHtmlElementAttributes() {
        $lang = $this->getLanguage();
        return [
            'lang' => $lang->getHtmlCode(),
            'dir' => $lang->getDir(),
            'class' => 'client-nojs',
        ];
    }

    function addToBodyAttributes( $out, &$bodyAttrs ) {
        // does nothing by default
    }

    function getLogo() {
        global $wgLogo;
        return $wgLogo;
    }

    public function shouldPreloadLogo() {
        return false;
    }

    function getCategoryLinks() {
        global $wgUseCategoryBrowser;

        $out = $this->getOutput();
        $allCats = $out->getCategoryLinks();

        if ( !count( $allCats ) ) {
            return '';
        }

        $embed = "<li>";
        $pop = "</li>";

        $s = '';
        $colon = $this->msg( 'colon-separator' )->escaped();

        if ( !empty( $allCats['normal'] ) ) {
            $t = $embed . implode( "{$pop}{$embed}", $allCats['normal'] ) . $pop;

            $msg = $this->msg( 'pagecategories' )->numParams( count( $allCats['normal'] ) )->escaped();
            $linkPage = $this->msg( 'pagecategorieslink' )->inContentLanguage()->text();
            $title = Title::newFromText( $linkPage );
            $link = $title ? Linker::link( $title, $msg ) : $msg;
            $s .= '<div id="mw-normal-catlinks" class="mw-normal-catlinks">' .
                $link . $colon . '<ul>' . $t . '</ul>' . '</div>';
        }

        # Hidden categories
        if ( isset( $allCats['hidden'] ) ) {
            if ( $this->getUser()->getBoolOption( 'showhiddencats' ) ) {
                $class = ' mw-hidden-cats-user-shown';
            } elseif ( $this->getTitle()->getNamespace() == NS_CATEGORY ) {
                $class = ' mw-hidden-cats-ns-shown';
            } else {
                $class = ' mw-hidden-cats-hidden';
            }

            $s .= "<div id=\"mw-hidden-catlinks\" class=\"mw-hidden-catlinks$class\">" .
                $this->msg( 'hidden-categories' )->numParams( count( $allCats['hidden'] ) )->escaped() .
                $colon . '<ul>' . $embed . implode( "{$pop}{$embed}", $allCats['hidden'] ) . $pop . '</ul>' .
                '</div>';
        }

        # optional 'dmoz-like' category browser. Will be shown under the list
        # of categories an article belong to
        if ( $wgUseCategoryBrowser ) {
            $s .= '<br /><hr />';

            # get a big array of the parents tree
            $parenttree = $this->getTitle()->getParentCategoryTree();
            # Skin object passed by reference cause it can not be
            # accessed under the method subfunction drawCategoryBrowser
            $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) );
            # Clean out bogus first entry and sort them
            unset( $tempout[0] );
            asort( $tempout );
            # Output one per line
            $s .= implode( "<br />\n", $tempout );
        }

        return $s;
    }

    function drawCategoryBrowser( $tree ) {
        $return = '';

        foreach ( $tree as $element => $parent ) {
            if ( empty( $parent ) ) {
                # element start a new list
                $return .= "\n";
            } else {
                # grab the others elements
                $return .= $this->drawCategoryBrowser( $parent ) . ' &gt; ';
            }

            # add our current element to the list
            $eltitle = Title::newFromText( $element );
            $return .= Linker::link( $eltitle, htmlspecialchars( $eltitle->getText() ) );
        }

        return $return;
    }

    function getCategories() {
        $out = $this->getOutput();
        $catlinks = $this->getCategoryLinks();

        // Check what we're showing
        $allCats = $out->getCategoryLinks();
        $showHidden = $this->getUser()->getBoolOption( 'showhiddencats' ) ||
                        $this->getTitle()->getNamespace() == NS_CATEGORY;

        $classes = [ 'catlinks' ];
        if ( empty( $allCats['normal'] ) && !( !empty( $allCats['hidden'] ) && $showHidden ) ) {
            $classes[] = 'catlinks-allhidden';
        }

        return Html::rawElement(
            'div',
            [ 'id' => 'catlinks', 'class' => $classes, 'data-mw' => 'interface' ],
            $catlinks
        );
    }

    protected function afterContentHook() {
        $data = '';

        if ( Hooks::run( 'SkinAfterContent', [ &$data, $this ] ) ) {
            // adding just some spaces shouldn't toggle the output
            // of the whole <div/>, so we use trim() here
            if ( trim( $data ) != '' ) {
                // Doing this here instead of in the skins to
                // ensure that the div has the same ID in all
                // skins
                $data = "<div id='mw-data-after-content'>\n" .
                    "\t$data\n" .
                    "</div>\n";
            }
        } else {
            wfDebug( "Hook SkinAfterContent changed output processing.\n" );
        }

        return $data;
    }

    protected function generateDebugHTML() {
        return MWDebug::getHTMLDebugLog();
    }

    function bottomScripts() {
        // TODO and the suckage continues. This function is really just a wrapper around
        // OutputPage::getBottomScripts() which takes a Skin param. This should be cleaned
        // up at some point
        $chunks = [ $this->getOutput()->getBottomScripts() ];

        // Keep the hook appendage separate to preserve WrappedString objects.
        // This enables BaseTemplate::getTrail() to merge them where possible.
        $extraHtml = '';
        Hooks::run( 'SkinAfterBottomScripts', [ $this, &$extraHtml ] );
        if ( $extraHtml !== '' ) {
            $chunks[] = $extraHtml;
        }
        return WrappedString::join( "\n", $chunks );
    }

    function printSource() {
        $oldid = $this->getRevisionId();
        if ( $oldid ) {
            $canonicalUrl = $this->getTitle()->getCanonicalURL( 'oldid=' . $oldid );
            $url = htmlspecialchars( wfExpandIRI( $canonicalUrl ) );
        } else {
            // oldid not available for non existing pages
            $url = htmlspecialchars( wfExpandIRI( $this->getTitle()->getCanonicalURL() ) );
        }

        return $this->msg( 'retrievedfrom' )
            ->rawParams( '<a dir="ltr" href="' . $url . '">' . $url . '</a>' )
            ->parse();
    }

    function getUndeleteLink() {
        $action = $this->getRequest()->getVal( 'action', 'view' );

        if ( $this->getTitle()->userCan( 'deletedhistory', $this->getUser() ) &&
            ( !$this->getTitle()->exists() || $action == 'history' ) ) {
            $n = $this->getTitle()->isDeleted();

            if ( $n ) {
                if ( $this->getTitle()->quickUserCan( 'undelete', $this->getUser() ) ) {
                    $msg = 'thisisdeleted';
                } else {
                    $msg = 'viewdeleted';
                }

                return $this->msg( $msg )->rawParams(
                    Linker::linkKnown(
                        SpecialPage::getTitleFor( 'Undelete', $this->getTitle()->getPrefixedDBkey() ),
                        $this->msg( 'restorelink' )->numParams( $n )->escaped() )
                    )->escaped();
            }
        }

        return '';
    }

    function subPageSubtitle( $out = null ) {
        if ( $out === null ) {
            $out = $this->getOutput();
        }
        $title = $out->getTitle();
        $subpages = '';

        if ( !Hooks::run( 'SkinSubPageSubtitle', [ &$subpages, $this, $out ] ) ) {
            return $subpages;
        }

        if ( $out->isArticle() && MWNamespace::hasSubpages( $title->getNamespace() ) ) {
            $ptext = $title->getPrefixedText();
            if ( strpos( $ptext, '/' ) !== false ) {
                $links = explode( '/', $ptext );
                array_pop( $links );
                $c = 0;
                $growinglink = '';
                $display = '';
                $lang = $this->getLanguage();

                foreach ( $links as $link ) {
                    $growinglink .= $link;
                    $display .= $link;
                    $linkObj = Title::newFromText( $growinglink );

                    if ( is_object( $linkObj ) && $linkObj->isKnown() ) {
                        $getlink = Linker::linkKnown(
                            $linkObj,
                            htmlspecialchars( $display )
                        );

                        $c++;

                        if ( $c > 1 ) {
                            $subpages .= $lang->getDirMarkEntity() . $this->msg( 'pipe-separator' )->escaped();
                        } else {
                            $subpages .= '&lt; ';
                        }

                        $subpages .= $getlink;
                        $display = '';
                    } else {
                        $display .= '/';
                    }
                    $growinglink .= '/';
                }
            }
        }

        return $subpages;
    }

    function getSearchLink() {
        $searchPage = SpecialPage::getTitleFor( 'Search' );
        return $searchPage->getLocalURL();
    }

    function escapeSearchLink() {
        return htmlspecialchars( $this->getSearchLink() );
    }

    function getCopyright( $type = 'detect' ) {
        global $wgRightsPage, $wgRightsUrl, $wgRightsText;

        if ( $type == 'detect' ) {
            if ( !$this->isRevisionCurrent()
                && !$this->msg( 'history_copyright' )->inContentLanguage()->isDisabled()
            ) {
                $type = 'history';
            } else {
                $type = 'normal';
            }
        }

        if ( $type == 'history' ) {
            $msg = 'history_copyright';
        } else {
            $msg = 'copyright';
        }

        if ( $wgRightsPage ) {
            $title = Title::newFromText( $wgRightsPage );
            $link = Linker::linkKnown( $title, $wgRightsText );
        } elseif ( $wgRightsUrl ) {
            $link = Linker::makeExternalLink( $wgRightsUrl, $wgRightsText );
        } elseif ( $wgRightsText ) {
            $link = $wgRightsText;
        } else {
            # Give up now
            return '';
        }

        // Allow for site and per-namespace customization of copyright notice.
        // @todo Remove deprecated $forContent param from hook handlers and then remove here.
        $forContent = true;

        Hooks::run(
            'SkinCopyrightFooter',
            [ $this->getTitle(), $type, &$msg, &$link, &$forContent ]
        );

        return $this->msg( $msg )->rawParams( $link )->text();
    }

    function getCopyrightIcon() {
        global $wgRightsUrl, $wgRightsText, $wgRightsIcon, $wgFooterIcons;

        $out = '';

        if ( $wgFooterIcons['copyright']['copyright'] ) {
            $out = $wgFooterIcons['copyright']['copyright'];
        } elseif ( $wgRightsIcon ) {
            $icon = htmlspecialchars( $wgRightsIcon );

            if ( $wgRightsUrl ) {
                $url = htmlspecialchars( $wgRightsUrl );
                $out .= '<a href="' . $url . '">';
            }

            $text = htmlspecialchars( $wgRightsText );
            $out .= "<img src=\"$icon\" alt=\"$text\" width=\"88\" height=\"31\" />";

            if ( $wgRightsUrl ) {
                $out .= '</a>';
            }
        }

        return $out;
    }

    function getPoweredBy() {
        global $wgResourceBasePath;

        $url1 = htmlspecialchars(
            "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
        );
        $url1_5 = htmlspecialchars(
            "$wgResourceBasePath/resources/assets/poweredby_mediawiki_132x47.png"
        );
        $url2 = htmlspecialchars(
            "$wgResourceBasePath/resources/assets/poweredby_mediawiki_176x62.png"
        );
        $text = '<a href="//www.mediawiki.org/"><img src="' . $url1
            . '" srcset="' . $url1_5 . ' 1.5x, ' . $url2 . ' 2x" '
            . 'height="31" width="88" alt="Powered by MediaWiki" /></a>';
        Hooks::run( 'SkinGetPoweredBy', [ &$text, $this ] );
        return $text;
    }

    protected function lastModified() {
        $timestamp = $this->getOutput()->getRevisionTimestamp();

        # No cached timestamp, load it from the database
        if ( $timestamp === null ) {
            $timestamp = Revision::getTimestampFromId( $this->getTitle(), $this->getRevisionId() );
        }

        if ( $timestamp ) {
            $d = $this->getLanguage()->userDate( $timestamp, $this->getUser() );
            $t = $this->getLanguage()->userTime( $timestamp, $this->getUser() );
            $s = ' ' . $this->msg( 'lastmodifiedat', $d, $t )->parse();
        } else {
            $s = '';
        }

        if ( MediaWikiServices::getInstance()->getDBLoadBalancer()->getLaggedReplicaMode() ) {
            $s .= ' <strong>' . $this->msg( 'laggedslavemode' )->parse() . '</strong>';
        }

        return $s;
    }

    function logoText( $align = '' ) {
        if ( $align != '' ) {
            $a = " style='float: {$align};'";
        } else {
            $a = '';
        }

        $mp = $this->msg( 'mainpage' )->escaped();
        $mptitle = Title::newMainPage();
        $url = ( is_object( $mptitle ) ? htmlspecialchars( $mptitle->getLocalURL() ) : '' );

        $logourl = $this->getLogo();
        $s = "<a href='{$url}'><img{$a} src='{$logourl}' alt='[{$mp}]' /></a>";

        return $s;
    }

    function makeFooterIcon( $icon, $withImage = 'withImage' ) {
        if ( is_string( $icon ) ) {
            $html = $icon;
        } else { // Assuming array
            $url = $icon["url"] ?? null;
            unset( $icon["url"] );
            if ( isset( $icon["src"] ) && $withImage === 'withImage' ) {
                // do this the lazy way, just pass icon data as an attribute array
                $html = Html::element( 'img', $icon );
            } else {
                $html = htmlspecialchars( $icon["alt"] );
            }
            if ( $url ) {
                global $wgExternalLinkTarget;
                $html = Html::rawElement( 'a',
                    [ "href" => $url, "target" => $wgExternalLinkTarget ],
                    $html );
            }
        }
        return $html;
    }

    function mainPageLink() {
        $s = Linker::linkKnown(
            Title::newMainPage(),
            $this->msg( 'mainpage' )->escaped()
        );

        return $s;
    }

    public function footerLink( $desc, $page ) {
        $title = $this->footerLinkTitle( $desc, $page );
        if ( !$title ) {
            return '';
        }

        return Linker::linkKnown(
            $title,
            $this->msg( $desc )->escaped()
        );
    }

    private function footerLinkTitle( $desc, $page ) {
        // If the link description has been set to "-" in the default language,
        if ( $this->msg( $desc )->inContentLanguage()->isDisabled() ) {
            // then it is disabled, for all languages.
            return null;
        }
        // Otherwise, we display the link for the user, described in their
        // language (which may or may not be the same as the default language),
        // but we make the link target be the one site-wide page.
        $title = Title::newFromText( $this->msg( $page )->inContentLanguage()->text() );

        return $title ?: null;
    }

    function privacyLink() {
        return $this->footerLink( 'privacy', 'privacypage' );
    }

    function aboutLink() {
        return $this->footerLink( 'aboutsite', 'aboutpage' );
    }

    function disclaimerLink() {
        return $this->footerLink( 'disclaimers', 'disclaimerpage' );
    }

    function editUrlOptions() {
        $options = [ 'action' => 'edit' ];

        if ( !$this->isRevisionCurrent() ) {
            $options['oldid'] = intval( $this->getRevisionId() );
        }

        return $options;
    }

    function showEmailUser( $id ) {
        if ( $id instanceof User ) {
            $targetUser = $id;
        } else {
            $targetUser = User::newFromId( $id );
        }

        # The sending user must have a confirmed email address and the receiving
        # user must accept emails from the sender.
        return $this->getUser()->canSendEmail()
            && SpecialEmailUser::validateTarget( $targetUser, $this->getUser() ) === '';
    }

    function getSkinStylePath( $name ) {
        global $wgStylePath;

        if ( $this->stylename === null ) {
            $class = static::class;
            throw new MWException( "$class::\$stylename must be set to use getSkinStylePath()" );
        }

        return "$wgStylePath/{$this->stylename}/$name";
    }

    /* these are used extensively in SkinTemplate, but also some other places */

    static function makeMainPageUrl( $urlaction = '' ) {
        $title = Title::newMainPage();
        self::checkTitle( $title, '' );

        return $title->getLinkURL( $urlaction );
    }

    static function makeSpecialUrl( $name, $urlaction = '', $proto = null ) {
        $title = SpecialPage::getSafeTitleFor( $name );
        if ( is_null( $proto ) ) {
            return $title->getLocalURL( $urlaction );
        } else {
            return $title->getFullURL( $urlaction, false, $proto );
        }
    }

    static function makeSpecialUrlSubpage( $name, $subpage, $urlaction = '' ) {
        $title = SpecialPage::getSafeTitleFor( $name, $subpage );
        return $title->getLocalURL( $urlaction );
    }

    static function makeI18nUrl( $name, $urlaction = '' ) {
        $title = Title::newFromText( wfMessage( $name )->inContentLanguage()->text() );
        self::checkTitle( $title, $name );
        return $title->getLocalURL( $urlaction );
    }

    static function makeUrl( $name, $urlaction = '' ) {
        $title = Title::newFromText( $name );
        self::checkTitle( $title, $name );

        return $title->getLocalURL( $urlaction );
    }

    static function makeInternalOrExternalUrl( $name ) {
        if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $name ) ) {
            return $name;
        } else {
            return self::makeUrl( $name );
        }
    }

    static function makeNSUrl( $name, $urlaction = '', $namespace = NS_MAIN ) {
        $title = Title::makeTitleSafe( $namespace, $name );
        self::checkTitle( $title, $name );

        return $title->getLocalURL( $urlaction );
    }

    static function makeUrlDetails( $name, $urlaction = '' ) {
        $title = Title::newFromText( $name );
        self::checkTitle( $title, $name );

        return [
            'href' => $title->getLocalURL( $urlaction ),
            'exists' => $title->isKnown(),
        ];
    }

    static function makeKnownUrlDetails( $name, $urlaction = '' ) {
        $title = Title::newFromText( $name );
        self::checkTitle( $title, $name );

        return [
            'href' => $title->getLocalURL( $urlaction ),
            'exists' => true
        ];
    }

    static function checkTitle( &$title, $name ) {
        if ( !is_object( $title ) ) {
            $title = Title::newFromText( $name );
            if ( !is_object( $title ) ) {
                $title = Title::newFromText( '--error: link target missing--' );
            }
        }
    }

    public function buildSidebar() {
        global $wgEnableSidebarCache, $wgSidebarCacheExpiry;

        $callback = function ( $old = null, &$ttl = null ) {
            $bar = [];
            $this->addToSidebar( $bar, 'sidebar' );
            Hooks::run( 'SkinBuildSidebar', [ $this, &$bar ] );
            if ( MessageCache::singleton()->isDisabled() ) {
                $ttl = WANObjectCache::TTL_UNCACHEABLE; // bug T133069
            }

            return $bar;
        };

        $msgCache = MessageCache::singleton();
        $wanCache = MediaWikiServices::getInstance()->getMainWANObjectCache();

        $sidebar = $wgEnableSidebarCache
            ? $wanCache->getWithSetCallback(
                $wanCache->makeKey( 'sidebar', $this->getLanguage()->getCode() ),
                $wgSidebarCacheExpiry,
                $callback,
                [
                    'checkKeys' => [
                        // Unless there is both no exact $code override nor an i18n definition
                        // in the software, the only MediaWiki page to check is for $code.
                        $msgCache->getCheckKey( $this->getLanguage()->getCode() )
                    ],
                    'lockTSE' => 30
                ]
            )
            : $callback();

        // Apply post-processing to the cached value
        Hooks::run( 'SidebarBeforeOutput', [ $this, &$sidebar ] );

        return $sidebar;
    }

    public function addToSidebar( &$bar, $message ) {
        $this->addToSidebarPlain( $bar, $this->msg( $message )->inContentLanguage()->plain() );
    }

    function addToSidebarPlain( &$bar, $text ) {
        $lines = explode( "\n", $text );

        $heading = '';
        $messageTitle = $this->getConfig()->get( 'EnableSidebarCache' )
            ? Title::newMainPage() : $this->getTitle();

        foreach ( $lines as $line ) {
            if ( strpos( $line, '*' ) !== 0 ) {
                continue;
            }
            $line = rtrim( $line, "\r" ); // for Windows compat

            if ( strpos( $line, '**' ) !== 0 ) {
                $heading = trim( $line, '* ' );
                if ( !array_key_exists( $heading, $bar ) ) {
                    $bar[$heading] = [];
                }
            } else {
                $line = trim( $line, '* ' );

                if ( strpos( $line, '|' ) !== false ) { // sanity check
                    $line = MessageCache::singleton()->transform( $line, false, null, $messageTitle );
                    $line = array_map( 'trim', explode( '|', $line, 2 ) );
                    if ( count( $line ) !== 2 ) {
                        // Second sanity check, could be hit by people doing
                        // funky stuff with parserfuncs... (T35321)
                        continue;
                    }

                    $extraAttribs = [];

                    $msgLink = $this->msg( $line[0] )->title( $messageTitle )->inContentLanguage();
                    if ( $msgLink->exists() ) {
                        $link = $msgLink->text();
                        if ( $link == '-' ) {
                            continue;
                        }
                    } else {
                        $link = $line[0];
                    }
                    $msgText = $this->msg( $line[1] )->title( $messageTitle );
                    if ( $msgText->exists() ) {
                        $text = $msgText->text();
                    } else {
                        $text = $line[1];
                    }

                    if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $link ) ) {
                        $href = $link;

                        // Parser::getExternalLinkAttribs won't work here because of the Namespace things
                        global $wgNoFollowLinks, $wgNoFollowDomainExceptions;
                        if ( $wgNoFollowLinks && !wfMatchesDomainList( $href, $wgNoFollowDomainExceptions ) ) {
                            $extraAttribs['rel'] = 'nofollow';
                        }

                        global $wgExternalLinkTarget;
                        if ( $wgExternalLinkTarget ) {
                            $extraAttribs['target'] = $wgExternalLinkTarget;
                        }
                    } else {
                        $title = Title::newFromText( $link );

                        if ( $title ) {
                            $title = $title->fixSpecialName();
                            $href = $title->getLinkURL();
                        } else {
                            $href = 'INVALID-TITLE';
                        }
                    }

                    $bar[$heading][] = array_merge( [
                        'text' => $text,
                        'href' => $href,
                        'id' => Sanitizer::escapeIdForAttribute( 'n-' . strtr( $line[1], ' ', '-' ) ),
                        'active' => false,
                    ], $extraAttribs );
                } else {
                    continue;
                }
            }
        }

        return $bar;
    }

    function getNewtalks() {
        $newMessagesAlert = '';
        $user = $this->getUser();
        $newtalks = $user->getNewMessageLinks();
        $out = $this->getOutput();

        // Allow extensions to disable or modify the new messages alert
        if ( !Hooks::run( 'GetNewMessagesAlert', [ &$newMessagesAlert, $newtalks, $user, $out ] ) ) {
            return '';
        }
        if ( $newMessagesAlert ) {
            return $newMessagesAlert;
        }

        if ( count( $newtalks ) == 1 && $newtalks[0]['wiki'] === wfWikiID() ) {
            $uTalkTitle = $user->getTalkPage();
            $lastSeenRev = $newtalks[0]['rev'] ?? null;
            $nofAuthors = 0;
            if ( $lastSeenRev !== null ) {
                $plural = true; // Default if we have a last seen revision: if unknown, use plural
                $latestRev = Revision::newFromTitle( $uTalkTitle, false, Revision::READ_NORMAL );
                if ( $latestRev !== null ) {
                    // Singular if only 1 unseen revision, plural if several unseen revisions.
                    $plural = $latestRev->getParentId() !== $lastSeenRev->getId();
                    $nofAuthors = $uTalkTitle->countAuthorsBetween(
                        $lastSeenRev, $latestRev, 10, 'include_new' );
                }
            } else {
                // Singular if no revision -> diff link will show latest change only in any case
                $plural = false;
            }
            $plural = $plural ? 999 : 1;
            // 999 signifies "more than one revision". We don't know how many, and even if we did,
            // the number of revisions or authors is not necessarily the same as the number of
            // "messages".
            $newMessagesLink = Linker::linkKnown(
                $uTalkTitle,
                $this->msg( 'newmessageslinkplural' )->params( $plural )->escaped(),
                [],
                $uTalkTitle->isRedirect() ? [ 'redirect' => 'no' ] : []
            );

            $newMessagesDiffLink = Linker::linkKnown(
                $uTalkTitle,
                $this->msg( 'newmessagesdifflinkplural' )->params( $plural )->escaped(),
                [],
                $lastSeenRev !== null
                    ? [ 'oldid' => $lastSeenRev->getId(), 'diff' => 'cur' ]
                    : [ 'diff' => 'cur' ]
            );

            if ( $nofAuthors >= 1 && $nofAuthors <= 10 ) {
                $newMessagesAlert = $this->msg(
                    'youhavenewmessagesfromusers',
                    $newMessagesLink,
                    $newMessagesDiffLink
                )->numParams( $nofAuthors, $plural );
            } else {
                // $nofAuthors === 11 signifies "11 or more" ("more than 10")
                $newMessagesAlert = $this->msg(
                    $nofAuthors > 10 ? 'youhavenewmessagesmanyusers' : 'youhavenewmessages',
                    $newMessagesLink,
                    $newMessagesDiffLink
                )->numParams( $plural );
            }
            $newMessagesAlert = $newMessagesAlert->text();
            # Disable CDN cache
            $out->setCdnMaxage( 0 );
        } elseif ( count( $newtalks ) ) {
            $sep = $this->msg( 'newtalkseparator' )->escaped();
            $msgs = [];

            foreach ( $newtalks as $newtalk ) {
                $msgs[] = Xml::element(
                    'a',
                    [ 'href' => $newtalk['link'] ], $newtalk['wiki']
                );
            }
            $parts = implode( $sep, $msgs );
            $newMessagesAlert = $this->msg( 'youhavenewmessagesmulti' )->rawParams( $parts )->escaped();
            $out->setCdnMaxage( 0 );
        }

        return $newMessagesAlert;
    }

    private function getCachedNotice( $name ) {
        global $wgRenderHashAppend;

        $needParse = false;

        if ( $name === 'default' ) {
            // special case
            global $wgSiteNotice;
            $notice = $wgSiteNotice;
            if ( empty( $notice ) ) {
                return false;
            }
        } else {
            $msg = $this->msg( $name )->inContentLanguage();
            if ( $msg->isBlank() ) {
                return '';
            } elseif ( $msg->isDisabled() ) {
                return false;
            }
            $notice = $msg->plain();
        }

        $services = MediaWikiServices::getInstance();
        $cache = $services->getMainWANObjectCache();
        $parsed = $cache->getWithSetCallback(
            // Use the extra hash appender to let eg SSL variants separately cache
            // Key is verified with md5 hash of unparsed wikitext
            $cache->makeKey( $name, $wgRenderHashAppend, md5( $notice ) ),
            // TTL in seconds
            600,
            function () use ( $notice ) {
                return $this->getOutput()->parse( $notice );
            }
        );

        $contLang = $services->getContentLanguage();
        return Html::rawElement(
            'div',
            [
                'id' => 'localNotice',
                'lang' => $contLang->getHtmlCode(),
                'dir' => $contLang->getDir()
            ],
            $parsed
        );
    }

    function getSiteNotice() {
        $siteNotice = '';

        if ( Hooks::run( 'SiteNoticeBefore', [ &$siteNotice, $this ] ) ) {
            if ( is_object( $this->getUser() ) && $this->getUser()->isLoggedIn() ) {
                $siteNotice = $this->getCachedNotice( 'sitenotice' );
            } else {
                $anonNotice = $this->getCachedNotice( 'anonnotice' );
                if ( $anonNotice === false ) {
                    $siteNotice = $this->getCachedNotice( 'sitenotice' );
                } else {
                    $siteNotice = $anonNotice;
                }
            }
            if ( $siteNotice === false ) {
                $siteNotice = $this->getCachedNotice( 'default' );
            }
        }

        Hooks::run( 'SiteNoticeAfter', [ &$siteNotice, $this ] );
        return $siteNotice;
    }

    public function doEditSectionLink( Title $nt, $section, $tooltip, Language $lang ) {
        // HTML generated here should probably have userlangattributes
        // added to it for LTR text on RTL pages

        $attribs = [];
        if ( !is_null( $tooltip ) ) {
            $attribs['title'] = $this->msg( 'editsectionhint' )->rawParams( $tooltip )
                ->inLanguage( $lang )->text();
        }

        $links = [
            'editsection' => [
                'text' => $this->msg( 'editsection' )->inLanguage( $lang )->escaped(),
                'targetTitle' => $nt,
                'attribs' => $attribs,
                'query' => [ 'action' => 'edit', 'section' => $section ],
                'options' => [ 'noclasses', 'known' ]
            ]
        ];

        Hooks::run( 'SkinEditSectionLinks', [ $this, $nt, $section, $tooltip, &$links, $lang ] );

        $result = '<span class="mw-editsection"><span class="mw-editsection-bracket">[</span>';

        $linksHtml = [];
        foreach ( $links as $k => $linkDetails ) {
            $linksHtml[] = Linker::link(
                $linkDetails['targetTitle'],
                $linkDetails['text'],
                $linkDetails['attribs'],
                $linkDetails['query'],
                $linkDetails['options']
            );
        }

        $result .= implode(
            '<span class="mw-editsection-divider">'
                . $this->msg( 'pipe-separator' )->inLanguage( $lang )->escaped()
                . '</span>',
            $linksHtml
        );

        $result .= '<span class="mw-editsection-bracket">]</span></span>';
        return $result;
    }

}