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
24 * @defgroup Skins Skins
28 * The main skin class which provides methods and properties for all other skins.
30 * See docs/skin.txt for more information.
34 abstract class Skin
extends ContextSource
{
35 protected $skinname = null;
36 protected $mRelevantTitle = null;
37 protected $mRelevantUser = null;
40 * @var string Stylesheets set to use. Subdirectory in skins/ where various stylesheets are
41 * located. Only needs to be set if you intend to use the getSkinStylePath() method.
43 public $stylename = null;
46 * Fetch the set of available skins.
47 * @return array Associative array of strings
49 static function getSkinNames() {
50 return SkinFactory
::getDefaultInstance()->getSkinNames();
54 * Fetch the skinname messages for available skins.
57 static function getSkinNameMessages() {
59 foreach ( self
::getSkinNames() as $skinKey => $skinName ) {
60 $messages[] = "skinname-$skinKey";
66 * Fetch the list of user-selectable skins in regards to $wgSkipSkins.
67 * Useful for Special:Preferences and other places where you
68 * only want to show skins users _can_ use.
72 public static function getAllowedSkins() {
75 $allowedSkins = self
::getSkinNames();
77 foreach ( $wgSkipSkins as $skip ) {
78 unset( $allowedSkins[$skip] );
85 * @deprecated since 1.23, use getAllowedSkins
88 public static function getUsableSkins() {
89 wfDeprecated( __METHOD__
, '1.23' );
90 return self
::getAllowedSkins();
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 = Skin
::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;
144 * Factory method for loading a skin of a given type
145 * @param string $key 'monobook', 'vector', etc.
147 * @deprecated since 1.24; Use SkinFactory instead
149 static function &newFromKey( $key ) {
150 wfDeprecated( __METHOD__
, '1.24' );
152 $key = Skin
::normalizeKey( $key );
153 $factory = SkinFactory
::getDefaultInstance();
155 // normalizeKey() guarantees that a skin with this key will exist.
156 $skin = $factory->makeSkin( $key );
161 * @return string Skin name
163 public function getSkinName() {
164 return $this->skinname
;
168 * @param OutputPage $out
170 function initPage( OutputPage
$out ) {
171 wfProfileIn( __METHOD__
);
173 $this->preloadExistence();
175 wfProfileOut( __METHOD__
);
179 * Defines the ResourceLoader modules that should be added to the skin
180 * It is recommended that skins wishing to override call parent::getDefaultModules()
181 * and substitute out any modules they wish to change by using a key to look them up
182 * @return array Array of modules with helper keys for easy overriding
184 public function getDefaultModules() {
185 global $wgIncludeLegacyJavaScript, $wgPreloadJavaScriptMwUtil, $wgUseAjax,
186 $wgAjaxWatch, $wgEnableAPI, $wgEnableWriteAPI;
188 $out = $this->getOutput();
189 $user = $out->getUser();
191 // modules that enhance the page content in some way
193 'mediawiki.page.ready',
195 // modules that exist for legacy reasons
197 // modules relating to search functionality
199 // modules relating to functionality relating to watching an article
201 // modules which relate to the current users preferences
204 if ( $wgIncludeLegacyJavaScript ) {
205 $modules['legacy'][] = 'mediawiki.legacy.wikibits';
208 if ( $wgPreloadJavaScriptMwUtil ) {
209 $modules['legacy'][] = 'mediawiki.util';
212 // Add various resources if required
214 $modules['legacy'][] = 'mediawiki.legacy.ajax';
216 if ( $wgEnableAPI ) {
217 if ( $wgEnableWriteAPI && $wgAjaxWatch && $user->isLoggedIn()
218 && $user->isAllowed( 'writeapi' )
220 $modules['watch'][] = 'mediawiki.page.watch.ajax';
223 $modules['search'][] = 'mediawiki.searchSuggest';
227 if ( $user->getBoolOption( 'editsectiononrightclick' ) ) {
228 $modules['user'][] = 'mediawiki.action.view.rightClickEdit';
231 // Crazy edit-on-double-click stuff
232 if ( $out->isArticle() && $user->getOption( 'editondblclick' ) ) {
233 $modules['user'][] = 'mediawiki.action.view.dblClickEdit';
239 * Preload the existence of three commonly-requested pages in a single query
241 function preloadExistence() {
244 $user = $this->getUser();
245 $title = $this->getRelevantTitle();
248 if ( $user->isLoggedIn() ||
$this->showIPinHeader() ) {
249 $titles[] = $user->getUserPage();
250 $titles[] = $user->getTalkPage();
254 if ( $title->isSpecialPage() ) {
256 } elseif ( $title->isTalkPage() ) {
257 $titles[] = $title->getSubjectPage();
259 $titles[] = $title->getTalkPage();
262 wfRunHooks( 'SkinPreloadExistence', array( &$titles, $this ) );
264 if ( count( $titles ) ) {
265 $lb = new LinkBatch( $titles );
266 $lb->setCaller( __METHOD__
);
272 * Get the current revision ID
276 public function getRevisionId() {
277 return $this->getOutput()->getRevisionId();
281 * Whether the revision displayed is the latest revision of the page
285 public function isRevisionCurrent() {
286 $revID = $this->getRevisionId();
287 return $revID == 0 ||
$revID == $this->getTitle()->getLatestRevID();
291 * Set the "relevant" title
292 * @see self::getRelevantTitle()
295 public function setRelevantTitle( $t ) {
296 $this->mRelevantTitle
= $t;
300 * Return the "relevant" title.
301 * A "relevant" title is not necessarily the actual title of the page.
302 * Special pages like Special:MovePage use set the page they are acting on
303 * as their "relevant" title, this allows the skin system to display things
304 * such as content tabs which belong to to that page instead of displaying
305 * a basic special page tab which has almost no meaning.
309 public function getRelevantTitle() {
310 if ( isset( $this->mRelevantTitle
) ) {
311 return $this->mRelevantTitle
;
313 return $this->getTitle();
317 * Set the "relevant" user
318 * @see self::getRelevantUser()
321 public function setRelevantUser( $u ) {
322 $this->mRelevantUser
= $u;
326 * Return the "relevant" user.
327 * A "relevant" user is similar to a relevant title. Special pages like
328 * Special:Contributions mark the user which they are relevant to so that
329 * things like the toolbox can display the information they usually are only
330 * able to display on a user's userpage and talkpage.
333 public function getRelevantUser() {
334 if ( isset( $this->mRelevantUser
) ) {
335 return $this->mRelevantUser
;
337 $title = $this->getRelevantTitle();
338 if ( $title->hasSubjectNamespace( NS_USER
) ) {
339 $rootUser = $title->getRootText();
340 if ( User
::isIP( $rootUser ) ) {
341 $this->mRelevantUser
= User
::newFromName( $rootUser, false );
343 $user = User
::newFromName( $rootUser, false );
344 if ( $user && $user->isLoggedIn() ) {
345 $this->mRelevantUser
= $user;
348 return $this->mRelevantUser
;
354 * Outputs the HTML generated by other functions.
355 * @param OutputPage $out
357 abstract function outputPage( OutputPage
$out = null );
363 static function makeVariablesScript( $data ) {
365 return Html
::inlineScript(
366 ResourceLoader
::makeLoaderConditionalScript( ResourceLoader
::makeConfigSetScript( $data ) )
374 * Get the query to generate a dynamic stylesheet
378 public static function getDynamicStylesheetQuery() {
379 global $wgSquidMaxage;
383 'maxage' => $wgSquidMaxage,
384 'usemsgcache' => 'yes',
385 'ctype' => 'text/css',
386 'smaxage' => $wgSquidMaxage,
391 * Add skin specific stylesheets
392 * Calling this method with an $out of anything but the same OutputPage
393 * inside ->getOutput() is deprecated. The $out arg is kept
394 * for compatibility purposes with skins.
395 * @param OutputPage $out
398 abstract function setupSkinUserCss( OutputPage
$out );
402 * @param Title $title
405 function getPageClasses( $title ) {
406 $numeric = 'ns-' . $title->getNamespace();
408 if ( $title->isSpecialPage() ) {
409 $type = 'ns-special';
410 // bug 23315: provide a class based on the canonical special page name without subpages
411 list( $canonicalName ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
412 if ( $canonicalName ) {
413 $type .= ' ' . Sanitizer
::escapeClass( "mw-special-$canonicalName" );
415 $type .= ' mw-invalidspecialpage';
417 } elseif ( $title->isTalkPage() ) {
420 $type = 'ns-subject';
423 $name = Sanitizer
::escapeClass( 'page-' . $title->getPrefixedText() );
425 return "$numeric $type $name";
429 * Return values for <html> element
430 * @return array Array of associative name-to-value elements for <html> element
432 public function getHtmlElementAttributes() {
433 $lang = $this->getLanguage();
435 'lang' => $lang->getHtmlCode(),
436 'dir' => $lang->getDir(),
437 'class' => 'client-nojs',
442 * This will be called by OutputPage::headElement when it is creating the
443 * "<body>" tag, skins can override it if they have a need to add in any
444 * body attributes or classes of their own.
445 * @param OutputPage $out
446 * @param array $bodyAttrs
448 function addToBodyAttributes( $out, &$bodyAttrs ) {
449 // does nothing by default
464 function getCategoryLinks() {
465 global $wgUseCategoryBrowser;
467 $out = $this->getOutput();
468 $allCats = $out->getCategoryLinks();
470 if ( !count( $allCats ) ) {
478 $colon = $this->msg( 'colon-separator' )->escaped();
480 if ( !empty( $allCats['normal'] ) ) {
481 $t = $embed . implode( "{$pop}{$embed}", $allCats['normal'] ) . $pop;
483 $msg = $this->msg( 'pagecategories' )->numParams( count( $allCats['normal'] ) )->escaped();
484 $linkPage = wfMessage( 'pagecategorieslink' )->inContentLanguage()->text();
485 $s .= '<div id="mw-normal-catlinks" class="mw-normal-catlinks">' .
486 Linker
::link( Title
::newFromText( $linkPage ), $msg )
487 . $colon . '<ul>' . $t . '</ul>' . '</div>';
491 if ( isset( $allCats['hidden'] ) ) {
492 if ( $this->getUser()->getBoolOption( 'showhiddencats' ) ) {
493 $class = ' mw-hidden-cats-user-shown';
494 } elseif ( $this->getTitle()->getNamespace() == NS_CATEGORY
) {
495 $class = ' mw-hidden-cats-ns-shown';
497 $class = ' mw-hidden-cats-hidden';
500 $s .= "<div id=\"mw-hidden-catlinks\" class=\"mw-hidden-catlinks$class\">" .
501 $this->msg( 'hidden-categories' )->numParams( count( $allCats['hidden'] ) )->escaped() .
502 $colon . '<ul>' . $embed . implode( "{$pop}{$embed}", $allCats['hidden'] ) . $pop . '</ul>' .
506 # optional 'dmoz-like' category browser. Will be shown under the list
507 # of categories an article belong to
508 if ( $wgUseCategoryBrowser ) {
509 $s .= '<br /><hr />';
511 # get a big array of the parents tree
512 $parenttree = $this->getTitle()->getParentCategoryTree();
513 # Skin object passed by reference cause it can not be
514 # accessed under the method subfunction drawCategoryBrowser
515 $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) );
516 # Clean out bogus first entry and sort them
517 unset( $tempout[0] );
519 # Output one per line
520 $s .= implode( "<br />\n", $tempout );
527 * Render the array as a series of links.
528 * @param array $tree Categories tree returned by Title::getParentCategoryTree
529 * @return string Separated by >, terminate with "\n"
531 function drawCategoryBrowser( $tree ) {
534 foreach ( $tree as $element => $parent ) {
535 if ( empty( $parent ) ) {
536 # element start a new list
539 # grab the others elements
540 $return .= $this->drawCategoryBrowser( $parent ) . ' > ';
543 # add our current element to the list
544 $eltitle = Title
::newFromText( $element );
545 $return .= Linker
::link( $eltitle, htmlspecialchars( $eltitle->getText() ) );
554 function getCategories() {
555 $out = $this->getOutput();
557 $catlinks = $this->getCategoryLinks();
559 $classes = 'catlinks';
561 // Check what we're showing
562 $allCats = $out->getCategoryLinks();
563 $showHidden = $this->getUser()->getBoolOption( 'showhiddencats' ) ||
564 $this->getTitle()->getNamespace() == NS_CATEGORY
;
566 if ( empty( $allCats['normal'] ) && !( !empty( $allCats['hidden'] ) && $showHidden ) ) {
567 $classes .= ' catlinks-allhidden';
570 return "<div id='catlinks' class='$classes'>{$catlinks}</div>";
574 * This runs a hook to allow extensions placing their stuff after content
575 * and article metadata (e.g. categories).
576 * Note: This function has nothing to do with afterContent().
578 * This hook is placed here in order to allow using the same hook for all
579 * skins, both the SkinTemplate based ones and the older ones, which directly
580 * use this class to get their data.
582 * The output of this function gets processed in SkinTemplate::outputPage() for
583 * the SkinTemplate based skins, all other skins should directly echo it.
585 * @return string Empty by default, if not changed by any hook function.
587 protected function afterContentHook() {
590 if ( wfRunHooks( 'SkinAfterContent', array( &$data, $this ) ) ) {
591 // adding just some spaces shouldn't toggle the output
592 // of the whole <div/>, so we use trim() here
593 if ( trim( $data ) != '' ) {
594 // Doing this here instead of in the skins to
595 // ensure that the div has the same ID in all
597 $data = "<div id='mw-data-after-content'>\n" .
602 wfDebug( "Hook SkinAfterContent changed output processing.\n" );
609 * Generate debug data HTML for displaying at the bottom of the main content
611 * @return string HTML containing debug data, if enabled (otherwise empty).
613 protected function generateDebugHTML() {
614 return MWDebug
::getHTMLDebugLog();
618 * This gets called shortly before the "</body>" tag.
620 * @return string HTML-wrapped JS code to be put before "</body>"
622 function bottomScripts() {
623 // TODO and the suckage continues. This function is really just a wrapper around
624 // OutputPage::getBottomScripts() which takes a Skin param. This should be cleaned
626 $bottomScriptText = $this->getOutput()->getBottomScripts();
627 wfRunHooks( 'SkinAfterBottomScripts', array( $this, &$bottomScriptText ) );
629 return $bottomScriptText;
633 * Text with the permalink to the source page,
634 * usually shown on the footer of a printed page
636 * @return string HTML text with an URL
638 function printSource() {
639 $oldid = $this->getRevisionId();
641 $canonicalUrl = $this->getTitle()->getCanonicalURL( 'oldid=' . $oldid );
642 $url = htmlspecialchars( wfExpandIRI( $canonicalUrl ) );
644 // oldid not available for non existing pages
645 $url = htmlspecialchars( wfExpandIRI( $this->getTitle()->getCanonicalURL() ) );
648 return $this->msg( 'retrievedfrom', '<a dir="ltr" href="' . $url
649 . '">' . $url . '</a>' )->text();
655 function getUndeleteLink() {
656 $action = $this->getRequest()->getVal( 'action', 'view' );
658 if ( $this->getTitle()->userCan( 'deletedhistory', $this->getUser() ) &&
659 ( $this->getTitle()->getArticleID() == 0 ||
$action == 'history' ) ) {
660 $n = $this->getTitle()->isDeleted();
663 if ( $this->getTitle()->userCan( 'undelete', $this->getUser() ) ) {
664 $msg = 'thisisdeleted';
666 $msg = 'viewdeleted';
669 return $this->msg( $msg )->rawParams(
671 SpecialPage
::getTitleFor( 'Undelete', $this->getTitle()->getPrefixedDBkey() ),
672 $this->msg( 'restorelink' )->numParams( $n )->escaped() )
683 function subPageSubtitle() {
684 $out = $this->getOutput();
687 if ( !wfRunHooks( 'SkinSubPageSubtitle', array( &$subpages, $this, $out ) ) ) {
691 if ( $out->isArticle() && MWNamespace
::hasSubpages( $out->getTitle()->getNamespace() ) ) {
692 $ptext = $this->getTitle()->getPrefixedText();
693 if ( preg_match( '/\//', $ptext ) ) {
694 $links = explode( '/', $ptext );
699 $lang = $this->getLanguage();
701 foreach ( $links as $link ) {
702 $growinglink .= $link;
704 $linkObj = Title
::newFromText( $growinglink );
706 if ( is_object( $linkObj ) && $linkObj->isKnown() ) {
707 $getlink = Linker
::linkKnown(
709 htmlspecialchars( $display )
715 $subpages .= $lang->getDirMarkEntity() . $this->msg( 'pipe-separator' )->escaped();
717 $subpages .= '< ';
720 $subpages .= $getlink;
734 * Returns true if the IP should be shown in the header
737 function showIPinHeader() {
738 global $wgShowIPinHeader;
739 return $wgShowIPinHeader && session_id() != '';
745 function getSearchLink() {
746 $searchPage = SpecialPage
::getTitleFor( 'Search' );
747 return $searchPage->getLocalURL();
753 function escapeSearchLink() {
754 return htmlspecialchars( $this->getSearchLink() );
758 * @param string $type
761 function getCopyright( $type = 'detect' ) {
762 global $wgRightsPage, $wgRightsUrl, $wgRightsText;
764 if ( $type == 'detect' ) {
765 if ( !$this->isRevisionCurrent()
766 && !$this->msg( 'history_copyright' )->inContentLanguage()->isDisabled()
774 if ( $type == 'history' ) {
775 $msg = 'history_copyright';
780 if ( $wgRightsPage ) {
781 $title = Title
::newFromText( $wgRightsPage );
782 $link = Linker
::linkKnown( $title, $wgRightsText );
783 } elseif ( $wgRightsUrl ) {
784 $link = Linker
::makeExternalLink( $wgRightsUrl, $wgRightsText );
785 } elseif ( $wgRightsText ) {
786 $link = $wgRightsText;
792 // Allow for site and per-namespace customization of copyright notice.
793 // @todo Remove deprecated $forContent param from hook handlers and then remove here.
797 'SkinCopyrightFooter',
798 array( $this->getTitle(), $type, &$msg, &$link, &$forContent )
801 return $this->msg( $msg )->rawParams( $link )->text();
805 * @return null|string
807 function getCopyrightIcon() {
808 global $wgRightsUrl, $wgRightsText, $wgRightsIcon, $wgCopyrightIcon;
812 if ( $wgCopyrightIcon ) {
813 $out = $wgCopyrightIcon;
814 } elseif ( $wgRightsIcon ) {
815 $icon = htmlspecialchars( $wgRightsIcon );
817 if ( $wgRightsUrl ) {
818 $url = htmlspecialchars( $wgRightsUrl );
819 $out .= '<a href="' . $url . '">';
822 $text = htmlspecialchars( $wgRightsText );
823 $out .= "<img src=\"$icon\" alt=\"$text\" width=\"88\" height=\"31\" />";
825 if ( $wgRightsUrl ) {
834 * Gets the powered by MediaWiki icon.
837 function getPoweredBy() {
838 global $wgResourceBasePath;
840 $url = htmlspecialchars( "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png" );
841 $text = '<a href="//www.mediawiki.org/"><img src="' . $url
842 . '" height="31" width="88" alt="Powered by MediaWiki" /></a>';
843 wfRunHooks( 'SkinGetPoweredBy', array( &$text, $this ) );
848 * Get the timestamp of the latest revision, formatted in user language
852 protected function lastModified() {
853 $timestamp = $this->getOutput()->getRevisionTimestamp();
855 # No cached timestamp, load it from the database
856 if ( $timestamp === null ) {
857 $timestamp = Revision
::getTimestampFromId( $this->getTitle(), $this->getRevisionId() );
861 $d = $this->getLanguage()->userDate( $timestamp, $this->getUser() );
862 $t = $this->getLanguage()->userTime( $timestamp, $this->getUser() );
863 $s = ' ' . $this->msg( 'lastmodifiedat', $d, $t )->text();
868 if ( wfGetLB()->getLaggedSlaveMode() ) {
869 $s .= ' <strong>' . $this->msg( 'laggedslavemode' )->text() . '</strong>';
876 * @param string $align
879 function logoText( $align = '' ) {
880 if ( $align != '' ) {
881 $a = " style='float: {$align};'";
886 $mp = $this->msg( 'mainpage' )->escaped();
887 $mptitle = Title
::newMainPage();
888 $url = ( is_object( $mptitle ) ?
htmlspecialchars( $mptitle->getLocalURL() ) : '' );
890 $logourl = $this->getLogo();
891 $s = "<a href='{$url}'><img{$a} src='{$logourl}' alt='[{$mp}]' /></a>";
897 * Renders a $wgFooterIcons icon according to the method's arguments
898 * @param array $icon The icon to build the html for, see $wgFooterIcons
899 * for the format of this array.
900 * @param bool|string $withImage Whether to use the icon's image or output
901 * a text-only footericon.
902 * @return string HTML
904 function makeFooterIcon( $icon, $withImage = 'withImage' ) {
905 if ( is_string( $icon ) ) {
907 } else { // Assuming array
908 $url = isset( $icon["url"] ) ?
$icon["url"] : null;
909 unset( $icon["url"] );
910 if ( isset( $icon["src"] ) && $withImage === 'withImage' ) {
911 // do this the lazy way, just pass icon data as an attribute array
912 $html = Html
::element( 'img', $icon );
914 $html = htmlspecialchars( $icon["alt"] );
917 $html = Html
::rawElement( 'a', array( "href" => $url ), $html );
924 * Gets the link to the wiki's main page.
927 function mainPageLink() {
928 $s = Linker
::linkKnown(
929 Title
::newMainPage(),
930 $this->msg( 'mainpage' )->escaped()
937 * Returns an HTML link for use in the footer
938 * @param string $desc The i18n message key for the link text
939 * @param string $page The i18n message key for the page to link to
940 * @return string HTML anchor
942 public function footerLink( $desc, $page ) {
943 $section = new ProfileSection( __METHOD__
);
944 // if the link description has been set to "-" in the default language,
945 if ( $this->msg( $desc )->inContentLanguage()->isDisabled() ) {
946 // then it is disabled, for all languages.
949 // Otherwise, we display the link for the user, described in their
950 // language (which may or may not be the same as the default language),
951 // but we make the link target be the one site-wide page.
952 $title = Title
::newFromText( $this->msg( $page )->inContentLanguage()->text() );
954 return Linker
::linkKnown(
956 $this->msg( $desc )->escaped()
962 * Gets the link to the wiki's privacy policy page.
963 * @return string HTML
965 function privacyLink() {
966 return $this->footerLink( 'privacy', 'privacypage' );
970 * Gets the link to the wiki's about page.
971 * @return string HTML
973 function aboutLink() {
974 return $this->footerLink( 'aboutsite', 'aboutpage' );
978 * Gets the link to the wiki's general disclaimers page.
979 * @return string HTML
981 function disclaimerLink() {
982 return $this->footerLink( 'disclaimers', 'disclaimerpage' );
986 * Return URL options for the 'edit page' link.
987 * This may include an 'oldid' specifier, if the current page view is such.
992 function editUrlOptions() {
993 $options = array( 'action' => 'edit' );
995 if ( !$this->isRevisionCurrent() ) {
996 $options['oldid'] = intval( $this->getRevisionId() );
1003 * @param User|int $id
1006 function showEmailUser( $id ) {
1007 if ( $id instanceof User
) {
1010 $targetUser = User
::newFromId( $id );
1013 # The sending user must have a confirmed email address and the target
1014 # user must have a confirmed email address and allow emails from users.
1015 return $this->getUser()->canSendEmail() &&
1016 $targetUser->canReceiveEmail();
1020 * This function previously returned a fully resolved style path URL to images or styles stored in
1021 * the legacy skins/common/ directory.
1023 * That directory has been removed in 1.24 and the function always returns an empty string.
1025 * @deprecated since 1.24
1026 * @param string $name The name or path of a skin resource file
1027 * @return string Empty string
1029 function getCommonStylePath( $name ) {
1030 wfDeprecated( __METHOD__
, '1.24' );
1035 * Return a fully resolved style path url to images or styles stored in the current skins's folder.
1036 * This method returns a url resolved using the configured skin style path
1037 * and includes the style version inside of the url.
1039 * Requires $stylename to be set, otherwise throws MWException.
1041 * @param string $name The name or path of a skin resource file
1042 * @return string The fully resolved style path url including styleversion
1044 function getSkinStylePath( $name ) {
1045 global $wgStylePath, $wgStyleVersion;
1047 if ( $this->stylename
=== null ) {
1048 $class = get_class( $this );
1049 throw new MWException( "$class::\$stylename must be set to use getSkinStylePath()" );
1052 return "$wgStylePath/{$this->stylename}/$name?$wgStyleVersion";
1055 /* these are used extensively in SkinTemplate, but also some other places */
1058 * @param string $urlaction
1061 static function makeMainPageUrl( $urlaction = '' ) {
1062 $title = Title
::newMainPage();
1063 self
::checkTitle( $title, '' );
1065 return $title->getLocalURL( $urlaction );
1069 * Make a URL for a Special Page using the given query and protocol.
1071 * If $proto is set to null, make a local URL. Otherwise, make a full
1072 * URL with the protocol specified.
1074 * @param string $name Name of the Special page
1075 * @param string $urlaction Query to append
1076 * @param string|null $proto Protocol to use or null for a local URL
1079 static function makeSpecialUrl( $name, $urlaction = '', $proto = null ) {
1080 $title = SpecialPage
::getSafeTitleFor( $name );
1081 if ( is_null( $proto ) ) {
1082 return $title->getLocalURL( $urlaction );
1084 return $title->getFullURL( $urlaction, false, $proto );
1089 * @param string $name
1090 * @param string $subpage
1091 * @param string $urlaction
1094 static function makeSpecialUrlSubpage( $name, $subpage, $urlaction = '' ) {
1095 $title = SpecialPage
::getSafeTitleFor( $name, $subpage );
1096 return $title->getLocalURL( $urlaction );
1100 * @param string $name
1101 * @param string $urlaction
1104 static function makeI18nUrl( $name, $urlaction = '' ) {
1105 $title = Title
::newFromText( wfMessage( $name )->inContentLanguage()->text() );
1106 self
::checkTitle( $title, $name );
1107 return $title->getLocalURL( $urlaction );
1111 * @param string $name
1112 * @param string $urlaction
1115 static function makeUrl( $name, $urlaction = '' ) {
1116 $title = Title
::newFromText( $name );
1117 self
::checkTitle( $title, $name );
1119 return $title->getLocalURL( $urlaction );
1123 * If url string starts with http, consider as external URL, else
1125 * @param string $name
1126 * @return string URL
1128 static function makeInternalOrExternalUrl( $name ) {
1129 if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $name ) ) {
1132 return self
::makeUrl( $name );
1137 * this can be passed the NS number as defined in Language.php
1138 * @param string $name
1139 * @param string $urlaction
1140 * @param int $namespace
1143 static function makeNSUrl( $name, $urlaction = '', $namespace = NS_MAIN
) {
1144 $title = Title
::makeTitleSafe( $namespace, $name );
1145 self
::checkTitle( $title, $name );
1147 return $title->getLocalURL( $urlaction );
1151 * these return an array with the 'href' and boolean 'exists'
1152 * @param string $name
1153 * @param string $urlaction
1156 static function makeUrlDetails( $name, $urlaction = '' ) {
1157 $title = Title
::newFromText( $name );
1158 self
::checkTitle( $title, $name );
1161 'href' => $title->getLocalURL( $urlaction ),
1162 'exists' => $title->getArticleID() != 0,
1167 * Make URL details where the article exists (or at least it's convenient to think so)
1168 * @param string $name Article name
1169 * @param string $urlaction
1172 static function makeKnownUrlDetails( $name, $urlaction = '' ) {
1173 $title = Title
::newFromText( $name );
1174 self
::checkTitle( $title, $name );
1177 'href' => $title->getLocalURL( $urlaction ),
1183 * make sure we have some title to operate on
1185 * @param Title $title
1186 * @param string $name
1188 static function checkTitle( &$title, $name ) {
1189 if ( !is_object( $title ) ) {
1190 $title = Title
::newFromText( $name );
1191 if ( !is_object( $title ) ) {
1192 $title = Title
::newFromText( '--error: link target missing--' );
1198 * Build an array that represents the sidebar(s), the navigation bar among them.
1200 * BaseTemplate::getSidebar can be used to simplify the format and id generation in new skins.
1202 * The format of the returned array is array( heading => content, ... ), where:
1203 * - heading is the heading of a navigation portlet. It is either:
1204 * - magic string to be handled by the skins ('SEARCH' / 'LANGUAGES' / 'TOOLBOX' / ...)
1205 * - a message name (e.g. 'navigation'), the message should be HTML-escaped by the skin
1206 * - plain text, which should be HTML-escaped by the skin
1207 * - content is the contents of the portlet. It is either:
1208 * - HTML text (<ul><li>...</li>...</ul>)
1209 * - array of link data in a format accepted by BaseTemplate::makeListItem()
1210 * - (for a magic string as a key, any value)
1212 * Note that extensions can control the sidebar contents using the SkinBuildSidebar hook
1213 * and can technically insert anything in here; skin creators are expected to handle
1214 * values described above.
1218 function buildSidebar() {
1219 global $wgMemc, $wgEnableSidebarCache, $wgSidebarCacheExpiry;
1220 wfProfileIn( __METHOD__
);
1222 $key = wfMemcKey( 'sidebar', $this->getLanguage()->getCode() );
1224 if ( $wgEnableSidebarCache ) {
1225 $cachedsidebar = $wgMemc->get( $key );
1226 if ( $cachedsidebar ) {
1227 wfRunHooks( 'SidebarBeforeOutput', array( $this, &$cachedsidebar ) );
1229 wfProfileOut( __METHOD__
);
1230 return $cachedsidebar;
1235 $this->addToSidebar( $bar, 'sidebar' );
1237 wfRunHooks( 'SkinBuildSidebar', array( $this, &$bar ) );
1238 if ( $wgEnableSidebarCache ) {
1239 $wgMemc->set( $key, $bar, $wgSidebarCacheExpiry );
1242 wfRunHooks( 'SidebarBeforeOutput', array( $this, &$bar ) );
1244 wfProfileOut( __METHOD__
);
1249 * Add content from a sidebar system message
1250 * Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
1252 * This is just a wrapper around addToSidebarPlain() for backwards compatibility
1255 * @param string $message
1257 function addToSidebar( &$bar, $message ) {
1258 $this->addToSidebarPlain( $bar, wfMessage( $message )->inContentLanguage()->plain() );
1262 * Add content from plain text
1265 * @param string $text
1268 function addToSidebarPlain( &$bar, $text ) {
1269 $lines = explode( "\n", $text );
1273 foreach ( $lines as $line ) {
1274 if ( strpos( $line, '*' ) !== 0 ) {
1277 $line = rtrim( $line, "\r" ); // for Windows compat
1279 if ( strpos( $line, '**' ) !== 0 ) {
1280 $heading = trim( $line, '* ' );
1281 if ( !array_key_exists( $heading, $bar ) ) {
1282 $bar[$heading] = array();
1285 $line = trim( $line, '* ' );
1287 if ( strpos( $line, '|' ) !== false ) { // sanity check
1288 $line = MessageCache
::singleton()->transform( $line, false, null, $this->getTitle() );
1289 $line = array_map( 'trim', explode( '|', $line, 2 ) );
1290 if ( count( $line ) !== 2 ) {
1291 // Second sanity check, could be hit by people doing
1292 // funky stuff with parserfuncs... (bug 33321)
1296 $extraAttribs = array();
1298 $msgLink = $this->msg( $line[0] )->inContentLanguage();
1299 if ( $msgLink->exists() ) {
1300 $link = $msgLink->text();
1301 if ( $link == '-' ) {
1307 $msgText = $this->msg( $line[1] );
1308 if ( $msgText->exists() ) {
1309 $text = $msgText->text();
1314 if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $link ) ) {
1317 // Parser::getExternalLinkAttribs won't work here because of the Namespace things
1318 global $wgNoFollowLinks, $wgNoFollowDomainExceptions;
1319 if ( $wgNoFollowLinks && !wfMatchesDomainList( $href, $wgNoFollowDomainExceptions ) ) {
1320 $extraAttribs['rel'] = 'nofollow';
1323 global $wgExternalLinkTarget;
1324 if ( $wgExternalLinkTarget ) {
1325 $extraAttribs['target'] = $wgExternalLinkTarget;
1328 $title = Title
::newFromText( $link );
1331 $title = $title->fixSpecialName();
1332 $href = $title->getLinkURL();
1334 $href = 'INVALID-TITLE';
1338 $bar[$heading][] = array_merge( array(
1341 'id' => 'n-' . Sanitizer
::escapeId( strtr( $line[1], ' ', '-' ), 'noninitial' ),
1354 * This function previously controlled whether the 'mediawiki.legacy.wikiprintable' module
1355 * should be loaded by OutputPage. That module no longer exists and the return value of this
1356 * method is ignored.
1358 * If your skin doesn't provide its own print styles, the 'mediawiki.legacy.commonPrint' module
1359 * can be used instead (SkinTemplate-based skins do it automatically).
1361 * @deprecated since 1.22
1364 public function commonPrintStylesheet() {
1365 wfDeprecated( __METHOD__
, '1.22' );
1370 * Gets new talk page messages for the current user and returns an
1371 * appropriate alert message (or an empty string if there are no messages)
1374 function getNewtalks() {
1376 $newMessagesAlert = '';
1377 $user = $this->getUser();
1378 $newtalks = $user->getNewMessageLinks();
1379 $out = $this->getOutput();
1381 // Allow extensions to disable or modify the new messages alert
1382 if ( !wfRunHooks( 'GetNewMessagesAlert', array( &$newMessagesAlert, $newtalks, $user, $out ) ) ) {
1385 if ( $newMessagesAlert ) {
1386 return $newMessagesAlert;
1389 if ( count( $newtalks ) == 1 && $newtalks[0]['wiki'] === wfWikiID() ) {
1390 $uTalkTitle = $user->getTalkPage();
1391 $lastSeenRev = isset( $newtalks[0]['rev'] ) ?
$newtalks[0]['rev'] : null;
1393 if ( $lastSeenRev !== null ) {
1394 $plural = true; // Default if we have a last seen revision: if unknown, use plural
1395 $latestRev = Revision
::newFromTitle( $uTalkTitle, false, Revision
::READ_NORMAL
);
1396 if ( $latestRev !== null ) {
1397 // Singular if only 1 unseen revision, plural if several unseen revisions.
1398 $plural = $latestRev->getParentId() !== $lastSeenRev->getId();
1399 $nofAuthors = $uTalkTitle->countAuthorsBetween(
1400 $lastSeenRev, $latestRev, 10, 'include_new' );
1403 // Singular if no revision -> diff link will show latest change only in any case
1406 $plural = $plural ?
999 : 1;
1407 // 999 signifies "more than one revision". We don't know how many, and even if we did,
1408 // the number of revisions or authors is not necessarily the same as the number of
1410 $newMessagesLink = Linker
::linkKnown(
1412 $this->msg( 'newmessageslinkplural' )->params( $plural )->escaped(),
1414 array( 'redirect' => 'no' )
1417 $newMessagesDiffLink = Linker
::linkKnown(
1419 $this->msg( 'newmessagesdifflinkplural' )->params( $plural )->escaped(),
1421 $lastSeenRev !== null
1422 ?
array( 'oldid' => $lastSeenRev->getId(), 'diff' => 'cur' )
1423 : array( 'diff' => 'cur' )
1426 if ( $nofAuthors >= 1 && $nofAuthors <= 10 ) {
1427 $newMessagesAlert = $this->msg(
1428 'youhavenewmessagesfromusers',
1430 $newMessagesDiffLink
1431 )->numParams( $nofAuthors, $plural );
1433 // $nofAuthors === 11 signifies "11 or more" ("more than 10")
1434 $newMessagesAlert = $this->msg(
1435 $nofAuthors > 10 ?
'youhavenewmessagesmanyusers' : 'youhavenewmessages',
1437 $newMessagesDiffLink
1438 )->numParams( $plural );
1440 $newMessagesAlert = $newMessagesAlert->text();
1441 # Disable Squid cache
1442 $out->setSquidMaxage( 0 );
1443 } elseif ( count( $newtalks ) ) {
1444 $sep = $this->msg( 'newtalkseparator' )->escaped();
1447 foreach ( $newtalks as $newtalk ) {
1448 $msgs[] = Xml
::element(
1450 array( 'href' => $newtalk['link'] ), $newtalk['wiki']
1453 $parts = implode( $sep, $msgs );
1454 $newMessagesAlert = $this->msg( 'youhavenewmessagesmulti' )->rawParams( $parts )->escaped();
1455 $out->setSquidMaxage( 0 );
1458 return $newMessagesAlert;
1462 * Get a cached notice
1464 * @param string $name Message name, or 'default' for $wgSiteNotice
1465 * @return string HTML fragment
1467 private function getCachedNotice( $name ) {
1468 global $wgRenderHashAppend, $parserMemc, $wgContLang;
1470 wfProfileIn( __METHOD__
);
1474 if ( $name === 'default' ) {
1476 global $wgSiteNotice;
1477 $notice = $wgSiteNotice;
1478 if ( empty( $notice ) ) {
1479 wfProfileOut( __METHOD__
);
1483 $msg = $this->msg( $name )->inContentLanguage();
1484 if ( $msg->isDisabled() ) {
1485 wfProfileOut( __METHOD__
);
1488 $notice = $msg->plain();
1491 // Use the extra hash appender to let eg SSL variants separately cache.
1492 $key = wfMemcKey( $name . $wgRenderHashAppend );
1493 $cachedNotice = $parserMemc->get( $key );
1494 if ( is_array( $cachedNotice ) ) {
1495 if ( md5( $notice ) == $cachedNotice['hash'] ) {
1496 $notice = $cachedNotice['html'];
1505 $parsed = $this->getOutput()->parse( $notice );
1506 $parserMemc->set( $key, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
1510 $notice = Html
::rawElement( 'div', array( 'id' => 'localNotice',
1511 'lang' => $wgContLang->getHtmlCode(), 'dir' => $wgContLang->getDir() ), $notice );
1512 wfProfileOut( __METHOD__
);
1517 * Get a notice based on page's namespace
1519 * @return string HTML fragment
1521 function getNamespaceNotice() {
1522 wfProfileIn( __METHOD__
);
1524 $key = 'namespacenotice-' . $this->getTitle()->getNsText();
1525 $namespaceNotice = $this->getCachedNotice( $key );
1526 if ( $namespaceNotice && substr( $namespaceNotice, 0, 7 ) != '<p><' ) {
1527 $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . '</div>';
1529 $namespaceNotice = '';
1532 wfProfileOut( __METHOD__
);
1533 return $namespaceNotice;
1537 * Get the site notice
1539 * @return string HTML fragment
1541 function getSiteNotice() {
1542 wfProfileIn( __METHOD__
);
1545 if ( wfRunHooks( 'SiteNoticeBefore', array( &$siteNotice, $this ) ) ) {
1546 if ( is_object( $this->getUser() ) && $this->getUser()->isLoggedIn() ) {
1547 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1549 $anonNotice = $this->getCachedNotice( 'anonnotice' );
1550 if ( !$anonNotice ) {
1551 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1553 $siteNotice = $anonNotice;
1556 if ( !$siteNotice ) {
1557 $siteNotice = $this->getCachedNotice( 'default' );
1561 wfRunHooks( 'SiteNoticeAfter', array( &$siteNotice, $this ) );
1562 wfProfileOut( __METHOD__
);
1567 * Create a section edit link. This supersedes editSectionLink() and
1568 * editSectionLinkForOther().
1570 * @param Title $nt The title being linked to (may not be the same as
1571 * the current page, if the section is included from a template)
1572 * @param string $section The designation of the section being pointed to,
1573 * to be included in the link, like "§ion=$section"
1574 * @param string $tooltip The tooltip to use for the link: will be escaped
1575 * and wrapped in the 'editsectionhint' message
1576 * @param string $lang Language code
1577 * @return string HTML to use for edit link
1579 public function doEditSectionLink( Title
$nt, $section, $tooltip = null, $lang = false ) {
1580 // HTML generated here should probably have userlangattributes
1581 // added to it for LTR text on RTL pages
1583 $lang = wfGetLangObj( $lang );
1586 if ( !is_null( $tooltip ) ) {
1587 # Bug 25462: undo double-escaping.
1588 $tooltip = Sanitizer
::decodeCharReferences( $tooltip );
1589 $attribs['title'] = wfMessage( 'editsectionhint' )->rawParams( $tooltip )
1590 ->inLanguage( $lang )->text();
1592 $link = Linker
::link( $nt, wfMessage( 'editsection' )->inLanguage( $lang )->text(),
1594 array( 'action' => 'edit', 'section' => $section ),
1595 array( 'noclasses', 'known' )
1598 # Add the brackets and the span and run the hook.
1599 $result = '<span class="mw-editsection">'
1600 . '<span class="mw-editsection-bracket">[</span>'
1602 . '<span class="mw-editsection-bracket">]</span>'
1605 wfRunHooks( 'DoEditSectionLink', array( $this, $nt, $section, $tooltip, &$result, $lang ) );
1610 * Use PHP's magic __call handler to intercept legacy calls to the linker
1611 * for backwards compatibility.
1613 * @param string $fname Name of called method
1614 * @param array $args Arguments to the method
1615 * @throws MWException
1618 function __call( $fname, $args ) {
1619 $realFunction = array( 'Linker', $fname );
1620 if ( is_callable( $realFunction ) ) {
1621 wfDeprecated( get_class( $this ) . '::' . $fname, '1.21' );
1622 return call_user_func_array( $realFunction, $args );
1624 $className = get_class( $this );
1625 throw new MWException( "Call to undefined method $className::$fname" );