includes/skins/SkinTemplate.php

   1 <?php
   2 /**
   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.
   7  *
   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.
  12  *
  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
  17  *
  18  * @file
  19  */
  20
  21 /**
  22  * Base class for template-based skins.
  23  *
  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/
  28  *
  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.
  32  *
  33  * @ingroup Skins
  34  */
  35 class SkinTemplate extends Skin {
  36         /**
  37          * @var string Name of our skin, it probably needs to be all lower case.
  38          *   Child classes should override the default.
  39          */
  40         public $skinname = 'monobook';
  41
  42         /**
  43          * @var string For QuickTemplate, the name of the subclass which will
  44          *   actually fill the template.  Child classes should override the default.
  45          */
  46         public $template = 'QuickTemplate';
  47
  48         /**
  49          * Add specific styles for this skin
  50          *
  51          * @param OutputPage $out
  52          */
  53         function setupSkinUserCss( OutputPage $out ) {
  54                 $out->addModuleStyles( array(
  55                         'mediawiki.legacy.shared',
  56                         'mediawiki.legacy.commonPrint',
  57                         'mediawiki.ui.button'
  58                 ) );
  59         }
  60
  61         /**
  62          * Create the template engine object; we feed it a bunch of data
  63          * and eventually it spits out some HTML. Should have interface
  64          * roughly equivalent to PHPTAL 0.7.
  65          *
  66          * @param string $classname
  67          * @param bool|string $repository Subdirectory where we keep template files
  68          * @param bool|string $cache_dir
  69          * @return QuickTemplate
  70          * @private
  71          */
  72         function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
  73                 return new $classname( $this->getConfig() );
  74         }
  75
  76         /**
  77          * Generates array of language links for the current page
  78          *
  79          * @return array
  80          */
  81         public function getLanguages() {
  82                 global $wgHideInterlanguageLinks;
  83                 if ( $wgHideInterlanguageLinks ) {
  84                         return array();
  85                 }
  86
  87                 $userLang = $this->getLanguage();
  88                 $languageLinks = array();
  89
  90                 foreach ( $this->getOutput()->getLanguageLinks() as $languageLinkText ) {
  91                         $languageLinkParts = explode( ':', $languageLinkText, 2 );
  92                         $class = 'interlanguage-link interwiki-' . $languageLinkParts[0];
  93                         unset( $languageLinkParts );
  94
  95                         $languageLinkTitle = Title::newFromText( $languageLinkText );
  96                         if ( $languageLinkTitle ) {
  97                                 $ilInterwikiCode = $languageLinkTitle->getInterwiki();
  98                                 $ilLangName = Language::fetchLanguageName( $ilInterwikiCode );
  99
 100                                 if ( strval( $ilLangName ) === '' ) {
 101                                         $ilDisplayTextMsg = wfMessage( "interlanguage-link-$ilInterwikiCode" );
 102                                         if ( !$ilDisplayTextMsg->isDisabled() ) {
 103                                                 // Use custom MW message for the display text
 104                                                 $ilLangName = $ilDisplayTextMsg->text();
 105                                         } else {
 106                                                 // Last resort: fallback to the language link target
 107                                                 $ilLangName = $languageLinkText;
 108                                         }
 109                                 } else {
 110                                         // Use the language autonym as display text
 111                                         $ilLangName = $this->formatLanguageName( $ilLangName );
 112                                 }
 113
 114                                 // CLDR extension or similar is required to localize the language name;
 115                                 // otherwise we'll end up with the autonym again.
 116                                 $ilLangLocalName = Language::fetchLanguageName(
 117                                         $ilInterwikiCode,
 118                                         $userLang->getCode()
 119                                 );
 120
 121                                 $languageLinkTitleText = $languageLinkTitle->getText();
 122                                 if ( $ilLangLocalName === '' ) {
 123                                         $ilFriendlySiteName = wfMessage( "interlanguage-link-sitename-$ilInterwikiCode" );
 124                                         if ( !$ilFriendlySiteName->isDisabled() ) {
 125                                                 if ( $languageLinkTitleText === '' ) {
 126                                                         $ilTitle = wfMessage(
 127                                                                 'interlanguage-link-title-nonlangonly',
 128                                                                 $ilFriendlySiteName->text()
 129                                                         )->text();
 130                                                 } else {
 131                                                         $ilTitle = wfMessage(
 132                                                                 'interlanguage-link-title-nonlang',
 133                                                                 $languageLinkTitleText,
 134                                                                 $ilFriendlySiteName->text()
 135                                                         )->text();
 136                                                 }
 137                                         } else {
 138                                                 // we have nothing friendly to put in the title, so fall back to
 139                                                 // displaying the interlanguage link itself in the title text
 140                                                 // (similar to what is done in page content)
 141                                                 $ilTitle = $languageLinkTitle->getInterwiki() .
 142                                                         ":$languageLinkTitleText";
 143                                         }
 144                                 } elseif ( $languageLinkTitleText === '' ) {
 145                                         $ilTitle = wfMessage(
 146                                                 'interlanguage-link-title-langonly',
 147                                                 $ilLangLocalName
 148                                         )->text();
 149                                 } else {
 150                                         $ilTitle = wfMessage(
 151                                                 'interlanguage-link-title',
 152                                                 $languageLinkTitleText,
 153                                                 $ilLangLocalName
 154                                         )->text();
 155                                 }
 156
 157                                 $ilInterwikiCodeBCP47 = wfBCP47( $ilInterwikiCode );
 158                                 $languageLink = array(
 159                                         'href' => $languageLinkTitle->getFullURL(),
 160                                         'text' => $ilLangName,
 161                                         'title' => $ilTitle,
 162                                         'class' => $class,
 163                                         'lang' => $ilInterwikiCodeBCP47,
 164                                         'hreflang' => $ilInterwikiCodeBCP47,
 165                                 );
 166                                 wfRunHooks(
 167                                         'SkinTemplateGetLanguageLink',
 168                                         array( &$languageLink, $languageLinkTitle, $this->getTitle(), $this->getOutput() )
 169                                 );
 170                                 $languageLinks[] = $languageLink;
 171                         }
 172                 }
 173
 174                 return $languageLinks;
 175         }
 176
 177         protected function setupTemplateForOutput() {
 178                 wfProfileIn( __METHOD__ );
 179
 180                 $request = $this->getRequest();
 181                 $user = $this->getUser();
 182                 $title = $this->getTitle();
 183
 184                 wfProfileIn( __METHOD__ . '-init' );
 185                 $tpl = $this->setupTemplate( $this->template, 'skins' );
 186                 wfProfileOut( __METHOD__ . '-init' );
 187
 188                 wfProfileIn( __METHOD__ . '-stuff' );
 189                 $this->thispage = $title->getPrefixedDBkey();
 190                 $this->titletxt = $title->getPrefixedText();
 191                 $this->userpage = $user->getUserPage()->getPrefixedText();
 192                 $query = array();
 193                 if ( !$request->wasPosted() ) {
 194                         $query = $request->getValues();
 195                         unset( $query['title'] );
 196                         unset( $query['returnto'] );
 197                         unset( $query['returntoquery'] );
 198                 }
 199                 $this->thisquery = wfArrayToCgi( $query );
 200                 $this->loggedin = $user->isLoggedIn();
 201                 $this->username = $user->getName();
 202
 203                 if ( $this->loggedin || $this->showIPinHeader() ) {
 204                         $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
 205                 } else {
 206                         # This won't be used in the standard skins, but we define it to preserve the interface
 207                         # To save time, we check for existence
 208                         $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
 209                 }
 210
 211                 wfProfileOut( __METHOD__ . '-stuff' );
 212
 213                 wfProfileOut( __METHOD__ );
 214
 215                 return $tpl;
 216         }
 217
 218         /**
 219          * initialize various variables and generate the template
 220          *
 221          * @param OutputPage $out
 222          */
 223         function outputPage( OutputPage $out = null ) {
 224                 wfProfileIn( __METHOD__ );
 225                 Profiler::instance()->setTemplated( true );
 226
 227                 $oldContext = null;
 228                 if ( $out !== null ) {
 229                         // @todo Add wfDeprecated in 1.20
 230                         $oldContext = $this->getContext();
 231                         $this->setContext( $out->getContext() );
 232                 }
 233
 234                 $out = $this->getOutput();
 235
 236                 wfProfileIn( __METHOD__ . '-init' );
 237                 $this->initPage( $out );
 238                 wfProfileOut( __METHOD__ . '-init' );
 239                 $tpl = $this->prepareQuickTemplate( $out );
 240                 // execute template
 241                 wfProfileIn( __METHOD__ . '-execute' );
 242                 $res = $tpl->execute();
 243                 wfProfileOut( __METHOD__ . '-execute' );
 244
 245                 // result may be an error
 246                 $this->printOrError( $res );
 247
 248                 if ( $oldContext ) {
 249                         $this->setContext( $oldContext );
 250                 }
 251
 252                 wfProfileOut( __METHOD__ );
 253         }
 254
 255         /**
 256          * initialize various variables and generate the template
 257          *
 258          * @since 1.23
 259          * @return QuickTemplate The template to be executed by outputPage
 260          */
 261         protected function prepareQuickTemplate() {
 262                 global $wgContLang, $wgScript, $wgStylePath, $wgMimeType, $wgJsMimeType,
 263                         $wgDisableCounters, $wgSitename, $wgLogo, $wgMaxCredits,
 264                         $wgShowCreditsIfMax, $wgPageShowWatchingUsers, $wgArticlePath,
 265                         $wgScriptPath, $wgServer;
 266
 267                 wfProfileIn( __METHOD__ );
 268
 269                 $title = $this->getTitle();
 270                 $request = $this->getRequest();
 271                 $out = $this->getOutput();
 272                 $tpl = $this->setupTemplateForOutput();
 273
 274                 wfProfileIn( __METHOD__ . '-stuff2' );
 275                 $tpl->set( 'title', $out->getPageTitle() );
 276                 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
 277                 $tpl->set( 'displaytitle', $out->mPageLinkTitle );
 278
 279                 $tpl->setRef( 'thispage', $this->thispage );
 280                 $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
 281                 $tpl->set( 'titletext', $title->getText() );
 282                 $tpl->set( 'articleid', $title->getArticleID() );
 283
 284                 $tpl->set( 'isarticle', $out->isArticle() );
 285
 286                 $subpagestr = $this->subPageSubtitle();
 287                 if ( $subpagestr !== '' ) {
 288                         $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
 289                 }
 290                 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
 291
 292                 $undelete = $this->getUndeleteLink();
 293                 if ( $undelete === '' ) {
 294                         $tpl->set( 'undelete', '' );
 295                 } else {
 296                         $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
 297                 }
 298
 299                 $tpl->set( 'catlinks', $this->getCategories() );
 300                 if ( $out->isSyndicated() ) {
 301                         $feeds = array();
 302                         foreach ( $out->getSyndicationLinks() as $format => $link ) {
 303                                 $feeds[$format] = array(
 304                                         // Messages: feed-atom, feed-rss
 305                                         'text' => $this->msg( "feed-$format" )->text(),
 306                                         'href' => $link
 307                                 );
 308                         }
 309                         $tpl->setRef( 'feeds', $feeds );
 310                 } else {
 311                         $tpl->set( 'feeds', false );
 312                 }
 313
 314                 $tpl->setRef( 'mimetype', $wgMimeType );
 315                 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
 316                 $tpl->set( 'charset', 'UTF-8' );
 317                 $tpl->setRef( 'wgScript', $wgScript );
 318                 $tpl->setRef( 'skinname', $this->skinname );
 319                 $tpl->set( 'skinclass', get_class( $this ) );
 320                 $tpl->setRef( 'skin', $this );
 321                 $tpl->setRef( 'stylename', $this->stylename );
 322                 $tpl->set( 'printable', $out->isPrintable() );
 323                 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
 324                 $tpl->setRef( 'loggedin', $this->loggedin );
 325                 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
 326                 $tpl->set( 'searchaction', $this->escapeSearchLink() );
 327                 $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
 328                 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
 329                 $tpl->setRef( 'stylepath', $wgStylePath );
 330                 $tpl->setRef( 'articlepath', $wgArticlePath );
 331                 $tpl->setRef( 'scriptpath', $wgScriptPath );
 332                 $tpl->setRef( 'serverurl', $wgServer );
 333                 $tpl->setRef( 'logopath', $wgLogo );
 334                 $tpl->setRef( 'sitename', $wgSitename );
 335
 336                 $userLang = $this->getLanguage();
 337                 $userLangCode = $userLang->getHtmlCode();
 338                 $userLangDir = $userLang->getDir();
 339
 340                 $tpl->set( 'lang', $userLangCode );
 341                 $tpl->set( 'dir', $userLangDir );
 342                 $tpl->set( 'rtl', $userLang->isRTL() );
 343
 344                 $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
 345                 $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
 346                 $tpl->set( 'username', $this->loggedin ? $this->username : null );
 347                 $tpl->setRef( 'userpage', $this->userpage );
 348                 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
 349                 $tpl->set( 'userlang', $userLangCode );
 350
 351                 // Users can have their language set differently than the
 352                 // content of the wiki. For these users, tell the web browser
 353                 // that interface elements are in a different language.
 354                 $tpl->set( 'userlangattributes', '' );
 355                 $tpl->set( 'specialpageattributes', '' ); # obsolete
 356                 // Used by VectorBeta to insert HTML before content but after the
 357                 // heading for the page title. Defaults to empty string.
 358                 $tpl->set( 'prebodyhtml', '' );
 359
 360                 if ( $userLangCode !== $wgContLang->getHtmlCode() || $userLangDir !== $wgContLang->getDir() ) {
 361                         $escUserlang = htmlspecialchars( $userLangCode );
 362                         $escUserdir = htmlspecialchars( $userLangDir );
 363                         // Attributes must be in double quotes because htmlspecialchars() doesn't
 364                         // escape single quotes
 365                         $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
 366                         $tpl->set( 'userlangattributes', $attrs );
 367                 }
 368
 369                 wfProfileOut( __METHOD__ . '-stuff2' );
 370
 371                 wfProfileIn( __METHOD__ . '-stuff3' );
 372                 $tpl->set( 'newtalk', $this->getNewtalks() );
 373                 $tpl->set( 'logo', $this->logoText() );
 374
 375                 $tpl->set( 'copyright', false );
 376                 $tpl->set( 'viewcount', false );
 377                 $tpl->set( 'lastmod', false );
 378                 $tpl->set( 'credits', false );
 379                 $tpl->set( 'numberofwatchingusers', false );
 380                 if ( $out->isArticle() && $title->exists() ) {
 381                         if ( $this->isRevisionCurrent() ) {
 382                                 if ( !$wgDisableCounters ) {
 383                                         $viewcount = $this->getWikiPage()->getCount();
 384                                         if ( $viewcount ) {
 385                                                 $tpl->set( 'viewcount', $this->msg( 'viewcount' )->numParams( $viewcount )->parse() );
 386                                         }
 387                                 }
 388
 389                                 if ( $wgPageShowWatchingUsers ) {
 390                                         $dbr = wfGetDB( DB_SLAVE );
 391                                         $num = $dbr->selectField( 'watchlist', 'COUNT(*)',
 392                                                 array( 'wl_title' => $title->getDBkey(), 'wl_namespace' => $title->getNamespace() ),
 393                                                 __METHOD__
 394                                         );
 395                                         if ( $num > 0 ) {
 396                                                 $tpl->set( 'numberofwatchingusers',
 397                                                         $this->msg( 'number_of_watching_users_pageview' )->numParams( $num )->parse()
 398                                                 );
 399                                         }
 400                                 }
 401
 402                                 if ( $wgMaxCredits != 0 ) {
 403                                         $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
 404                                                 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
 405                                 } else {
 406                                         $tpl->set( 'lastmod', $this->lastModified() );
 407                                 }
 408                         }
 409                         $tpl->set( 'copyright', $this->getCopyright() );
 410                 }
 411                 wfProfileOut( __METHOD__ . '-stuff3' );
 412
 413                 wfProfileIn( __METHOD__ . '-stuff4' );
 414                 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
 415                 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
 416                 $tpl->set( 'disclaimer', $this->disclaimerLink() );
 417                 $tpl->set( 'privacy', $this->privacyLink() );
 418                 $tpl->set( 'about', $this->aboutLink() );
 419
 420                 $tpl->set( 'footerlinks', array(
 421                         'info' => array(
 422                                 'lastmod',
 423                                 'viewcount',
 424                                 'numberofwatchingusers',
 425                                 'credits',
 426                                 'copyright',
 427                         ),
 428                         'places' => array(
 429                                 'privacy',
 430                                 'about',
 431                                 'disclaimer',
 432                         ),
 433                 ) );
 434
 435                 global $wgFooterIcons;
 436                 $tpl->set( 'footericons', $wgFooterIcons );
 437                 foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
 438                         if ( count( $footerIconsBlock ) > 0 ) {
 439                                 foreach ( $footerIconsBlock as &$footerIcon ) {
 440                                         if ( isset( $footerIcon['src'] ) ) {
 441                                                 if ( !isset( $footerIcon['width'] ) ) {
 442                                                         $footerIcon['width'] = 88;
 443                                                 }
 444                                                 if ( !isset( $footerIcon['height'] ) ) {
 445                                                         $footerIcon['height'] = 31;
 446                                                 }
 447                                         }
 448                                 }
 449                         } else {
 450                                 unset( $tpl->data['footericons'][$footerIconsKey] );
 451                         }
 452                 }
 453
 454                 $tpl->set( 'sitenotice', $this->getSiteNotice() );
 455                 $tpl->set( 'bottomscripts', $this->bottomScripts() );
 456                 $tpl->set( 'printfooter', $this->printSource() );
 457
 458                 # An ID that includes the actual body text; without categories, contentSub, ...
 459                 $realBodyAttribs = array( 'id' => 'mw-content-text' );
 460
 461                 # Add a mw-content-ltr/rtl class to be able to style based on text direction
 462                 # when the content is different from the UI language, i.e.:
 463                 # not for special pages or file pages AND only when viewing AND if the page exists
 464                 # (or is in MW namespace, because that has default content)
 465                 if ( !in_array( $title->getNamespace(), array( NS_SPECIAL, NS_FILE ) ) &&
 466                         Action::getActionName( $this ) === 'view' &&
 467                         ( $title->exists() || $title->getNamespace() == NS_MEDIAWIKI ) ) {
 468                         $pageLang = $title->getPageViewLanguage();
 469                         $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
 470                         $realBodyAttribs['dir'] = $pageLang->getDir();
 471                         $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
 472                 }
 473
 474                 $out->mBodytext = Html::rawElement( 'div', $realBodyAttribs, $out->mBodytext );
 475                 $tpl->setRef( 'bodytext', $out->mBodytext );
 476
 477                 $language_urls = $this->getLanguages();
 478                 if ( count( $language_urls ) ) {
 479                         $tpl->setRef( 'language_urls', $language_urls );
 480                 } else {
 481                         $tpl->set( 'language_urls', false );
 482                 }
 483                 wfProfileOut( __METHOD__ . '-stuff4' );
 484
 485                 wfProfileIn( __METHOD__ . '-stuff5' );
 486                 # Personal toolbar
 487                 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
 488                 $content_navigation = $this->buildContentNavigationUrls();
 489                 $content_actions = $this->buildContentActionUrls( $content_navigation );
 490                 $tpl->setRef( 'content_navigation', $content_navigation );
 491                 $tpl->setRef( 'content_actions', $content_actions );
 492
 493                 $tpl->set( 'sidebar', $this->buildSidebar() );
 494                 $tpl->set( 'nav_urls', $this->buildNavUrls() );
 495
 496                 // Set the head scripts near the end, in case the above actions resulted in added scripts
 497                 $tpl->set( 'headelement', $out->headElement( $this ) );
 498
 499                 $tpl->set( 'debug', '' );
 500                 $tpl->set( 'debughtml', $this->generateDebugHTML() );
 501                 $tpl->set( 'reporttime', wfReportTime() );
 502
 503                 // original version by hansm
 504                 if ( !wfRunHooks( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
 505                         wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
 506                 }
 507
 508                 // Set the bodytext to another key so that skins can just output it on it's own
 509                 // and output printfooter and debughtml separately
 510                 $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
 511
 512                 // Append printfooter and debughtml onto bodytext so that skins that
 513                 // were already using bodytext before they were split out don't suddenly
 514                 // start not outputting information.
 515                 $tpl->data['bodytext'] .= Html::rawElement(
 516                         'div',
 517                         array( 'class' => 'printfooter' ),
 518                         "\n{$tpl->data['printfooter']}"
 519                 ) . "\n";
 520                 $tpl->data['bodytext'] .= $tpl->data['debughtml'];
 521
 522                 // allow extensions adding stuff after the page content.
 523                 // See Skin::afterContentHook() for further documentation.
 524                 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
 525                 wfProfileOut( __METHOD__ . '-stuff5' );
 526
 527                 wfProfileOut( __METHOD__ );
 528                 return $tpl;
 529         }
 530
 531         /**
 532          * Get the HTML for the p-personal list
 533          * @return string
 534          */
 535         public function getPersonalToolsList() {
 536                 $tpl = $this->setupTemplateForOutput();
 537                 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
 538                 $html = '';
 539                 foreach ( $tpl->getPersonalTools() as $key => $item ) {
 540                         $html .= $tpl->makeListItem( $key, $item );
 541                 }
 542                 return $html;
 543         }
 544
 545         /**
 546          * Format language name for use in sidebar interlanguage links list.
 547          * By default it is capitalized.
 548          *
 549          * @param string $name Language name, e.g. "English" or "español"
 550          * @return string
 551          * @private
 552          */
 553         function formatLanguageName( $name ) {
 554                 return $this->getLanguage()->ucfirst( $name );
 555         }
 556
 557         /**
 558          * Output the string, or print error message if it's
 559          * an error object of the appropriate type.
 560          * For the base class, assume strings all around.
 561          *
 562          * @param string $str
 563          * @private
 564          */
 565         function printOrError( $str ) {
 566                 echo $str;
 567         }
 568
 569         /**
 570          * Output a boolean indicating if buildPersonalUrls should output separate
 571          * login and create account links or output a combined link
 572          * By default we simply return a global config setting that affects most skins
 573          * This is setup as a method so that like with $wgLogo and getLogo() a skin
 574          * can override this setting and always output one or the other if it has
 575          * a reason it can't output one of the two modes.
 576          * @return bool
 577          */
 578         function useCombinedLoginLink() {
 579                 global $wgUseCombinedLoginLink;
 580                 return $wgUseCombinedLoginLink;
 581         }
 582
 583         /**
 584          * build array of urls for personal toolbar
 585          * @return array
 586          */
 587         protected function buildPersonalUrls() {
 588                 $title = $this->getTitle();
 589                 $request = $this->getRequest();
 590                 $pageurl = $title->getLocalURL();
 591                 wfProfileIn( __METHOD__ );
 592
 593                 /* set up the default links for the personal toolbar */
 594                 $personal_urls = array();
 595
 596                 # Due to bug 32276, if a user does not have read permissions,
 597                 # $this->getTitle() will just give Special:Badtitle, which is
 598                 # not especially useful as a returnto parameter. Use the title
 599                 # from the request instead, if there was one.
 600                 if ( $this->getUser()->isAllowed( 'read' ) ) {
 601                         $page = $this->getTitle();
 602                 } else {
 603                         $page = Title::newFromText( $request->getVal( 'title', '' ) );
 604                 }
 605                 $page = $request->getVal( 'returnto', $page );
 606                 $a = array();
 607                 if ( strval( $page ) !== '' ) {
 608                         $a['returnto'] = $page;
 609                         $query = $request->getVal( 'returntoquery', $this->thisquery );
 610                         if ( $query != '' ) {
 611                                 $a['returntoquery'] = $query;
 612                         }
 613                 }
 614
 615                 $returnto = wfArrayToCgi( $a );
 616                 if ( $this->loggedin ) {
 617                         $personal_urls['userpage'] = array(
 618                                 'text' => $this->username,
 619                                 'href' => &$this->userpageUrlDetails['href'],
 620                                 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 621                                 'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
 622                                 'dir' => 'auto'
 623                         );
 624                         $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 625                         $personal_urls['mytalk'] = array(
 626                                 'text' => $this->msg( 'mytalk' )->text(),
 627                                 'href' => &$usertalkUrlDetails['href'],
 628                                 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 629                                 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
 630                         );
 631                         $href = self::makeSpecialUrl( 'Preferences' );
 632                         $personal_urls['preferences'] = array(
 633                                 'text' => $this->msg( 'mypreferences' )->text(),
 634                                 'href' => $href,
 635                                 'active' => ( $href == $pageurl )
 636                         );
 637
 638                         if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
 639                                 $href = self::makeSpecialUrl( 'Watchlist' );
 640                                 $personal_urls['watchlist'] = array(
 641                                         'text' => $this->msg( 'mywatchlist' )->text(),
 642                                         'href' => $href,
 643                                         'active' => ( $href == $pageurl )
 644                                 );
 645                         }
 646
 647                         # We need to do an explicit check for Special:Contributions, as we
 648                         # have to match both the title, and the target, which could come
 649                         # from request values (Special:Contributions?target=Jimbo_Wales)
 650                         # or be specified in "sub page" form
 651                         # (Special:Contributions/Jimbo_Wales). The plot
 652                         # thickens, because the Title object is altered for special pages,
 653                         # so it doesn't contain the original alias-with-subpage.
 654                         $origTitle = Title::newFromText( $request->getText( 'title' ) );
 655                         if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
 656                                 list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
 657                                 $active = $spName == 'Contributions'
 658                                         && ( ( $spPar && $spPar == $this->username )
 659                                                 || $request->getText( 'target' ) == $this->username );
 660                         } else {
 661                                 $active = false;
 662                         }
 663
 664                         $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
 665                         $personal_urls['mycontris'] = array(
 666                                 'text' => $this->msg( 'mycontris' )->text(),
 667                                 'href' => $href,
 668                                 'active' => $active
 669                         );
 670                         $personal_urls['logout'] = array(
 671                                 'text' => $this->msg( 'pt-userlogout' )->text(),
 672                                 'href' => self::makeSpecialUrl( 'Userlogout',
 673                                         // userlogout link must always contain an & character, otherwise we might not be able
 674                                         // to detect a buggy precaching proxy (bug 17790)
 675                                         $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto
 676                                 ),
 677                                 'active' => false
 678                         );
 679                 } else {
 680                         $useCombinedLoginLink = $this->useCombinedLoginLink();
 681                         $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
 682                                 ? 'nav-login-createaccount'
 683                                 : 'pt-login';
 684                         $is_signup = $request->getText( 'type' ) == 'signup';
 685
 686                         $login_url = array(
 687                                 'text' => $this->msg( $loginlink )->text(),
 688                                 'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
 689                                 'active' => $title->isSpecial( 'Userlogin' )
 690                                         && ( $loginlink == 'nav-login-createaccount' || !$is_signup ),
 691                         );
 692                         $createaccount_url = array(
 693                                 'text' => $this->msg( 'pt-createaccount' )->text(),
 694                                 'href' => self::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
 695                                 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup,
 696                         );
 697
 698                         if ( $this->showIPinHeader() ) {
 699                                 $href = &$this->userpageUrlDetails['href'];
 700                                 $personal_urls['anonuserpage'] = array(
 701                                         'text' => $this->username,
 702                                         'href' => $href,
 703                                         'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 704                                         'active' => ( $pageurl == $href )
 705                                 );
 706                                 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 707                                 $href = &$usertalkUrlDetails['href'];
 708                                 $personal_urls['anontalk'] = array(
 709                                         'text' => $this->msg( 'anontalk' )->text(),
 710                                         'href' => $href,
 711                                         'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 712                                         'active' => ( $pageurl == $href )
 713                                 );
 714                         }
 715
 716                         if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
 717                                 $personal_urls['createaccount'] = $createaccount_url;
 718                         }
 719
 720                         $personal_urls['login'] = $login_url;
 721                 }
 722
 723                 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title, $this ) );
 724                 wfProfileOut( __METHOD__ );
 725                 return $personal_urls;
 726         }
 727
 728         /**
 729          * Builds an array with tab definition
 730          *
 731          * @param Title $title Page Where the tab links to
 732          * @param string|array $message Message key or an array of message keys (will fall back)
 733          * @param bool $selected Display the tab as selected
 734          * @param string $query Query string attached to tab URL
 735          * @param bool $checkEdit Check if $title exists and mark with .new if one doesn't
 736          *
 737          * @return array
 738          */
 739         function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
 740                 $classes = array();
 741                 if ( $selected ) {
 742                         $classes[] = 'selected';
 743                 }
 744                 if ( $checkEdit && !$title->isKnown() ) {
 745                         $classes[] = 'new';
 746                         if ( $query !== '' ) {
 747                                 $query = 'action=edit&redlink=1&' . $query;
 748                         } else {
 749                                 $query = 'action=edit&redlink=1';
 750                         }
 751                 }
 752
 753                 // wfMessageFallback will nicely accept $message as an array of fallbacks
 754                 // or just a single key
 755                 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
 756                 if ( is_array( $message ) ) {
 757                         // for hook compatibility just keep the last message name
 758                         $message = end( $message );
 759                 }
 760                 if ( $msg->exists() ) {
 761                         $text = $msg->text();
 762                 } else {
 763                         global $wgContLang;
 764                         $text = $wgContLang->getFormattedNsText(
 765                                 MWNamespace::getSubject( $title->getNamespace() ) );
 766                 }
 767
 768                 $result = array();
 769                 if ( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
 770                                 $title, $message, $selected, $checkEdit,
 771                                 &$classes, &$query, &$text, &$result ) ) ) {
 772                         return $result;
 773                 }
 774
 775                 return array(
 776                         'class' => implode( ' ', $classes ),
 777                         'text' => $text,
 778                         'href' => $title->getLocalURL( $query ),
 779                         'primary' => true );
 780         }
 781
 782         function makeTalkUrlDetails( $name, $urlaction = '' ) {
 783                 $title = Title::newFromText( $name );
 784                 if ( !is_object( $title ) ) {
 785                         throw new MWException( __METHOD__ . " given invalid pagename $name" );
 786                 }
 787                 $title = $title->getTalkPage();
 788                 self::checkTitle( $title, $name );
 789                 return array(
 790                         'href' => $title->getLocalURL( $urlaction ),
 791                         'exists' => $title->getArticleID() != 0,
 792                 );
 793         }
 794
 795         function makeArticleUrlDetails( $name, $urlaction = '' ) {
 796                 $title = Title::newFromText( $name );
 797                 $title = $title->getSubjectPage();
 798                 self::checkTitle( $title, $name );
 799                 return array(
 800                         'href' => $title->getLocalURL( $urlaction ),
 801                         'exists' => $title->getArticleID() != 0,
 802                 );
 803         }
 804
 805         /**
 806          * a structured array of links usually used for the tabs in a skin
 807          *
 808          * There are 4 standard sections
 809          * namespaces: Used for namespace tabs like special, page, and talk namespaces
 810          * views: Used for primary page views like read, edit, history
 811          * actions: Used for most extra page actions like deletion, protection, etc...
 812          * variants: Used to list the language variants for the page
 813          *
 814          * Each section's value is a key/value array of links for that section.
 815          * The links themselves have these common keys:
 816          * - class: The css classes to apply to the tab
 817          * - text: The text to display on the tab
 818          * - href: The href for the tab to point to
 819          * - rel: An optional rel= for the tab's link
 820          * - redundant: If true the tab will be dropped in skins using content_actions
 821          *   this is useful for tabs like "Read" which only have meaning in skins that
 822          *   take special meaning from the grouped structure of content_navigation
 823          *
 824          * Views also have an extra key which can be used:
 825          * - primary: If this is not true skins like vector may try to hide the tab
 826          *            when the user has limited space in their browser window
 827          *
 828          * content_navigation using code also expects these ids to be present on the
 829          * links, however these are usually automatically generated by SkinTemplate
 830          * itself and are not necessary when using a hook. The only things these may
 831          * matter to are people modifying content_navigation after it's initial creation:
 832          * - id: A "preferred" id, most skins are best off outputting this preferred
 833          *   id for best compatibility.
 834          * - tooltiponly: This is set to true for some tabs in cases where the system
 835          *   believes that the accesskey should not be added to the tab.
 836          *
 837          * @return array
 838          */
 839         protected function buildContentNavigationUrls() {
 840                 global $wgDisableLangConversion;
 841
 842                 wfProfileIn( __METHOD__ );
 843
 844                 // Display tabs for the relevant title rather than always the title itself
 845                 $title = $this->getRelevantTitle();
 846                 $onPage = $title->equals( $this->getTitle() );
 847
 848                 $out = $this->getOutput();
 849                 $request = $this->getRequest();
 850                 $user = $this->getUser();
 851
 852                 $content_navigation = array(
 853                         'namespaces' => array(),
 854                         'views' => array(),
 855                         'actions' => array(),
 856                         'variants' => array()
 857                 );
 858
 859                 // parameters
 860                 $action = $request->getVal( 'action', 'view' );
 861
 862                 $userCanRead = $title->quickUserCan( 'read', $user );
 863
 864                 $preventActiveTabs = false;
 865                 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
 866
 867                 // Checks if page is some kind of content
 868                 if ( $title->canExist() ) {
 869                         // Gets page objects for the related namespaces
 870                         $subjectPage = $title->getSubjectPage();
 871                         $talkPage = $title->getTalkPage();
 872
 873                         // Determines if this is a talk page
 874                         $isTalk = $title->isTalkPage();
 875
 876                         // Generates XML IDs from namespace names
 877                         $subjectId = $title->getNamespaceKey( '' );
 878
 879                         if ( $subjectId == 'main' ) {
 880                                 $talkId = 'talk';
 881                         } else {
 882                                 $talkId = "{$subjectId}_talk";
 883                         }
 884
 885                         $skname = $this->skinname;
 886
 887                         // Adds namespace links
 888                         $subjectMsg = array( "nstab-$subjectId" );
 889                         if ( $subjectPage->isMainPage() ) {
 890                                 array_unshift( $subjectMsg, 'mainpage-nstab' );
 891                         }
 892                         $content_navigation['namespaces'][$subjectId] = $this->tabAction(
 893                                 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
 894                         );
 895                         $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
 896                         $content_navigation['namespaces'][$talkId] = $this->tabAction(
 897                                 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
 898                         );
 899                         $content_navigation['namespaces'][$talkId]['context'] = 'talk';
 900
 901                         if ( $userCanRead ) {
 902                                 $isForeignFile = $title->inNamespace( NS_FILE ) && $this->canUseWikiPage() &&
 903                                         $this->getWikiPage() instanceof WikiFilePage && !$this->getWikiPage()->isLocal();
 904
 905                                 // Adds view view link
 906                                 if ( $title->exists() || $isForeignFile ) {
 907                                         $content_navigation['views']['view'] = $this->tabAction(
 908                                                 $isTalk ? $talkPage : $subjectPage,
 909                                                 array( "$skname-view-view", 'view' ),
 910                                                 ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
 911                                         );
 912                                         // signal to hide this from simple content_actions
 913                                         $content_navigation['views']['view']['redundant'] = true;
 914                                 }
 915
 916                                 // If it is a non-local file, show a link to the file in its own repository
 917                                 if ( $isForeignFile ) {
 918                                         $file = $this->getWikiPage()->getFile();
 919                                         $content_navigation['views']['view-foreign'] = array(
 920                                                 'class' => '',
 921                                                 'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
 922                                                         setContext( $this->getContext() )->
 923                                                         params( $file->getRepo()->getDisplayName() )->text(),
 924                                                 'href' => $file->getDescriptionUrl(),
 925                                                 'primary' => false,
 926                                         );
 927                                 }
 928
 929                                 wfProfileIn( __METHOD__ . '-edit' );
 930
 931                                 // Checks if user can edit the current page if it exists or create it otherwise
 932                                 if ( $title->quickUserCan( 'edit', $user )
 933                                         && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
 934                                 ) {
 935                                         // Builds CSS class for talk page links
 936                                         $isTalkClass = $isTalk ? ' istalk' : '';
 937                                         // Whether the user is editing the page
 938                                         $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
 939                                         // Whether to show the "Add a new section" tab
 940                                         // Checks if this is a current rev of talk page and is not forced to be hidden
 941                                         $showNewSection = !$out->forceHideNewSectionLink()
 942                                                 && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
 943                                         $section = $request->getVal( 'section' );
 944
 945                                         if ( $title->exists()
 946                                                 || ( $title->getNamespace() == NS_MEDIAWIKI
 947                                                         && $title->getDefaultMessageText() !== false
 948                                                 )
 949                                         ) {
 950                                                 $msgKey = $isForeignFile ? 'edit-local' : 'edit';
 951                                         } else {
 952                                                 $msgKey = $isForeignFile ? 'create-local' : 'create';
 953                                         }
 954                                         $content_navigation['views']['edit'] = array(
 955                                                 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
 956                                                         ? 'selected'
 957                                                         : ''
 958                                                 ) . $isTalkClass,
 959                                                 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
 960                                                         ->setContext( $this->getContext() )->text(),
 961                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 962                                                 'primary' => !$isForeignFile, // don't collapse this in vector
 963                                         );
 964
 965                                         // section link
 966                                         if ( $showNewSection ) {
 967                                                 // Adds new section link
 968                                                 //$content_navigation['actions']['addsection']
 969                                                 $content_navigation['views']['addsection'] = array(
 970                                                         'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
 971                                                         'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
 972                                                                 ->setContext( $this->getContext() )->text(),
 973                                                         'href' => $title->getLocalURL( 'action=edit&section=new' )
 974                                                 );
 975                                         }
 976                                 // Checks if the page has some kind of viewable content
 977                                 } elseif ( $title->hasSourceText() ) {
 978                                         // Adds view source view link
 979                                         $content_navigation['views']['viewsource'] = array(
 980                                                 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
 981                                                 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
 982                                                         ->setContext( $this->getContext() )->text(),
 983                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 984                                                 'primary' => true, // don't collapse this in vector
 985                                         );
 986                                 }
 987                                 wfProfileOut( __METHOD__ . '-edit' );
 988
 989                                 wfProfileIn( __METHOD__ . '-live' );
 990                                 // Checks if the page exists
 991                                 if ( $title->exists() ) {
 992                                         // Adds history view link
 993                                         $content_navigation['views']['history'] = array(
 994                                                 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
 995                                                 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
 996                                                         ->setContext( $this->getContext() )->text(),
 997                                                 'href' => $title->getLocalURL( 'action=history' ),
 998                                                 'rel' => 'archives',
 999                                         );
1000
1001                                         if ( $title->quickUserCan( 'delete', $user ) ) {
1002                                                 $content_navigation['actions']['delete'] = array(
1003                                                         'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
1004                                                         'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
1005                                                                 ->setContext( $this->getContext() )->text(),
1006                                                         'href' => $title->getLocalURL( 'action=delete' )
1007                                                 );
1008                                         }
1009
1010                                         if ( $title->quickUserCan( 'move', $user ) ) {
1011                                                 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
1012                                                 $content_navigation['actions']['move'] = array(
1013                                                         'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
1014                                                         'text' => wfMessageFallback( "$skname-action-move", 'move' )
1015                                                                 ->setContext( $this->getContext() )->text(),
1016                                                         'href' => $moveTitle->getLocalURL()
1017                                                 );
1018                                         }
1019                                 } else {
1020                                         // article doesn't exist or is deleted
1021                                         if ( $user->isAllowed( 'deletedhistory' ) ) {
1022                                                 $n = $title->isDeleted();
1023                                                 if ( $n ) {
1024                                                         $undelTitle = SpecialPage::getTitleFor( 'Undelete' );
1025                                                         // If the user can't undelete but can view deleted
1026                                                         // history show them a "View .. deleted" tab instead.
1027                                                         $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
1028                                                         $content_navigation['actions']['undelete'] = array(
1029                                                                 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1030                                                                 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1031                                                                         ->setContext( $this->getContext() )->numParams( $n )->text(),
1032                                                                 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
1033                                                         );
1034                                                 }
1035                                         }
1036                                 }
1037
1038                                 if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1039                                         MWNamespace::getRestrictionLevels( $title->getNamespace(), $user ) !== array( '' )
1040                                 ) {
1041                                         $mode = $title->isProtected() ? 'unprotect' : 'protect';
1042                                         $content_navigation['actions'][$mode] = array(
1043                                                 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1044                                                 'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1045                                                         ->setContext( $this->getContext() )->text(),
1046                                                 'href' => $title->getLocalURL( "action=$mode" )
1047                                         );
1048                                 }
1049
1050                                 wfProfileOut( __METHOD__ . '-live' );
1051
1052                                 // Checks if the user is logged in
1053                                 if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1054                                         /**
1055                                          * The following actions use messages which, if made particular to
1056                                          * the any specific skins, would break the Ajax code which makes this
1057                                          * action happen entirely inline. OutputPage::getJSVars
1058                                          * defines a set of messages in a javascript object - and these
1059                                          * messages are assumed to be global for all skins. Without making
1060                                          * a change to that procedure these messages will have to remain as
1061                                          * the global versions.
1062                                          */
1063                                         $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1064                                         $token = WatchAction::getWatchToken( $title, $user, $mode );
1065                                         $content_navigation['actions'][$mode] = array(
1066                                                 'class' => $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : false,
1067                                                 // uses 'watch' or 'unwatch' message
1068                                                 'text' => $this->msg( $mode )->text(),
1069                                                 'href' => $title->getLocalURL( array( 'action' => $mode, 'token' => $token ) )
1070                                         );
1071                                 }
1072                         }
1073
1074                         wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
1075
1076                         if ( $userCanRead && !$wgDisableLangConversion ) {
1077                                 $pageLang = $title->getPageLanguage();
1078                                 // Gets list of language variants
1079                                 $variants = $pageLang->getVariants();
1080                                 // Checks that language conversion is enabled and variants exist
1081                                 // And if it is not in the special namespace
1082                                 if ( count( $variants ) > 1 ) {
1083                                         // Gets preferred variant (note that user preference is
1084                                         // only possible for wiki content language variant)
1085                                         $preferred = $pageLang->getPreferredVariant();
1086                                         if ( Action::getActionName( $this ) === 'view' ) {
1087                                                 $params = $request->getQueryValues();
1088                                                 unset( $params['title'] );
1089                                         } else {
1090                                                 $params = array();
1091                                         }
1092                                         // Loops over each variant
1093                                         foreach ( $variants as $code ) {
1094                                                 // Gets variant name from language code
1095                                                 $varname = $pageLang->getVariantname( $code );
1096                                                 // Appends variant link
1097                                                 $content_navigation['variants'][] = array(
1098                                                         'class' => ( $code == $preferred ) ? 'selected' : false,
1099                                                         'text' => $varname,
1100                                                         'href' => $title->getLocalURL( array( 'variant' => $code ) + $params ),
1101                                                         'lang' => wfBCP47( $code ),
1102                                                         'hreflang' => wfBCP47( $code ),
1103                                                 );
1104                                         }
1105                                 }
1106                         }
1107                 } else {
1108                         // If it's not content, it's got to be a special page
1109                         $content_navigation['namespaces']['special'] = array(
1110                                 'class' => 'selected',
1111                                 'text' => $this->msg( 'nstab-special' )->text(),
1112                                 'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1113                                 'context' => 'subject'
1114                         );
1115
1116                         wfRunHooks( 'SkinTemplateNavigation::SpecialPage',
1117                                 array( &$this, &$content_navigation ) );
1118                 }
1119
1120                 // Equiv to SkinTemplateContentActions
1121                 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1122
1123                 // Setup xml ids and tooltip info
1124                 foreach ( $content_navigation as $section => &$links ) {
1125                         foreach ( $links as $key => &$link ) {
1126                                 $xmlID = $key;
1127                                 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1128                                         $xmlID = 'ca-nstab-' . $xmlID;
1129                                 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1130                                         $xmlID = 'ca-talk';
1131                                 } elseif ( $section == 'variants' ) {
1132                                         $xmlID = 'ca-varlang-' . $xmlID;
1133                                 } else {
1134                                         $xmlID = 'ca-' . $xmlID;
1135                                 }
1136                                 $link['id'] = $xmlID;
1137                         }
1138                 }
1139
1140                 # We don't want to give the watch tab an accesskey if the
1141                 # page is being edited, because that conflicts with the
1142                 # accesskey on the watch checkbox.  We also don't want to
1143                 # give the edit tab an accesskey, because that's fairly
1144                 # superfluous and conflicts with an accesskey (Ctrl-E) often
1145                 # used for editing in Safari.
1146                 if ( in_array( $action, array( 'edit', 'submit' ) ) ) {
1147                         if ( isset( $content_navigation['views']['edit'] ) ) {
1148                                 $content_navigation['views']['edit']['tooltiponly'] = true;
1149                         }
1150                         if ( isset( $content_navigation['actions']['watch'] ) ) {
1151                                 $content_navigation['actions']['watch']['tooltiponly'] = true;
1152                         }
1153                         if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1154                                 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1155                         }
1156                 }
1157
1158                 wfProfileOut( __METHOD__ );
1159
1160                 return $content_navigation;
1161         }
1162
1163         /**
1164          * an array of edit links by default used for the tabs
1165          * @param array $content_navigation
1166          * @return array
1167          */
1168         private function buildContentActionUrls( $content_navigation ) {
1169
1170                 wfProfileIn( __METHOD__ );
1171
1172                 // content_actions has been replaced with content_navigation for backwards
1173                 // compatibility and also for skins that just want simple tabs content_actions
1174                 // is now built by flattening the content_navigation arrays into one
1175
1176                 $content_actions = array();
1177
1178                 foreach ( $content_navigation as $links ) {
1179                         foreach ( $links as $key => $value ) {
1180                                 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1181                                         // Redundant tabs are dropped from content_actions
1182                                         continue;
1183                                 }
1184
1185                                 // content_actions used to have ids built using the "ca-$key" pattern
1186                                 // so the xmlID based id is much closer to the actual $key that we want
1187                                 // for that reason we'll just strip out the ca- if present and use
1188                                 // the latter potion of the "id" as the $key
1189                                 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1190                                         $key = substr( $value['id'], 3 );
1191                                 }
1192
1193                                 if ( isset( $content_actions[$key] ) ) {
1194                                         wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1195                                                 "content_navigation into content_actions.\n" );
1196                                         continue;
1197                                 }
1198
1199                                 $content_actions[$key] = $value;
1200                         }
1201                 }
1202
1203                 wfProfileOut( __METHOD__ );
1204
1205                 return $content_actions;
1206         }
1207
1208         /**
1209          * build array of common navigation links
1210          * @return array
1211          */
1212         protected function buildNavUrls() {
1213                 global $wgUploadNavigationUrl;
1214
1215                 wfProfileIn( __METHOD__ );
1216
1217                 $out = $this->getOutput();
1218                 $request = $this->getRequest();
1219
1220                 $nav_urls = array();
1221                 $nav_urls['mainpage'] = array( 'href' => self::makeMainPageUrl() );
1222                 if ( $wgUploadNavigationUrl ) {
1223                         $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1224                 } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1225                         $nav_urls['upload'] = array( 'href' => self::makeSpecialUrl( 'Upload' ) );
1226                 } else {
1227                         $nav_urls['upload'] = false;
1228                 }
1229                 $nav_urls['specialpages'] = array( 'href' => self::makeSpecialUrl( 'Specialpages' ) );
1230
1231                 $nav_urls['print'] = false;
1232                 $nav_urls['permalink'] = false;
1233                 $nav_urls['info'] = false;
1234                 $nav_urls['whatlinkshere'] = false;
1235                 $nav_urls['recentchangeslinked'] = false;
1236                 $nav_urls['contributions'] = false;
1237                 $nav_urls['log'] = false;
1238                 $nav_urls['blockip'] = false;
1239                 $nav_urls['emailuser'] = false;
1240                 $nav_urls['userrights'] = false;
1241
1242                 // A print stylesheet is attached to all pages, but nobody ever
1243                 // figures that out. :)  Add a link...
1244                 if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1245                         $nav_urls['print'] = array(
1246                                 'text' => $this->msg( 'printableversion' )->text(),
1247                                 'href' => $this->getTitle()->getLocalURL(
1248                                         $request->appendQueryValue( 'printable', 'yes', true ) )
1249                         );
1250                 }
1251
1252                 if ( $out->isArticle() ) {
1253                         // Also add a "permalink" while we're at it
1254                         $revid = $this->getRevisionId();
1255                         if ( $revid ) {
1256                                 $nav_urls['permalink'] = array(
1257                                         'text' => $this->msg( 'permalink' )->text(),
1258                                         'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1259                                 );
1260                         }
1261
1262                         // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1263                         wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1264                                 array( &$this, &$nav_urls, &$revid, &$revid ) );
1265                 }
1266
1267                 if ( $out->isArticleRelated() ) {
1268                         $nav_urls['whatlinkshere'] = array(
1269                                 'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1270                         );
1271
1272                         $nav_urls['info'] = array(
1273                                 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1274                                 'href' => $this->getTitle()->getLocalURL( "action=info" )
1275                         );
1276
1277                         if ( $this->getTitle()->getArticleID() ) {
1278                                 $nav_urls['recentchangeslinked'] = array(
1279                                         'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1280                                 );
1281                         }
1282                 }
1283
1284                 $user = $this->getRelevantUser();
1285                 if ( $user ) {
1286                         $rootUser = $user->getName();
1287
1288                         $nav_urls['contributions'] = array(
1289                                 'text' => $this->msg( 'contributions', $rootUser )->text(),
1290                                 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1291                         );
1292
1293                         $nav_urls['log'] = array(
1294                                 'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1295                         );
1296
1297                         if ( $this->getUser()->isAllowed( 'block' ) ) {
1298                                 $nav_urls['blockip'] = array(
1299                                         'text' => $this->msg( 'blockip', $rootUser )->text(),
1300                                         'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1301                                 );
1302                         }
1303
1304                         if ( $this->showEmailUser( $user ) ) {
1305                                 $nav_urls['emailuser'] = array(
1306                                         'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1307                                 );
1308                         }
1309
1310                         if ( !$user->isAnon() ) {
1311                                 $sur = new UserrightsPage;
1312                                 $sur->setContext( $this->getContext() );
1313                                 if ( $sur->userCanExecute( $this->getUser() ) ) {
1314                                         $nav_urls['userrights'] = array(
1315                                                 'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1316                                         );
1317                                 }
1318                         }
1319                 }
1320
1321                 wfProfileOut( __METHOD__ );
1322                 return $nav_urls;
1323         }
1324
1325         /**
1326          * Generate strings used for xml 'id' names
1327          * @return string
1328          */
1329         protected function getNameSpaceKey() {
1330                 return $this->getTitle()->getNamespaceKey();
1331         }
1332 }