Linker.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkTarget;
use MediaWiki\MediaWikiServices;

class Linker {
    const TOOL_LINKS_NOBLOCK = 1;
    const TOOL_LINKS_EMAIL = 2;

    static function getInterwikiLinkAttributes( $title, $unused = null, $class = 'external' ) {
        global $wgContLang;

        wfDeprecated( __METHOD__, '1.25' );

        # @todo FIXME: We have a whole bunch of handling here that doesn't happen in
        # getExternalLinkAttributes, why?
        $title = urldecode( $title );
        $title = $wgContLang->checkTitleEncoding( $title );
        $title = preg_replace( '/[\\x00-\\x1f]/', ' ', $title );

        return self::getLinkAttributesInternal( $title, $class );
    }

    static function getInternalLinkAttributes( $title, $unused = null, $class = '' ) {
        wfDeprecated( __METHOD__, '1.25' );

        $title = urldecode( $title );
        $title = strtr( $title, '_', ' ' );
        return self::getLinkAttributesInternal( $title, $class );
    }

    static function getInternalLinkAttributesObj( $nt, $unused = null, $class = '', $title = false ) {
        wfDeprecated( __METHOD__, '1.25' );

        if ( $title === false ) {
            $title = $nt->getPrefixedText();
        }
        return self::getLinkAttributesInternal( $title, $class );
    }

    private static function getLinkAttributesInternal( $title, $class ) {
        wfDeprecated( __METHOD__, '1.25' );

        $title = htmlspecialchars( $title );
        $class = htmlspecialchars( $class );
        $r = '';
        if ( $class != '' ) {
            $r .= " class=\"$class\"";
        }
        if ( $title != '' ) {
            $r .= " title=\"$title\"";
        }
        return $r;
    }

    public static function getLinkColour( LinkTarget $t, $threshold ) {
        wfDeprecated( __METHOD__, '1.28' );
        $services = MediaWikiServices::getInstance();
        $linkRenderer = $services->getLinkRenderer();
        if ( $threshold !== $linkRenderer->getStubThreshold() ) {
            // Need to create a new instance with the right stub threshold...
            $linkRenderer = $services->getLinkRendererFactory()->create();
            $linkRenderer->setStubThreshold( $threshold );
        }

        return $linkRenderer->getLinkClasses( $t );
    }

    public static function link(
        $target, $html = null, $customAttribs = [], $query = [], $options = []
    ) {
        if ( !$target instanceof Title ) {
            wfWarn( __METHOD__ . ': Requires $target to be a Title object.', 2 );
            return "<!-- ERROR -->$html";
        }

        if ( is_string( $query ) ) {
            // some functions withing core using this still hand over query strings
            wfDeprecated( __METHOD__ . ' with parameter $query as string (should be array)', '1.20' );
            $query = wfCgiToArray( $query );
        }

        $services = MediaWikiServices::getInstance();
        $options = (array)$options;
        if ( $options ) {
            // Custom options, create new LinkRenderer
            if ( !isset( $options['stubThreshold'] ) ) {
                $defaultLinkRenderer = $services->getLinkRenderer();
                $options['stubThreshold'] = $defaultLinkRenderer->getStubThreshold();
            }
            $linkRenderer = $services->getLinkRendererFactory()
                ->createFromLegacyOptions( $options );
        } else {
            $linkRenderer = $services->getLinkRenderer();
        }

        if ( $html !== null ) {
            $text = new HtmlArmor( $html );
        } else {
            $text = $html; // null
        }
        if ( in_array( 'known', $options, true ) ) {
            return $linkRenderer->makeKnownLink( $target, $text, $customAttribs, $query );
        } elseif ( in_array( 'broken', $options, true ) ) {
            return $linkRenderer->makeBrokenLink( $target, $text, $customAttribs, $query );
        } elseif ( in_array( 'noclasses', $options, true ) ) {
            return $linkRenderer->makePreloadedLink( $target, $text, '', $customAttribs, $query );
        } else {
            return $linkRenderer->makeLink( $target, $text, $customAttribs, $query );
        }
    }

    public static function linkKnown(
        $target, $html = null, $customAttribs = [],
        $query = [], $options = [ 'known' ]
    ) {
        return self::link( $target, $html, $customAttribs, $query, $options );
    }

    public static function makeSelfLinkObj( $nt, $html = '', $query = '', $trail = '', $prefix = '' ) {
        $ret = "<strong class=\"selflink\">{$prefix}{$html}</strong>{$trail}";
        if ( !Hooks::run( 'SelfLinkBegin', [ $nt, &$html, &$trail, &$prefix, &$ret ] ) ) {
            return $ret;
        }

        if ( $html == '' ) {
            $html = htmlspecialchars( $nt->getPrefixedText() );
        }
        list( $inside, $trail ) = self::splitTrail( $trail );
        return "<strong class=\"selflink\">{$prefix}{$html}{$inside}</strong>{$trail}";
    }

    public static function getInvalidTitleDescription( IContextSource $context, $namespace, $title ) {
        global $wgContLang;

        // First we check whether the namespace exists or not.
        if ( MWNamespace::exists( $namespace ) ) {
            if ( $namespace == NS_MAIN ) {
                $name = $context->msg( 'blanknamespace' )->text();
            } else {
                $name = $wgContLang->getFormattedNsText( $namespace );
            }
            return $context->msg( 'invalidtitle-knownnamespace', $namespace, $name, $title )->text();
        } else {
            return $context->msg( 'invalidtitle-unknownnamespace', $namespace, $title )->text();
        }
    }

