BaseTemplate.php

Go to the documentation of this file.

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

abstract class BaseTemplate extends QuickTemplate {

    public function getMsg( $name /* ... */ ) {
        return $this->getSkin()->msg( ...func_get_args() );
    }

    function msg( $str ) {
        echo $this->getMsg( $str )->escaped();
    }

    function msgHtml( $str ) {
        wfDeprecated( __METHOD__, '1.32' );
        echo $this->getMsg( $str )->text();
    }

    function msgWiki( $str ) {
        // TODO: Add wfDeprecated( __METHOD__, '1.33' ) after 1.33 got released
        echo $this->getMsg( $str )->parseAsBlock();
    }

    function getToolbox() {
        $toolbox = [];
        if ( isset( $this->data['nav_urls']['whatlinkshere'] )
            && $this->data['nav_urls']['whatlinkshere']
        ) {
            $toolbox['whatlinkshere'] = $this->data['nav_urls']['whatlinkshere'];
            $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
        }
        if ( isset( $this->data['nav_urls']['recentchangeslinked'] )
            && $this->data['nav_urls']['recentchangeslinked']
        ) {
            $toolbox['recentchangeslinked'] = $this->data['nav_urls']['recentchangeslinked'];
            $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
            $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
            $toolbox['recentchangeslinked']['rel'] = 'nofollow';
        }
        if ( isset( $this->data['feeds'] ) && $this->data['feeds'] ) {
            $toolbox['feeds']['id'] = 'feedlinks';
            $toolbox['feeds']['links'] = [];
            foreach ( $this->data['feeds'] as $key => $feed ) {
                $toolbox['feeds']['links'][$key] = $feed;
                $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
                $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
                $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
                $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
            }
        }
        foreach ( [ 'contributions', 'log', 'blockip', 'emailuser',
            'userrights', 'upload', 'specialpages' ] as $special
        ) {
            if ( isset( $this->data['nav_urls'][$special] ) && $this->data['nav_urls'][$special] ) {
                $toolbox[$special] = $this->data['nav_urls'][$special];
                $toolbox[$special]['id'] = "t-$special";
            }
        }
        if ( isset( $this->data['nav_urls']['print'] ) && $this->data['nav_urls']['print'] ) {
            $toolbox['print'] = $this->data['nav_urls']['print'];
            $toolbox['print']['id'] = 't-print';
            $toolbox['print']['rel'] = 'alternate';
            $toolbox['print']['msg'] = 'printableversion';
        }
        if ( isset( $this->data['nav_urls']['permalink'] ) && $this->data['nav_urls']['permalink'] ) {
            $toolbox['permalink'] = $this->data['nav_urls']['permalink'];
            $toolbox['permalink']['id'] = 't-permalink';
        }
        if ( isset( $this->data['nav_urls']['info'] ) && $this->data['nav_urls']['info'] ) {
            $toolbox['info'] = $this->data['nav_urls']['info'];
            $toolbox['info']['id'] = 't-info';
        }

        // Avoid PHP 7.1 warning from passing $this by reference
        $template = $this;
        Hooks::run( 'BaseTemplateToolbox', [ &$template, &$toolbox ] );
        return $toolbox;
    }

    function getPersonalTools() {
        $personal_tools = [];
        foreach ( $this->get( 'personal_urls' ) as $key => $plink ) {
            # The class on a personal_urls item is meant to go on the <a> instead
            # of the <li> so we have to use a single item "links" array instead
            # of using most of the personal_url's keys directly.
            $ptool = [
                'links' => [
                    [ 'single-id' => "pt-$key" ],
                ],
                'id' => "pt-$key",
            ];
            if ( isset( $plink['active'] ) ) {
                $ptool['active'] = $plink['active'];
            }
            foreach ( [ 'href', 'class', 'text', 'dir', 'data', 'exists' ] as $k ) {
                if ( isset( $plink[$k] ) ) {
                    $ptool['links'][0][$k] = $plink[$k];
                }
            }
            $personal_tools[$key] = $ptool;
        }
        return $personal_tools;
    }

    function getSidebar( $options = [] ) {
        // Force the rendering of the following portals
        $sidebar = $this->data['sidebar'];
        if ( !isset( $sidebar['SEARCH'] ) ) {
            $sidebar['SEARCH'] = true;
        }
        if ( !isset( $sidebar['TOOLBOX'] ) ) {
            $sidebar['TOOLBOX'] = true;
        }
        if ( !isset( $sidebar['LANGUAGES'] ) ) {
            $sidebar['LANGUAGES'] = true;
        }

        if ( !isset( $options['search'] ) || $options['search'] !== true ) {
            unset( $sidebar['SEARCH'] );
        }
        if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
            unset( $sidebar['TOOLBOX'] );
        }
        if ( isset( $options['languages'] ) && $options['languages'] === false ) {
            unset( $sidebar['LANGUAGES'] );
        }

