3 * Base class for all skins.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use Wikimedia\WrappedString
;
25 use Wikimedia\WrappedStringList
;
28 * @defgroup Skins Skins
32 * The main skin class which provides methods and properties for all other skins.
34 * See docs/skin.txt for more information.
38 abstract class Skin
extends ContextSource
{
42 protected $skinname = null;
44 protected $mRelevantTitle = null;
45 protected $mRelevantUser = null;
48 * @var string Stylesheets set to use. Subdirectory in skins/ where various stylesheets are
49 * located. Only needs to be set if you intend to use the getSkinStylePath() method.
51 public $stylename = null;
54 * Fetch the set of available skins.
55 * @return array Associative array of strings
57 static function getSkinNames() {
58 $skinFactory = MediaWikiServices
::getInstance()->getSkinFactory();
59 return $skinFactory->getSkinNames();
63 * Fetch the skinname messages for available skins.
66 static function getSkinNameMessages() {
68 foreach ( self
::getSkinNames() as $skinKey => $skinName ) {
69 $messages[] = "skinname-$skinKey";
75 * Fetch the list of user-selectable skins in regards to $wgSkipSkins.
76 * Useful for Special:Preferences and other places where you
77 * only want to show skins users _can_ use.
81 public static function getAllowedSkins() {
84 $allowedSkins = self
::getSkinNames();
86 foreach ( $wgSkipSkins as $skip ) {
87 unset( $allowedSkins[$skip] );
94 * Normalize a skin preference value to a form that can be loaded.
96 * If a skin can't be found, it will fall back to the configured default ($wgDefaultSkin), or the
97 * hardcoded default ($wgFallbackSkin) if the default skin is unavailable too.
99 * @param string $key 'monobook', 'vector', etc.
102 static function normalizeKey( $key ) {
103 global $wgDefaultSkin, $wgFallbackSkin;
105 $skinNames = self
::getSkinNames();
107 // Make keys lowercase for case-insensitive matching.
108 $skinNames = array_change_key_case( $skinNames, CASE_LOWER
);
109 $key = strtolower( $key );
110 $defaultSkin = strtolower( $wgDefaultSkin );
111 $fallbackSkin = strtolower( $wgFallbackSkin );
113 if ( $key == '' ||
$key == 'default' ) {
114 // Don't return the default immediately;
115 // in a misconfiguration we need to fall back.
119 if ( isset( $skinNames[$key] ) ) {
123 // Older versions of the software used a numeric setting
124 // in the user preferences.
130 if ( isset( $fallback[$key] ) ) {
131 $key = $fallback[$key];
134 if ( isset( $skinNames[$key] ) ) {
136 } elseif ( isset( $skinNames[$defaultSkin] ) ) {
139 return $fallbackSkin;
145 * @param string|null $skinname
147 public function __construct( $skinname = null ) {
148 if ( is_string( $skinname ) ) {
149 $this->skinname
= $skinname;
154 * @return string|null Skin name
156 public function getSkinName() {
157 return $this->skinname
;
161 * @param OutputPage $out
163 public function initPage( OutputPage
$out ) {
164 $this->preloadExistence();
168 * Defines the ResourceLoader modules that should be added to the skin
169 * It is recommended that skins wishing to override call parent::getDefaultModules()
170 * and substitute out any modules they wish to change by using a key to look them up
172 * Any modules defined with the 'styles' key will be added as render blocking CSS via
173 * Output::addModuleStyles. Similarly, each key should refer to a list of modules
175 * @return array Array of modules with helper keys for easy overriding
177 public function getDefaultModules() {
178 $out = $this->getOutput();
179 $user = $this->getUser();
181 // Modules declared in the $modules literal are loaded
182 // for ALL users, on ALL pages, in ALL skins.
183 // Keep this list as small as possible!
186 // The 'styles' key sets render-blocking style modules
187 // Unlike other keys in $modules, this is an associative array
188 // where each key is its own group pointing to a list of modules
190 'mediawiki.legacy.shared',
191 'mediawiki.legacy.commonPrint',
198 'mediawiki.page.startup',
200 // modules that enhance the content in some way
202 'mediawiki.page.ready',
204 // modules relating to search functionality
206 'mediawiki.searchSuggest',
208 // modules relating to functionality relating to watching an article
210 // modules which relate to the current users preferences
212 // modules relating to RSS/Atom Feeds
216 // Preload jquery.tablesorter for mediawiki.page.ready
217 if ( strpos( $out->getHTML(), 'sortable' ) !== false ) {
218 $modules['content'][] = 'jquery.tablesorter';
219 $modules['styles']['content'][] = 'jquery.tablesorter.styles';
222 // Preload jquery.makeCollapsible for mediawiki.page.ready
223 if ( strpos( $out->getHTML(), 'mw-collapsible' ) !== false ) {
224 $modules['content'][] = 'jquery.makeCollapsible';
225 $modules['styles']['content'][] = 'jquery.makeCollapsible.styles';
228 // Deprecated since 1.26: Unconditional loading of mediawiki.ui.button
229 // on every page is deprecated. Express a dependency instead.
230 if ( strpos( $out->getHTML(), 'mw-ui-button' ) !== false ) {
231 $modules['styles']['content'][] = 'mediawiki.ui.button';
234 if ( $out->isTOCEnabled() ) {
235 $modules['content'][] = 'mediawiki.toc';
236 $modules['styles']['content'][] = 'mediawiki.toc.styles';
239 // Add various resources if required
240 if ( $user->isLoggedIn()
241 && $user->isAllowedAll( 'writeapi', 'viewmywatchlist', 'editmywatchlist' )
242 && $this->getRelevantTitle()->canExist()
244 $modules['watch'][] = 'mediawiki.page.watch.ajax';
247 if ( $user->getBoolOption( 'editsectiononrightclick' ) ) {
248 $modules['user'][] = 'mediawiki.action.view.rightClickEdit';
251 // Crazy edit-on-double-click stuff
252 if ( $out->isArticle() && $user->getOption( 'editondblclick' ) ) {
253 $modules['user'][] = 'mediawiki.action.view.dblClickEdit';
256 if ( $out->isSyndicated() ) {
257 $modules['styles']['syndicate'][] = 'mediawiki.feedlink';
264 * Preload the existence of three commonly-requested pages in a single query
266 protected function preloadExistence() {
270 $user = $this->getUser();
271 if ( $user->isLoggedIn() ) {
272 $titles[] = $user->getUserPage();
273 $titles[] = $user->getTalkPage();
276 // Check, if the page can hold some kind of content, otherwise do nothing
277 $title = $this->getRelevantTitle();
278 if ( $title->canExist() ) {
279 if ( $title->isTalkPage() ) {
280 $titles[] = $title->getSubjectPage();
282 $titles[] = $title->getTalkPage();
286 // Footer links (used by SkinTemplate::prepareQuickTemplate)
288 $this->footerLinkTitle( 'privacy', 'privacypage' ),
289 $this->footerLinkTitle( 'aboutsite', 'aboutpage' ),
290 $this->footerLinkTitle( 'disclaimers', 'disclaimerpage' ),
297 Hooks
::run( 'SkinPreloadExistence', [ &$titles, $this ] );
300 $lb = new LinkBatch( $titles );
301 $lb->setCaller( __METHOD__
);
307 * Get the current revision ID
311 public function getRevisionId() {
312 return $this->getOutput()->getRevisionId();
316 * Whether the revision displayed is the latest revision of the page
320 public function isRevisionCurrent() {
321 $revID = $this->getRevisionId();
322 return $revID == 0 ||
$revID == $this->getTitle()->getLatestRevID();
326 * Set the "relevant" title
327 * @see self::getRelevantTitle()
330 public function setRelevantTitle( $t ) {
331 $this->mRelevantTitle
= $t;
335 * Return the "relevant" title.
336 * A "relevant" title is not necessarily the actual title of the page.
337 * Special pages like Special:MovePage use set the page they are acting on
338 * as their "relevant" title, this allows the skin system to display things
339 * such as content tabs which belong to to that page instead of displaying
340 * a basic special page tab which has almost no meaning.
344 public function getRelevantTitle() {
345 return $this->mRelevantTitle ??
$this->getTitle();
349 * Set the "relevant" user
350 * @see self::getRelevantUser()
353 public function setRelevantUser( $u ) {
354 $this->mRelevantUser
= $u;
358 * Return the "relevant" user.
359 * A "relevant" user is similar to a relevant title. Special pages like
360 * Special:Contributions mark the user which they are relevant to so that
361 * things like the toolbox can display the information they usually are only
362 * able to display on a user's userpage and talkpage.
365 public function getRelevantUser() {
366 if ( isset( $this->mRelevantUser
) ) {
367 return $this->mRelevantUser
;
369 $title = $this->getRelevantTitle();
370 if ( $title->hasSubjectNamespace( NS_USER
) ) {
371 $rootUser = $title->getRootText();
372 if ( User
::isIP( $rootUser ) ) {
373 $this->mRelevantUser
= User
::newFromName( $rootUser, false );
375 $user = User
::newFromName( $rootUser, false );
378 $user->load( User
::READ_NORMAL
);
380 if ( $user->isLoggedIn() ) {
381 $this->mRelevantUser
= $user;
385 return $this->mRelevantUser
;
391 * Outputs the HTML generated by other functions.
392 * @param OutputPage|null $out
394 abstract function outputPage( OutputPage
$out = null );
398 * @param string|null $nonce OutputPage::getCSPNonce()
399 * @return string|WrappedString HTML
401 public static function makeVariablesScript( $data, $nonce = null ) {
403 return ResourceLoader
::makeInlineScript(
404 ResourceLoader
::makeConfigSetScript( $data ),
412 * Get the query to generate a dynamic stylesheet
414 * @deprecated since 1.32 Use action=raw&ctype=text/css directly.
417 public static function getDynamicStylesheetQuery() {
420 'ctype' => 'text/css',
425 * Hook point for adding style modules to OutputPage.
427 * @deprecated since 1.32 Use getDefaultModules() instead.
428 * @param OutputPage $out Legacy parameter, identical to $this->getOutput()
430 public function setupSkinUserCss( OutputPage
$out ) {
436 * @param Title $title
439 function getPageClasses( $title ) {
440 $numeric = 'ns-' . $title->getNamespace();
441 $user = $this->getUser();
443 if ( $title->isSpecialPage() ) {
444 $type = 'ns-special';
445 // T25315: provide a class based on the canonical special page name without subpages
446 list( $canonicalName ) = MediaWikiServices
::getInstance()->getSpecialPageFactory()->
447 resolveAlias( $title->getDBkey() );
448 if ( $canonicalName ) {
449 $type .= ' ' . Sanitizer
::escapeClass( "mw-special-$canonicalName" );
451 $type .= ' mw-invalidspecialpage';
454 if ( $title->isTalkPage() ) {
457 $type = 'ns-subject';
459 // T208315: add HTML class when the user can edit the page
460 if ( $title->quickUserCan( 'edit', $user ) ) {
461 $type .= ' mw-editable';
465 $name = Sanitizer
::escapeClass( 'page-' . $title->getPrefixedText() );
466 $root = Sanitizer
::escapeClass( 'rootpage-' . $title->getRootTitle()->getPrefixedText() );
468 return "$numeric $type $name $root";
472 * Return values for <html> element
473 * @return array Array of associative name-to-value elements for <html> element
475 public function getHtmlElementAttributes() {
476 $lang = $this->getLanguage();
478 'lang' => $lang->getHtmlCode(),
479 'dir' => $lang->getDir(),
480 'class' => 'client-nojs',
485 * This will be called by OutputPage::headElement when it is creating the
486 * "<body>" tag, skins can override it if they have a need to add in any
487 * body attributes or classes of their own.
488 * @param OutputPage $out
489 * @param array &$bodyAttrs
491 function addToBodyAttributes( $out, &$bodyAttrs ) {
492 // does nothing by default
500 return $this->getConfig()->get( 'Logo' );
504 * Whether the logo should be preloaded with an HTTP link header or not
506 * @deprecated since 1.32 Redundant. It now happens automatically based on whether
507 * the skin loads a stylesheet based on ResourceLoaderSkinModule, which all
508 * skins that use wgLogo in CSS do, and other's would not.
512 public function shouldPreloadLogo() {
517 * @return string HTML
519 function getCategoryLinks() {
520 $out = $this->getOutput();
521 $allCats = $out->getCategoryLinks();
522 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
524 if ( $allCats === [] ) {
532 $colon = $this->msg( 'colon-separator' )->escaped();
534 if ( !empty( $allCats['normal'] ) ) {
535 $t = $embed . implode( $pop . $embed, $allCats['normal'] ) . $pop;
537 $msg = $this->msg( 'pagecategories' )->numParams( count( $allCats['normal'] ) );
538 $linkPage = $this->msg( 'pagecategorieslink' )->inContentLanguage()->text();
539 $title = Title
::newFromText( $linkPage );
540 $link = $title ?
$linkRenderer->makeLink( $title, $msg->text() ) : $msg->escaped();
541 $s .= '<div id="mw-normal-catlinks" class="mw-normal-catlinks">' .
542 $link . $colon . '<ul>' . $t . '</ul></div>';
546 if ( isset( $allCats['hidden'] ) ) {
547 if ( $this->getUser()->getBoolOption( 'showhiddencats' ) ) {
548 $class = ' mw-hidden-cats-user-shown';
549 } elseif ( $this->getTitle()->getNamespace() == NS_CATEGORY
) {
550 $class = ' mw-hidden-cats-ns-shown';
552 $class = ' mw-hidden-cats-hidden';
555 $s .= "<div id=\"mw-hidden-catlinks\" class=\"mw-hidden-catlinks$class\">" .
556 $this->msg( 'hidden-categories' )->numParams( count( $allCats['hidden'] ) )->escaped() .
557 $colon . '<ul>' . $embed . implode( $pop . $embed, $allCats['hidden'] ) . $pop . '</ul>' .
561 # optional 'dmoz-like' category browser. Will be shown under the list
562 # of categories an article belong to
563 if ( $this->getConfig()->get( 'UseCategoryBrowser' ) ) {
564 $s .= '<br /><hr />';
566 # get a big array of the parents tree
567 $parenttree = $this->getTitle()->getParentCategoryTree();
568 # Skin object passed by reference cause it can not be
569 # accessed under the method subfunction drawCategoryBrowser
570 $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) );
571 # Clean out bogus first entry and sort them
572 unset( $tempout[0] );
574 # Output one per line
575 $s .= implode( "<br />\n", $tempout );
582 * Render the array as a series of links.
583 * @param array $tree Categories tree returned by Title::getParentCategoryTree
584 * @return string Separated by >, terminate with "\n"
586 function drawCategoryBrowser( $tree ) {
588 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
590 foreach ( $tree as $element => $parent ) {
591 if ( empty( $parent ) ) {
592 # element start a new list
595 # grab the others elements
596 $return .= $this->drawCategoryBrowser( $parent ) . ' > ';
599 # add our current element to the list
600 $eltitle = Title
::newFromText( $element );
601 $return .= $linkRenderer->makeLink( $eltitle, $eltitle->getText() );
608 * @return string HTML
610 function getCategories() {
611 $out = $this->getOutput();
612 $catlinks = $this->getCategoryLinks();
614 // Check what we're showing
615 $allCats = $out->getCategoryLinks();
616 $showHidden = $this->getUser()->getBoolOption( 'showhiddencats' ) ||
617 $this->getTitle()->getNamespace() == NS_CATEGORY
;
619 $classes = [ 'catlinks' ];
620 if ( empty( $allCats['normal'] ) && !( !empty( $allCats['hidden'] ) && $showHidden ) ) {
621 $classes[] = 'catlinks-allhidden';
624 return Html
::rawElement(
626 [ 'id' => 'catlinks', 'class' => $classes, 'data-mw' => 'interface' ],
632 * This runs a hook to allow extensions placing their stuff after content
633 * and article metadata (e.g. categories).
634 * Note: This function has nothing to do with afterContent().
636 * This hook is placed here in order to allow using the same hook for all
637 * skins, both the SkinTemplate based ones and the older ones, which directly
638 * use this class to get their data.
640 * The output of this function gets processed in SkinTemplate::outputPage() for
641 * the SkinTemplate based skins, all other skins should directly echo it.
643 * @return string Empty by default, if not changed by any hook function.
645 protected function afterContentHook() {
648 if ( Hooks
::run( 'SkinAfterContent', [ &$data, $this ] ) ) {
649 // adding just some spaces shouldn't toggle the output
650 // of the whole <div/>, so we use trim() here
651 if ( trim( $data ) != '' ) {
652 // Doing this here instead of in the skins to
653 // ensure that the div has the same ID in all
655 $data = "<div id='mw-data-after-content'>\n" .
660 wfDebug( "Hook SkinAfterContent changed output processing.\n" );
667 * Generate debug data HTML for displaying at the bottom of the main content
669 * @return string HTML containing debug data, if enabled (otherwise empty).
671 protected function generateDebugHTML() {
672 return MWDebug
::getHTMLDebugLog();
676 * This gets called shortly before the "</body>" tag.
678 * @return string|WrappedStringList HTML containing scripts to put before `</body>`
680 function bottomScripts() {
681 // TODO and the suckage continues. This function is really just a wrapper around
682 // OutputPage::getBottomScripts() which takes a Skin param. This should be cleaned
684 $chunks = [ $this->getOutput()->getBottomScripts() ];
686 // Keep the hook appendage separate to preserve WrappedString objects.
687 // This enables BaseTemplate::getTrail() to merge them where possible.
689 Hooks
::run( 'SkinAfterBottomScripts', [ $this, &$extraHtml ] );
690 if ( $extraHtml !== '' ) {
691 $chunks[] = $extraHtml;
693 return WrappedString
::join( "\n", $chunks );
697 * Text with the permalink to the source page,
698 * usually shown on the footer of a printed page
700 * @return string HTML text with an URL
702 function printSource() {
703 $oldid = $this->getRevisionId();
705 $canonicalUrl = $this->getTitle()->getCanonicalURL( 'oldid=' . $oldid );
706 $url = htmlspecialchars( wfExpandIRI( $canonicalUrl ) );
708 // oldid not available for non existing pages
709 $url = htmlspecialchars( wfExpandIRI( $this->getTitle()->getCanonicalURL() ) );
712 return $this->msg( 'retrievedfrom' )
713 ->rawParams( '<a dir="ltr" href="' . $url . '">' . $url . '</a>' )
718 * @return string HTML
720 function getUndeleteLink() {
721 $action = $this->getRequest()->getVal( 'action', 'view' );
722 $title = $this->getTitle();
723 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
725 if ( ( !$title->exists() ||
$action == 'history' ) &&
726 $title->quickUserCan( 'deletedhistory', $this->getUser() )
728 $n = $title->isDeleted();
731 if ( $this->getTitle()->quickUserCan( 'undelete', $this->getUser() ) ) {
732 $msg = 'thisisdeleted';
734 $msg = 'viewdeleted';
737 return $this->msg( $msg )->rawParams(
738 $linkRenderer->makeKnownLink(
739 SpecialPage
::getTitleFor( 'Undelete', $this->getTitle()->getPrefixedDBkey() ),
740 $this->msg( 'restorelink' )->numParams( $n )->text() )
749 * @param OutputPage|null $out Defaults to $this->getOutput() if left as null
752 function subPageSubtitle( $out = null ) {
753 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
754 if ( $out === null ) {
755 $out = $this->getOutput();
757 $title = $out->getTitle();
760 if ( !Hooks
::run( 'SkinSubPageSubtitle', [ &$subpages, $this, $out ] ) ) {
765 $out->isArticle() && MediaWikiServices
::getInstance()->getNamespaceInfo()->
766 hasSubpages( $title->getNamespace() )
768 $ptext = $title->getPrefixedText();
769 if ( strpos( $ptext, '/' ) !== false ) {
770 $links = explode( '/', $ptext );
775 $lang = $this->getLanguage();
777 foreach ( $links as $link ) {
778 $growinglink .= $link;
780 $linkObj = Title
::newFromText( $growinglink );
782 if ( is_object( $linkObj ) && $linkObj->isKnown() ) {
783 $getlink = $linkRenderer->makeKnownLink(
790 $subpages .= $lang->getDirMarkEntity() . $this->msg( 'pipe-separator' )->escaped();
792 $subpages .= '< ';
795 $subpages .= $getlink;
811 function getSearchLink() {
812 $searchPage = SpecialPage
::getTitleFor( 'Search' );
813 return $searchPage->getLocalURL();
819 function escapeSearchLink() {
820 return htmlspecialchars( $this->getSearchLink() );
824 * @param string $type
827 function getCopyright( $type = 'detect' ) {
828 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
829 if ( $type == 'detect' ) {
830 if ( !$this->isRevisionCurrent()
831 && !$this->msg( 'history_copyright' )->inContentLanguage()->isDisabled()
839 if ( $type == 'history' ) {
840 $msg = 'history_copyright';
845 $config = $this->getConfig();
847 if ( $config->get( 'RightsPage' ) ) {
848 $title = Title
::newFromText( $config->get( 'RightsPage' ) );
849 $link = $linkRenderer->makeKnownLink(
850 $title, new HtmlArmor( $config->get( 'RightsText' ) )
852 } elseif ( $config->get( 'RightsUrl' ) ) {
853 $link = Linker
::makeExternalLink( $config->get( 'RightsUrl' ), $config->get( 'RightsText' ) );
854 } elseif ( $config->get( 'RightsText' ) ) {
855 $link = $config->get( 'RightsText' );
861 // Allow for site and per-namespace customization of copyright notice.
862 // @todo Remove deprecated $forContent param from hook handlers and then remove here.
866 'SkinCopyrightFooter',
867 [ $this->getTitle(), $type, &$msg, &$link, &$forContent ]
870 return $this->msg( $msg )->rawParams( $link )->text();
874 * @return null|string
876 function getCopyrightIcon() {
878 $config = $this->getConfig();
880 $footerIcons = $config->get( 'FooterIcons' );
881 if ( $footerIcons['copyright']['copyright'] ) {
882 $out = $footerIcons['copyright']['copyright'];
883 } elseif ( $config->get( 'RightsIcon' ) ) {
884 $icon = htmlspecialchars( $config->get( 'RightsIcon' ) );
885 $url = $config->get( 'RightsUrl' );
888 $out .= '<a href="' . htmlspecialchars( $url ) . '">';
891 $text = htmlspecialchars( $config->get( 'RightsText' ) );
892 $out .= "<img src=\"$icon\" alt=\"$text\" width=\"88\" height=\"31\" />";
903 * Gets the powered by MediaWiki icon.
906 function getPoweredBy() {
907 $resourceBasePath = $this->getConfig()->get( 'ResourceBasePath' );
908 $url1 = htmlspecialchars(
909 "$resourceBasePath/resources/assets/poweredby_mediawiki_88x31.png"
911 $url1_5 = htmlspecialchars(
912 "$resourceBasePath/resources/assets/poweredby_mediawiki_132x47.png"
914 $url2 = htmlspecialchars(
915 "$resourceBasePath/resources/assets/poweredby_mediawiki_176x62.png"
917 $text = '<a href="https://www.mediawiki.org/"><img src="' . $url1
918 . '" srcset="' . $url1_5 . ' 1.5x, ' . $url2 . ' 2x" '
919 . 'height="31" width="88" alt="Powered by MediaWiki" /></a>';
920 Hooks
::run( 'SkinGetPoweredBy', [ &$text, $this ] );
925 * Get the timestamp of the latest revision, formatted in user language
929 protected function lastModified() {
930 $timestamp = $this->getOutput()->getRevisionTimestamp();
932 # No cached timestamp, load it from the database
933 if ( $timestamp === null ) {
934 $timestamp = Revision
::getTimestampFromId( $this->getTitle(), $this->getRevisionId() );
938 $d = $this->getLanguage()->userDate( $timestamp, $this->getUser() );
939 $t = $this->getLanguage()->userTime( $timestamp, $this->getUser() );
940 $s = ' ' . $this->msg( 'lastmodifiedat', $d, $t )->parse();
945 if ( MediaWikiServices
::getInstance()->getDBLoadBalancer()->getLaggedReplicaMode() ) {
946 $s .= ' <strong>' . $this->msg( 'laggedslavemode' )->parse() . '</strong>';
953 * @param string $align
956 function logoText( $align = '' ) {
957 if ( $align != '' ) {
958 $a = " style='float: {$align};'";
963 $mp = $this->msg( 'mainpage' )->escaped();
964 $mptitle = Title
::newMainPage();
965 $url = ( is_object( $mptitle ) ?
htmlspecialchars( $mptitle->getLocalURL() ) : '' );
967 $logourl = $this->getLogo();
968 $s = "<a href='{$url}'><img{$a} src='{$logourl}' alt='[{$mp}]' /></a>";
974 * Renders a $wgFooterIcons icon according to the method's arguments
975 * @param array $icon The icon to build the html for, see $wgFooterIcons
976 * for the format of this array.
977 * @param bool|string $withImage Whether to use the icon's image or output
978 * a text-only footericon.
979 * @return string HTML
981 function makeFooterIcon( $icon, $withImage = 'withImage' ) {
982 if ( is_string( $icon ) ) {
984 } else { // Assuming array
985 $url = $icon["url"] ??
null;
986 unset( $icon["url"] );
987 if ( isset( $icon["src"] ) && $withImage === 'withImage' ) {
988 // do this the lazy way, just pass icon data as an attribute array
989 $html = Html
::element( 'img', $icon );
991 $html = htmlspecialchars( $icon["alt"] );
994 $html = Html
::rawElement( 'a',
995 [ "href" => $url, "target" => $this->getConfig()->get( 'ExternalLinkTarget' ) ],
1003 * Gets the link to the wiki's main page.
1006 function mainPageLink() {
1007 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
1008 $s = $linkRenderer->makeKnownLink(
1009 Title
::newMainPage(),
1010 $this->msg( 'mainpage' )->text()
1017 * Returns an HTML link for use in the footer
1018 * @param string $desc The i18n message key for the link text
1019 * @param string $page The i18n message key for the page to link to
1020 * @return string HTML anchor
1022 public function footerLink( $desc, $page ) {
1023 $title = $this->footerLinkTitle( $desc, $page );
1024 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
1029 return $linkRenderer->makeKnownLink(
1031 $this->msg( $desc )->text()
1036 * @param string $desc
1037 * @param string $page
1038 * @return Title|null
1040 private function footerLinkTitle( $desc, $page ) {
1041 // If the link description has been set to "-" in the default language,
1042 if ( $this->msg( $desc )->inContentLanguage()->isDisabled() ) {
1043 // then it is disabled, for all languages.
1046 // Otherwise, we display the link for the user, described in their
1047 // language (which may or may not be the same as the default language),
1048 // but we make the link target be the one site-wide page.
1049 $title = Title
::newFromText( $this->msg( $page )->inContentLanguage()->text() );
1051 return $title ?
: null;
1055 * Gets the link to the wiki's privacy policy page.
1056 * @return string HTML
1058 function privacyLink() {
1059 return $this->footerLink( 'privacy', 'privacypage' );
1063 * Gets the link to the wiki's about page.
1064 * @return string HTML
1066 function aboutLink() {
1067 return $this->footerLink( 'aboutsite', 'aboutpage' );
1071 * Gets the link to the wiki's general disclaimers page.
1072 * @return string HTML
1074 function disclaimerLink() {
1075 return $this->footerLink( 'disclaimers', 'disclaimerpage' );
1079 * Return URL options for the 'edit page' link.
1080 * This may include an 'oldid' specifier, if the current page view is such.
1085 function editUrlOptions() {
1086 $options = [ 'action' => 'edit' ];
1088 if ( !$this->isRevisionCurrent() ) {
1089 $options['oldid'] = intval( $this->getRevisionId() );
1096 * @param User|int $id
1099 function showEmailUser( $id ) {
1100 if ( $id instanceof User
) {
1103 $targetUser = User
::newFromId( $id );
1106 # The sending user must have a confirmed email address and the receiving
1107 # user must accept emails from the sender.
1108 return $this->getUser()->canSendEmail()
1109 && SpecialEmailUser
::validateTarget( $targetUser, $this->getUser() ) === '';
1113 * Return a fully resolved style path URL to images or styles stored in the
1114 * current skin's folder. This method returns a URL resolved using the
1115 * configured skin style path.
1117 * Requires $stylename to be set, otherwise throws MWException.
1119 * @param string $name The name or path of a skin resource file
1120 * @return string The fully resolved style path URL
1121 * @throws MWException
1123 function getSkinStylePath( $name ) {
1124 if ( $this->stylename
=== null ) {
1125 $class = static::class;
1126 throw new MWException( "$class::\$stylename must be set to use getSkinStylePath()" );
1129 return $this->getConfig()->get( 'StylePath' ) . "/{$this->stylename}/$name";
1132 /* these are used extensively in SkinTemplate, but also some other places */
1135 * @param string|string[] $urlaction
1138 static function makeMainPageUrl( $urlaction = '' ) {
1139 $title = Title
::newMainPage();
1140 self
::checkTitle( $title, '' );
1142 return $title->getLinkURL( $urlaction );
1146 * Make a URL for a Special Page using the given query and protocol.
1148 * If $proto is set to null, make a local URL. Otherwise, make a full
1149 * URL with the protocol specified.
1151 * @param string $name Name of the Special page
1152 * @param string|string[] $urlaction Query to append
1153 * @param string|null $proto Protocol to use or null for a local URL
1156 static function makeSpecialUrl( $name, $urlaction = '', $proto = null ) {
1157 $title = SpecialPage
::getSafeTitleFor( $name );
1158 if ( is_null( $proto ) ) {
1159 return $title->getLocalURL( $urlaction );
1161 return $title->getFullURL( $urlaction, false, $proto );
1166 * @param string $name
1167 * @param string $subpage
1168 * @param string|string[] $urlaction
1171 static function makeSpecialUrlSubpage( $name, $subpage, $urlaction = '' ) {
1172 $title = SpecialPage
::getSafeTitleFor( $name, $subpage );
1173 return $title->getLocalURL( $urlaction );
1177 * @param string $name
1178 * @param string|string[] $urlaction
1181 static function makeI18nUrl( $name, $urlaction = '' ) {
1182 $title = Title
::newFromText( wfMessage( $name )->inContentLanguage()->text() );
1183 self
::checkTitle( $title, $name );
1184 return $title->getLocalURL( $urlaction );
1188 * @param string $name
1189 * @param string|string[] $urlaction
1192 static function makeUrl( $name, $urlaction = '' ) {
1193 $title = Title
::newFromText( $name );
1194 self
::checkTitle( $title, $name );
1196 return $title->getLocalURL( $urlaction );
1200 * If url string starts with http, consider as external URL, else
1202 * @param string $name
1203 * @return string URL
1205 static function makeInternalOrExternalUrl( $name ) {
1206 if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $name ) ) {
1209 return self
::makeUrl( $name );
1214 * this can be passed the NS number as defined in Language.php
1215 * @param string $name
1216 * @param string|string[] $urlaction
1217 * @param int $namespace
1220 static function makeNSUrl( $name, $urlaction = '', $namespace = NS_MAIN
) {
1221 $title = Title
::makeTitleSafe( $namespace, $name );
1222 self
::checkTitle( $title, $name );
1224 return $title->getLocalURL( $urlaction );
1228 * these return an array with the 'href' and boolean 'exists'
1229 * @param string $name
1230 * @param string|string[] $urlaction
1233 static function makeUrlDetails( $name, $urlaction = '' ) {
1234 $title = Title
::newFromText( $name );
1235 self
::checkTitle( $title, $name );
1238 'href' => $title->getLocalURL( $urlaction ),
1239 'exists' => $title->isKnown(),
1244 * Make URL details where the article exists (or at least it's convenient to think so)
1245 * @param string $name Article name
1246 * @param string|string[] $urlaction
1249 static function makeKnownUrlDetails( $name, $urlaction = '' ) {
1250 $title = Title
::newFromText( $name );
1251 self
::checkTitle( $title, $name );
1254 'href' => $title->getLocalURL( $urlaction ),
1260 * make sure we have some title to operate on
1262 * @param Title &$title
1263 * @param string $name
1265 static function checkTitle( &$title, $name ) {
1266 if ( !is_object( $title ) ) {
1267 $title = Title
::newFromText( $name );
1268 if ( !is_object( $title ) ) {
1269 $title = Title
::newFromText( '--error: link target missing--' );
1275 * Build an array that represents the sidebar(s), the navigation bar among them.
1277 * BaseTemplate::getSidebar can be used to simplify the format and id generation in new skins.
1279 * The format of the returned array is [ heading => content, ... ], where:
1280 * - heading is the heading of a navigation portlet. It is either:
1281 * - magic string to be handled by the skins ('SEARCH' / 'LANGUAGES' / 'TOOLBOX' / ...)
1282 * - a message name (e.g. 'navigation'), the message should be HTML-escaped by the skin
1283 * - plain text, which should be HTML-escaped by the skin
1284 * - content is the contents of the portlet. It is either:
1285 * - HTML text (<ul><li>...</li>...</ul>)
1286 * - array of link data in a format accepted by BaseTemplate::makeListItem()
1287 * - (for a magic string as a key, any value)
1289 * Note that extensions can control the sidebar contents using the SkinBuildSidebar hook
1290 * and can technically insert anything in here; skin creators are expected to handle
1291 * values described above.
1295 public function buildSidebar() {
1296 $callback = function ( $old = null, &$ttl = null ) {
1298 $this->addToSidebar( $bar, 'sidebar' );
1299 Hooks
::run( 'SkinBuildSidebar', [ $this, &$bar ] );
1300 if ( MessageCache
::singleton()->isDisabled() ) {
1301 $ttl = WANObjectCache
::TTL_UNCACHEABLE
; // bug T133069
1307 $msgCache = MessageCache
::singleton();
1308 $wanCache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1309 $config = $this->getConfig();
1311 $sidebar = $config->get( 'EnableSidebarCache' )
1312 ?
$wanCache->getWithSetCallback(
1313 $wanCache->makeKey( 'sidebar', $this->getLanguage()->getCode() ),
1314 $config->get( 'SidebarCacheExpiry' ),
1318 // Unless there is both no exact $code override nor an i18n definition
1319 // in the software, the only MediaWiki page to check is for $code.
1320 $msgCache->getCheckKey( $this->getLanguage()->getCode() )
1327 // Apply post-processing to the cached value
1328 Hooks
::run( 'SidebarBeforeOutput', [ $this, &$sidebar ] );
1334 * Add content from a sidebar system message
1335 * Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
1337 * This is just a wrapper around addToSidebarPlain() for backwards compatibility
1339 * @param array &$bar
1340 * @param string $message
1342 public function addToSidebar( &$bar, $message ) {
1343 $this->addToSidebarPlain( $bar, $this->msg( $message )->inContentLanguage()->plain() );
1347 * Add content from plain text
1349 * @param array &$bar
1350 * @param string $text
1353 function addToSidebarPlain( &$bar, $text ) {
1354 $lines = explode( "\n", $text );
1357 $config = $this->getConfig();
1358 $messageTitle = $config->get( 'EnableSidebarCache' )
1359 ? Title
::newMainPage() : $this->getTitle();
1361 foreach ( $lines as $line ) {
1362 if ( strpos( $line, '*' ) !== 0 ) {
1365 $line = rtrim( $line, "\r" ); // for Windows compat
1367 if ( strpos( $line, '**' ) !== 0 ) {
1368 $heading = trim( $line, '* ' );
1369 if ( !array_key_exists( $heading, $bar ) ) {
1370 $bar[$heading] = [];
1373 $line = trim( $line, '* ' );
1375 if ( strpos( $line, '|' ) !== false ) { // sanity check
1376 $line = MessageCache
::singleton()->transform( $line, false, null, $messageTitle );
1377 $line = array_map( 'trim', explode( '|', $line, 2 ) );
1378 if ( count( $line ) !== 2 ) {
1379 // Second sanity check, could be hit by people doing
1380 // funky stuff with parserfuncs... (T35321)
1386 $msgLink = $this->msg( $line[0] )->title( $messageTitle )->inContentLanguage();
1387 if ( $msgLink->exists() ) {
1388 $link = $msgLink->text();
1389 if ( $link == '-' ) {
1395 $msgText = $this->msg( $line[1] )->title( $messageTitle );
1396 if ( $msgText->exists() ) {
1397 $text = $msgText->text();
1402 if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $link ) ) {
1405 // Parser::getExternalLinkAttribs won't work here because of the Namespace things
1406 if ( $config->get( 'NoFollowLinks' ) &&
1407 !wfMatchesDomainList( $href, $config->get( 'NoFollowDomainExceptions' ) )
1409 $extraAttribs['rel'] = 'nofollow';
1412 if ( $config->get( 'ExternalLinkTarget' ) ) {
1413 $extraAttribs['target'] = $config->get( 'ExternalLinkTarget' );
1416 $title = Title
::newFromText( $link );
1419 $title = $title->fixSpecialName();
1420 $href = $title->getLinkURL();
1422 $href = 'INVALID-TITLE';
1426 $bar[$heading][] = array_merge( [
1429 'id' => Sanitizer
::escapeIdForAttribute( 'n-' . strtr( $line[1], ' ', '-' ) ),
1442 * Gets new talk page messages for the current user and returns an
1443 * appropriate alert message (or an empty string if there are no messages)
1446 function getNewtalks() {
1447 $newMessagesAlert = '';
1448 $user = $this->getUser();
1449 $newtalks = $user->getNewMessageLinks();
1450 $out = $this->getOutput();
1451 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
1453 // Allow extensions to disable or modify the new messages alert
1454 if ( !Hooks
::run( 'GetNewMessagesAlert', [ &$newMessagesAlert, $newtalks, $user, $out ] ) ) {
1457 if ( $newMessagesAlert ) {
1458 return $newMessagesAlert;
1461 if ( count( $newtalks ) == 1 && WikiMap
::isCurrentWikiId( $newtalks[0]['wiki'] ) ) {
1462 $uTalkTitle = $user->getTalkPage();
1463 $lastSeenRev = $newtalks[0]['rev'] ??
null;
1465 if ( $lastSeenRev !== null ) {
1466 $plural = true; // Default if we have a last seen revision: if unknown, use plural
1467 $latestRev = Revision
::newFromTitle( $uTalkTitle, false, Revision
::READ_NORMAL
);
1468 if ( $latestRev !== null ) {
1469 // Singular if only 1 unseen revision, plural if several unseen revisions.
1470 $plural = $latestRev->getParentId() !== $lastSeenRev->getId();
1471 $nofAuthors = $uTalkTitle->countAuthorsBetween(
1472 $lastSeenRev, $latestRev, 10, 'include_new' );
1475 // Singular if no revision -> diff link will show latest change only in any case
1478 $plural = $plural ?
999 : 1;
1479 // 999 signifies "more than one revision". We don't know how many, and even if we did,
1480 // the number of revisions or authors is not necessarily the same as the number of
1482 $newMessagesLink = $linkRenderer->makeKnownLink(
1484 $this->msg( 'newmessageslinkplural' )->params( $plural )->text(),
1486 $uTalkTitle->isRedirect() ?
[ 'redirect' => 'no' ] : []
1489 $newMessagesDiffLink = $linkRenderer->makeKnownLink(
1491 $this->msg( 'newmessagesdifflinkplural' )->params( $plural )->text(),
1493 $lastSeenRev !== null
1494 ?
[ 'oldid' => $lastSeenRev->getId(), 'diff' => 'cur' ]
1495 : [ 'diff' => 'cur' ]
1498 if ( $nofAuthors >= 1 && $nofAuthors <= 10 ) {
1499 $newMessagesAlert = $this->msg(
1500 'youhavenewmessagesfromusers',
1502 $newMessagesDiffLink
1503 )->numParams( $nofAuthors, $plural );
1505 // $nofAuthors === 11 signifies "11 or more" ("more than 10")
1506 $newMessagesAlert = $this->msg(
1507 $nofAuthors > 10 ?
'youhavenewmessagesmanyusers' : 'youhavenewmessages',
1509 $newMessagesDiffLink
1510 )->numParams( $plural );
1512 $newMessagesAlert = $newMessagesAlert->text();
1514 $out->setCdnMaxage( 0 );
1515 } elseif ( count( $newtalks ) ) {
1516 $sep = $this->msg( 'newtalkseparator' )->escaped();
1519 foreach ( $newtalks as $newtalk ) {
1520 $msgs[] = Xml
::element(
1522 [ 'href' => $newtalk['link'] ], $newtalk['wiki']
1525 $parts = implode( $sep, $msgs );
1526 $newMessagesAlert = $this->msg( 'youhavenewmessagesmulti' )->rawParams( $parts )->escaped();
1527 $out->setCdnMaxage( 0 );
1530 return $newMessagesAlert;
1534 * Get a cached notice
1536 * @param string $name Message name, or 'default' for $wgSiteNotice
1537 * @return string|bool HTML fragment, or false to indicate that the caller
1538 * should fall back to the next notice in its sequence
1540 private function getCachedNotice( $name ) {
1541 $config = $this->getConfig();
1543 if ( $name === 'default' ) {
1545 $notice = $config->get( 'SiteNotice' );
1546 if ( empty( $notice ) ) {
1550 $msg = $this->msg( $name )->inContentLanguage();
1551 if ( $msg->isBlank() ) {
1553 } elseif ( $msg->isDisabled() ) {
1556 $notice = $msg->plain();
1559 $services = MediaWikiServices
::getInstance();
1560 $cache = $services->getMainWANObjectCache();
1561 $parsed = $cache->getWithSetCallback(
1562 // Use the extra hash appender to let eg SSL variants separately cache
1563 // Key is verified with md5 hash of unparsed wikitext
1564 $cache->makeKey( $name, $config->get( 'RenderHashAppend' ), md5( $notice ) ),
1567 function () use ( $notice ) {
1568 return $this->getOutput()->parseAsInterface( $notice );
1572 $contLang = $services->getContentLanguage();
1573 return Html
::rawElement(
1576 'id' => 'localNotice',
1577 'lang' => $contLang->getHtmlCode(),
1578 'dir' => $contLang->getDir()
1585 * Get the site notice
1587 * @return string HTML fragment
1589 function getSiteNotice() {
1592 if ( Hooks
::run( 'SiteNoticeBefore', [ &$siteNotice, $this ] ) ) {
1593 if ( is_object( $this->getUser() ) && $this->getUser()->isLoggedIn() ) {
1594 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1596 $anonNotice = $this->getCachedNotice( 'anonnotice' );
1597 if ( $anonNotice === false ) {
1598 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1600 $siteNotice = $anonNotice;
1603 if ( $siteNotice === false ) {
1604 $siteNotice = $this->getCachedNotice( 'default' );
1608 Hooks
::run( 'SiteNoticeAfter', [ &$siteNotice, $this ] );
1613 * Create a section edit link.
1615 * @suppress SecurityCheck-XSS $links has keys of different taint types
1616 * @param Title $nt The title being linked to (may not be the same as
1617 * the current page, if the section is included from a template)
1618 * @param string $section The designation of the section being pointed to,
1619 * to be included in the link, like "§ion=$section"
1620 * @param string|null $tooltip The tooltip to use for the link: will be escaped
1621 * and wrapped in the 'editsectionhint' message
1622 * @param Language $lang Language object
1623 * @return string HTML to use for edit link
1625 public function doEditSectionLink( Title
$nt, $section, $tooltip, Language
$lang ) {
1626 // HTML generated here should probably have userlangattributes
1627 // added to it for LTR text on RTL pages
1630 if ( !is_null( $tooltip ) ) {
1631 $attribs['title'] = $this->msg( 'editsectionhint' )->rawParams( $tooltip )
1632 ->inLanguage( $lang )->text();
1637 'text' => $this->msg( 'editsection' )->inLanguage( $lang )->text(),
1638 'targetTitle' => $nt,
1639 'attribs' => $attribs,
1640 'query' => [ 'action' => 'edit', 'section' => $section ]
1644 Hooks
::run( 'SkinEditSectionLinks', [ $this, $nt, $section, $tooltip, &$links, $lang ] );
1646 $result = '<span class="mw-editsection"><span class="mw-editsection-bracket">[</span>';
1648 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
1650 foreach ( $links as $k => $linkDetails ) {
1651 $linksHtml[] = $linkRenderer->makeKnownLink(
1652 $linkDetails['targetTitle'],
1653 $linkDetails['text'],
1654 $linkDetails['attribs'],
1655 $linkDetails['query']
1660 '<span class="mw-editsection-divider">'
1661 . $this->msg( 'pipe-separator' )->inLanguage( $lang )->escaped()
1666 $result .= '<span class="mw-editsection-bracket">]</span></span>';