cc294f8636fa91fa78afbe3f07bf7b55cf4298b7
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
22 * Base class for template-based skins.
24 * Template-filler skin base class
25 * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
26 * Based on Brion's smarty skin
27 * @copyright Copyright © Gabriel Wicke -- http://www.aulinx.de/
29 * @todo Needs some serious refactoring into functions that correspond
30 * to the computations individual esi snippets need. Most importantly no body
31 * parsing for most of those of course.
35 class SkinTemplate
extends Skin
{
37 * @var string Name of our skin, it probably needs to be all lower case.
38 * Child classes should override the default.
40 public $skinname = 'monobook';
43 * @var string For QuickTemplate, the name of the subclass which will
44 * actually fill the template. Child classes should override the default.
46 public $template = 'QuickTemplate';
49 * Add specific styles for this skin
51 * @param OutputPage $out
53 function setupSkinUserCss( OutputPage
$out ) {
54 $moduleStyles = array(
55 'mediawiki.legacy.shared',
56 'mediawiki.legacy.commonPrint',
57 'mediawiki.ui.button',
58 'mediawiki.sectionAnchor'
60 if ( $out->isSyndicated() ) {
61 $moduleStyles[] = 'mediawiki.legacy.feeds';
63 $out->addModuleStyles( $moduleStyles );
67 * Create the template engine object; we feed it a bunch of data
68 * and eventually it spits out some HTML. Should have interface
69 * roughly equivalent to PHPTAL 0.7.
71 * @param string $classname
72 * @param bool|string $repository Subdirectory where we keep template files
73 * @param bool|string $cache_dir
74 * @return QuickTemplate
77 function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
78 return new $classname( $this->getConfig() );
82 * Generates array of language links for the current page
86 public function getLanguages() {
87 global $wgHideInterlanguageLinks;
88 if ( $wgHideInterlanguageLinks ) {
92 $userLang = $this->getLanguage();
93 $languageLinks = array();
95 foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
96 $languageLinkParts = explode( ':', $languageLinkText, 2 );
97 $class = 'interlanguage-link interwiki-' . $languageLinkParts[0];
98 unset( $languageLinkParts );
100 $languageLinkTitle = Title
::newFromText( $languageLinkText );
101 if ( $languageLinkTitle ) {
102 $ilInterwikiCode = $languageLinkTitle->getInterwiki();
103 $ilLangName = Language
::fetchLanguageName( $ilInterwikiCode );
105 if ( strval( $ilLangName ) === '' ) {
106 $ilDisplayTextMsg = wfMessage( "interlanguage-link-$ilInterwikiCode" );
107 if ( !$ilDisplayTextMsg->isDisabled() ) {
108 // Use custom MW message for the display text
109 $ilLangName = $ilDisplayTextMsg->text();
111 // Last resort: fallback to the language link target
112 $ilLangName = $languageLinkText;
115 // Use the language autonym as display text
116 $ilLangName = $this->formatLanguageName( $ilLangName );
119 // CLDR extension or similar is required to localize the language name;
120 // otherwise we'll end up with the autonym again.
121 $ilLangLocalName = Language
::fetchLanguageName(
126 $languageLinkTitleText = $languageLinkTitle->getText();
127 if ( $ilLangLocalName === '' ) {
128 $ilFriendlySiteName = wfMessage( "interlanguage-link-sitename-$ilInterwikiCode" );
129 if ( !$ilFriendlySiteName->isDisabled() ) {
130 if ( $languageLinkTitleText === '' ) {
131 $ilTitle = wfMessage(
132 'interlanguage-link-title-nonlangonly',
133 $ilFriendlySiteName->text()
136 $ilTitle = wfMessage(
137 'interlanguage-link-title-nonlang',
138 $languageLinkTitleText,
139 $ilFriendlySiteName->text()
143 // we have nothing friendly to put in the title, so fall back to
144 // displaying the interlanguage link itself in the title text
145 // (similar to what is done in page content)
146 $ilTitle = $languageLinkTitle->getInterwiki() .
147 ":$languageLinkTitleText";
149 } elseif ( $languageLinkTitleText === '' ) {
150 $ilTitle = wfMessage(
151 'interlanguage-link-title-langonly',
155 $ilTitle = wfMessage(
156 'interlanguage-link-title',
157 $languageLinkTitleText,
162 $ilInterwikiCodeBCP47 = wfBCP47( $ilInterwikiCode );
163 $languageLink = array(
164 'href' => $languageLinkTitle->getFullURL(),
165 'text' => $ilLangName,
168 'lang' => $ilInterwikiCodeBCP47,
169 'hreflang' => $ilInterwikiCodeBCP47,
172 'SkinTemplateGetLanguageLink',
173 array( &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() )
175 $languageLinks[] = $languageLink;
179 return $languageLinks;
182 protected function setupTemplateForOutput() {
184 $request = $this->getRequest();
185 $user = $this->getUser();
186 $title = $this->getTitle();
188 $tpl = $this->setupTemplate( $this->template
, 'skins' );
190 $this->thispage
= $title->getPrefixedDBkey();
191 $this->titletxt
= $title->getPrefixedText();
192 $this->userpage
= $user->getUserPage()->getPrefixedText();
194 if ( !$request->wasPosted() ) {
195 $query = $request->getValues();
196 unset( $query['title'] );
197 unset( $query['returnto'] );
198 unset( $query['returntoquery'] );
200 $this->thisquery
= wfArrayToCgi( $query );
201 $this->loggedin
= $user->isLoggedIn();
202 $this->username
= $user->getName();
204 if ( $this->loggedin ||
$this->showIPinHeader() ) {
205 $this->userpageUrlDetails
= self
::makeUrlDetails( $this->userpage
);
207 # This won't be used in the standard skins, but we define it to preserve the interface
208 # To save time, we check for existence
209 $this->userpageUrlDetails
= self
::makeKnownUrlDetails( $this->userpage
);
216 * initialize various variables and generate the template
218 * @param OutputPage $out
220 function outputPage( OutputPage
$out = null ) {
221 Profiler
::instance()->setTemplated( true );
224 if ( $out !== null ) {
225 // Deprecated since 1.20, note added in 1.25
226 wfDeprecated( __METHOD__
, '1.25' );
227 $oldContext = $this->getContext();
228 $this->setContext( $out->getContext() );
231 $out = $this->getOutput();
233 $this->initPage( $out );
234 $tpl = $this->prepareQuickTemplate( $out );
236 $res = $tpl->execute();
238 // result may be an error
239 $this->printOrError( $res );
242 $this->setContext( $oldContext );
248 * initialize various variables and generate the template
251 * @return QuickTemplate The template to be executed by outputPage
253 protected function prepareQuickTemplate() {
254 global $wgContLang, $wgScript, $wgStylePath, $wgMimeType, $wgJsMimeType,
255 $wgSitename, $wgLogo, $wgMaxCredits,
256 $wgShowCreditsIfMax, $wgArticlePath,
257 $wgScriptPath, $wgServer;
259 $title = $this->getTitle();
260 $request = $this->getRequest();
261 $out = $this->getOutput();
262 $tpl = $this->setupTemplateForOutput();
264 $tpl->set( 'title', $out->getPageTitle() );
265 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
266 $tpl->set( 'displaytitle', $out->mPageLinkTitle
);
268 $tpl->setRef( 'thispage', $this->thispage
);
269 $tpl->setRef( 'titleprefixeddbkey', $this->thispage
);
270 $tpl->set( 'titletext', $title->getText() );
271 $tpl->set( 'articleid', $title->getArticleID() );
273 $tpl->set( 'isarticle', $out->isArticle() );
275 $subpagestr = $this->subPageSubtitle();
276 if ( $subpagestr !== '' ) {
277 $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
279 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
281 $undelete = $this->getUndeleteLink();
282 if ( $undelete === '' ) {
283 $tpl->set( 'undelete', '' );
285 $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
288 $tpl->set( 'catlinks', $this->getCategories() );
289 if ( $out->isSyndicated() ) {
291 foreach ( $out->getSyndicationLinks() as $format => $link ) {
292 $feeds[$format] = array(
293 // Messages: feed-atom, feed-rss
294 'text' => $this->msg( "feed-$format" )->text(),
298 $tpl->setRef( 'feeds', $feeds );
300 $tpl->set( 'feeds', false );
303 $tpl->setRef( 'mimetype', $wgMimeType );
304 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
305 $tpl->set( 'charset', 'UTF-8' );
306 $tpl->setRef( 'wgScript', $wgScript );
307 $tpl->setRef( 'skinname', $this->skinname
);
308 $tpl->set( 'skinclass', get_class( $this ) );
309 $tpl->setRef( 'skin', $this );
310 $tpl->setRef( 'stylename', $this->stylename
);
311 $tpl->set( 'printable', $out->isPrintable() );
312 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
313 $tpl->setRef( 'loggedin', $this->loggedin
);
314 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
315 $tpl->set( 'searchaction', $this->escapeSearchLink() );
316 $tpl->set( 'searchtitle', SpecialPage
::getTitleFor( 'Search' )->getPrefixedDBkey() );
317 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
318 $tpl->setRef( 'stylepath', $wgStylePath );
319 $tpl->setRef( 'articlepath', $wgArticlePath );
320 $tpl->setRef( 'scriptpath', $wgScriptPath );
321 $tpl->setRef( 'serverurl', $wgServer );
322 $tpl->setRef( 'logopath', $wgLogo );
323 $tpl->setRef( 'sitename', $wgSitename );
325 $userLang = $this->getLanguage();
326 $userLangCode = $userLang->getHtmlCode();
327 $userLangDir = $userLang->getDir();
329 $tpl->set( 'lang', $userLangCode );
330 $tpl->set( 'dir', $userLangDir );
331 $tpl->set( 'rtl', $userLang->isRTL() );
333 $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ?
' capitalize-all-nouns' : '' );
334 $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
335 $tpl->set( 'username', $this->loggedin ?
$this->username
: null );
336 $tpl->setRef( 'userpage', $this->userpage
);
337 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails
['href'] );
338 $tpl->set( 'userlang', $userLangCode );
340 // Users can have their language set differently than the
341 // content of the wiki. For these users, tell the web browser
342 // that interface elements are in a different language.
343 $tpl->set( 'userlangattributes', '' );
344 $tpl->set( 'specialpageattributes', '' ); # obsolete
345 // Used by VectorBeta to insert HTML before content but after the
346 // heading for the page title. Defaults to empty string.
347 $tpl->set( 'prebodyhtml', '' );
349 if ( $userLangCode !== $wgContLang->getHtmlCode() ||
$userLangDir !== $wgContLang->getDir() ) {
350 $escUserlang = htmlspecialchars( $userLangCode );
351 $escUserdir = htmlspecialchars( $userLangDir );
352 // Attributes must be in double quotes because htmlspecialchars() doesn't
353 // escape single quotes
354 $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
355 $tpl->set( 'userlangattributes', $attrs );
358 $tpl->set( 'newtalk', $this->getNewtalks() );
359 $tpl->set( 'logo', $this->logoText() );
361 $tpl->set( 'copyright', false );
363 $tpl->set( 'viewcount', false );
364 $tpl->set( 'lastmod', false );
365 $tpl->set( 'credits', false );
366 $tpl->set( 'numberofwatchingusers', false );
367 if ( $out->isArticle() && $title->exists() ) {
368 if ( $this->isRevisionCurrent() ) {
369 if ( $wgMaxCredits != 0 ) {
370 $tpl->set( 'credits', Action
::factory( 'credits', $this->getWikiPage(),
371 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
373 $tpl->set( 'lastmod', $this->lastModified() );
376 $tpl->set( 'copyright', $this->getCopyright() );
379 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
380 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
381 $tpl->set( 'disclaimer', $this->disclaimerLink() );
382 $tpl->set( 'privacy', $this->privacyLink() );
383 $tpl->set( 'about', $this->aboutLink() );
385 $tpl->set( 'footerlinks', array(
388 'numberofwatchingusers',
399 global $wgFooterIcons;
400 $tpl->set( 'footericons', $wgFooterIcons );
401 foreach ( $tpl->data
['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
402 if ( count( $footerIconsBlock ) > 0 ) {
403 foreach ( $footerIconsBlock as &$footerIcon ) {
404 if ( isset( $footerIcon['src'] ) ) {
405 if ( !isset( $footerIcon['width'] ) ) {
406 $footerIcon['width'] = 88;
408 if ( !isset( $footerIcon['height'] ) ) {
409 $footerIcon['height'] = 31;
414 unset( $tpl->data
['footericons'][$footerIconsKey] );
418 $tpl->set( 'indicators', $out->getIndicators() );
420 $tpl->set( 'sitenotice', $this->getSiteNotice() );
421 $tpl->set( 'bottomscripts', $this->bottomScripts() );
422 $tpl->set( 'printfooter', $this->printSource() );
424 # An ID that includes the actual body text; without categories, contentSub, ...
425 $realBodyAttribs = array( 'id' => 'mw-content-text' );
427 # Add a mw-content-ltr/rtl class to be able to style based on text direction
428 # when the content is different from the UI language, i.e.:
429 # not for special pages or file pages AND only when viewing
430 if ( !in_array( $title->getNamespace(), array( NS_SPECIAL
, NS_FILE
) ) &&
431 Action
::getActionName( $this ) === 'view' ) {
432 $pageLang = $title->getPageViewLanguage();
433 $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
434 $realBodyAttribs['dir'] = $pageLang->getDir();
435 $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
438 $out->mBodytext
= Html
::rawElement( 'div', $realBodyAttribs, $out->mBodytext
);
439 $tpl->setRef( 'bodytext', $out->mBodytext
);
441 $language_urls = $this->getLanguages();
442 if ( count( $language_urls ) ) {
443 $tpl->setRef( 'language_urls', $language_urls );
445 $tpl->set( 'language_urls', false );
449 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
450 $content_navigation = $this->buildContentNavigationUrls();
451 $content_actions = $this->buildContentActionUrls( $content_navigation );
452 $tpl->setRef( 'content_navigation', $content_navigation );
453 $tpl->setRef( 'content_actions', $content_actions );
455 $tpl->set( 'sidebar', $this->buildSidebar() );
456 $tpl->set( 'nav_urls', $this->buildNavUrls() );
458 // Set the head scripts near the end, in case the above actions resulted in added scripts
459 $tpl->set( 'headelement', $out->headElement( $this ) );
461 $tpl->set( 'debug', '' );
462 $tpl->set( 'debughtml', $this->generateDebugHTML() );
463 $tpl->set( 'reporttime', wfReportTime() );
465 // original version by hansm
466 if ( !Hooks
::run( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
467 wfDebug( __METHOD__
. ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
470 // Set the bodytext to another key so that skins can just output it on its own
471 // and output printfooter and debughtml separately
472 $tpl->set( 'bodycontent', $tpl->data
['bodytext'] );
474 // Append printfooter and debughtml onto bodytext so that skins that
475 // were already using bodytext before they were split out don't suddenly
476 // start not outputting information.
477 $tpl->data
['bodytext'] .= Html
::rawElement(
479 array( 'class' => 'printfooter' ),
480 "\n{$tpl->data['printfooter']}"
482 $tpl->data
['bodytext'] .= $tpl->data
['debughtml'];
484 // allow extensions adding stuff after the page content.
485 // See Skin::afterContentHook() for further documentation.
486 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
492 * Get the HTML for the p-personal list
495 public function getPersonalToolsList() {
496 $tpl = $this->setupTemplateForOutput();
497 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
499 foreach ( $tpl->getPersonalTools() as $key => $item ) {
500 $html .= $tpl->makeListItem( $key, $item );
506 * Format language name for use in sidebar interlanguage links list.
507 * By default it is capitalized.
509 * @param string $name Language name, e.g. "English" or "español"
513 function formatLanguageName( $name ) {
514 return $this->getLanguage()->ucfirst( $name );
518 * Output the string, or print error message if it's
519 * an error object of the appropriate type.
520 * For the base class, assume strings all around.
525 function printOrError( $str ) {
530 * Output a boolean indicating if buildPersonalUrls should output separate
531 * login and create account links or output a combined link
532 * By default we simply return a global config setting that affects most skins
533 * This is setup as a method so that like with $wgLogo and getLogo() a skin
534 * can override this setting and always output one or the other if it has
535 * a reason it can't output one of the two modes.
538 function useCombinedLoginLink() {
539 global $wgUseCombinedLoginLink;
540 return $wgUseCombinedLoginLink;
544 * build array of urls for personal toolbar
547 protected function buildPersonalUrls() {
548 $title = $this->getTitle();
549 $request = $this->getRequest();
550 $pageurl = $title->getLocalURL();
552 /* set up the default links for the personal toolbar */
553 $personal_urls = array();
555 # Due to bug 32276, if a user does not have read permissions,
556 # $this->getTitle() will just give Special:Badtitle, which is
557 # not especially useful as a returnto parameter. Use the title
558 # from the request instead, if there was one.
559 if ( $this->getUser()->isAllowed( 'read' ) ) {
560 $page = $this->getTitle();
562 $page = Title
::newFromText( $request->getVal( 'title', '' ) );
564 $page = $request->getVal( 'returnto', $page );
566 if ( strval( $page ) !== '' ) {
567 $a['returnto'] = $page;
568 $query = $request->getVal( 'returntoquery', $this->thisquery
);
569 if ( $query != '' ) {
570 $a['returntoquery'] = $query;
574 $returnto = wfArrayToCgi( $a );
575 if ( $this->loggedin
) {
576 $personal_urls['userpage'] = array(
577 'text' => $this->username
,
578 'href' => &$this->userpageUrlDetails
['href'],
579 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
580 'active' => ( $this->userpageUrlDetails
['href'] == $pageurl ),
583 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
584 $personal_urls['mytalk'] = array(
585 'text' => $this->msg( 'mytalk' )->text(),
586 'href' => &$usertalkUrlDetails['href'],
587 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
588 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
590 $href = self
::makeSpecialUrl( 'Preferences' );
591 $personal_urls['preferences'] = array(
592 'text' => $this->msg( 'mypreferences' )->text(),
594 'active' => ( $href == $pageurl )
597 if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
598 $href = self
::makeSpecialUrl( 'Watchlist' );
599 $personal_urls['watchlist'] = array(
600 'text' => $this->msg( 'mywatchlist' )->text(),
602 'active' => ( $href == $pageurl )
606 # We need to do an explicit check for Special:Contributions, as we
607 # have to match both the title, and the target, which could come
608 # from request values (Special:Contributions?target=Jimbo_Wales)
609 # or be specified in "sub page" form
610 # (Special:Contributions/Jimbo_Wales). The plot
611 # thickens, because the Title object is altered for special pages,
612 # so it doesn't contain the original alias-with-subpage.
613 $origTitle = Title
::newFromText( $request->getText( 'title' ) );
614 if ( $origTitle instanceof Title
&& $origTitle->isSpecialPage() ) {
615 list( $spName, $spPar ) = SpecialPageFactory
::resolveAlias( $origTitle->getText() );
616 $active = $spName == 'Contributions'
617 && ( ( $spPar && $spPar == $this->username
)
618 ||
$request->getText( 'target' ) == $this->username
);
623 $href = self
::makeSpecialUrlSubpage( 'Contributions', $this->username
);
624 $personal_urls['mycontris'] = array(
625 'text' => $this->msg( 'mycontris' )->text(),
629 $personal_urls['logout'] = array(
630 'text' => $this->msg( 'pt-userlogout' )->text(),
631 'href' => self
::makeSpecialUrl( 'Userlogout',
632 // userlogout link must always contain an & character, otherwise we might not be able
633 // to detect a buggy precaching proxy (bug 17790)
634 $title->isSpecial( 'Preferences' ) ?
'noreturnto' : $returnto
639 $useCombinedLoginLink = $this->useCombinedLoginLink();
640 $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
641 ?
'nav-login-createaccount'
643 $is_signup = $request->getText( 'type' ) == 'signup';
646 'text' => $this->msg( $loginlink )->text(),
647 'href' => self
::makeSpecialUrl( 'Userlogin', $returnto ),
648 'active' => $title->isSpecial( 'Userlogin' )
649 && ( $loginlink == 'nav-login-createaccount' ||
!$is_signup ),
651 $createaccount_url = array(
652 'text' => $this->msg( 'pt-createaccount' )->text(),
653 'href' => self
::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
654 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup,
657 if ( $this->showIPinHeader() ) {
658 $href = &$this->userpageUrlDetails
['href'];
659 $personal_urls['anonuserpage'] = array(
660 'text' => $this->username
,
662 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
663 'active' => ( $pageurl == $href )
665 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
666 $href = &$usertalkUrlDetails['href'];
667 $personal_urls['anontalk'] = array(
668 'text' => $this->msg( 'anontalk' )->text(),
670 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
671 'active' => ( $pageurl == $href )
675 if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
676 $personal_urls['createaccount'] = $createaccount_url;
679 $personal_urls['login'] = $login_url;
682 Hooks
::run( 'PersonalUrls', array( &$personal_urls, &$title, $this ) );
683 return $personal_urls;
687 * Builds an array with tab definition
689 * @param Title $title Page Where the tab links to
690 * @param string|array $message Message key or an array of message keys (will fall back)
691 * @param bool $selected Display the tab as selected
692 * @param string $query Query string attached to tab URL
693 * @param bool $checkEdit Check if $title exists and mark with .new if one doesn't
697 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
700 $classes[] = 'selected';
702 if ( $checkEdit && !$title->isKnown() ) {
704 if ( $query !== '' ) {
705 $query = 'action=edit&redlink=1&' . $query;
707 $query = 'action=edit&redlink=1';
711 // wfMessageFallback will nicely accept $message as an array of fallbacks
712 // or just a single key
713 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
714 if ( is_array( $message ) ) {
715 // for hook compatibility just keep the last message name
716 $message = end( $message );
718 if ( $msg->exists() ) {
719 $text = $msg->text();
722 $text = $wgContLang->getConverter()->convertNamespace(
723 MWNamespace
::getSubject( $title->getNamespace() ) );
727 if ( !Hooks
::run( 'SkinTemplateTabAction', array( &$this,
728 $title, $message, $selected, $checkEdit,
729 &$classes, &$query, &$text, &$result ) ) ) {
734 'class' => implode( ' ', $classes ),
736 'href' => $title->getLocalURL( $query ),
740 function makeTalkUrlDetails( $name, $urlaction = '' ) {
741 $title = Title
::newFromText( $name );
742 if ( !is_object( $title ) ) {
743 throw new MWException( __METHOD__
. " given invalid pagename $name" );
745 $title = $title->getTalkPage();
746 self
::checkTitle( $title, $name );
748 'href' => $title->getLocalURL( $urlaction ),
749 'exists' => $title->isKnown(),
754 * @todo is this even used?
756 function makeArticleUrlDetails( $name, $urlaction = '' ) {
757 $title = Title
::newFromText( $name );
758 $title = $title->getSubjectPage();
759 self
::checkTitle( $title, $name );
761 'href' => $title->getLocalURL( $urlaction ),
762 'exists' => $title->exists(),
767 * a structured array of links usually used for the tabs in a skin
769 * There are 4 standard sections
770 * namespaces: Used for namespace tabs like special, page, and talk namespaces
771 * views: Used for primary page views like read, edit, history
772 * actions: Used for most extra page actions like deletion, protection, etc...
773 * variants: Used to list the language variants for the page
775 * Each section's value is a key/value array of links for that section.
776 * The links themselves have these common keys:
777 * - class: The css classes to apply to the tab
778 * - text: The text to display on the tab
779 * - href: The href for the tab to point to
780 * - rel: An optional rel= for the tab's link
781 * - redundant: If true the tab will be dropped in skins using content_actions
782 * this is useful for tabs like "Read" which only have meaning in skins that
783 * take special meaning from the grouped structure of content_navigation
785 * Views also have an extra key which can be used:
786 * - primary: If this is not true skins like vector may try to hide the tab
787 * when the user has limited space in their browser window
789 * content_navigation using code also expects these ids to be present on the
790 * links, however these are usually automatically generated by SkinTemplate
791 * itself and are not necessary when using a hook. The only things these may
792 * matter to are people modifying content_navigation after it's initial creation:
793 * - id: A "preferred" id, most skins are best off outputting this preferred
794 * id for best compatibility.
795 * - tooltiponly: This is set to true for some tabs in cases where the system
796 * believes that the accesskey should not be added to the tab.
800 protected function buildContentNavigationUrls() {
801 global $wgDisableLangConversion;
803 // Display tabs for the relevant title rather than always the title itself
804 $title = $this->getRelevantTitle();
805 $onPage = $title->equals( $this->getTitle() );
807 $out = $this->getOutput();
808 $request = $this->getRequest();
809 $user = $this->getUser();
811 $content_navigation = array(
812 'namespaces' => array(),
814 'actions' => array(),
815 'variants' => array()
819 $action = $request->getVal( 'action', 'view' );
821 $userCanRead = $title->quickUserCan( 'read', $user );
823 $preventActiveTabs = false;
824 Hooks
::run( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
826 // Checks if page is some kind of content
827 if ( $title->canExist() ) {
828 // Gets page objects for the related namespaces
829 $subjectPage = $title->getSubjectPage();
830 $talkPage = $title->getTalkPage();
832 // Determines if this is a talk page
833 $isTalk = $title->isTalkPage();
835 // Generates XML IDs from namespace names
836 $subjectId = $title->getNamespaceKey( '' );
838 if ( $subjectId == 'main' ) {
841 $talkId = "{$subjectId}_talk";
844 $skname = $this->skinname
;
846 // Adds namespace links
847 $subjectMsg = array( "nstab-$subjectId" );
848 if ( $subjectPage->isMainPage() ) {
849 array_unshift( $subjectMsg, 'mainpage-nstab' );
851 $content_navigation['namespaces'][$subjectId] = $this->tabAction(
852 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
854 $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
855 $content_navigation['namespaces'][$talkId] = $this->tabAction(
856 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
858 $content_navigation['namespaces'][$talkId]['context'] = 'talk';
860 if ( $userCanRead ) {
861 $isForeignFile = $title->inNamespace( NS_FILE
) && $this->canUseWikiPage() &&
862 $this->getWikiPage() instanceof WikiFilePage
&& !$this->getWikiPage()->isLocal();
864 // Adds view view link
865 if ( $title->exists() ||
$isForeignFile ) {
866 $content_navigation['views']['view'] = $this->tabAction(
867 $isTalk ?
$talkPage : $subjectPage,
868 array( "$skname-view-view", 'view' ),
869 ( $onPage && ( $action == 'view' ||
$action == 'purge' ) ), '', true
871 // signal to hide this from simple content_actions
872 $content_navigation['views']['view']['redundant'] = true;
875 // If it is a non-local file, show a link to the file in its own repository
876 if ( $isForeignFile ) {
877 $file = $this->getWikiPage()->getFile();
878 $content_navigation['views']['view-foreign'] = array(
880 'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
881 setContext( $this->getContext() )->
882 params( $file->getRepo()->getDisplayName() )->text(),
883 'href' => $file->getDescriptionUrl(),
888 // Checks if user can edit the current page if it exists or create it otherwise
889 if ( $title->quickUserCan( 'edit', $user )
890 && ( $title->exists() ||
$title->quickUserCan( 'create', $user ) )
892 // Builds CSS class for talk page links
893 $isTalkClass = $isTalk ?
' istalk' : '';
894 // Whether the user is editing the page
895 $isEditing = $onPage && ( $action == 'edit' ||
$action == 'submit' );
896 // Whether to show the "Add a new section" tab
897 // Checks if this is a current rev of talk page and is not forced to be hidden
898 $showNewSection = !$out->forceHideNewSectionLink()
899 && ( ( $isTalk && $this->isRevisionCurrent() ) ||
$out->showNewSectionLink() );
900 $section = $request->getVal( 'section' );
902 if ( $title->exists()
903 ||
( $title->getNamespace() == NS_MEDIAWIKI
904 && $title->getDefaultMessageText() !== false
907 $msgKey = $isForeignFile ?
'edit-local' : 'edit';
909 $msgKey = $isForeignFile ?
'create-local' : 'create';
911 $content_navigation['views']['edit'] = array(
912 'class' => ( $isEditing && ( $section !== 'new' ||
!$showNewSection )
916 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
917 ->setContext( $this->getContext() )->text(),
918 'href' => $title->getLocalURL( $this->editUrlOptions() ),
919 'primary' => !$isForeignFile, // don't collapse this in vector
923 if ( $showNewSection ) {
924 // Adds new section link
925 //$content_navigation['actions']['addsection']
926 $content_navigation['views']['addsection'] = array(
927 'class' => ( $isEditing && $section == 'new' ) ?
'selected' : false,
928 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
929 ->setContext( $this->getContext() )->text(),
930 'href' => $title->getLocalURL( 'action=edit§ion=new' )
933 // Checks if the page has some kind of viewable content
934 } elseif ( $title->hasSourceText() ) {
935 // Adds view source view link
936 $content_navigation['views']['viewsource'] = array(
937 'class' => ( $onPage && $action == 'edit' ) ?
'selected' : false,
938 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
939 ->setContext( $this->getContext() )->text(),
940 'href' => $title->getLocalURL( $this->editUrlOptions() ),
941 'primary' => true, // don't collapse this in vector
945 // Checks if the page exists
946 if ( $title->exists() ) {
947 // Adds history view link
948 $content_navigation['views']['history'] = array(
949 'class' => ( $onPage && $action == 'history' ) ?
'selected' : false,
950 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
951 ->setContext( $this->getContext() )->text(),
952 'href' => $title->getLocalURL( 'action=history' ),
955 if ( $title->quickUserCan( 'delete', $user ) ) {
956 $content_navigation['actions']['delete'] = array(
957 'class' => ( $onPage && $action == 'delete' ) ?
'selected' : false,
958 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
959 ->setContext( $this->getContext() )->text(),
960 'href' => $title->getLocalURL( 'action=delete' )
964 if ( $title->quickUserCan( 'move', $user ) ) {
965 $moveTitle = SpecialPage
::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
966 $content_navigation['actions']['move'] = array(
967 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ?
'selected' : false,
968 'text' => wfMessageFallback( "$skname-action-move", 'move' )
969 ->setContext( $this->getContext() )->text(),
970 'href' => $moveTitle->getLocalURL()
974 // article doesn't exist or is deleted
975 if ( $user->isAllowed( 'deletedhistory' ) ) {
976 $n = $title->isDeleted();
978 $undelTitle = SpecialPage
::getTitleFor( 'Undelete', $title->getPrefixedDBkey() );
979 // If the user can't undelete but can view deleted
980 // history show them a "View .. deleted" tab instead.
981 $msgKey = $user->isAllowed( 'undelete' ) ?
'undelete' : 'viewdeleted';
982 $content_navigation['actions']['undelete'] = array(
983 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ?
'selected' : false,
984 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
985 ->setContext( $this->getContext() )->numParams( $n )->text(),
986 'href' => $undelTitle->getLocalURL()
992 if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
993 MWNamespace
::getRestrictionLevels( $title->getNamespace(), $user ) !== array( '' )
995 $mode = $title->isProtected() ?
'unprotect' : 'protect';
996 $content_navigation['actions'][$mode] = array(
997 'class' => ( $onPage && $action == $mode ) ?
'selected' : false,
998 'text' => wfMessageFallback( "$skname-action-$mode", $mode )
999 ->setContext( $this->getContext() )->text(),
1000 'href' => $title->getLocalURL( "action=$mode" )
1004 // Checks if the user is logged in
1005 if ( $this->loggedin
&& $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1007 * The following actions use messages which, if made particular to
1008 * the any specific skins, would break the Ajax code which makes this
1009 * action happen entirely inline. OutputPage::getJSVars
1010 * defines a set of messages in a javascript object - and these
1011 * messages are assumed to be global for all skins. Without making
1012 * a change to that procedure these messages will have to remain as
1013 * the global versions.
1015 $mode = $user->isWatched( $title ) ?
'unwatch' : 'watch';
1016 $token = WatchAction
::getWatchToken( $title, $user, $mode );
1017 $content_navigation['actions'][$mode] = array(
1018 'class' => $onPage && ( $action == 'watch' ||
$action == 'unwatch' ) ?
'selected' : false,
1019 // uses 'watch' or 'unwatch' message
1020 'text' => $this->msg( $mode )->text(),
1021 'href' => $title->getLocalURL( array( 'action' => $mode, 'token' => $token ) )
1026 Hooks
::run( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
1028 if ( $userCanRead && !$wgDisableLangConversion ) {
1029 $pageLang = $title->getPageLanguage();
1030 // Gets list of language variants
1031 $variants = $pageLang->getVariants();
1032 // Checks that language conversion is enabled and variants exist
1033 // And if it is not in the special namespace
1034 if ( count( $variants ) > 1 ) {
1035 // Gets preferred variant (note that user preference is
1036 // only possible for wiki content language variant)
1037 $preferred = $pageLang->getPreferredVariant();
1038 if ( Action
::getActionName( $this ) === 'view' ) {
1039 $params = $request->getQueryValues();
1040 unset( $params['title'] );
1044 // Loops over each variant
1045 foreach ( $variants as $code ) {
1046 // Gets variant name from language code
1047 $varname = $pageLang->getVariantname( $code );
1048 // Appends variant link
1049 $content_navigation['variants'][] = array(
1050 'class' => ( $code == $preferred ) ?
'selected' : false,
1052 'href' => $title->getLocalURL( array( 'variant' => $code ) +
$params ),
1053 'lang' => wfBCP47( $code ),
1054 'hreflang' => wfBCP47( $code ),
1060 // If it's not content, it's got to be a special page
1061 $content_navigation['namespaces']['special'] = array(
1062 'class' => 'selected',
1063 'text' => $this->msg( 'nstab-special' )->text(),
1064 'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1065 'context' => 'subject'
1068 Hooks
::run( 'SkinTemplateNavigation::SpecialPage',
1069 array( &$this, &$content_navigation ) );
1072 // Equiv to SkinTemplateContentActions
1073 Hooks
::run( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1075 // Setup xml ids and tooltip info
1076 foreach ( $content_navigation as $section => &$links ) {
1077 foreach ( $links as $key => &$link ) {
1079 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1080 $xmlID = 'ca-nstab-' . $xmlID;
1081 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1083 $link['rel'] = 'discussion';
1084 } elseif ( $section == 'variants' ) {
1085 $xmlID = 'ca-varlang-' . $xmlID;
1087 $xmlID = 'ca-' . $xmlID;
1089 $link['id'] = $xmlID;
1093 # We don't want to give the watch tab an accesskey if the
1094 # page is being edited, because that conflicts with the
1095 # accesskey on the watch checkbox. We also don't want to
1096 # give the edit tab an accesskey, because that's fairly
1097 # superfluous and conflicts with an accesskey (Ctrl-E) often
1098 # used for editing in Safari.
1099 if ( in_array( $action, array( 'edit', 'submit' ) ) ) {
1100 if ( isset( $content_navigation['views']['edit'] ) ) {
1101 $content_navigation['views']['edit']['tooltiponly'] = true;
1103 if ( isset( $content_navigation['actions']['watch'] ) ) {
1104 $content_navigation['actions']['watch']['tooltiponly'] = true;
1106 if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1107 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1111 return $content_navigation;
1115 * an array of edit links by default used for the tabs
1116 * @param array $content_navigation
1119 private function buildContentActionUrls( $content_navigation ) {
1121 // content_actions has been replaced with content_navigation for backwards
1122 // compatibility and also for skins that just want simple tabs content_actions
1123 // is now built by flattening the content_navigation arrays into one
1125 $content_actions = array();
1127 foreach ( $content_navigation as $links ) {
1128 foreach ( $links as $key => $value ) {
1129 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1130 // Redundant tabs are dropped from content_actions
1134 // content_actions used to have ids built using the "ca-$key" pattern
1135 // so the xmlID based id is much closer to the actual $key that we want
1136 // for that reason we'll just strip out the ca- if present and use
1137 // the latter potion of the "id" as the $key
1138 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1139 $key = substr( $value['id'], 3 );
1142 if ( isset( $content_actions[$key] ) ) {
1143 wfDebug( __METHOD__
. ": Found a duplicate key for $key while flattening " .
1144 "content_navigation into content_actions.\n" );
1148 $content_actions[$key] = $value;
1152 return $content_actions;
1156 * build array of common navigation links
1159 protected function buildNavUrls() {
1160 global $wgUploadNavigationUrl;
1162 $out = $this->getOutput();
1163 $request = $this->getRequest();
1165 $nav_urls = array();
1166 $nav_urls['mainpage'] = array( 'href' => self
::makeMainPageUrl() );
1167 if ( $wgUploadNavigationUrl ) {
1168 $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1169 } elseif ( UploadBase
::isEnabled() && UploadBase
::isAllowed( $this->getUser() ) === true ) {
1170 $nav_urls['upload'] = array( 'href' => self
::makeSpecialUrl( 'Upload' ) );
1172 $nav_urls['upload'] = false;
1174 $nav_urls['specialpages'] = array( 'href' => self
::makeSpecialUrl( 'Specialpages' ) );
1176 $nav_urls['print'] = false;
1177 $nav_urls['permalink'] = false;
1178 $nav_urls['info'] = false;
1179 $nav_urls['whatlinkshere'] = false;
1180 $nav_urls['recentchangeslinked'] = false;
1181 $nav_urls['contributions'] = false;
1182 $nav_urls['log'] = false;
1183 $nav_urls['blockip'] = false;
1184 $nav_urls['emailuser'] = false;
1185 $nav_urls['userrights'] = false;
1187 // A print stylesheet is attached to all pages, but nobody ever
1188 // figures that out. :) Add a link...
1189 if ( !$out->isPrintable() && ( $out->isArticle() ||
$this->getTitle()->isSpecialPage() ) ) {
1190 $nav_urls['print'] = array(
1191 'text' => $this->msg( 'printableversion' )->text(),
1192 'href' => $this->getTitle()->getLocalURL(
1193 $request->appendQueryValue( 'printable', 'yes', true ) )
1197 if ( $out->isArticle() ) {
1198 // Also add a "permalink" while we're at it
1199 $revid = $this->getRevisionId();
1201 $nav_urls['permalink'] = array(
1202 'text' => $this->msg( 'permalink' )->text(),
1203 'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1207 // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1208 Hooks
::run( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1209 array( &$this, &$nav_urls, &$revid, &$revid ) );
1212 if ( $out->isArticleRelated() ) {
1213 $nav_urls['whatlinkshere'] = array(
1214 'href' => SpecialPage
::getTitleFor( 'Whatlinkshere', $this->thispage
)->getLocalURL()
1217 $nav_urls['info'] = array(
1218 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1219 'href' => $this->getTitle()->getLocalURL( "action=info" )
1222 if ( $this->getTitle()->exists() ) {
1223 $nav_urls['recentchangeslinked'] = array(
1224 'href' => SpecialPage
::getTitleFor( 'Recentchangeslinked', $this->thispage
)->getLocalURL()
1229 $user = $this->getRelevantUser();
1231 $rootUser = $user->getName();
1233 $nav_urls['contributions'] = array(
1234 'text' => $this->msg( 'contributions', $rootUser )->text(),
1235 'href' => self
::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1238 $nav_urls['log'] = array(
1239 'href' => self
::makeSpecialUrlSubpage( 'Log', $rootUser )
1242 if ( $this->getUser()->isAllowed( 'block' ) ) {
1243 $nav_urls['blockip'] = array(
1244 'text' => $this->msg( 'blockip', $rootUser )->text(),
1245 'href' => self
::makeSpecialUrlSubpage( 'Block', $rootUser )
1249 if ( $this->showEmailUser( $user ) ) {
1250 $nav_urls['emailuser'] = array(
1251 'href' => self
::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1255 if ( !$user->isAnon() ) {
1256 $sur = new UserrightsPage
;
1257 $sur->setContext( $this->getContext() );
1258 if ( $sur->userCanExecute( $this->getUser() ) ) {
1259 $nav_urls['userrights'] = array(
1260 'href' => self
::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1270 * Generate strings used for xml 'id' names
1273 protected function getNameSpaceKey() {
1274 return $this->getTitle()->getNamespaceKey();