        $boxes = [];
        foreach ( $sidebar as $boxName => $content ) {
            if ( $content === false ) {
                continue;
            }
            switch ( $boxName ) {
                case 'SEARCH':
                    // Search is a special case, skins should custom implement this
                    $boxes[$boxName] = [
                        'id' => 'p-search',
                        'header' => $this->getMsg( 'search' )->text(),
                        'generated' => false,
                        'content' => true,
                    ];
                    break;
                case 'TOOLBOX':
                    $msgObj = $this->getMsg( 'toolbox' );
                    $boxes[$boxName] = [
                        'id' => 'p-tb',
                        'header' => $msgObj->exists() ? $msgObj->text() : 'toolbox',
                        'generated' => false,
                        'content' => $this->getToolbox(),
                    ];
                    break;
                case 'LANGUAGES':
                    if ( $this->data['language_urls'] !== false ) {
                        $msgObj = $this->getMsg( 'otherlanguages' );
                        $boxes[$boxName] = [
                            'id' => 'p-lang',
                            'header' => $msgObj->exists() ? $msgObj->text() : 'otherlanguages',
                            'generated' => false,
                            'content' => $this->data['language_urls'] ?: [],
                        ];
                    }
                    break;
                default:
                    $msgObj = $this->getMsg( $boxName );
                    $boxes[$boxName] = [
                        'id' => "p-$boxName",
                        'header' => $msgObj->exists() ? $msgObj->text() : $boxName,
                        'generated' => true,
                        'content' => $content,
                    ];
                    break;
            }
        }

        // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
        $hookContents = null;
        if ( isset( $boxes['TOOLBOX'] ) ) {
            ob_start();
            // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
            // can abort and avoid outputting double toolbox links
            // Avoid PHP 7.1 warning from passing $this by reference
            $template = $this;
            Hooks::run( 'SkinTemplateToolboxEnd', [ &$template, true ] );
            $hookContents = ob_get_contents();
            ob_end_clean();
            if ( !trim( $hookContents ) ) {
                $hookContents = null;
            }
        }
        // END hack

