3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 use Wikimedia\WrappedString
;
22 use Wikimedia\WrappedStringList
;
25 * New base template for a skin's template extended from QuickTemplate
26 * this class features helper methods that provide common ways of interacting
27 * with the data stored in the QuickTemplate
29 abstract class BaseTemplate
extends QuickTemplate
{
32 * Get a Message object with its context set
34 * @param string $name Message name
35 * @param mixed ...$params Message params
38 public function getMsg( $name, ...$params ) {
39 return $this->getSkin()->msg( $name, ...$params );
42 function msg( $str ) {
43 echo $this->getMsg( $str )->escaped();
47 * @deprecated since 1.33 Use ->msg() or ->getMsg() instead.
49 function msgWiki( $str ) {
50 wfDeprecated( __METHOD__
, '1.33' ); // Hard-deprecated in 1.34
51 echo $this->getMsg( $str )->parseAsBlock();
55 * Create an array of common toolbox items from the data in the quicktemplate
56 * stored by SkinTemplate.
57 * The resulting array is built according to a format intended to be passed
58 * through makeListItem to generate the html.
61 function getToolbox() {
63 if ( isset( $this->data
['nav_urls']['whatlinkshere'] )
64 && $this->data
['nav_urls']['whatlinkshere']
66 $toolbox['whatlinkshere'] = $this->data
['nav_urls']['whatlinkshere'];
67 $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
69 if ( isset( $this->data
['nav_urls']['recentchangeslinked'] )
70 && $this->data
['nav_urls']['recentchangeslinked']
72 $toolbox['recentchangeslinked'] = $this->data
['nav_urls']['recentchangeslinked'];
73 $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
74 $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
75 $toolbox['recentchangeslinked']['rel'] = 'nofollow';
77 if ( isset( $this->data
['feeds'] ) && $this->data
['feeds'] ) {
78 $toolbox['feeds']['id'] = 'feedlinks';
79 $toolbox['feeds']['links'] = [];
80 foreach ( $this->data
['feeds'] as $key => $feed ) {
81 $toolbox['feeds']['links'][$key] = $feed;
82 $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
83 $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
84 $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
85 $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
88 foreach ( [ 'contributions', 'log', 'blockip', 'emailuser', 'mute',
89 'userrights', 'upload', 'specialpages' ] as $special
91 if ( isset( $this->data
['nav_urls'][$special] ) && $this->data
['nav_urls'][$special] ) {
92 $toolbox[$special] = $this->data
['nav_urls'][$special];
93 $toolbox[$special]['id'] = "t-$special";
96 if ( isset( $this->data
['nav_urls']['print'] ) && $this->data
['nav_urls']['print'] ) {
97 $toolbox['print'] = $this->data
['nav_urls']['print'];
98 $toolbox['print']['id'] = 't-print';
99 $toolbox['print']['rel'] = 'alternate';
100 $toolbox['print']['msg'] = 'printableversion';
102 if ( isset( $this->data
['nav_urls']['permalink'] ) && $this->data
['nav_urls']['permalink'] ) {
103 $toolbox['permalink'] = $this->data
['nav_urls']['permalink'];
104 $toolbox['permalink']['id'] = 't-permalink';
106 if ( isset( $this->data
['nav_urls']['info'] ) && $this->data
['nav_urls']['info'] ) {
107 $toolbox['info'] = $this->data
['nav_urls']['info'];
108 $toolbox['info']['id'] = 't-info';
111 // Avoid PHP 7.1 warning from passing $this by reference
113 Hooks
::run( 'BaseTemplateToolbox', [ &$template, &$toolbox ] );
118 * Create an array of personal tools items from the data in the quicktemplate
119 * stored by SkinTemplate.
120 * The resulting array is built according to a format intended to be passed
121 * through makeListItem to generate the html.
122 * This is in reality the same list as already stored in personal_urls
123 * however it is reformatted so that you can just pass the individual items
124 * to makeListItem instead of hardcoding the element creation boilerplate.
127 function getPersonalTools() {
128 $personal_tools = [];
129 foreach ( $this->get( 'personal_urls' ) as $key => $plink ) {
130 # The class on a personal_urls item is meant to go on the <a> instead
131 # of the <li> so we have to use a single item "links" array instead
132 # of using most of the personal_url's keys directly.
135 [ 'single-id' => "pt-$key" ],
139 if ( isset( $plink['active'] ) ) {
140 $ptool['active'] = $plink['active'];
151 if ( isset( $plink[$k] ) ) {
152 $ptool['links'][0][$k] = $plink[$k];
155 $personal_tools[$key] = $ptool;
157 return $personal_tools;
160 function getSidebar( $options = [] ) {
161 // Force the rendering of the following portals
162 $sidebar = $this->data
['sidebar'];
163 if ( !isset( $sidebar['SEARCH'] ) ) {
164 $sidebar['SEARCH'] = true;
166 if ( !isset( $sidebar['TOOLBOX'] ) ) {
167 $sidebar['TOOLBOX'] = true;
169 if ( !isset( $sidebar['LANGUAGES'] ) ) {
170 $sidebar['LANGUAGES'] = true;
173 if ( !isset( $options['search'] ) ||
$options['search'] !== true ) {
174 unset( $sidebar['SEARCH'] );
176 if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
177 unset( $sidebar['TOOLBOX'] );
179 if ( isset( $options['languages'] ) && $options['languages'] === false ) {
180 unset( $sidebar['LANGUAGES'] );
184 foreach ( $sidebar as $boxName => $content ) {
185 if ( $content === false ) {
188 switch ( $boxName ) {
190 // Search is a special case, skins should custom implement this
193 'header' => $this->getMsg( 'search' )->text(),
194 'generated' => false,
199 $msgObj = $this->getMsg( 'toolbox' );
202 'header' => $msgObj->exists() ?
$msgObj->text() : 'toolbox',
203 'generated' => false,
204 'content' => $this->getToolbox(),
208 if ( $this->data
['language_urls'] !== false ) {
209 $msgObj = $this->getMsg( 'otherlanguages' );
212 'header' => $msgObj->exists() ?
$msgObj->text() : 'otherlanguages',
213 'generated' => false,
214 'content' => $this->data
['language_urls'] ?
: [],
219 $msgObj = $this->getMsg( $boxName );
221 'id' => "p-$boxName",
222 'header' => $msgObj->exists() ?
$msgObj->text() : $boxName,
224 'content' => $content,
230 // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
231 $hookContents = null;
232 if ( isset( $boxes['TOOLBOX'] ) ) {
234 // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
235 // can abort and avoid outputting double toolbox links
236 // Avoid PHP 7.1 warning from passing $this by reference
238 Hooks
::run( 'SkinTemplateToolboxEnd', [ &$template, true ] );
239 $hookContents = ob_get_contents();
241 if ( !trim( $hookContents ) ) {
242 $hookContents = null;
247 if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
248 foreach ( $boxes as $boxName => $box ) {
249 if ( is_array( $box['content'] ) ) {
251 foreach ( $box['content'] as $key => $val ) {
252 $content .= "\n " . $this->makeListItem( $key, $val );
254 // HACK, shove the toolbox end onto the toolbox if we're rendering itself
255 if ( $hookContents ) {
256 $content .= "\n $hookContents";
259 $content .= "\n</ul>\n";
260 $boxes[$boxName]['content'] = $content;
263 } elseif ( $hookContents ) {
264 $boxes['TOOLBOXEND'] = [
265 'id' => 'p-toolboxend',
266 'header' => $boxes['TOOLBOX']['header'],
267 'generated' => false,
268 'content' => "<ul>{$hookContents}</ul>",
270 // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
272 foreach ( $boxes as $key => $box ) {
273 if ( $key === 'TOOLBOXEND' ) {
276 $boxes2[$key] = $box;
277 if ( $key === 'TOOLBOX' ) {
278 $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
289 * @param string $name
291 protected function renderAfterPortlet( $name ) {
292 echo $this->getAfterPortlet( $name );
296 * Allows extensions to hook into known portlets and add stuff to them
298 * @param string $name
300 * @return string html
303 protected function getAfterPortlet( $name ) {
306 Hooks
::run( 'BaseTemplateAfterPortlet', [ $this, $name, &$content ] );
308 if ( $content !== '' ) {
309 $html = Html
::rawElement(
311 [ 'class' => [ 'after-portlet', 'after-portlet-' . $name ] ],
320 * Makes a link, usually used by makeListItem to generate a link for an item
321 * in a list used in navigation lists, portlets, portals, sidebars, etc...
323 * @param string $key Usually a key from the list you are generating this
325 * @param array $item Contains some of a specific set of keys.
327 * The text of the link will be generated either from the contents of the
328 * "text" key in the $item array, if a "msg" key is present a message by
329 * that name will be used, and if neither of those are set the $key will be
330 * used as a message name.
332 * If a "href" key is not present makeLink will just output htmlescaped text.
333 * The "href", "id", "class", "rel", and "type" keys are used as attributes
334 * for the link if present.
336 * If an "id" or "single-id" (if you don't want the actual id to be output
337 * on the link) is present it will be used to generate a tooltip and
338 * accesskey for the link.
340 * The keys "context" and "primary" are ignored; these keys are used
341 * internally by skins and are not supposed to be included in the HTML
344 * If you don't want an accesskey, set $item['tooltiponly'] = true;
346 * If a "data" key is present, it must be an array, where the keys represent
347 * the data-xxx properties with their provided values. For example,
352 * will render as element properties:
353 * data-foo='1' data-bar='baz'
355 * @param array $options Can be used to affect the output of a link.
356 * Possible options are:
357 * - 'text-wrapper' key to specify a list of elements to wrap the text of
358 * a link in. This should be an array of arrays containing a 'tag' and
359 * optionally an 'attributes' key. If you only have one element you don't
360 * need to wrap it in another array. eg: To use <a><span>...</span></a>
361 * in all links use [ 'text-wrapper' => [ 'tag' => 'span' ] ]
363 * - 'link-class' key can be used to specify additional classes to apply
365 * - 'link-fallback' can be used to specify a tag to use instead of "<a>"
366 * if there is no link. eg: If you specify 'link-fallback' => 'span' than
367 * any non-link will output a "<span>" instead of just text.
371 function makeLink( $key, $item, $options = [] ) {
372 $text = $item['text'] ??
wfMessage( $item['msg'] ??
$key )->text();
374 $html = htmlspecialchars( $text );
376 if ( isset( $options['text-wrapper'] ) ) {
377 $wrapper = $options['text-wrapper'];
378 if ( isset( $wrapper['tag'] ) ) {
379 $wrapper = [ $wrapper ];
381 while ( count( $wrapper ) > 0 ) {
382 $element = array_pop( $wrapper );
383 $html = Html
::rawElement( $element['tag'], $element['attributes'] ??
null, $html );
387 if ( isset( $item['href'] ) ||
isset( $options['link-fallback'] ) ) {
389 foreach ( [ 'single-id', 'text', 'msg', 'tooltiponly', 'context', 'primary',
390 'tooltip-params', 'exists' ] as $k ) {
394 if ( isset( $attrs['data'] ) ) {
395 foreach ( $attrs['data'] as $key => $value ) {
396 $attrs[ 'data-' . $key ] = $value;
398 unset( $attrs[ 'data' ] );
401 if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
402 $item['single-id'] = $item['id'];
406 if ( isset( $item['tooltip-params'] ) ) {
407 $tooltipParams = $item['tooltip-params'];
410 if ( isset( $item['single-id'] ) ) {
411 $tooltipOption = isset( $item['exists'] ) && $item['exists'] === false ?
'nonexisting' : null;
413 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
414 $title = Linker
::titleAttrib( $item['single-id'], $tooltipOption, $tooltipParams );
415 if ( $title !== false ) {
416 $attrs['title'] = $title;
419 $tip = Linker
::tooltipAndAccesskeyAttribs(
424 if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
425 $attrs['title'] = $tip['title'];
427 if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
428 $attrs['accesskey'] = $tip['accesskey'];
432 if ( isset( $options['link-class'] ) ) {
433 if ( isset( $attrs['class'] ) ) {
434 $attrs['class'] .= " {$options['link-class']}";
436 $attrs['class'] = $options['link-class'];
439 $html = Html
::rawElement( isset( $attrs['href'] )
441 : $options['link-fallback'], $attrs, $html );
448 * Generates a list item for a navigation, portlet, portal, sidebar... list
450 * @param string $key Usually a key from the list you are generating this link from.
451 * @param array $item Array of list item data containing some of a specific set of keys.
452 * The "id", "class" and "itemtitle" keys will be used as attributes for the list item,
453 * if "active" contains a value of true a "active" class will also be appended to class.
454 * @phan-param array{id?:string,class?:string,itemtitle?:string,active?:bool} $item
456 * @param array $options
457 * @phan-param array{tag?:string} $options
459 * If you want something other than a "<li>" you can pass a tag name such as
460 * "tag" => "span" in the $options array to change the tag used.
461 * link/content data for the list item may come in one of two forms
462 * A "links" key may be used, in which case it should contain an array with
463 * a list of links to include inside the list item, see makeLink for the
464 * format of individual links array items.
466 * Otherwise the relevant keys from the list item $item array will be passed
467 * to makeLink instead. Note however that "id" and "class" are used by the
468 * list item directly so they will not be passed to makeLink
469 * (however the link will still support a tooltip and accesskey from it)
470 * If you need an id or class on a single link you should include a "links"
471 * array with just one link item inside of it. You can also set "link-class" in
472 * $item to set a class on the link itself. If you want to add a title
473 * to the list item itself, you can set "itemtitle" to the value.
474 * $options is also passed on to makeLink calls
478 function makeListItem( $key, $item, $options = [] ) {
479 // In case this is still set from SkinTemplate, we don't want it to appear in
480 // the HTML output (normally removed in SkinTemplate::buildContentActionUrls())
481 unset( $item['redundant'] );
483 if ( isset( $item['links'] ) ) {
485 foreach ( $item['links'] as $linkKey => $link ) {
486 $links[] = $this->makeLink( $linkKey, $link, $options );
488 $html = implode( ' ', $links );
491 // These keys are used by makeListItem and shouldn't be passed on to the link
492 foreach ( [ 'id', 'class', 'active', 'tag', 'itemtitle' ] as $k ) {
495 if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
496 // The id goes on the <li> not on the <a> for single links
497 // but makeSidebarLink still needs to know what id to use when
498 // generating tooltips and accesskeys.
499 $link['single-id'] = $item['id'];
501 if ( isset( $link['link-class'] ) ) {
502 // link-class should be set on the <a> itself,
503 // so pass it in as 'class'
504 $link['class'] = $link['link-class'];
505 unset( $link['link-class'] );
507 $html = $this->makeLink( $key, $link, $options );
511 foreach ( [ 'id', 'class' ] as $attr ) {
512 if ( isset( $item[$attr] ) ) {
513 $attrs[$attr] = $item[$attr];
516 if ( isset( $item['active'] ) && $item['active'] ) {
517 if ( !isset( $attrs['class'] ) ) {
518 $attrs['class'] = '';
520 $attrs['class'] .= ' active';
521 $attrs['class'] = trim( $attrs['class'] );
523 if ( isset( $item['itemtitle'] ) ) {
524 $attrs['title'] = $item['itemtitle'];
526 return Html
::rawElement( $options['tag'] ??
'li', $attrs, $html );
529 function makeSearchInput( $attrs = [] ) {
533 'placeholder' => wfMessage( 'searchsuggest-search' )->text(),
535 $realAttrs = array_merge( $realAttrs, Linker
::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
536 return Html
::element( 'input', $realAttrs );
539 function makeSearchButton( $mode, $attrs = [] ) {
546 'value' => wfMessage( $mode == 'go' ?
'searcharticle' : 'searchbutton' )->text(),
548 $realAttrs = array_merge(
550 Linker
::tooltipAndAccesskeyAttribs( "search-$mode" ),
553 return Html
::element( 'input', $realAttrs );
559 $buttonAttrs = array_merge(
561 Linker
::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
564 unset( $buttonAttrs['src'] );
565 unset( $buttonAttrs['alt'] );
566 unset( $buttonAttrs['width'] );
567 unset( $buttonAttrs['height'] );
569 'src' => $attrs['src'],
570 'alt' => $attrs['alt'] ??
wfMessage( 'searchbutton' )->text(),
571 'width' => $attrs['width'] ??
null,
572 'height' => $attrs['height'] ??
null,
574 return Html
::rawElement( 'button', $buttonAttrs, Html
::element( 'img', $imgAttrs ) );
576 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
581 * Returns an array of footerlinks trimmed down to only those footer links that
583 * If you pass "flat" as an option then the returned array will be a flat array
584 * of footer icons instead of a key/value array of footerlinks arrays broken
585 * up into categories.
586 * @param string|null $option
587 * @return array|mixed
589 function getFooterLinks( $option = null ) {
590 $footerlinks = $this->get( 'footerlinks' );
592 // Reduce footer links down to only those which are being used
593 $validFooterLinks = [];
594 foreach ( $footerlinks as $category => $links ) {
595 $validFooterLinks[$category] = [];
596 foreach ( $links as $link ) {
597 if ( isset( $this->data
[$link] ) && $this->data
[$link] ) {
598 $validFooterLinks[$category][] = $link;
601 if ( count( $validFooterLinks[$category] ) <= 0 ) {
602 unset( $validFooterLinks[$category] );
606 if ( $option == 'flat' ) {
607 // fold footerlinks into a single array using a bit of trickery
608 $validFooterLinks = array_merge( ...array_values( $validFooterLinks ) );
611 return $validFooterLinks;
615 * Returns an array of footer icons filtered down by options relevant to how
616 * the skin wishes to display them.
617 * If you pass "icononly" as the option all footer icons which do not have an
618 * image icon set will be filtered out.
619 * If you pass "nocopyright" then MediaWiki's copyright icon will not be included
620 * in the list of footer icons. This is mostly useful for skins which only
621 * display the text from footericons instead of the images and don't want a
622 * duplicate copyright statement because footerlinks already rendered one.
623 * @param string|null $option
626 function getFooterIcons( $option = null ) {
627 // Generate additional footer icons
628 $footericons = $this->get( 'footericons' );
630 if ( $option == 'icononly' ) {
631 // Unset any icons which don't have an image
632 foreach ( $footericons as &$footerIconsBlock ) {
633 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
634 if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
635 unset( $footerIconsBlock[$footerIconKey] );
639 // Redo removal of any empty blocks
640 foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
641 if ( count( $footerIconsBlock ) <= 0 ) {
642 unset( $footericons[$footerIconsKey] );
645 } elseif ( $option == 'nocopyright' ) {
646 unset( $footericons['copyright']['copyright'] );
647 if ( count( $footericons['copyright'] ) <= 0 ) {
648 unset( $footericons['copyright'] );
656 * Renderer for getFooterIcons and getFooterLinks
658 * @param string $iconStyle $option for getFooterIcons: "icononly", "nocopyright"
659 * @param string $linkStyle $option for getFooterLinks: "flat"
661 * @return string html
664 protected function getFooter( $iconStyle = 'icononly', $linkStyle = 'flat' ) {
665 $validFooterIcons = $this->getFooterIcons( $iconStyle );
666 $validFooterLinks = $this->getFooterLinks( $linkStyle );
670 if ( count( $validFooterIcons ) +
count( $validFooterLinks ) > 0 ) {
671 $html .= Html
::openElement( 'div', [
672 'id' => 'footer-bottom',
673 'role' => 'contentinfo',
674 'lang' => $this->get( 'userlang' ),
675 'dir' => $this->get( 'dir' )
677 $footerEnd = Html
::closeElement( 'div' );
681 foreach ( $validFooterIcons as $blockName => $footerIcons ) {
682 $html .= Html
::openElement( 'div', [
683 'id' => Sanitizer
::escapeIdForAttribute( "f-{$blockName}ico" ),
684 'class' => 'footer-icons'
686 foreach ( $footerIcons as $icon ) {
687 $html .= $this->getSkin()->makeFooterIcon( $icon );
689 $html .= Html
::closeElement( 'div' );
691 if ( count( $validFooterLinks ) > 0 ) {
692 $html .= Html
::openElement( 'ul', [ 'id' => 'f-list', 'class' => 'footer-places' ] );
693 foreach ( $validFooterLinks as $aLink ) {
694 $html .= Html
::rawElement(
696 [ 'id' => Sanitizer
::escapeIdForAttribute( $aLink ) ],
700 $html .= Html
::closeElement( 'ul' );
703 $html .= $this->getClear() . $footerEnd;
709 * Get a div with the core visualClear class, for clearing floats
711 * @return string html
714 protected function getClear() {
715 return Html
::element( 'div', [ 'class' => 'visualClear' ] );
719 * Get the suggested HTML for page status indicators: icons (or short text snippets) usually
720 * displayed in the top-right corner of the page, outside of the main content.
722 * Your skin may implement this differently, for example by handling some indicator names
723 * specially with a different UI. However, it is recommended to use a `<div class="mw-indicator"
724 * id="mw-indicator-<id>" />` as a wrapper element for each indicator, for better compatibility
725 * with extensions and user scripts.
727 * The raw data is available in `$this->data['indicators']` as an associative array (keys:
728 * identifiers, values: contents) internally ordered by keys.
730 * @return string HTML
733 public function getIndicators() {
734 $out = "<div class=\"mw-indicators mw-body-content\">\n";
735 foreach ( $this->data
['indicators'] as $id => $content ) {
736 $out .= Html
::rawElement(
739 'id' => Sanitizer
::escapeIdForAttribute( "mw-indicator-$id" ),
740 'class' => 'mw-indicator',
752 function printTrail() {
753 echo $this->getTrail();
757 * Get the basic end-page trail including bottomscripts, reporttime, and
758 * debug stuff. This should be called right before outputting the closing
759 * body and html tags.
761 * @return string|WrappedStringList HTML
764 public function getTrail() {
765 return WrappedString
::join( "\n", [
766 // @phan-suppress-next-line PhanTypeMismatchArgument
767 MWDebug
::getDebugHTML( $this->getSkin()->getContext() ),
768 $this->get( 'bottomscripts' ),
769 $this->get( 'reporttime' )