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 MediaWiki\Auth\AuthManager
;
22 use MediaWiki\MediaWikiServices
;
25 * Base class for template-based skins.
27 * Template-filler skin base class
28 * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
29 * Based on Brion's smarty skin
30 * @copyright Copyright © Gabriel Wicke -- http://www.aulinx.de/
32 * @todo Needs some serious refactoring into functions that correspond
33 * to the computations individual esi snippets need. Most importantly no body
34 * parsing for most of those of course.
38 class SkinTemplate
extends Skin
{
40 * @var string Name of our skin, it probably needs to be all lower case.
41 * Child classes should override the default.
43 public $skinname = 'monobook';
46 * @var string For QuickTemplate, the name of the subclass which will
47 * actually fill the template. Child classes should override the default.
49 public $template = QuickTemplate
::class;
57 public $userpageUrlDetails;
60 * Create the template engine object; we feed it a bunch of data
61 * and eventually it spits out some HTML. Should have interface
62 * roughly equivalent to PHPTAL 0.7.
64 * @param string $classname
65 * @param bool|string $repository Subdirectory where we keep template files
66 * @param bool|string $cache_dir
67 * @return QuickTemplate
70 function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
71 return new $classname( $this->getConfig() );
75 * Generates array of language links for the current page
79 public function getLanguages() {
80 global $wgHideInterlanguageLinks;
81 if ( $wgHideInterlanguageLinks ) {
85 $userLang = $this->getLanguage();
88 foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
89 $class = 'interlanguage-link interwiki-' . explode( ':', $languageLinkText, 2 )[0];
91 $languageLinkTitle = Title
::newFromText( $languageLinkText );
92 if ( $languageLinkTitle ) {
93 $ilInterwikiCode = $languageLinkTitle->getInterwiki();
94 $ilLangName = Language
::fetchLanguageName( $ilInterwikiCode );
96 if ( strval( $ilLangName ) === '' ) {
97 $ilDisplayTextMsg = wfMessage( "interlanguage-link-$ilInterwikiCode" );
98 if ( !$ilDisplayTextMsg->isDisabled() ) {
99 // Use custom MW message for the display text
100 $ilLangName = $ilDisplayTextMsg->text();
102 // Last resort: fallback to the language link target
103 $ilLangName = $languageLinkText;
106 // Use the language autonym as display text
107 $ilLangName = $this->formatLanguageName( $ilLangName );
110 // CLDR extension or similar is required to localize the language name;
111 // otherwise we'll end up with the autonym again.
112 $ilLangLocalName = Language
::fetchLanguageName(
117 $languageLinkTitleText = $languageLinkTitle->getText();
118 if ( $ilLangLocalName === '' ) {
119 $ilFriendlySiteName = wfMessage( "interlanguage-link-sitename-$ilInterwikiCode" );
120 if ( !$ilFriendlySiteName->isDisabled() ) {
121 if ( $languageLinkTitleText === '' ) {
122 $ilTitle = wfMessage(
123 'interlanguage-link-title-nonlangonly',
124 $ilFriendlySiteName->text()
127 $ilTitle = wfMessage(
128 'interlanguage-link-title-nonlang',
129 $languageLinkTitleText,
130 $ilFriendlySiteName->text()
134 // we have nothing friendly to put in the title, so fall back to
135 // displaying the interlanguage link itself in the title text
136 // (similar to what is done in page content)
137 $ilTitle = $languageLinkTitle->getInterwiki() .
138 ":$languageLinkTitleText";
140 } elseif ( $languageLinkTitleText === '' ) {
141 $ilTitle = wfMessage(
142 'interlanguage-link-title-langonly',
146 $ilTitle = wfMessage(
147 'interlanguage-link-title',
148 $languageLinkTitleText,
153 $ilInterwikiCodeBCP47 = LanguageCode
::bcp47( $ilInterwikiCode );
155 'href' => $languageLinkTitle->getFullURL(),
156 'text' => $ilLangName,
159 'link-class' => 'interlanguage-link-target',
160 'lang' => $ilInterwikiCodeBCP47,
161 'hreflang' => $ilInterwikiCodeBCP47,
164 'SkinTemplateGetLanguageLink',
165 [ &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() ]
167 $languageLinks[] = $languageLink;
171 return $languageLinks;
175 * @return QuickTemplate
177 protected function setupTemplateForOutput() {
178 $request = $this->getRequest();
179 $user = $this->getUser();
180 $title = $this->getTitle();
182 $tpl = $this->setupTemplate( $this->template
, 'skins' );
184 $this->thispage
= $title->getPrefixedDBkey();
185 $this->titletxt
= $title->getPrefixedText();
186 $this->userpage
= $user->getUserPage()->getPrefixedText();
188 if ( !$request->wasPosted() ) {
189 $query = $request->getValues();
190 unset( $query['title'] );
191 unset( $query['returnto'] );
192 unset( $query['returntoquery'] );
194 $this->thisquery
= wfArrayToCgi( $query );
195 $this->loggedin
= $user->isLoggedIn();
196 $this->username
= $user->getName();
198 if ( $this->loggedin
) {
199 $this->userpageUrlDetails
= self
::makeUrlDetails( $this->userpage
);
201 # This won't be used in the standard skins, but we define it to preserve the interface
202 # To save time, we check for existence
203 $this->userpageUrlDetails
= self
::makeKnownUrlDetails( $this->userpage
);
210 * initialize various variables and generate the template
212 * @param OutputPage|null $out
214 function outputPage( OutputPage
$out = null ) {
215 Profiler
::instance()->setTemplated( true );
218 if ( $out !== null ) {
219 // Deprecated since 1.20, note added in 1.25
220 wfDeprecated( __METHOD__
, '1.25' );
221 $oldContext = $this->getContext();
222 $this->setContext( $out->getContext() );
225 $out = $this->getOutput();
227 $this->initPage( $out );
228 $tpl = $this->prepareQuickTemplate();
230 $res = $tpl->execute();
232 // result may be an error
233 $this->printOrError( $res );
236 $this->setContext( $oldContext );
241 * Wrap the body text with language information and identifiable element
243 * @param Title $title
244 * @param string $html body text
245 * @return string html
247 protected function wrapHTML( $title, $html ) {
248 # An ID that includes the actual body text; without categories, contentSub, ...
249 $realBodyAttribs = [ 'id' => 'mw-content-text' ];
251 # Add a mw-content-ltr/rtl class to be able to style based on text
252 # direction when the content is different from the UI language (only
254 # Most information on special pages and file pages is in user language,
255 # rather than content language, so those will not get this
256 if ( Action
::getActionName( $this ) === 'view' &&
257 ( !$title->inNamespaces( NS_SPECIAL
, NS_FILE
) ||
$title->isRedirect() ) ) {
258 $pageLang = $title->getPageViewLanguage();
259 $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
260 $realBodyAttribs['dir'] = $pageLang->getDir();
261 $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
264 return Html
::rawElement( 'div', $realBodyAttribs, $html );
268 * initialize various variables and generate the template
271 * @return QuickTemplate The template to be executed by outputPage
273 protected function prepareQuickTemplate() {
274 global $wgScript, $wgStylePath, $wgMimeType, $wgJsMimeType,
275 $wgSitename, $wgLogo, $wgMaxCredits,
276 $wgShowCreditsIfMax, $wgArticlePath,
277 $wgScriptPath, $wgServer;
279 $title = $this->getTitle();
280 $request = $this->getRequest();
281 $out = $this->getOutput();
282 $tpl = $this->setupTemplateForOutput();
284 $tpl->set( 'title', $out->getPageTitle() );
285 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
286 $tpl->set( 'displaytitle', $out->mPageLinkTitle
);
288 $tpl->set( 'thispage', $this->thispage
);
289 $tpl->set( 'titleprefixeddbkey', $this->thispage
);
290 $tpl->set( 'titletext', $title->getText() );
291 $tpl->set( 'articleid', $title->getArticleID() );
293 $tpl->set( 'isarticle', $out->isArticle() );
295 $subpagestr = $this->subPageSubtitle();
296 if ( $subpagestr !== '' ) {
297 $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
299 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
301 $undelete = $this->getUndeleteLink();
302 if ( $undelete === '' ) {
303 $tpl->set( 'undelete', '' );
305 $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
308 $tpl->set( 'catlinks', $this->getCategories() );
309 if ( $out->isSyndicated() ) {
311 foreach ( $out->getSyndicationLinks() as $format => $link ) {
313 // Messages: feed-atom, feed-rss
314 'text' => $this->msg( "feed-$format" )->text(),
318 $tpl->set( 'feeds', $feeds );
320 $tpl->set( 'feeds', false );
323 $tpl->set( 'mimetype', $wgMimeType );
324 $tpl->set( 'jsmimetype', $wgJsMimeType );
325 $tpl->set( 'charset', 'UTF-8' );
326 $tpl->set( 'wgScript', $wgScript );
327 $tpl->set( 'skinname', $this->skinname
);
328 $tpl->set( 'skinclass', static::class );
329 $tpl->set( 'skin', $this );
330 $tpl->set( 'stylename', $this->stylename
);
331 $tpl->set( 'printable', $out->isPrintable() );
332 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
333 $tpl->set( 'loggedin', $this->loggedin
);
334 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
335 $tpl->set( 'searchaction', $this->escapeSearchLink() );
336 $tpl->set( 'searchtitle', SpecialPage
::getTitleFor( 'Search' )->getPrefixedDBkey() );
337 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
338 $tpl->set( 'stylepath', $wgStylePath );
339 $tpl->set( 'articlepath', $wgArticlePath );
340 $tpl->set( 'scriptpath', $wgScriptPath );
341 $tpl->set( 'serverurl', $wgServer );
342 $tpl->set( 'logopath', $wgLogo );
343 $tpl->set( 'sitename', $wgSitename );
345 $userLang = $this->getLanguage();
346 $userLangCode = $userLang->getHtmlCode();
347 $userLangDir = $userLang->getDir();
349 $tpl->set( 'lang', $userLangCode );
350 $tpl->set( 'dir', $userLangDir );
351 $tpl->set( 'rtl', $userLang->isRTL() );
353 $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ?
' capitalize-all-nouns' : '' );
354 $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
355 $tpl->set( 'username', $this->loggedin ?
$this->username
: null );
356 $tpl->set( 'userpage', $this->userpage
);
357 $tpl->set( 'userpageurl', $this->userpageUrlDetails
['href'] );
358 $tpl->set( 'userlang', $userLangCode );
360 // Users can have their language set differently than the
361 // content of the wiki. For these users, tell the web browser
362 // that interface elements are in a different language.
363 $tpl->set( 'userlangattributes', '' );
364 $tpl->set( 'specialpageattributes', '' ); # obsolete
365 // Used by VectorBeta to insert HTML before content but after the
366 // heading for the page title. Defaults to empty string.
367 $tpl->set( 'prebodyhtml', '' );
369 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
371 $userLangCode !== $contLang->getHtmlCode() ||
372 $userLangDir !== $contLang->getDir()
374 $escUserlang = htmlspecialchars( $userLangCode );
375 $escUserdir = htmlspecialchars( $userLangDir );
376 // Attributes must be in double quotes because htmlspecialchars() doesn't
377 // escape single quotes
378 $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
379 $tpl->set( 'userlangattributes', $attrs );
382 $tpl->set( 'newtalk', $this->getNewtalks() );
383 $tpl->set( 'logo', $this->logoText() );
385 $tpl->set( 'copyright', false );
387 $tpl->set( 'viewcount', false );
388 $tpl->set( 'lastmod', false );
389 $tpl->set( 'credits', false );
390 $tpl->set( 'numberofwatchingusers', false );
391 if ( $title->exists() ) {
392 if ( $out->isArticle() && $this->isRevisionCurrent() ) {
393 if ( $wgMaxCredits != 0 ) {
394 /** @var CreditsAction $action */
395 $action = Action
::factory(
396 'credits', $this->getWikiPage(), $this->getContext() );
397 $tpl->set( 'credits',
398 $action->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
400 $tpl->set( 'lastmod', $this->lastModified() );
403 if ( $out->showsCopyright() ) {
404 $tpl->set( 'copyright', $this->getCopyright() );
408 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
409 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
410 $tpl->set( 'disclaimer', $this->disclaimerLink() );
411 $tpl->set( 'privacy', $this->privacyLink() );
412 $tpl->set( 'about', $this->aboutLink() );
414 $tpl->set( 'footerlinks', [
417 'numberofwatchingusers',
428 global $wgFooterIcons;
429 $tpl->set( 'footericons', $wgFooterIcons );
430 foreach ( $tpl->data
['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
431 if ( count( $footerIconsBlock ) > 0 ) {
432 foreach ( $footerIconsBlock as &$footerIcon ) {
433 if ( isset( $footerIcon['src'] ) ) {
434 if ( !isset( $footerIcon['width'] ) ) {
435 $footerIcon['width'] = 88;
437 if ( !isset( $footerIcon['height'] ) ) {
438 $footerIcon['height'] = 31;
443 unset( $tpl->data
['footericons'][$footerIconsKey] );
447 $tpl->set( 'indicators', $out->getIndicators() );
449 $tpl->set( 'sitenotice', $this->getSiteNotice() );
450 $tpl->set( 'printfooter', $this->printSource() );
451 // Wrap the bodyText with #mw-content-text element
452 $out->mBodytext
= $this->wrapHTML( $title, $out->mBodytext
);
453 $tpl->set( 'bodytext', $out->mBodytext
);
455 $language_urls = $this->getLanguages();
456 if ( count( $language_urls ) ) {
457 $tpl->set( 'language_urls', $language_urls );
459 $tpl->set( 'language_urls', false );
463 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
464 $content_navigation = $this->buildContentNavigationUrls();
465 $content_actions = $this->buildContentActionUrls( $content_navigation );
466 $tpl->set( 'content_navigation', $content_navigation );
467 $tpl->set( 'content_actions', $content_actions );
469 $tpl->set( 'sidebar', $this->buildSidebar() );
470 $tpl->set( 'nav_urls', $this->buildNavUrls() );
472 // Do this last in case hooks above add bottom scripts
473 $tpl->set( 'bottomscripts', $this->bottomScripts() );
475 // Set the head scripts near the end, in case the above actions resulted in added scripts
476 $tpl->set( 'headelement', $out->headElement( $this ) );
478 $tpl->set( 'debug', '' );
479 $tpl->set( 'debughtml', $this->generateDebugHTML() );
480 $tpl->set( 'reporttime', wfReportTime( $out->getCSPNonce() ) );
482 // Avoid PHP 7.1 warning of passing $this by reference
483 $skinTemplate = $this;
484 // original version by hansm
485 if ( !Hooks
::run( 'SkinTemplateOutputPageBeforeExec', [ &$skinTemplate, &$tpl ] ) ) {
486 wfDebug( __METHOD__
. ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
489 // Set the bodytext to another key so that skins can just output it on its own
490 // and output printfooter and debughtml separately
491 $tpl->set( 'bodycontent', $tpl->data
['bodytext'] );
493 // Append printfooter and debughtml onto bodytext so that skins that
494 // were already using bodytext before they were split out don't suddenly
495 // start not outputting information.
496 $tpl->data
['bodytext'] .= Html
::rawElement(
498 [ 'class' => 'printfooter' ],
499 "\n{$tpl->data['printfooter']}"
501 $tpl->data
['bodytext'] .= $tpl->data
['debughtml'];
503 // allow extensions adding stuff after the page content.
504 // See Skin::afterContentHook() for further documentation.
505 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
511 * Get the HTML for the p-personal list
514 public function getPersonalToolsList() {
515 return $this->makePersonalToolsList();
519 * Get the HTML for the personal tools list
523 * @param array|null $personalTools
524 * @param array $options
527 public function makePersonalToolsList( $personalTools = null, $options = [] ) {
528 $tpl = $this->setupTemplateForOutput();
529 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
532 if ( $personalTools === null ) {
533 $personalTools = ( $tpl instanceof BaseTemplate
)
534 ?
$tpl->getPersonalTools()
538 foreach ( $personalTools as $key => $item ) {
539 $html .= $tpl->makeListItem( $key, $item, $options );
546 * Get personal tools for the user
550 * @return array Array of personal tools
552 public function getStructuredPersonalTools() {
553 $tpl = $this->setupTemplateForOutput();
554 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
556 return ( $tpl instanceof BaseTemplate
) ?
$tpl->getPersonalTools() : [];
560 * Format language name for use in sidebar interlanguage links list.
561 * By default it is capitalized.
563 * @param string $name Language name, e.g. "English" or "español"
567 function formatLanguageName( $name ) {
568 return $this->getLanguage()->ucfirst( $name );
572 * Output the string, or print error message if it's
573 * an error object of the appropriate type.
574 * For the base class, assume strings all around.
579 function printOrError( $str ) {
584 * Output a boolean indicating if buildPersonalUrls should output separate
585 * login and create account links or output a combined link
586 * By default we simply return a global config setting that affects most skins
587 * This is setup as a method so that like with $wgLogo and getLogo() a skin
588 * can override this setting and always output one or the other if it has
589 * a reason it can't output one of the two modes.
592 function useCombinedLoginLink() {
593 global $wgUseCombinedLoginLink;
594 return $wgUseCombinedLoginLink;
598 * build array of urls for personal toolbar
601 protected function buildPersonalUrls() {
602 $title = $this->getTitle();
603 $request = $this->getRequest();
604 $pageurl = $title->getLocalURL();
605 $authManager = AuthManager
::singleton();
607 /* set up the default links for the personal toolbar */
610 # Due to T34276, if a user does not have read permissions,
611 # $this->getTitle() will just give Special:Badtitle, which is
612 # not especially useful as a returnto parameter. Use the title
613 # from the request instead, if there was one.
614 if ( $this->getUser()->isAllowed( 'read' ) ) {
615 $page = $this->getTitle();
617 $page = Title
::newFromText( $request->getVal( 'title', '' ) );
619 $page = $request->getVal( 'returnto', $page );
621 if ( strval( $page ) !== '' ) {
622 $returnto['returnto'] = $page;
623 $query = $request->getVal( 'returntoquery', $this->thisquery
);
624 $paramsArray = wfCgiToArray( $query );
625 unset( $paramsArray['logoutToken'] );
626 $query = wfArrayToCgi( $paramsArray );
627 if ( $query != '' ) {
628 $returnto['returntoquery'] = $query;
632 if ( $this->loggedin
) {
633 $personal_urls['userpage'] = [
634 'text' => $this->username
,
635 'href' => &$this->userpageUrlDetails
['href'],
636 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
637 'exists' => $this->userpageUrlDetails
['exists'],
638 'active' => ( $this->userpageUrlDetails
['href'] == $pageurl ),
641 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
642 $personal_urls['mytalk'] = [
643 'text' => $this->msg( 'mytalk' )->text(),
644 'href' => &$usertalkUrlDetails['href'],
645 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
646 'exists' => $usertalkUrlDetails['exists'],
647 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
649 $href = self
::makeSpecialUrl( 'Preferences' );
650 $personal_urls['preferences'] = [
651 'text' => $this->msg( 'mypreferences' )->text(),
653 'active' => ( $href == $pageurl )
656 if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
657 $href = self
::makeSpecialUrl( 'Watchlist' );
658 $personal_urls['watchlist'] = [
659 'text' => $this->msg( 'mywatchlist' )->text(),
661 'active' => ( $href == $pageurl )
665 # We need to do an explicit check for Special:Contributions, as we
666 # have to match both the title, and the target, which could come
667 # from request values (Special:Contributions?target=Jimbo_Wales)
668 # or be specified in "sub page" form
669 # (Special:Contributions/Jimbo_Wales). The plot
670 # thickens, because the Title object is altered for special pages,
671 # so it doesn't contain the original alias-with-subpage.
672 $origTitle = Title
::newFromText( $request->getText( 'title' ) );
673 if ( $origTitle instanceof Title
&& $origTitle->isSpecialPage() ) {
674 list( $spName, $spPar ) =
675 MediaWikiServices
::getInstance()->getSpecialPageFactory()->
676 resolveAlias( $origTitle->getText() );
677 $active = $spName == 'Contributions'
678 && ( ( $spPar && $spPar == $this->username
)
679 ||
$request->getText( 'target' ) == $this->username
);
684 $href = self
::makeSpecialUrlSubpage( 'Contributions', $this->username
);
685 $personal_urls['mycontris'] = [
686 'text' => $this->msg( 'mycontris' )->text(),
691 // if we can't set the user, we can't unset it either
692 if ( $request->getSession()->canSetUser() ) {
693 $personal_urls['logout'] = [
694 'text' => $this->msg( 'pt-userlogout' )->text(),
695 'href' => self
::makeSpecialUrl( 'Userlogout',
696 // Note: userlogout link must always contain an & character, otherwise we might not be able
697 // to detect a buggy precaching proxy (T19790)
698 ( $title->isSpecial( 'Preferences' ) ?
[] : $returnto )
699 +
[ 'logoutToken' => $this->getUser()->getEditToken( 'logoutToken', $this->getRequest() ) ] ),
704 $useCombinedLoginLink = $this->useCombinedLoginLink();
705 if ( !$authManager->canCreateAccounts() ||
!$authManager->canAuthenticateNow() ) {
706 // don't show combined login/signup link if one of those is actually not available
707 $useCombinedLoginLink = false;
710 $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
711 ?
'nav-login-createaccount'
715 'text' => $this->msg( $loginlink )->text(),
716 'href' => self
::makeSpecialUrl( 'Userlogin', $returnto ),
717 'active' => $title->isSpecial( 'Userlogin' )
718 ||
$title->isSpecial( 'CreateAccount' ) && $useCombinedLoginLink,
720 $createaccount_url = [
721 'text' => $this->msg( 'pt-createaccount' )->text(),
722 'href' => self
::makeSpecialUrl( 'CreateAccount', $returnto ),
723 'active' => $title->isSpecial( 'CreateAccount' ),
726 // No need to show Talk and Contributions to anons if they can't contribute!
727 if ( User
::groupHasPermission( '*', 'edit' ) ) {
728 // Because of caching, we can't link directly to the IP talk and
729 // contributions pages. Instead we use the special page shortcuts
730 // (which work correctly regardless of caching). This means we can't
731 // determine whether these links are active or not, but since major
732 // skins (MonoBook, Vector) don't use this information, it's not a
734 $personal_urls['anontalk'] = [
735 'text' => $this->msg( 'anontalk' )->text(),
736 'href' => self
::makeSpecialUrlSubpage( 'Mytalk', false ),
739 $personal_urls['anoncontribs'] = [
740 'text' => $this->msg( 'anoncontribs' )->text(),
741 'href' => self
::makeSpecialUrlSubpage( 'Mycontributions', false ),
747 $authManager->canCreateAccounts()
748 && $this->getUser()->isAllowed( 'createaccount' )
749 && !$useCombinedLoginLink
751 $personal_urls['createaccount'] = $createaccount_url;
754 if ( $authManager->canAuthenticateNow() ) {
755 $key = User
::groupHasPermission( '*', 'read' )
758 $personal_urls[$key] = $login_url;
762 Hooks
::runWithoutAbort( 'PersonalUrls', [ &$personal_urls, &$title, $this ] );
763 return $personal_urls;
767 * Builds an array with tab definition
769 * @param Title $title Page Where the tab links to
770 * @param string|array $message Message key or an array of message keys (will fall back)
771 * @param bool $selected Display the tab as selected
772 * @param string $query Query string attached to tab URL
773 * @param bool $checkEdit Check if $title exists and mark with .new if one doesn't
777 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
780 $classes[] = 'selected';
783 if ( $checkEdit && !$title->isKnown() ) {
786 if ( $query !== '' ) {
787 $query = 'action=edit&redlink=1&' . $query;
789 $query = 'action=edit&redlink=1';
793 $linkClass = MediaWikiServices
::getInstance()->getLinkRenderer()->getLinkClasses( $title );
795 // wfMessageFallback will nicely accept $message as an array of fallbacks
796 // or just a single key
797 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
798 if ( is_array( $message ) ) {
799 // for hook compatibility just keep the last message name
800 $message = end( $message );
802 if ( $msg->exists() ) {
803 $text = $msg->text();
805 $text = MediaWikiServices
::getInstance()->getContentLanguage()->getConverter()->
806 convertNamespace( MWNamespace
::getSubject( $title->getNamespace() ) );
809 // Avoid PHP 7.1 warning of passing $this by reference
810 $skinTemplate = $this;
812 if ( !Hooks
::run( 'SkinTemplateTabAction', [ &$skinTemplate,
813 $title, $message, $selected, $checkEdit,
814 &$classes, &$query, &$text, &$result ] ) ) {
819 'class' => implode( ' ', $classes ),
821 'href' => $title->getLocalURL( $query ),
824 if ( $linkClass !== '' ) {
825 $result['link-class'] = $linkClass;
831 function makeTalkUrlDetails( $name, $urlaction = '' ) {
832 $title = Title
::newFromText( $name );
833 if ( !is_object( $title ) ) {
834 throw new MWException( __METHOD__
. " given invalid pagename $name" );
836 $title = $title->getTalkPage();
837 self
::checkTitle( $title, $name );
839 'href' => $title->getLocalURL( $urlaction ),
840 'exists' => $title->isKnown(),
845 * @todo is this even used?
846 * @param string $name
847 * @param string $urlaction
850 function makeArticleUrlDetails( $name, $urlaction = '' ) {
851 $title = Title
::newFromText( $name );
852 $title = $title->getSubjectPage();
853 self
::checkTitle( $title, $name );
855 'href' => $title->getLocalURL( $urlaction ),
856 'exists' => $title->exists(),
861 * a structured array of links usually used for the tabs in a skin
863 * There are 4 standard sections
864 * namespaces: Used for namespace tabs like special, page, and talk namespaces
865 * views: Used for primary page views like read, edit, history
866 * actions: Used for most extra page actions like deletion, protection, etc...
867 * variants: Used to list the language variants for the page
869 * Each section's value is a key/value array of links for that section.
870 * The links themselves have these common keys:
871 * - class: The css classes to apply to the tab
872 * - text: The text to display on the tab
873 * - href: The href for the tab to point to
874 * - rel: An optional rel= for the tab's link
875 * - redundant: If true the tab will be dropped in skins using content_actions
876 * this is useful for tabs like "Read" which only have meaning in skins that
877 * take special meaning from the grouped structure of content_navigation
879 * Views also have an extra key which can be used:
880 * - primary: If this is not true skins like vector may try to hide the tab
881 * when the user has limited space in their browser window
883 * content_navigation using code also expects these ids to be present on the
884 * links, however these are usually automatically generated by SkinTemplate
885 * itself and are not necessary when using a hook. The only things these may
886 * matter to are people modifying content_navigation after it's initial creation:
887 * - id: A "preferred" id, most skins are best off outputting this preferred
888 * id for best compatibility.
889 * - tooltiponly: This is set to true for some tabs in cases where the system
890 * believes that the accesskey should not be added to the tab.
894 protected function buildContentNavigationUrls() {
895 global $wgDisableLangConversion;
897 // Display tabs for the relevant title rather than always the title itself
898 $title = $this->getRelevantTitle();
899 $onPage = $title->equals( $this->getTitle() );
901 $out = $this->getOutput();
902 $request = $this->getRequest();
903 $user = $this->getUser();
905 $content_navigation = [
913 $action = $request->getVal( 'action', 'view' );
915 $userCanRead = $title->quickUserCan( 'read', $user );
917 // Avoid PHP 7.1 warning of passing $this by reference
918 $skinTemplate = $this;
919 $preventActiveTabs = false;
920 Hooks
::run( 'SkinTemplatePreventOtherActiveTabs', [ &$skinTemplate, &$preventActiveTabs ] );
922 // Checks if page is some kind of content
923 if ( $title->canExist() ) {
924 // Gets page objects for the related namespaces
925 $subjectPage = $title->getSubjectPage();
926 $talkPage = $title->getTalkPage();
928 // Determines if this is a talk page
929 $isTalk = $title->isTalkPage();
931 // Generates XML IDs from namespace names
932 $subjectId = $title->getNamespaceKey( '' );
934 if ( $subjectId == 'main' ) {
937 $talkId = "{$subjectId}_talk";
940 $skname = $this->skinname
;
942 // Adds namespace links
943 $subjectMsg = [ "nstab-$subjectId" ];
944 if ( $subjectPage->isMainPage() ) {
945 array_unshift( $subjectMsg, 'mainpage-nstab' );
947 $content_navigation['namespaces'][$subjectId] = $this->tabAction(
948 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
950 $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
951 $content_navigation['namespaces'][$talkId] = $this->tabAction(
952 $talkPage, [ "nstab-$talkId", 'talk' ], $isTalk && !$preventActiveTabs, '', $userCanRead
954 $content_navigation['namespaces'][$talkId]['context'] = 'talk';
956 if ( $userCanRead ) {
957 // Adds "view" view link
958 if ( $title->isKnown() ) {
959 $content_navigation['views']['view'] = $this->tabAction(
960 $isTalk ?
$talkPage : $subjectPage,
961 [ "$skname-view-view", 'view' ],
962 ( $onPage && ( $action == 'view' ||
$action == 'purge' ) ), '', true
964 // signal to hide this from simple content_actions
965 $content_navigation['views']['view']['redundant'] = true;
968 $page = $this->canUseWikiPage() ?
$this->getWikiPage() : false;
969 $isRemoteContent = $page && !$page->isLocal();
971 // If it is a non-local file, show a link to the file in its own repository
972 // @todo abstract this for remote content that isn't a file
973 if ( $isRemoteContent ) {
974 $content_navigation['views']['view-foreign'] = [
976 'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
977 setContext( $this->getContext() )->
978 params( $page->getWikiDisplayName() )->text(),
979 'href' => $page->getSourceURL(),
984 // Checks if user can edit the current page if it exists or create it otherwise
985 if ( $title->quickUserCan( 'edit', $user )
986 && ( $title->exists() ||
$title->quickUserCan( 'create', $user ) )
988 // Builds CSS class for talk page links
989 $isTalkClass = $isTalk ?
' istalk' : '';
990 // Whether the user is editing the page
991 $isEditing = $onPage && ( $action == 'edit' ||
$action == 'submit' );
992 // Whether to show the "Add a new section" tab
993 // Checks if this is a current rev of talk page and is not forced to be hidden
994 $showNewSection = !$out->forceHideNewSectionLink()
995 && ( ( $isTalk && $this->isRevisionCurrent() ) ||
$out->showNewSectionLink() );
996 $section = $request->getVal( 'section' );
998 if ( $title->exists()
999 ||
( $title->getNamespace() == NS_MEDIAWIKI
1000 && $title->getDefaultMessageText() !== false
1003 $msgKey = $isRemoteContent ?
'edit-local' : 'edit';
1005 $msgKey = $isRemoteContent ?
'create-local' : 'create';
1007 $content_navigation['views']['edit'] = [
1008 'class' => ( $isEditing && ( $section !== 'new' ||
!$showNewSection )
1012 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
1013 ->setContext( $this->getContext() )->text(),
1014 'href' => $title->getLocalURL( $this->editUrlOptions() ),
1015 'primary' => !$isRemoteContent, // don't collapse this in vector
1019 if ( $showNewSection ) {
1020 // Adds new section link
1021 // $content_navigation['actions']['addsection']
1022 $content_navigation['views']['addsection'] = [
1023 'class' => ( $isEditing && $section == 'new' ) ?
'selected' : false,
1024 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
1025 ->setContext( $this->getContext() )->text(),
1026 'href' => $title->getLocalURL( 'action=edit§ion=new' )
1029 // Checks if the page has some kind of viewable source content
1030 } elseif ( $title->hasSourceText() ) {
1031 // Adds view source view link
1032 $content_navigation['views']['viewsource'] = [
1033 'class' => ( $onPage && $action == 'edit' ) ?
'selected' : false,
1034 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
1035 ->setContext( $this->getContext() )->text(),
1036 'href' => $title->getLocalURL( $this->editUrlOptions() ),
1037 'primary' => true, // don't collapse this in vector
1041 // Checks if the page exists
1042 if ( $title->exists() ) {
1043 // Adds history view link
1044 $content_navigation['views']['history'] = [
1045 'class' => ( $onPage && $action == 'history' ) ?
'selected' : false,
1046 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
1047 ->setContext( $this->getContext() )->text(),
1048 'href' => $title->getLocalURL( 'action=history' ),
1051 if ( $title->quickUserCan( 'delete', $user ) ) {
1052 $content_navigation['actions']['delete'] = [
1053 'class' => ( $onPage && $action == 'delete' ) ?
'selected' : false,
1054 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
1055 ->setContext( $this->getContext() )->text(),
1056 'href' => $title->getLocalURL( 'action=delete' )
1060 if ( $title->quickUserCan( 'move', $user ) ) {
1061 $moveTitle = SpecialPage
::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
1062 $content_navigation['actions']['move'] = [
1063 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ?
'selected' : false,
1064 'text' => wfMessageFallback( "$skname-action-move", 'move' )
1065 ->setContext( $this->getContext() )->text(),
1066 'href' => $moveTitle->getLocalURL()
1070 // article doesn't exist or is deleted
1071 if ( $title->quickUserCan( 'deletedhistory', $user ) ) {
1072 $n = $title->isDeleted();
1074 $undelTitle = SpecialPage
::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
1075 // If the user can't undelete but can view deleted
1076 // history show them a "View .. deleted" tab instead.
1077 $msgKey = $title->quickUserCan( 'undelete', $user ) ?
'undelete' : 'viewdeleted';
1078 $content_navigation['actions']['undelete'] = [
1079 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ?
'selected' : false,
1080 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1081 ->setContext( $this->getContext() )->numParams( $n )->text(),
1082 'href' => $undelTitle->getLocalURL()
1088 if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1089 MWNamespace
::getRestrictionLevels( $title->getNamespace(), $user ) !== [ '' ]
1091 $mode = $title->isProtected() ?
'unprotect' : 'protect';
1092 $content_navigation['actions'][$mode] = [
1093 'class' => ( $onPage && $action == $mode ) ?
'selected' : false,
1094 'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1095 ->setContext( $this->getContext() )->text(),
1096 'href' => $title->getLocalURL( "action=$mode" )
1100 // Checks if the user is logged in
1101 if ( $this->loggedin
&& $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1103 * The following actions use messages which, if made particular to
1104 * the any specific skins, would break the Ajax code which makes this
1105 * action happen entirely inline. OutputPage::getJSVars
1106 * defines a set of messages in a javascript object - and these
1107 * messages are assumed to be global for all skins. Without making
1108 * a change to that procedure these messages will have to remain as
1109 * the global versions.
1111 $mode = $user->isWatched( $title ) ?
'unwatch' : 'watch';
1112 $content_navigation['actions'][$mode] = [
1113 'class' => 'mw-watchlink ' . (
1114 $onPage && ( $action == 'watch' ||
$action == 'unwatch' ) ?
'selected' : ''
1116 // uses 'watch' or 'unwatch' message
1117 'text' => $this->msg( $mode )->text(),
1118 'href' => $title->getLocalURL( [ 'action' => $mode ] ),
1119 // Set a data-mw=interface attribute, which the mediawiki.page.ajax
1120 // module will look for to make sure it's a trusted link
1122 'mw' => 'interface',
1128 // Avoid PHP 7.1 warning of passing $this by reference
1129 $skinTemplate = $this;
1130 Hooks
::runWithoutAbort(
1131 'SkinTemplateNavigation',
1132 [ &$skinTemplate, &$content_navigation ]
1135 if ( $userCanRead && !$wgDisableLangConversion ) {
1136 $pageLang = $title->getPageLanguage();
1137 // Checks that language conversion is enabled and variants exist
1138 // And if it is not in the special namespace
1139 if ( $pageLang->hasVariants() ) {
1140 // Gets list of language variants
1141 $variants = $pageLang->getVariants();
1142 // Gets preferred variant (note that user preference is
1143 // only possible for wiki content language variant)
1144 $preferred = $pageLang->getPreferredVariant();
1145 if ( Action
::getActionName( $this ) === 'view' ) {
1146 $params = $request->getQueryValues();
1147 unset( $params['title'] );
1151 // Loops over each variant
1152 foreach ( $variants as $code ) {
1153 // Gets variant name from language code
1154 $varname = $pageLang->getVariantname( $code );
1155 // Appends variant link
1156 $content_navigation['variants'][] = [
1157 'class' => ( $code == $preferred ) ?
'selected' : false,
1159 'href' => $title->getLocalURL( [ 'variant' => $code ] +
$params ),
1160 'lang' => LanguageCode
::bcp47( $code ),
1161 'hreflang' => LanguageCode
::bcp47( $code ),
1167 // If it's not content, it's got to be a special page
1168 $content_navigation['namespaces']['special'] = [
1169 'class' => 'selected',
1170 'text' => $this->msg( 'nstab-special' )->text(),
1171 'href' => $request->getRequestURL(), // @see: T4457, T4510
1172 'context' => 'subject'
1175 // Avoid PHP 7.1 warning of passing $this by reference
1176 $skinTemplate = $this;
1177 Hooks
::runWithoutAbort( 'SkinTemplateNavigation::SpecialPage',
1178 [ &$skinTemplate, &$content_navigation ] );
1181 // Avoid PHP 7.1 warning of passing $this by reference
1182 $skinTemplate = $this;
1183 // Equiv to SkinTemplateContentActions
1184 Hooks
::runWithoutAbort( 'SkinTemplateNavigation::Universal',
1185 [ &$skinTemplate, &$content_navigation ] );
1187 // Setup xml ids and tooltip info
1188 foreach ( $content_navigation as $section => &$links ) {
1189 foreach ( $links as $key => &$link ) {
1191 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1192 $xmlID = 'ca-nstab-' . $xmlID;
1193 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1195 $link['rel'] = 'discussion';
1196 } elseif ( $section == 'variants' ) {
1197 $xmlID = 'ca-varlang-' . $xmlID;
1199 $xmlID = 'ca-' . $xmlID;
1201 $link['id'] = $xmlID;
1205 # We don't want to give the watch tab an accesskey if the
1206 # page is being edited, because that conflicts with the
1207 # accesskey on the watch checkbox. We also don't want to
1208 # give the edit tab an accesskey, because that's fairly
1209 # superfluous and conflicts with an accesskey (Ctrl-E) often
1210 # used for editing in Safari.
1211 if ( in_array( $action, [ 'edit', 'submit' ] ) ) {
1212 if ( isset( $content_navigation['views']['edit'] ) ) {
1213 $content_navigation['views']['edit']['tooltiponly'] = true;
1215 if ( isset( $content_navigation['actions']['watch'] ) ) {
1216 $content_navigation['actions']['watch']['tooltiponly'] = true;
1218 if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1219 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1223 return $content_navigation;
1227 * an array of edit links by default used for the tabs
1228 * @param array $content_navigation
1231 private function buildContentActionUrls( $content_navigation ) {
1232 // content_actions has been replaced with content_navigation for backwards
1233 // compatibility and also for skins that just want simple tabs content_actions
1234 // is now built by flattening the content_navigation arrays into one
1236 $content_actions = [];
1238 foreach ( $content_navigation as $links ) {
1239 foreach ( $links as $key => $value ) {
1240 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1241 // Redundant tabs are dropped from content_actions
1245 // content_actions used to have ids built using the "ca-$key" pattern
1246 // so the xmlID based id is much closer to the actual $key that we want
1247 // for that reason we'll just strip out the ca- if present and use
1248 // the latter potion of the "id" as the $key
1249 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1250 $key = substr( $value['id'], 3 );
1253 if ( isset( $content_actions[$key] ) ) {
1254 wfDebug( __METHOD__
. ": Found a duplicate key for $key while flattening " .
1255 "content_navigation into content_actions.\n" );
1259 $content_actions[$key] = $value;
1263 return $content_actions;
1267 * build array of common navigation links
1270 protected function buildNavUrls() {
1271 global $wgUploadNavigationUrl;
1273 $out = $this->getOutput();
1274 $request = $this->getRequest();
1277 $nav_urls['mainpage'] = [ 'href' => self
::makeMainPageUrl() ];
1278 if ( $wgUploadNavigationUrl ) {
1279 $nav_urls['upload'] = [ 'href' => $wgUploadNavigationUrl ];
1280 } elseif ( UploadBase
::isEnabled() && UploadBase
::isAllowed( $this->getUser() ) === true ) {
1281 $nav_urls['upload'] = [ 'href' => self
::makeSpecialUrl( 'Upload' ) ];
1283 $nav_urls['upload'] = false;
1285 $nav_urls['specialpages'] = [ 'href' => self
::makeSpecialUrl( 'Specialpages' ) ];
1287 $nav_urls['print'] = false;
1288 $nav_urls['permalink'] = false;
1289 $nav_urls['info'] = false;
1290 $nav_urls['whatlinkshere'] = false;
1291 $nav_urls['recentchangeslinked'] = false;
1292 $nav_urls['contributions'] = false;
1293 $nav_urls['log'] = false;
1294 $nav_urls['blockip'] = false;
1295 $nav_urls['emailuser'] = false;
1296 $nav_urls['userrights'] = false;
1298 // A print stylesheet is attached to all pages, but nobody ever
1299 // figures that out. :) Add a link...
1300 if ( !$out->isPrintable() && ( $out->isArticle() ||
$this->getTitle()->isSpecialPage() ) ) {
1301 $nav_urls['print'] = [
1302 'text' => $this->msg( 'printableversion' )->text(),
1303 'href' => $this->getTitle()->getLocalURL(
1304 $request->appendQueryValue( 'printable', 'yes' ) )
1308 if ( $out->isArticle() ) {
1309 // Also add a "permalink" while we're at it
1310 $revid = $this->getRevisionId();
1312 $nav_urls['permalink'] = [
1313 'text' => $this->msg( 'permalink' )->text(),
1314 'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1318 // Avoid PHP 7.1 warning of passing $this by reference
1319 $skinTemplate = $this;
1320 // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1321 Hooks
::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1322 [ &$skinTemplate, &$nav_urls, &$revid, &$revid ] );
1325 if ( $out->isArticleRelated() ) {
1326 $nav_urls['whatlinkshere'] = [
1327 'href' => SpecialPage
::getTitleFor( 'Whatlinkshere', $this->thispage
)->getLocalURL()
1330 $nav_urls['info'] = [
1331 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1332 'href' => $this->getTitle()->getLocalURL( "action=info" )
1335 if ( $this->getTitle()->exists() ||
$this->getTitle()->inNamespace( NS_CATEGORY
) ) {
1336 $nav_urls['recentchangeslinked'] = [
1337 'href' => SpecialPage
::getTitleFor( 'Recentchangeslinked', $this->thispage
)->getLocalURL()
1342 $user = $this->getRelevantUser();
1344 $rootUser = $user->getName();
1346 $nav_urls['contributions'] = [
1347 'text' => $this->msg( 'contributions', $rootUser )->text(),
1348 'href' => self
::makeSpecialUrlSubpage( 'Contributions', $rootUser ),
1349 'tooltip-params' => [ $rootUser ],
1352 $nav_urls['log'] = [
1353 'href' => self
::makeSpecialUrlSubpage( 'Log', $rootUser )
1356 if ( $this->getUser()->isAllowed( 'block' ) ) {
1357 $nav_urls['blockip'] = [
1358 'text' => $this->msg( 'blockip', $rootUser )->text(),
1359 'href' => self
::makeSpecialUrlSubpage( 'Block', $rootUser )
1363 if ( $this->showEmailUser( $user ) ) {
1364 $nav_urls['emailuser'] = [
1365 'text' => $this->msg( 'tool-link-emailuser', $rootUser )->text(),
1366 'href' => self
::makeSpecialUrlSubpage( 'Emailuser', $rootUser ),
1367 'tooltip-params' => [ $rootUser ],
1371 if ( !$user->isAnon() ) {
1372 $sur = new UserrightsPage
;
1373 $sur->setContext( $this->getContext() );
1374 $canChange = $sur->userCanChangeRights( $user );
1375 $nav_urls['userrights'] = [
1376 'text' => $this->msg(
1377 $canChange ?
'tool-link-userrights' : 'tool-link-userrights-readonly',
1380 'href' => self
::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1389 * Generate strings used for xml 'id' names
1392 protected function getNameSpaceKey() {
1393 return $this->getTitle()->getNamespaceKey();