        if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
            foreach ( $boxes as $boxName => $box ) {
                if ( is_array( $box['content'] ) ) {
                    $content = '<ul>';
                    foreach ( $box['content'] as $key => $val ) {
                        $content .= "\n " . $this->makeListItem( $key, $val );
                    }
                    // HACK, shove the toolbox end onto the toolbox if we're rendering itself
                    if ( $hookContents ) {
                        $content .= "\n $hookContents";
                    }
                    // END hack
                    $content .= "\n</ul>\n";
                    $boxes[$boxName]['content'] = $content;
                }
            }
        } elseif ( $hookContents ) {
            $boxes['TOOLBOXEND'] = [
                'id' => 'p-toolboxend',
                'header' => $boxes['TOOLBOX']['header'],
                'generated' => false,
                'content' => "<ul>{$hookContents}</ul>",
            ];
            // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
            $boxes2 = [];
            foreach ( $boxes as $key => $box ) {
                if ( $key === 'TOOLBOXEND' ) {
                    continue;
                }
                $boxes2[$key] = $box;
                if ( $key === 'TOOLBOX' ) {
                    $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
                }
            }
            $boxes = $boxes2;
            // END hack
        }

        return $boxes;
    }

    protected function renderAfterPortlet( $name ) {
        echo $this->getAfterPortlet( $name );
    }

    protected function getAfterPortlet( $name ) {
        $html = '';
        $content = '';
        Hooks::run( 'BaseTemplateAfterPortlet', [ $this, $name, &$content ] );

        if ( $content !== '' ) {
            $html = Html::rawElement(
                'div',
                [ 'class' => [ 'after-portlet', 'after-portlet-' . $name ] ],
                $content
            );
        }

        return $html;
    }

    function makeLink( $key, $item, $options = [] ) {
        $text = $item['text'] ?? wfMessage( $item['msg'] ?? $key )->text();

        $html = htmlspecialchars( $text );

        if ( isset( $options['text-wrapper'] ) ) {
            $wrapper = $options['text-wrapper'];
            if ( isset( $wrapper['tag'] ) ) {
                $wrapper = [ $wrapper ];
            }
            while ( count( $wrapper ) > 0 ) {
                $element = array_pop( $wrapper );
                $html = Html::rawElement( $element['tag'], $element['attributes'] ?? null, $html );
            }
        }

        if ( isset( $item['href'] ) || isset( $options['link-fallback'] ) ) {
            $attrs = $item;
            foreach ( [ 'single-id', 'text', 'msg', 'tooltiponly', 'context', 'primary',
                'tooltip-params', 'exists' ] as $k ) {
                unset( $attrs[$k] );
            }

            if ( isset( $attrs['data'] ) ) {
                foreach ( $attrs['data'] as $key => $value ) {
                    $attrs[ 'data-' . $key ] = $value;
                }
                unset( $attrs[ 'data' ] );
            }

            if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
                $item['single-id'] = $item['id'];
            }

            $tooltipParams = [];
            if ( isset( $item['tooltip-params'] ) ) {
                $tooltipParams = $item['tooltip-params'];
            }

            if ( isset( $item['single-id'] ) ) {
                $tooltipOption = isset( $item['exists'] ) && $item['exists'] === false ? 'nonexisting' : null;

                if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
                    $title = Linker::titleAttrib( $item['single-id'], $tooltipOption, $tooltipParams );
                    if ( $title !== false ) {
                        $attrs['title'] = $title;
                    }
                } else {
                    $tip = Linker::tooltipAndAccesskeyAttribs(
                        $item['single-id'],
                        $tooltipParams,
                        $tooltipOption
                    );
                    if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
                        $attrs['title'] = $tip['title'];
                    }
                    if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
                        $attrs['accesskey'] = $tip['accesskey'];
                    }
                }
            }
            if ( isset( $options['link-class'] ) ) {
                if ( isset( $attrs['class'] ) ) {
                    $attrs['class'] .= " {$options['link-class']}";
                } else {
                    $attrs['class'] = $options['link-class'];
                }
            }
            $html = Html::rawElement( isset( $attrs['href'] )
                ? 'a'
                : $options['link-fallback'], $attrs, $html );
        }

        return $html;
    }

    function makeListItem( $key, $item, $options = [] ) {
        if ( isset( $item['links'] ) ) {
            $links = [];
            foreach ( $item['links'] as $linkKey => $link ) {
                $links[] = $this->makeLink( $linkKey, $link, $options );
            }
            $html = implode( ' ', $links );
        } else {
            $link = $item;
            // These keys are used by makeListItem and shouldn't be passed on to the link
            foreach ( [ 'id', 'class', 'active', 'tag', 'itemtitle' ] as $k ) {
                unset( $link[$k] );
            }
            if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
                // The id goes on the <li> not on the <a> for single links
                // but makeSidebarLink still needs to know what id to use when
                // generating tooltips and accesskeys.
                $link['single-id'] = $item['id'];
            }
            if ( isset( $link['link-class'] ) ) {
                // link-class should be set on the <a> itself,
                // so pass it in as 'class'
                $link['class'] = $link['link-class'];
                unset( $link['link-class'] );
            }
            $html = $this->makeLink( $key, $link, $options );
        }

        $attrs = [];
        foreach ( [ 'id', 'class' ] as $attr ) {
            if ( isset( $item[$attr] ) ) {
                $attrs[$attr] = $item[$attr];
            }
        }
        if ( isset( $item['active'] ) && $item['active'] ) {
            if ( !isset( $attrs['class'] ) ) {
                $attrs['class'] = '';
            }
            $attrs['class'] .= ' active';
            $attrs['class'] = trim( $attrs['class'] );
        }
        if ( isset( $item['itemtitle'] ) ) {
            $attrs['title'] = $item['itemtitle'];
        }
        return Html::rawElement( $options['tag'] ?? 'li', $attrs, $html );
    }

    function makeSearchInput( $attrs = [] ) {
        $realAttrs = [
            'type' => 'search',
            'name' => 'search',
            'placeholder' => wfMessage( 'searchsuggest-search' )->text(),
        ];
        $realAttrs = array_merge( $realAttrs, Linker::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
        return Html::element( 'input', $realAttrs );
    }

    function makeSearchButton( $mode, $attrs = [] ) {
        switch ( $mode ) {
            case 'go':
            case 'fulltext':
                $realAttrs = [
                    'type' => 'submit',
                    'name' => $mode,
                    'value' => wfMessage( $mode == 'go' ? 'searcharticle' : 'searchbutton' )->text(),
                ];
                $realAttrs = array_merge(
                    $realAttrs,
                    Linker::tooltipAndAccesskeyAttribs( "search-$mode" ),
                    $attrs
                );
                return Html::element( 'input', $realAttrs );
            case 'image':
                $buttonAttrs = [
                    'type' => 'submit',
                    'name' => 'button',
                ];
                $buttonAttrs = array_merge(
                    $buttonAttrs,
                    Linker::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
                    $attrs
                );
                unset( $buttonAttrs['src'] );
                unset( $buttonAttrs['alt'] );
                unset( $buttonAttrs['width'] );
                unset( $buttonAttrs['height'] );
                $imgAttrs = [
                    'src' => $attrs['src'],
                    'alt' => $attrs['alt'] ?? wfMessage( 'searchbutton' )->text(),
                    'width' => $attrs['width'] ?? null,
                    'height' => $attrs['height'] ?? null,
                ];
                return Html::rawElement( 'button', $buttonAttrs, Html::element( 'img', $imgAttrs ) );
            default:
                throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
        }
    }

    function getFooterLinks( $option = null ) {
        $footerlinks = $this->get( 'footerlinks' );

        // Reduce footer links down to only those which are being used
        $validFooterLinks = [];
        foreach ( $footerlinks as $category => $links ) {
            $validFooterLinks[$category] = [];
            foreach ( $links as $link ) {
                if ( isset( $this->data[$link] ) && $this->data[$link] ) {
                    $validFooterLinks[$category][] = $link;
                }
            }
            if ( count( $validFooterLinks[$category] ) <= 0 ) {
                unset( $validFooterLinks[$category] );
            }
        }

        if ( $option == 'flat' ) {
            // fold footerlinks into a single array using a bit of trickery
            $validFooterLinks = array_merge( ...array_values( $validFooterLinks ) );
        }

        return $validFooterLinks;
    }

    function getFooterIcons( $option = null ) {
        // Generate additional footer icons
        $footericons = $this->get( 'footericons' );

        if ( $option == 'icononly' ) {
            // Unset any icons which don't have an image
            foreach ( $footericons as &$footerIconsBlock ) {
                foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
                    if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
                        unset( $footerIconsBlock[$footerIconKey] );
                    }
                }
            }
            // Redo removal of any empty blocks
            foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
                if ( count( $footerIconsBlock ) <= 0 ) {
                    unset( $footericons[$footerIconsKey] );
                }
            }
        } elseif ( $option == 'nocopyright' ) {
            unset( $footericons['copyright']['copyright'] );
            if ( count( $footericons['copyright'] ) <= 0 ) {
                unset( $footericons['copyright'] );
            }
        }

        return $footericons;
    }

    protected function getFooter( $iconStyle = 'icononly', $linkStyle = 'flat' ) {
        $validFooterIcons = $this->getFooterIcons( $iconStyle );
        $validFooterLinks = $this->getFooterLinks( $linkStyle );

        $html = '';

        if ( count( $validFooterIcons ) + count( $validFooterLinks ) > 0 ) {
            $html .= Html::openElement( 'div', [
                'id' => 'footer-bottom',
                'role' => 'contentinfo',
                'lang' => $this->get( 'userlang' ),
                'dir' => $this->get( 'dir' )
            ] );
            $footerEnd = Html::closeElement( 'div' );
        } else {
            $footerEnd = '';
        }
        foreach ( $validFooterIcons as $blockName => $footerIcons ) {
            $html .= Html::openElement( 'div', [
                'id' => Sanitizer::escapeIdForAttribute( "f-{$blockName}ico" ),
                'class' => 'footer-icons'
            ] );
            foreach ( $footerIcons as $icon ) {
                $html .= $this->getSkin()->makeFooterIcon( $icon );
            }
            $html .= Html::closeElement( 'div' );
        }
        if ( count( $validFooterLinks ) > 0 ) {
            $html .= Html::openElement( 'ul', [ 'id' => 'f-list', 'class' => 'footer-places' ] );
            foreach ( $validFooterLinks as $aLink ) {
                $html .= Html::rawElement(
                    'li',
                    [ 'id' => Sanitizer::escapeIdForAttribute( $aLink ) ],
                    $this->get( $aLink )
                );
            }
            $html .= Html::closeElement( 'ul' );
        }

        $html .= $this->getClear() . $footerEnd;

        return $html;
    }

    protected function getClear() {
        return Html::element( 'div', [ 'class' => 'visualClear' ] );
    }

    public function getIndicators() {
        $out = "<div class=\"mw-indicators mw-body-content\">\n";
        foreach ( $this->data['indicators'] as $id => $content ) {
            $out .= Html::rawElement(
                'div',
                [
                    'id' => Sanitizer::escapeIdForAttribute( "mw-indicator-$id" ),
                    'class' => 'mw-indicator',
                ],
                $content
            ) . "\n";
        }
        $out .= "</div>\n";
        return $out;
    }

    function printTrail() {
        echo $this->getTrail();
    }

    public function getTrail() {
        return WrappedString::join( "\n", [
            MWDebug::getDebugHTML( $this->getSkin()->getContext() ),
            $this->get( 'bottomscripts' ),
            $this->get( 'reporttime' )
        ] );
    }
}