    public static function normaliseSpecialPage( LinkTarget $target ) {
        if ( $target->getNamespace() == NS_SPECIAL && !$target->isExternal() ) {
            list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $target->getDBkey() );
            if ( !$name ) {
                return $target;
            }
            $ret = SpecialPage::getTitleValueFor( $name, $subpage, $target->getFragment() );
            return $ret;
        } else {
            return $target;
        }
    }

    private static function fnamePart( $url ) {
        $basename = strrchr( $url, '/' );
        if ( false === $basename ) {
            $basename = $url;
        } else {
            $basename = substr( $basename, 1 );
        }
        return $basename;
    }

    public static function makeExternalImage( $url, $alt = '' ) {
        if ( $alt == '' ) {
            $alt = self::fnamePart( $url );
        }
        $img = '';
        $success = Hooks::run( 'LinkerMakeExternalImage', [ &$url, &$alt, &$img ] );
        if ( !$success ) {
            wfDebug( "Hook LinkerMakeExternalImage changed the output of external image "
                . "with url {$url} and alt text {$alt} to {$img}\n", true );
            return $img;
        }
        return Html::element( 'img',
            [
                'src' => $url,
                'alt' => $alt ] );
    }

    public static function makeImageLink( Parser $parser, Title $title,
        $file, $frameParams = [], $handlerParams = [], $time = false,
        $query = "", $widthOption = null
    ) {
        $res = null;
        $dummy = new DummyLinker;
        if ( !Hooks::run( 'ImageBeforeProduceHTML', [ &$dummy, &$title,
            &$file, &$frameParams, &$handlerParams, &$time, &$res ] ) ) {
            return $res;
        }

        if ( $file && !$file->allowInlineDisplay() ) {
            wfDebug( __METHOD__ . ': ' . $title->getPrefixedDBkey() . " does not allow inline display\n" );
            return self::link( $title );
        }

        // Clean up parameters
        $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
        if ( !isset( $frameParams['align'] ) ) {
            $frameParams['align'] = '';
        }
        if ( !isset( $frameParams['alt'] ) ) {
            $frameParams['alt'] = '';
        }
        if ( !isset( $frameParams['title'] ) ) {
            $frameParams['title'] = '';
        }
        if ( !isset( $frameParams['class'] ) ) {
            $frameParams['class'] = '';
        }

        $prefix = $postfix = '';

        if ( 'center' == $frameParams['align'] ) {
            $prefix = '<div class="center">';
            $postfix = '</div>';
            $frameParams['align'] = 'none';
        }
        if ( $file && !isset( $handlerParams['width'] ) ) {
            if ( isset( $handlerParams['height'] ) && $file->isVectorized() ) {
                // If its a vector image, and user only specifies height
                // we don't want it to be limited by its "normal" width.
                global $wgSVGMaxSize;
                $handlerParams['width'] = $wgSVGMaxSize;
            } else {
                $handlerParams['width'] = $file->getWidth( $page );
            }

            if ( isset( $frameParams['thumbnail'] )
                || isset( $frameParams['manualthumb'] )
                || isset( $frameParams['framed'] )
                || isset( $frameParams['frameless'] )
                || !$handlerParams['width']
            ) {
                global $wgThumbLimits, $wgThumbUpright;

                if ( $widthOption === null || !isset( $wgThumbLimits[$widthOption] ) ) {
                    $widthOption = User::getDefaultOption( 'thumbsize' );
                }

                // Reduce width for upright images when parameter 'upright' is used
                if ( isset( $frameParams['upright'] ) && $frameParams['upright'] == 0 ) {
                    $frameParams['upright'] = $wgThumbUpright;
                }

                // For caching health: If width scaled down due to upright
                // parameter, round to full __0 pixel to avoid the creation of a
                // lot of odd thumbs.
                $prefWidth = isset( $frameParams['upright'] ) ?
                    round( $wgThumbLimits[$widthOption] * $frameParams['upright'], -1 ) :
                    $wgThumbLimits[$widthOption];

                // Use width which is smaller: real image width or user preference width
                // Unless image is scalable vector.
                if ( !isset( $handlerParams['height'] ) && ( $handlerParams['width'] <= 0 ||
                        $prefWidth < $handlerParams['width'] || $file->isVectorized() ) ) {
                    $handlerParams['width'] = $prefWidth;
                }
            }
        }

        if ( isset( $frameParams['thumbnail'] ) || isset( $frameParams['manualthumb'] )
            || isset( $frameParams['framed'] )
        ) {
            # Create a thumbnail. Alignment depends on the writing direction of
            # the page content language (right-aligned for LTR languages,
            # left-aligned for RTL languages)
            # If a thumbnail width has not been provided, it is set
            # to the default user option as specified in Language*.php
            if ( $frameParams['align'] == '' ) {
                $frameParams['align'] = $parser->getTargetLanguage()->alignEnd();
            }
            return $prefix .
                self::makeThumbLink2( $title, $file, $frameParams, $handlerParams, $time, $query ) .
                $postfix;
        }

        if ( $file && isset( $frameParams['frameless'] ) ) {
            $srcWidth = $file->getWidth( $page );
            # For "frameless" option: do not present an image bigger than the
            # source (for bitmap-style images). This is the same behavior as the
            # "thumb" option does it already.
            if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
                $handlerParams['width'] = $srcWidth;
            }
        }

        if ( $file && isset( $handlerParams['width'] ) ) {
            # Create a resized image, without the additional thumbnail features
            $thumb = $file->transform( $handlerParams );
        } else {
            $thumb = false;
        }

        if ( !$thumb ) {
            $s = self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
        } else {
            self::processResponsiveImages( $file, $thumb, $handlerParams );
            $params = [
                'alt' => $frameParams['alt'],
                'title' => $frameParams['title'],
                'valign' => isset( $frameParams['valign'] ) ? $frameParams['valign'] : false,
                'img-class' => $frameParams['class'] ];
            if ( isset( $frameParams['border'] ) ) {
                $params['img-class'] .= ( $params['img-class'] !== '' ? ' ' : '' ) . 'thumbborder';
            }
            $params = self::getImageLinkMTOParams( $frameParams, $query, $parser ) + $params;

            $s = $thumb->toHtml( $params );
        }
        if ( $frameParams['align'] != '' ) {
            $s = "<div class=\"float{$frameParams['align']}\">{$s}</div>";
        }
        return str_replace( "\n", ' ', $prefix . $s . $postfix );
    }

    private static function getImageLinkMTOParams( $frameParams, $query = '', $parser = null ) {
        $mtoParams = [];
        if ( isset( $frameParams['link-url'] ) && $frameParams['link-url'] !== '' ) {
            $mtoParams['custom-url-link'] = $frameParams['link-url'];
            if ( isset( $frameParams['link-target'] ) ) {
                $mtoParams['custom-target-link'] = $frameParams['link-target'];
            }
            if ( $parser ) {
                $extLinkAttrs = $parser->getExternalLinkAttribs( $frameParams['link-url'] );
                foreach ( $extLinkAttrs as $name => $val ) {
                    // Currently could include 'rel' and 'target'
                    $mtoParams['parser-extlink-' . $name] = $val;
                }
            }
        } elseif ( isset( $frameParams['link-title'] ) && $frameParams['link-title'] !== '' ) {
            $mtoParams['custom-title-link'] = Title::newFromLinkTarget(
                self::normaliseSpecialPage( $frameParams['link-title'] )
            );
        } elseif ( !empty( $frameParams['no-link'] ) ) {
            // No link
        } else {
            $mtoParams['desc-link'] = true;
            $mtoParams['desc-query'] = $query;
        }
        return $mtoParams;
    }

    public static function makeThumbLinkObj( Title $title, $file, $label = '', $alt,
        $align = 'right', $params = [], $framed = false, $manualthumb = ""
    ) {
        $frameParams = [
            'alt' => $alt,
            'caption' => $label,
            'align' => $align
        ];
        if ( $framed ) {
            $frameParams['framed'] = true;
        }
        if ( $manualthumb ) {
            $frameParams['manualthumb'] = $manualthumb;
        }
        return self::makeThumbLink2( $title, $file, $frameParams, $params );
    }

    public static function makeThumbLink2( Title $title, $file, $frameParams = [],
        $handlerParams = [], $time = false, $query = ""
    ) {
        $exists = $file && $file->exists();

        $page = isset( $handlerParams['page'] ) ? $handlerParams['page'] : false;
        if ( !isset( $frameParams['align'] ) ) {
            $frameParams['align'] = 'right';
        }
        if ( !isset( $frameParams['alt'] ) ) {
            $frameParams['alt'] = '';
        }
        if ( !isset( $frameParams['title'] ) ) {
            $frameParams['title'] = '';
        }
        if ( !isset( $frameParams['caption'] ) ) {
            $frameParams['caption'] = '';
        }

        if ( empty( $handlerParams['width'] ) ) {
            // Reduce width for upright images when parameter 'upright' is used
            $handlerParams['width'] = isset( $frameParams['upright'] ) ? 130 : 180;
        }
        $thumb = false;
        $noscale = false;
        $manualthumb = false;

        if ( !$exists ) {
            $outerWidth = $handlerParams['width'] + 2;
        } else {
            if ( isset( $frameParams['manualthumb'] ) ) {
                # Use manually specified thumbnail
                $manual_title = Title::makeTitleSafe( NS_FILE, $frameParams['manualthumb'] );
                if ( $manual_title ) {
                    $manual_img = wfFindFile( $manual_title );
                    if ( $manual_img ) {
                        $thumb = $manual_img->getUnscaledThumb( $handlerParams );
                        $manualthumb = true;
                    } else {
                        $exists = false;
                    }
                }
            } elseif ( isset( $frameParams['framed'] ) ) {
                // Use image dimensions, don't scale
                $thumb = $file->getUnscaledThumb( $handlerParams );
                $noscale = true;
            } else {
                # Do not present an image bigger than the source, for bitmap-style images
                # This is a hack to maintain compatibility with arbitrary pre-1.10 behavior
                $srcWidth = $file->getWidth( $page );
                if ( $srcWidth && !$file->mustRender() && $handlerParams['width'] > $srcWidth ) {
                    $handlerParams['width'] = $srcWidth;
                }
                $thumb = $file->transform( $handlerParams );
            }

            if ( $thumb ) {
                $outerWidth = $thumb->getWidth() + 2;
            } else {
                $outerWidth = $handlerParams['width'] + 2;
            }
        }

        # ThumbnailImage::toHtml() already adds page= onto the end of DjVu URLs
        # So we don't need to pass it here in $query. However, the URL for the
        # zoom icon still needs it, so we make a unique query for it. See bug 14771
        $url = $title->getLocalURL( $query );
        if ( $page ) {
            $url = wfAppendQuery( $url, [ 'page' => $page ] );
        }
        if ( $manualthumb
            && !isset( $frameParams['link-title'] )
            && !isset( $frameParams['link-url'] )
            && !isset( $frameParams['no-link'] ) ) {
            $frameParams['link-url'] = $url;
        }

        $s = "<div class=\"thumb t{$frameParams['align']}\">"
            . "<div class=\"thumbinner\" style=\"width:{$outerWidth}px;\">";

        if ( !$exists ) {
            $s .= self::makeBrokenImageLinkObj( $title, $frameParams['title'], '', '', '', $time == true );
            $zoomIcon = '';
        } elseif ( !$thumb ) {
            $s .= wfMessage( 'thumbnail_error', '' )->escaped();
            $zoomIcon = '';
        } else {
            if ( !$noscale && !$manualthumb ) {
                self::processResponsiveImages( $file, $thumb, $handlerParams );
            }
            $params = [
                'alt' => $frameParams['alt'],
                'title' => $frameParams['title'],
                'img-class' => ( isset( $frameParams['class'] ) && $frameParams['class'] !== ''
                    ? $frameParams['class'] . ' '
                    : '' ) . 'thumbimage'
            ];
            $params = self::getImageLinkMTOParams( $frameParams, $query ) + $params;
            $s .= $thumb->toHtml( $params );
            if ( isset( $frameParams['framed'] ) ) {
                $zoomIcon = "";
            } else {
                $zoomIcon = Html::rawElement( 'div', [ 'class' => 'magnify' ],
                    Html::rawElement( 'a', [
                        'href' => $url,
                        'class' => 'internal',
                        'title' => wfMessage( 'thumbnail-more' )->text() ],
                        "" ) );
            }
        }
        $s .= '  <div class="thumbcaption">' . $zoomIcon . $frameParams['caption'] . "</div></div></div>";
        return str_replace( "\n", ' ', $s );
    }

    public static function processResponsiveImages( $file, $thumb, $hp ) {
        global $wgResponsiveImages;
        if ( $wgResponsiveImages && $thumb && !$thumb->isError() ) {
            $hp15 = $hp;
            $hp15['width'] = round( $hp['width'] * 1.5 );
            $hp20 = $hp;
            $hp20['width'] = $hp['width'] * 2;
            if ( isset( $hp['height'] ) ) {
                $hp15['height'] = round( $hp['height'] * 1.5 );
                $hp20['height'] = $hp['height'] * 2;
            }

            $thumb15 = $file->transform( $hp15 );
            $thumb20 = $file->transform( $hp20 );
            if ( $thumb15 && !$thumb15->isError() && $thumb15->getUrl() !== $thumb->getUrl() ) {
                $thumb->responsiveUrls['1.5'] = $thumb15->getUrl();
            }
            if ( $thumb20 && !$thumb20->isError() && $thumb20->getUrl() !== $thumb->getUrl() ) {
                $thumb->responsiveUrls['2'] = $thumb20->getUrl();
            }
        }
    }

    public static function makeBrokenImageLinkObj( $title, $label = '',
        $query = '', $unused1 = '', $unused2 = '', $time = false
    ) {
        if ( !$title instanceof Title ) {
            wfWarn( __METHOD__ . ': Requires $title to be a Title object.' );
            return "<!-- ERROR -->" . htmlspecialchars( $label );
        }

        global $wgEnableUploads, $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
        if ( $label == '' ) {
            $label = $title->getPrefixedText();
        }
        $encLabel = htmlspecialchars( $label );
        $currentExists = $time ? ( wfFindFile( $title ) != false ) : false;

        if ( ( $wgUploadMissingFileUrl || $wgUploadNavigationUrl || $wgEnableUploads )
            && !$currentExists
        ) {
            $redir = RepoGroup::singleton()->getLocalRepo()->checkRedirect( $title );

            if ( $redir ) {
                // We already know it's a redirect, so mark it
                // accordingly
                return self::link(
                    $title,
                    $encLabel,
                    [ 'class' => 'mw-redirect' ],
                    wfCgiToArray( $query ),
                    [ 'known', 'noclasses' ]
                );
            }

            $href = self::getUploadUrl( $title, $query );

            return '<a href="' . htmlspecialchars( $href ) . '" class="new" title="' .
                htmlspecialchars( $title->getPrefixedText(), ENT_QUOTES ) . '">' .
                $encLabel . '</a>';
        }

        return self::link( $title, $encLabel, [], wfCgiToArray( $query ), [ 'known', 'noclasses' ] );
    }

    protected static function getUploadUrl( $destFile, $query = '' ) {
        global $wgUploadMissingFileUrl, $wgUploadNavigationUrl;
        $q = 'wpDestFile=' . $destFile->getPartialURL();
        if ( $query != '' ) {
            $q .= '&' . $query;
        }

        if ( $wgUploadMissingFileUrl ) {
            return wfAppendQuery( $wgUploadMissingFileUrl, $q );
        } elseif ( $wgUploadNavigationUrl ) {
            return wfAppendQuery( $wgUploadNavigationUrl, $q );
        } else {
            $upload = SpecialPage::getTitleFor( 'Upload' );
            return $upload->getLocalURL( $q );
        }
    }

    public static function makeMediaLinkObj( $title, $html = '', $time = false ) {
        $img = wfFindFile( $title, [ 'time' => $time ] );
        return self::makeMediaLinkFile( $title, $img, $html );
    }

    public static function makeMediaLinkFile( Title $title, $file, $html = '' ) {
        if ( $file && $file->exists() ) {
            $url = $file->getUrl();
            $class = 'internal';
        } else {
            $url = self::getUploadUrl( $title );
            $class = 'new';
        }

        $alt = $title->getText();
        if ( $html == '' ) {
            $html = $alt;
        }

        $ret = '';
        $attribs = [
            'href' => $url,
            'class' => $class,
            'title' => $alt
        ];

        if ( !Hooks::run( 'LinkerMakeMediaLinkFile',
            [ $title, $file, &$html, &$attribs, &$ret ] ) ) {
            wfDebug( "Hook LinkerMakeMediaLinkFile changed the output of link "
                . "with url {$url} and text {$html} to {$ret}\n", true );
            return $ret;
        }

        return Html::rawElement( 'a', $attribs, $html );
    }

    public static function specialLink( $name, $key = '' ) {
        if ( $key == '' ) {
            $key = strtolower( $name );
        }

        return self::linkKnown( SpecialPage::getTitleFor( $name ), wfMessage( $key )->text() );
    }

    public static function makeExternalLink( $url, $text, $escape = true,
        $linktype = '', $attribs = [], $title = null
    ) {
        global $wgTitle;
        $class = "external";
        if ( $linktype ) {
            $class .= " $linktype";
        }
        if ( isset( $attribs['class'] ) && $attribs['class'] ) {
            $class .= " {$attribs['class']}";
        }
        $attribs['class'] = $class;

        if ( $escape ) {
            $text = htmlspecialchars( $text );
        }

        if ( !$title ) {
            $title = $wgTitle;
        }
        $newRel = Parser::getExternalLinkRel( $url, $title );
        if ( !isset( $attribs['rel'] ) || $attribs['rel'] === '' ) {
            $attribs['rel'] = $newRel;
        } elseif ( $newRel !== '' ) {
            // Merge the rel attributes.
            $newRels = explode( ' ', $newRel );
            $oldRels = explode( ' ', $attribs['rel'] );
            $combined = array_unique( array_merge( $newRels, $oldRels ) );
            $attribs['rel'] = implode( ' ', $combined );
        }
        $link = '';
        $success = Hooks::run( 'LinkerMakeExternalLink',
            [ &$url, &$text, &$link, &$attribs, $linktype ] );
        if ( !$success ) {
            wfDebug( "Hook LinkerMakeExternalLink changed the output of link "
                . "with url {$url} and text {$text} to {$link}\n", true );
            return $link;
        }
        $attribs['href'] = $url;
        return Html::rawElement( 'a', $attribs, $text );
    }

    public static function userLink( $userId, $userName, $altUserName = false ) {
        $classes = 'mw-userlink';
        if ( $userId == 0 ) {
            $page = SpecialPage::getTitleFor( 'Contributions', $userName );
            if ( $altUserName === false ) {
                $altUserName = IP::prettifyIP( $userName );
            }
            $classes .= ' mw-anonuserlink'; // Separate link class for anons (bug 43179)
        } else {
            $page = Title::makeTitle( NS_USER, $userName );
        }

        // Wrap the output with <bdi> tags for directionality isolation
        return self::link(
            $page,
            '<bdi>' . htmlspecialchars( $altUserName !== false ? $altUserName : $userName ) . '</bdi>',
            [ 'class' => $classes ]
        );
    }

    public static function userToolLinks(
        $userId, $userText, $redContribsWhenNoEdits = false, $flags = 0, $edits = null
    ) {
        global $wgUser, $wgDisableAnonTalk, $wgLang;
        $talkable = !( $wgDisableAnonTalk && 0 == $userId );
        $blockable = !( $flags & self::TOOL_LINKS_NOBLOCK );
        $addEmailLink = $flags & self::TOOL_LINKS_EMAIL && $userId;

        $items = [];
        if ( $talkable ) {
            $items[] = self::userTalkLink( $userId, $userText );
        }
        if ( $userId ) {
            // check if the user has an edit
            $attribs = [];
            if ( $redContribsWhenNoEdits ) {
                if ( intval( $edits ) === 0 && $edits !== 0 ) {
                    $user = User::newFromId( $userId );
                    $edits = $user->getEditCount();
                }
                if ( $edits === 0 ) {
                    $attribs['class'] = 'new';
                }
            }
            $contribsPage = SpecialPage::getTitleFor( 'Contributions', $userText );

            $items[] = self::link( $contribsPage, wfMessage( 'contribslink' )->escaped(), $attribs );
        }
        if ( $blockable && $wgUser->isAllowed( 'block' ) ) {
            $items[] = self::blockLink( $userId, $userText );
        }

        if ( $addEmailLink && $wgUser->canSendEmail() ) {
            $items[] = self::emailLink( $userId, $userText );
        }

        Hooks::run( 'UserToolLinksEdit', [ $userId, $userText, &$items ] );

        if ( $items ) {
            return wfMessage( 'word-separator' )->escaped()
                . '<span class="mw-usertoollinks">'
                . wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $items ) )->escaped()
                . '</span>';
        } else {
            return '';
        }
    }

    public static function userToolLinksRedContribs( $userId, $userText, $edits = null ) {
        return self::userToolLinks( $userId, $userText, true, 0, $edits );
    }

    public static function userTalkLink( $userId, $userText ) {
        $userTalkPage = Title::makeTitle( NS_USER_TALK, $userText );
        $userTalkLink = self::link( $userTalkPage, wfMessage( 'talkpagelinktext' )->escaped() );
        return $userTalkLink;
    }

    public static function blockLink( $userId, $userText ) {
        $blockPage = SpecialPage::getTitleFor( 'Block', $userText );
        $blockLink = self::link( $blockPage, wfMessage( 'blocklink' )->escaped() );
        return $blockLink;
    }

    public static function emailLink( $userId, $userText ) {
        $emailPage = SpecialPage::getTitleFor( 'Emailuser', $userText );
        $emailLink = self::link( $emailPage, wfMessage( 'emaillink' )->escaped() );
        return $emailLink;
    }

    public static function revUserLink( $rev, $isPublic = false ) {
        if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
            $link = wfMessage( 'rev-deleted-user' )->escaped();
        } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
            $link = self::userLink( $rev->getUser( Revision::FOR_THIS_USER ),
                $rev->getUserText( Revision::FOR_THIS_USER ) );
        } else {
            $link = wfMessage( 'rev-deleted-user' )->escaped();
        }
        if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
            return '<span class="history-deleted">' . $link . '</span>';
        }
        return $link;
    }

    public static function revUserTools( $rev, $isPublic = false ) {
        if ( $rev->isDeleted( Revision::DELETED_USER ) && $isPublic ) {
            $link = wfMessage( 'rev-deleted-user' )->escaped();
        } elseif ( $rev->userCan( Revision::DELETED_USER ) ) {
            $userId = $rev->getUser( Revision::FOR_THIS_USER );
            $userText = $rev->getUserText( Revision::FOR_THIS_USER );
            $link = self::userLink( $userId, $userText )
                . self::userToolLinks( $userId, $userText );
        } else {
            $link = wfMessage( 'rev-deleted-user' )->escaped();
        }
        if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
            return ' <span class="history-deleted">' . $link . '</span>';
        }
        return $link;
    }

    public static function formatComment(
        $comment, $title = null, $local = false, $wikiId = null
    ) {
        # Sanitize text a bit:
        $comment = str_replace( "\n", " ", $comment );
        # Allow HTML entities (for bug 13815)
        $comment = Sanitizer::escapeHtmlAllowEntities( $comment );

        # Render autocomments and make links:
        $comment = self::formatAutocomments( $comment, $title, $local, $wikiId );
        $comment = self::formatLinksInComment( $comment, $title, $local, $wikiId );

        return $comment;
    }

    private static function formatAutocomments(
        $comment, $title = null, $local = false, $wikiId = null
    ) {
        // @todo $append here is something of a hack to preserve the status
        // quo. Someone who knows more about bidi and such should decide
        // (1) what sane rendering even *is* for an LTR edit summary on an RTL
        // wiki, both when autocomments exist and when they don't, and
        // (2) what markup will make that actually happen.
        $append = '';
        $comment = preg_replace_callback(
            // To detect the presence of content before or after the
            // auto-comment, we use capturing groups inside optional zero-width
            // assertions. But older versions of PCRE can't directly make
            // zero-width assertions optional, so wrap them in a non-capturing
            // group.
            '!(?:(?<=(.)))?/\*\s*(.*?)\s*\*/(?:(?=(.)))?!',
            function ( $match ) use ( $title, $local, $wikiId, &$append ) {
                global $wgLang;

                // Ensure all match positions are defined
                $match += [ '', '', '', '' ];

                $pre = $match[1] !== '';
                $auto = $match[2];
                $post = $match[3] !== '';
                $comment = null;

                Hooks::run(
                    'FormatAutocomments',
                    [ &$comment, $pre, $auto, $post, $title, $local, $wikiId ]
                );

                if ( $comment === null ) {
                    $link = '';
                    if ( $title ) {
                        $section = $auto;
                        # Remove links that a user may have manually put in the autosummary
                        # This could be improved by copying as much of Parser::stripSectionName as desired.
                        $section = str_replace( '[[:', '', $section );
                        $section = str_replace( '[[', '', $section );
                        $section = str_replace( ']]', '', $section );

                        $section = Sanitizer::normalizeSectionNameWhitespace( $section ); # bug 22784
                        if ( $local ) {
                            $sectionTitle = Title::newFromText( '#' . $section );
                        } else {
                            $sectionTitle = Title::makeTitleSafe( $title->getNamespace(),
                                $title->getDBkey(), $section );
                        }
                        if ( $sectionTitle ) {
                            $link = Linker::makeCommentLink( $sectionTitle, $wgLang->getArrow(), $wikiId, 'noclasses' );
                        } else {
                            $link = '';
                        }
                    }
                    if ( $pre ) {
                        # written summary $presep autocomment (summary /* section */)
                        $pre = wfMessage( 'autocomment-prefix' )->inContentLanguage()->escaped();
                    }
                    if ( $post ) {
                        # autocomment $postsep written summary (/* section */ summary)
                        $auto .= wfMessage( 'colon-separator' )->inContentLanguage()->escaped();
                    }
                    $auto = '<span class="autocomment">' . $auto . '</span>';
                    $comment = $pre . $link . $wgLang->getDirMark()
                        . '<span dir="auto">' . $auto;
                    $append .= '</span>';
                }
                return $comment;
            },
            $comment
        );
        return $comment . $append;
    }

    public static function formatLinksInComment(
        $comment, $title = null, $local = false, $wikiId = null
    ) {
        return preg_replace_callback(
            '/
                \[\[
                :? # ignore optional leading colon
                ([^\]|]+) # 1. link target; page names cannot include ] or |
                (?:\|
                    # 2. link text
                    # Stop matching at ]] without relying on backtracking.
                    ((?:]?[^\]])*+)
                )?
                \]\]
                ([^[]*) # 3. link trail (the text up until the next link)
            /x',
            function ( $match ) use ( $title, $local, $wikiId ) {
                global $wgContLang;

                $medians = '(?:' . preg_quote( MWNamespace::getCanonicalName( NS_MEDIA ), '/' ) . '|';
                $medians .= preg_quote( $wgContLang->getNsText( NS_MEDIA ), '/' ) . '):';

                $comment = $match[0];

                # fix up urlencoded title texts (copied from Parser::replaceInternalLinks)
                if ( strpos( $match[1], '%' ) !== false ) {
                    $match[1] = strtr(
                        rawurldecode( $match[1] ),
                        [ '<' => '&lt;', '>' => '&gt;' ]
                    );
                }

                # Handle link renaming [[foo|text]] will show link as "text"
                if ( $match[2] != "" ) {
                    $text = $match[2];
                } else {
                    $text = $match[1];
                }
                $submatch = [];
                $thelink = null;
                if ( preg_match( '/^' . $medians . '(.*)$/i', $match[1], $submatch ) ) {
                    # Media link; trail not supported.
                    $linkRegexp = '/\[\[(.*?)\]\]/';
                    $title = Title::makeTitleSafe( NS_FILE, $submatch[1] );
                    if ( $title ) {
                        $thelink = Linker::makeMediaLinkObj( $title, $text );
                    }
                } else {
                    # Other kind of link
                    # Make sure its target is non-empty
                    if ( isset( $match[1][0] ) && $match[1][0] == ':' ) {
                        $match[1] = substr( $match[1], 1 );
                    }
                    if ( $match[1] !== false && $match[1] !== '' ) {
                        if ( preg_match( $wgContLang->linkTrail(), $match[3], $submatch ) ) {
                            $trail = $submatch[1];
                        } else {
                            $trail = "";
                        }
                        $linkRegexp = '/\[\[(.*?)\]\]' . preg_quote( $trail, '/' ) . '/';
                        list( $inside, $trail ) = Linker::splitTrail( $trail );

                        $linkText = $text;
                        $linkTarget = Linker::normalizeSubpageLink( $title, $match[1], $linkText );

                        $target = Title::newFromText( $linkTarget );
                        if ( $target ) {
                            if ( $target->getText() == '' && !$target->isExternal()
                                && !$local && $title
                            ) {
                                $newTarget = clone $title;
                                $newTarget->setFragment( '#' . $target->getFragment() );
                                $target = $newTarget;
                            }

                            $thelink = Linker::makeCommentLink( $target, $linkText . $inside, $wikiId ) . $trail;
                        }
                    }
                }
                if ( $thelink ) {
                    // If the link is still valid, go ahead and replace it in!
                    $comment = preg_replace(
                        $linkRegexp,
                        StringUtils::escapeRegexReplacement( $thelink ),
                        $comment,
                        1
                    );
                }

                return $comment;
            },
            $comment
        );
    }

    public static function makeCommentLink(
        Title $title, $text, $wikiId = null, $options = []
    ) {
        if ( $wikiId !== null && !$title->isExternal() ) {
            $link = Linker::makeExternalLink(
                WikiMap::getForeignURL(
                    $wikiId,
                    $title->getPrefixedText(),
                    $title->getFragment()
                ),
                $text,
                /* escape = */ false // Already escaped
            );
        } else {
            $link = Linker::link( $title, $text, [], [], $options );
        }

        return $link;
    }

    public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
        # Valid link forms:
        # Foobar -- normal
        # :Foobar -- override special treatment of prefix (images, language links)
        # /Foobar -- convert to CurrentPage/Foobar
        # /Foobar/ -- convert to CurrentPage/Foobar, strip the initial and final / from text
        # ../ -- convert to CurrentPage, from CurrentPage/CurrentSubPage
        # ../Foobar -- convert to CurrentPage/Foobar,
        #              (from CurrentPage/CurrentSubPage)
        # ../Foobar/ -- convert to CurrentPage/Foobar, use 'Foobar' as text
        #              (from CurrentPage/CurrentSubPage)

        $ret = $target; # default return value is no change

        # Some namespaces don't allow subpages,
        # so only perform processing if subpages are allowed
        if ( $contextTitle && MWNamespace::hasSubpages( $contextTitle->getNamespace() ) ) {
            $hash = strpos( $target, '#' );
            if ( $hash !== false ) {
                $suffix = substr( $target, $hash );
                $target = substr( $target, 0, $hash );
            } else {
                $suffix = '';
            }
            # bug 7425
            $target = trim( $target );
            # Look at the first character
            if ( $target != '' && $target[0] === '/' ) {
                # / at end means we don't want the slash to be shown
                $m = [];
                $trailingSlashes = preg_match_all( '%(/+)$%', $target, $m );
                if ( $trailingSlashes ) {
                    $noslash = $target = substr( $target, 1, -strlen( $m[0][0] ) );
                } else {
                    $noslash = substr( $target, 1 );
                }

                $ret = $contextTitle->getPrefixedText() . '/' . trim( $noslash ) . $suffix;
                if ( $text === '' ) {
                    $text = $target . $suffix;
                } # this might be changed for ugliness reasons
            } else {
                # check for .. subpage backlinks
                $dotdotcount = 0;
                $nodotdot = $target;
                while ( strncmp( $nodotdot, "../", 3 ) == 0 ) {
                    ++$dotdotcount;
                    $nodotdot = substr( $nodotdot, 3 );
                }
                if ( $dotdotcount > 0 ) {
                    $exploded = explode( '/', $contextTitle->getPrefixedText() );
                    if ( count( $exploded ) > $dotdotcount ) { # not allowed to go below top level page
                        $ret = implode( '/', array_slice( $exploded, 0, -$dotdotcount ) );
                        # / at the end means don't show full path
                        if ( substr( $nodotdot, -1, 1 ) === '/' ) {
                            $nodotdot = rtrim( $nodotdot, '/' );
                            if ( $text === '' ) {
                                $text = $nodotdot . $suffix;
                            }
                        }
                        $nodotdot = trim( $nodotdot );
                        if ( $nodotdot != '' ) {
                            $ret .= '/' . $nodotdot;
                        }
                        $ret .= $suffix;
                    }
                }
            }
        }

        return $ret;
    }

    public static function commentBlock(
        $comment, $title = null, $local = false, $wikiId = null
    ) {
        // '*' used to be the comment inserted by the software way back
        // in antiquity in case none was provided, here for backwards
        // compatibility, acc. to brion -ævar
        if ( $comment == '' || $comment == '*' ) {
            return '';
        } else {
            $formatted = self::formatComment( $comment, $title, $local, $wikiId );
            $formatted = wfMessage( 'parentheses' )->rawParams( $formatted )->escaped();
            return " <span class=\"comment\">$formatted</span>";
        }
    }

    public static function revComment( Revision $rev, $local = false, $isPublic = false ) {
        if ( $rev->getComment( Revision::RAW ) == "" ) {
            return "";
        }
        if ( $rev->isDeleted( Revision::DELETED_COMMENT ) && $isPublic ) {
            $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
        } elseif ( $rev->userCan( Revision::DELETED_COMMENT ) ) {
            $block = self::commentBlock( $rev->getComment( Revision::FOR_THIS_USER ),
                $rev->getTitle(), $local );
        } else {
            $block = " <span class=\"comment\">" . wfMessage( 'rev-deleted-comment' )->escaped() . "</span>";
        }
        if ( $rev->isDeleted( Revision::DELETED_COMMENT ) ) {
            return " <span class=\"history-deleted\">$block</span>";
        }
        return $block;
    }

    public static function formatRevisionSize( $size ) {
        if ( $size == 0 ) {
            $stxt = wfMessage( 'historyempty' )->escaped();
        } else {
            $stxt = wfMessage( 'nbytes' )->numParams( $size )->escaped();
            $stxt = wfMessage( 'parentheses' )->rawParams( $stxt )->escaped();
        }
        return "<span class=\"history-size\">$stxt</span>";
    }

    public static function tocIndent() {
        return "\n<ul>";
    }

    public static function tocUnindent( $level ) {
        return "</li>\n" . str_repeat( "</ul>\n</li>\n", $level > 0 ? $level : 0 );
    }

    public static function tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex = false ) {
        $classes = "toclevel-$level";
        if ( $sectionIndex !== false ) {
            $classes .= " tocsection-$sectionIndex";
        }
        return "\n<li class=\"$classes\"><a href=\"#" .
            $anchor . '"><span class="tocnumber">' .
            $tocnumber . '</span> <span class="toctext">' .
            $tocline . '</span></a>';
    }

    public static function tocLineEnd() {
        return "</li>\n";
    }

    public static function tocList( $toc, $lang = false ) {
        $lang = wfGetLangObj( $lang );
        $title = wfMessage( 'toc' )->inLanguage( $lang )->escaped();

        return '<div id="toc" class="toc">'
            . '<div id="toctitle"><h2>' . $title . "</h2></div>\n"
            . $toc
            . "</ul>\n</div>\n";
    }

    public static function generateTOC( $tree, $lang = false ) {
        $toc = '';
        $lastLevel = 0;
        foreach ( $tree as $section ) {
            if ( $section['toclevel'] > $lastLevel ) {
                $toc .= self::tocIndent();
            } elseif ( $section['toclevel'] < $lastLevel ) {
                $toc .= self::tocUnindent(
                    $lastLevel - $section['toclevel'] );
            } else {
                $toc .= self::tocLineEnd();
            }

            $toc .= self::tocLine( $section['anchor'],
                $section['line'], $section['number'],
                $section['toclevel'], $section['index'] );
            $lastLevel = $section['toclevel'];
        }
        $toc .= self::tocLineEnd();
        return self::tocList( $toc, $lang );
    }

    public static function makeHeadline( $level, $attribs, $anchor, $html,
        $link, $legacyAnchor = false
    ) {
        $ret = "<h$level$attribs"
            . "<span class=\"mw-headline\" id=\"$anchor\">$html</span>"
            . $link
            . "</h$level>";
        if ( $legacyAnchor !== false ) {
            $ret = "<div id=\"$legacyAnchor\"></div>$ret";
        }
        return $ret;
    }

    static function splitTrail( $trail ) {
        global $wgContLang;
        $regex = $wgContLang->linkTrail();
        $inside = '';
        if ( $trail !== '' ) {
            $m = [];
            if ( preg_match( $regex, $trail, $m ) ) {
                $inside = $m[1];
                $trail = $m[2];
            }
        }
        return [ $inside, $trail ];
    }

    public static function generateRollback( $rev, IContextSource $context = null,
        $options = [ 'verify' ]
    ) {
        if ( $context === null ) {
            $context = RequestContext::getMain();
        }

        $editCount = false;
        if ( in_array( 'verify', $options, true ) ) {
            $editCount = self::getRollbackEditCount( $rev, true );
            if ( $editCount === false ) {
                return '';
            }
        }

        $inner = self::buildRollbackLink( $rev, $context, $editCount );

        if ( !in_array( 'noBrackets', $options, true ) ) {
            $inner = $context->msg( 'brackets' )->rawParams( $inner )->escaped();
        }

        return '<span class="mw-rollback-link">' . $inner . '</span>';
    }

    public static function getRollbackEditCount( $rev, $verify ) {
        global $wgShowRollbackEditCount;
        if ( !is_int( $wgShowRollbackEditCount ) || !$wgShowRollbackEditCount > 0 ) {
            // Nothing has happened, indicate this by returning 'null'
            return null;
        }

        $dbr = wfGetDB( DB_REPLICA );

        // Up to the value of $wgShowRollbackEditCount revisions are counted
        $res = $dbr->select(
            'revision',
            [ 'rev_user_text', 'rev_deleted' ],
            // $rev->getPage() returns null sometimes
            [ 'rev_page' => $rev->getTitle()->getArticleID() ],
            __METHOD__,
            [
                'USE INDEX' => [ 'revision' => 'page_timestamp' ],
                'ORDER BY' => 'rev_timestamp DESC',
                'LIMIT' => $wgShowRollbackEditCount + 1
            ]
        );

        $editCount = 0;
        $moreRevs = false;
        foreach ( $res as $row ) {
            if ( $rev->getUserText( Revision::RAW ) != $row->rev_user_text ) {
                if ( $verify &&
                    ( $row->rev_deleted & Revision::DELETED_TEXT
                        || $row->rev_deleted & Revision::DELETED_USER
                ) ) {
                    // If the user or the text of the revision we might rollback
                    // to is deleted in some way we can't rollback. Similar to
                    // the sanity checks in WikiPage::commitRollback.
                    return false;
                }
                $moreRevs = true;
                break;
            }
            $editCount++;
        }

        if ( $verify && $editCount <= $wgShowRollbackEditCount && !$moreRevs ) {
            // We didn't find at least $wgShowRollbackEditCount revisions made by the current user
            // and there weren't any other revisions. That means that the current user is the only
            // editor, so we can't rollback
            return false;
        }
        return $editCount;
    }

    public static function buildRollbackLink( $rev, IContextSource $context = null,
        $editCount = false
    ) {
        global $wgShowRollbackEditCount, $wgMiserMode;

        // To config which pages are affected by miser mode
        $disableRollbackEditCountSpecialPage = [ 'Recentchanges', 'Watchlist' ];

        if ( $context === null ) {
            $context = RequestContext::getMain();
        }

        $title = $rev->getTitle();
        $query = [
            'action' => 'rollback',
            'from' => $rev->getUserText(),
            'token' => $context->getUser()->getEditToken( 'rollback' ),
        ];
        $attrs = [
            'data-mw' => 'interface',
            'title' => $context->msg( 'tooltip-rollback' )->text(),
        ];
        $options = [ 'known', 'noclasses' ];

        if ( $context->getRequest()->getBool( 'bot' ) ) {
            $query['bot'] = '1';
            $query['hidediff'] = '1'; // bug 15999
        }

        $disableRollbackEditCount = false;
        if ( $wgMiserMode ) {
            foreach ( $disableRollbackEditCountSpecialPage as $specialPage ) {
                if ( $context->getTitle()->isSpecial( $specialPage ) ) {
                    $disableRollbackEditCount = true;
                    break;
                }
            }
        }

        if ( !$disableRollbackEditCount
            && is_int( $wgShowRollbackEditCount )
            && $wgShowRollbackEditCount > 0
        ) {
            if ( !is_numeric( $editCount ) ) {
                $editCount = self::getRollbackEditCount( $rev, false );
            }

            if ( $editCount > $wgShowRollbackEditCount ) {
                $html = $context->msg( 'rollbacklinkcount-morethan' )
                    ->numParams( $wgShowRollbackEditCount )->parse();
            } else {
                $html = $context->msg( 'rollbacklinkcount' )->numParams( $editCount )->parse();
            }

            return self::link( $title, $html, $attrs, $query, $options );
        } else {
            $html = $context->msg( 'rollbacklink' )->escaped();
            return self::link( $title, $html, $attrs, $query, $options );
        }
    }

    public static function formatTemplates( $templates, $preview = false,
        $section = false, $more = null
    ) {
        wfDeprecated( __METHOD__, '1.28' );

        $type = false;
        if ( $preview ) {
            $type = 'preview';
        } elseif ( $section ) {
            $type = 'section';
        }

        if ( $more instanceof Message ) {
            $more = $more->toString();
        }

        $formatter = new TemplatesOnThisPageFormatter(
            RequestContext::getMain(),
            MediaWikiServices::getInstance()->getLinkRenderer()
        );
        return $formatter->format( $templates, $type, $more );
    }

    public static function formatHiddenCategories( $hiddencats ) {

        $outText = '';
        if ( count( $hiddencats ) > 0 ) {
            # Construct the HTML
            $outText = '<div class="mw-hiddenCategoriesExplanation">';
            $outText .= wfMessage( 'hiddencategories' )->numParams( count( $hiddencats ) )->parseAsBlock();
            $outText .= "</div><ul>\n";

            foreach ( $hiddencats as $titleObj ) {
                # If it's hidden, it must exist - no need to check with a LinkBatch
                $outText .= '<li>'
                    . self::link( $titleObj, null, [], [], 'known' )
                    . "</li>\n";
            }
            $outText .= '</ul>';
        }
        return $outText;
    }

    public static function formatSize( $size ) {
        wfDeprecated( __METHOD__, '1.28' );

        global $wgLang;
        return htmlspecialchars( $wgLang->formatSize( $size ) );
    }

    public static function titleAttrib( $name, $options = null, array $msgParams = [] ) {
        $message = wfMessage( "tooltip-$name", $msgParams );
        if ( !$message->exists() ) {
            $tooltip = false;
        } else {
            $tooltip = $message->text();
            # Compatibility: formerly some tooltips had [alt-.] hardcoded
            $tooltip = preg_replace( "/ ?\[alt-.\]$/", '', $tooltip );
            # Message equal to '-' means suppress it.
            if ( $tooltip == '-' ) {
                $tooltip = false;
            }
        }

        if ( $options == 'withaccess' ) {
            $accesskey = self::accesskey( $name );
            if ( $accesskey !== false ) {
                // Should be build the same as in jquery.accessKeyLabel.js
                if ( $tooltip === false || $tooltip === '' ) {
                    $tooltip = wfMessage( 'brackets', $accesskey )->text();
                } else {
                    $tooltip .= wfMessage( 'word-separator' )->text();
                    $tooltip .= wfMessage( 'brackets', $accesskey )->text();
                }
            }
        }

        return $tooltip;
    }

    public static $accesskeycache;

    public static function accesskey( $name ) {
        if ( isset( self::$accesskeycache[$name] ) ) {
            return self::$accesskeycache[$name];
        }

        $message = wfMessage( "accesskey-$name" );

        if ( !$message->exists() ) {
            $accesskey = false;
        } else {
            $accesskey = $message->plain();
            if ( $accesskey === '' || $accesskey === '-' ) {
                # @todo FIXME: Per standard MW behavior, a value of '-' means to suppress the
                # attribute, but this is broken for accesskey: that might be a useful
                # value.
                $accesskey = false;
            }
        }

        self::$accesskeycache[$name] = $accesskey;
        return self::$accesskeycache[$name];
    }

    public static function getRevDeleteLink( User $user, Revision $rev, Title $title ) {
        $canHide = $user->isAllowed( 'deleterevision' );
        if ( !$canHide && !( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) ) {
            return '';
        }

        if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
            return Linker::revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
        } else {
            if ( $rev->getId() ) {
                // RevDelete links using revision ID are stable across
                // page deletion and undeletion; use when possible.
                $query = [
                    'type' => 'revision',
                    'target' => $title->getPrefixedDBkey(),
                    'ids' => $rev->getId()
                ];
            } else {
                // Older deleted entries didn't save a revision ID.
                // We have to refer to these by timestamp, ick!
                $query = [
                    'type' => 'archive',
                    'target' => $title->getPrefixedDBkey(),
                    'ids' => $rev->getTimestamp()
                ];
            }
            return Linker::revDeleteLink( $query,
                $rev->isDeleted( Revision::DELETED_RESTRICTED ), $canHide );
        }
    }

    public static function revDeleteLink( $query = [], $restricted = false, $delete = true ) {
        $sp = SpecialPage::getTitleFor( 'Revisiondelete' );
        $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
        $html = wfMessage( $msgKey )->escaped();
        $tag = $restricted ? 'strong' : 'span';
        $link = self::link( $sp, $html, [], $query, [ 'known', 'noclasses' ] );
        return Xml::tags(
            $tag,
            [ 'class' => 'mw-revdelundel-link' ],
            wfMessage( 'parentheses' )->rawParams( $link )->escaped()
        );
    }

    public static function revDeleteLinkDisabled( $delete = true ) {
        $msgKey = $delete ? 'rev-delundel' : 'rev-showdeleted';
        $html = wfMessage( $msgKey )->escaped();
        $htmlParentheses = wfMessage( 'parentheses' )->rawParams( $html )->escaped();
        return Xml::tags( 'span', [ 'class' => 'mw-revdelundel-link' ], $htmlParentheses );
    }

    /* Deprecated methods */

    public static function tooltipAndAccesskeyAttribs( $name, array $msgParams = [] ) {
        # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
        # no attribute" instead of "output '' as value for attribute", this
        # would be three lines.
        $attribs = [
            'title' => self::titleAttrib( $name, 'withaccess', $msgParams ),
            'accesskey' => self::accesskey( $name )
        ];
        if ( $attribs['title'] === false ) {
            unset( $attribs['title'] );
        }
        if ( $attribs['accesskey'] === false ) {
            unset( $attribs['accesskey'] );
        }
        return $attribs;
    }

    public static function tooltip( $name, $options = null ) {
        # @todo FIXME: If Sanitizer::expandAttributes() treated "false" as "output
        # no attribute" instead of "output '' as value for attribute", this
        # would be two lines.
        $tooltip = self::titleAttrib( $name, $options );
        if ( $tooltip === false ) {
            return '';
        }
        return Xml::expandAttributes( [
            'title' => $tooltip
        ] );
    }

}