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, $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 ( $wgMaxCredits != 0 ) {
 390                                         $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
 391                                                 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
 392                                 } else {
 393                                         $tpl->set( 'lastmod', $this->lastModified() );
 394                                 }
 395                         }
 396                         $tpl->set( 'copyright', $this->getCopyright() );
 397                 }
 398                 wfProfileOut( __METHOD__ . '-stuff3' );
 399
 400                 wfProfileIn( __METHOD__ . '-stuff4' );
 401                 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
 402                 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
 403                 $tpl->set( 'disclaimer', $this->disclaimerLink() );
 404                 $tpl->set( 'privacy', $this->privacyLink() );
 405                 $tpl->set( 'about', $this->aboutLink() );
 406
 407                 $tpl->set( 'footerlinks', array(
 408                         'info' => array(
 409                                 'lastmod',
 410                                 'viewcount',
 411                                 'numberofwatchingusers',
 412                                 'credits',
 413                                 'copyright',
 414                         ),
 415                         'places' => array(
 416                                 'privacy',
 417                                 'about',
 418                                 'disclaimer',
 419                         ),
 420                 ) );
 421
 422                 global $wgFooterIcons;
 423                 $tpl->set( 'footericons', $wgFooterIcons );
 424                 foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
 425                         if ( count( $footerIconsBlock ) > 0 ) {
 426                                 foreach ( $footerIconsBlock as &$footerIcon ) {
 427                                         if ( isset( $footerIcon['src'] ) ) {
 428                                                 if ( !isset( $footerIcon['width'] ) ) {
 429                                                         $footerIcon['width'] = 88;
 430                                                 }
 431                                                 if ( !isset( $footerIcon['height'] ) ) {
 432                                                         $footerIcon['height'] = 31;
 433                                                 }
 434                                         }
 435                                 }
 436                         } else {
 437                                 unset( $tpl->data['footericons'][$footerIconsKey] );
 438                         }
 439                 }
 440
 441                 $tpl->set( 'sitenotice', $this->getSiteNotice() );
 442                 $tpl->set( 'bottomscripts', $this->bottomScripts() );
 443                 $tpl->set( 'printfooter', $this->printSource() );
 444
 445                 # An ID that includes the actual body text; without categories, contentSub, ...
 446                 $realBodyAttribs = array( 'id' => 'mw-content-text' );
 447
 448                 # Add a mw-content-ltr/rtl class to be able to style based on text direction
 449                 # when the content is different from the UI language, i.e.:
 450                 # not for special pages or file pages AND only when viewing AND if the page exists
 451                 # (or is in MW namespace, because that has default content)
 452                 if ( !in_array( $title->getNamespace(), array( NS_SPECIAL, NS_FILE ) ) &&
 453                         Action::getActionName( $this ) === 'view' &&
 454                         ( $title->exists() || $title->getNamespace() == NS_MEDIAWIKI ) ) {
 455                         $pageLang = $title->getPageViewLanguage();
 456                         $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
 457                         $realBodyAttribs['dir'] = $pageLang->getDir();
 458                         $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
 459                 }
 460
 461                 $out->mBodytext = Html::rawElement( 'div', $realBodyAttribs, $out->mBodytext );
 462                 $tpl->setRef( 'bodytext', $out->mBodytext );
 463
 464                 $language_urls = $this->getLanguages();
 465                 if ( count( $language_urls ) ) {
 466                         $tpl->setRef( 'language_urls', $language_urls );
 467                 } else {
 468                         $tpl->set( 'language_urls', false );
 469                 }
 470                 wfProfileOut( __METHOD__ . '-stuff4' );
 471
 472                 wfProfileIn( __METHOD__ . '-stuff5' );
 473                 # Personal toolbar
 474                 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
 475                 $content_navigation = $this->buildContentNavigationUrls();
 476                 $content_actions = $this->buildContentActionUrls( $content_navigation );
 477                 $tpl->setRef( 'content_navigation', $content_navigation );
 478                 $tpl->setRef( 'content_actions', $content_actions );
 479
 480                 $tpl->set( 'sidebar', $this->buildSidebar() );
 481                 $tpl->set( 'nav_urls', $this->buildNavUrls() );
 482
 483                 // Set the head scripts near the end, in case the above actions resulted in added scripts
 484                 $tpl->set( 'headelement', $out->headElement( $this ) );
 485
 486                 $tpl->set( 'debug', '' );
 487                 $tpl->set( 'debughtml', $this->generateDebugHTML() );
 488                 $tpl->set( 'reporttime', wfReportTime() );
 489
 490                 // original version by hansm
 491                 if ( !wfRunHooks( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
 492                         wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
 493                 }
 494
 495                 // Set the bodytext to another key so that skins can just output it on it's own
 496                 // and output printfooter and debughtml separately
 497                 $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
 498
 499                 // Append printfooter and debughtml onto bodytext so that skins that
 500                 // were already using bodytext before they were split out don't suddenly
 501                 // start not outputting information.
 502                 $tpl->data['bodytext'] .= Html::rawElement(
 503                         'div',
 504                         array( 'class' => 'printfooter' ),
 505                         "\n{$tpl->data['printfooter']}"
 506                 ) . "\n";
 507                 $tpl->data['bodytext'] .= $tpl->data['debughtml'];
 508
 509                 // allow extensions adding stuff after the page content.
 510                 // See Skin::afterContentHook() for further documentation.
 511                 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
 512                 wfProfileOut( __METHOD__ . '-stuff5' );
 513
 514                 wfProfileOut( __METHOD__ );
 515                 return $tpl;
 516         }
 517
 518         /**
 519          * Get the HTML for the p-personal list
 520          * @return string
 521          */
 522         public function getPersonalToolsList() {
 523                 $tpl = $this->setupTemplateForOutput();
 524                 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
 525                 $html = '';
 526                 foreach ( $tpl->getPersonalTools() as $key => $item ) {
 527                         $html .= $tpl->makeListItem( $key, $item );
 528                 }
 529                 return $html;
 530         }
 531
 532         /**
 533          * Format language name for use in sidebar interlanguage links list.
 534          * By default it is capitalized.
 535          *
 536          * @param string $name Language name, e.g. "English" or "español"
 537          * @return string
 538          * @private
 539          */
 540         function formatLanguageName( $name ) {
 541                 return $this->getLanguage()->ucfirst( $name );
 542         }
 543
 544         /**
 545          * Output the string, or print error message if it's
 546          * an error object of the appropriate type.
 547          * For the base class, assume strings all around.
 548          *
 549          * @param string $str
 550          * @private
 551          */
 552         function printOrError( $str ) {
 553                 echo $str;
 554         }
 555
 556         /**
 557          * Output a boolean indicating if buildPersonalUrls should output separate
 558          * login and create account links or output a combined link
 559          * By default we simply return a global config setting that affects most skins
 560          * This is setup as a method so that like with $wgLogo and getLogo() a skin
 561          * can override this setting and always output one or the other if it has
 562          * a reason it can't output one of the two modes.
 563          * @return bool
 564          */
 565         function useCombinedLoginLink() {
 566                 global $wgUseCombinedLoginLink;
 567                 return $wgUseCombinedLoginLink;
 568         }
 569
 570         /**
 571          * build array of urls for personal toolbar
 572          * @return array
 573          */
 574         protected function buildPersonalUrls() {
 575                 $title = $this->getTitle();
 576                 $request = $this->getRequest();
 577                 $pageurl = $title->getLocalURL();
 578                 wfProfileIn( __METHOD__ );
 579
 580                 /* set up the default links for the personal toolbar */
 581                 $personal_urls = array();
 582
 583                 # Due to bug 32276, if a user does not have read permissions,
 584                 # $this->getTitle() will just give Special:Badtitle, which is
 585                 # not especially useful as a returnto parameter. Use the title
 586                 # from the request instead, if there was one.
 587                 if ( $this->getUser()->isAllowed( 'read' ) ) {
 588                         $page = $this->getTitle();
 589                 } else {
 590                         $page = Title::newFromText( $request->getVal( 'title', '' ) );
 591                 }
 592                 $page = $request->getVal( 'returnto', $page );
 593                 $a = array();
 594                 if ( strval( $page ) !== '' ) {
 595                         $a['returnto'] = $page;
 596                         $query = $request->getVal( 'returntoquery', $this->thisquery );
 597                         if ( $query != '' ) {
 598                                 $a['returntoquery'] = $query;
 599                         }
 600                 }
 601
 602                 $returnto = wfArrayToCgi( $a );
 603                 if ( $this->loggedin ) {
 604                         $personal_urls['userpage'] = array(
 605                                 'text' => $this->username,
 606                                 'href' => &$this->userpageUrlDetails['href'],
 607                                 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 608                                 'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
 609                                 'dir' => 'auto'
 610                         );
 611                         $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 612                         $personal_urls['mytalk'] = array(
 613                                 'text' => $this->msg( 'mytalk' )->text(),
 614                                 'href' => &$usertalkUrlDetails['href'],
 615                                 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 616                                 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
 617                         );
 618                         $href = self::makeSpecialUrl( 'Preferences' );
 619                         $personal_urls['preferences'] = array(
 620                                 'text' => $this->msg( 'mypreferences' )->text(),
 621                                 'href' => $href,
 622                                 'active' => ( $href == $pageurl )
 623                         );
 624
 625                         if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
 626                                 $href = self::makeSpecialUrl( 'Watchlist' );
 627                                 $personal_urls['watchlist'] = array(
 628                                         'text' => $this->msg( 'mywatchlist' )->text(),
 629                                         'href' => $href,
 630                                         'active' => ( $href == $pageurl )
 631                                 );
 632                         }
 633
 634                         # We need to do an explicit check for Special:Contributions, as we
 635                         # have to match both the title, and the target, which could come
 636                         # from request values (Special:Contributions?target=Jimbo_Wales)
 637                         # or be specified in "sub page" form
 638                         # (Special:Contributions/Jimbo_Wales). The plot
 639                         # thickens, because the Title object is altered for special pages,
 640                         # so it doesn't contain the original alias-with-subpage.
 641                         $origTitle = Title::newFromText( $request->getText( 'title' ) );
 642                         if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
 643                                 list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
 644                                 $active = $spName == 'Contributions'
 645                                         && ( ( $spPar && $spPar == $this->username )
 646                                                 || $request->getText( 'target' ) == $this->username );
 647                         } else {
 648                                 $active = false;
 649                         }
 650
 651                         $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
 652                         $personal_urls['mycontris'] = array(
 653                                 'text' => $this->msg( 'mycontris' )->text(),
 654                                 'href' => $href,
 655                                 'active' => $active
 656                         );
 657                         $personal_urls['logout'] = array(
 658                                 'text' => $this->msg( 'pt-userlogout' )->text(),
 659                                 'href' => self::makeSpecialUrl( 'Userlogout',
 660                                         // userlogout link must always contain an & character, otherwise we might not be able
 661                                         // to detect a buggy precaching proxy (bug 17790)
 662                                         $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto
 663                                 ),
 664                                 'active' => false
 665                         );
 666                 } else {
 667                         $useCombinedLoginLink = $this->useCombinedLoginLink();
 668                         $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
 669                                 ? 'nav-login-createaccount'
 670                                 : 'pt-login';
 671                         $is_signup = $request->getText( 'type' ) == 'signup';
 672
 673                         $login_url = array(
 674                                 'text' => $this->msg( $loginlink )->text(),
 675                                 'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
 676                                 'active' => $title->isSpecial( 'Userlogin' )
 677                                         && ( $loginlink == 'nav-login-createaccount' || !$is_signup ),
 678                         );
 679                         $createaccount_url = array(
 680                                 'text' => $this->msg( 'pt-createaccount' )->text(),
 681                                 'href' => self::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
 682                                 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup,
 683                         );
 684
 685                         if ( $this->showIPinHeader() ) {
 686                                 $href = &$this->userpageUrlDetails['href'];
 687                                 $personal_urls['anonuserpage'] = array(
 688                                         'text' => $this->username,
 689                                         'href' => $href,
 690                                         'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 691                                         'active' => ( $pageurl == $href )
 692                                 );
 693                                 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 694                                 $href = &$usertalkUrlDetails['href'];
 695                                 $personal_urls['anontalk'] = array(
 696                                         'text' => $this->msg( 'anontalk' )->text(),
 697                                         'href' => $href,
 698                                         'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 699                                         'active' => ( $pageurl == $href )
 700                                 );
 701                         }
 702
 703                         if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
 704                                 $personal_urls['createaccount'] = $createaccount_url;
 705                         }
 706
 707                         $personal_urls['login'] = $login_url;
 708                 }
 709
 710                 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title, $this ) );
 711                 wfProfileOut( __METHOD__ );
 712                 return $personal_urls;
 713         }
 714
 715         /**
 716          * Builds an array with tab definition
 717          *
 718          * @param Title $title Page Where the tab links to
 719          * @param string|array $message Message key or an array of message keys (will fall back)
 720          * @param bool $selected Display the tab as selected
 721          * @param string $query Query string attached to tab URL
 722          * @param bool $checkEdit Check if $title exists and mark with .new if one doesn't
 723          *
 724          * @return array
 725          */
 726         function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
 727                 $classes = array();
 728                 if ( $selected ) {
 729                         $classes[] = 'selected';
 730                 }
 731                 if ( $checkEdit && !$title->isKnown() ) {
 732                         $classes[] = 'new';
 733                         if ( $query !== '' ) {
 734                                 $query = 'action=edit&redlink=1&' . $query;
 735                         } else {
 736                                 $query = 'action=edit&redlink=1';
 737                         }
 738                 }
 739
 740                 // wfMessageFallback will nicely accept $message as an array of fallbacks
 741                 // or just a single key
 742                 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
 743                 if ( is_array( $message ) ) {
 744                         // for hook compatibility just keep the last message name
 745                         $message = end( $message );
 746                 }
 747                 if ( $msg->exists() ) {
 748                         $text = $msg->text();
 749                 } else {
 750                         global $wgContLang;
 751                         $text = $wgContLang->getFormattedNsText(
 752                                 MWNamespace::getSubject( $title->getNamespace() ) );
 753                 }
 754
 755                 $result = array();
 756                 if ( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
 757                                 $title, $message, $selected, $checkEdit,
 758                                 &$classes, &$query, &$text, &$result ) ) ) {
 759                         return $result;
 760                 }
 761
 762                 return array(
 763                         'class' => implode( ' ', $classes ),
 764                         'text' => $text,
 765                         'href' => $title->getLocalURL( $query ),
 766                         'primary' => true );
 767         }
 768
 769         function makeTalkUrlDetails( $name, $urlaction = '' ) {
 770                 $title = Title::newFromText( $name );
 771                 if ( !is_object( $title ) ) {
 772                         throw new MWException( __METHOD__ . " given invalid pagename $name" );
 773                 }
 774                 $title = $title->getTalkPage();
 775                 self::checkTitle( $title, $name );
 776                 return array(
 777                         'href' => $title->getLocalURL( $urlaction ),
 778                         'exists' => $title->getArticleID() != 0,
 779                 );
 780         }
 781
 782         function makeArticleUrlDetails( $name, $urlaction = '' ) {
 783                 $title = Title::newFromText( $name );
 784                 $title = $title->getSubjectPage();
 785                 self::checkTitle( $title, $name );
 786                 return array(
 787                         'href' => $title->getLocalURL( $urlaction ),
 788                         'exists' => $title->getArticleID() != 0,
 789                 );
 790         }
 791
 792         /**
 793          * a structured array of links usually used for the tabs in a skin
 794          *
 795          * There are 4 standard sections
 796          * namespaces: Used for namespace tabs like special, page, and talk namespaces
 797          * views: Used for primary page views like read, edit, history
 798          * actions: Used for most extra page actions like deletion, protection, etc...
 799          * variants: Used to list the language variants for the page
 800          *
 801          * Each section's value is a key/value array of links for that section.
 802          * The links themselves have these common keys:
 803          * - class: The css classes to apply to the tab
 804          * - text: The text to display on the tab
 805          * - href: The href for the tab to point to
 806          * - rel: An optional rel= for the tab's link
 807          * - redundant: If true the tab will be dropped in skins using content_actions
 808          *   this is useful for tabs like "Read" which only have meaning in skins that
 809          *   take special meaning from the grouped structure of content_navigation
 810          *
 811          * Views also have an extra key which can be used:
 812          * - primary: If this is not true skins like vector may try to hide the tab
 813          *            when the user has limited space in their browser window
 814          *
 815          * content_navigation using code also expects these ids to be present on the
 816          * links, however these are usually automatically generated by SkinTemplate
 817          * itself and are not necessary when using a hook. The only things these may
 818          * matter to are people modifying content_navigation after it's initial creation:
 819          * - id: A "preferred" id, most skins are best off outputting this preferred
 820          *   id for best compatibility.
 821          * - tooltiponly: This is set to true for some tabs in cases where the system
 822          *   believes that the accesskey should not be added to the tab.
 823          *
 824          * @return array
 825          */
 826         protected function buildContentNavigationUrls() {
 827                 global $wgDisableLangConversion;
 828
 829                 wfProfileIn( __METHOD__ );
 830
 831                 // Display tabs for the relevant title rather than always the title itself
 832                 $title = $this->getRelevantTitle();
 833                 $onPage = $title->equals( $this->getTitle() );
 834
 835                 $out = $this->getOutput();
 836                 $request = $this->getRequest();
 837                 $user = $this->getUser();
 838
 839                 $content_navigation = array(
 840                         'namespaces' => array(),
 841                         'views' => array(),
 842                         'actions' => array(),
 843                         'variants' => array()
 844                 );
 845
 846                 // parameters
 847                 $action = Action::getActionName( $this );
 848
 849                 $userCanRead = $title->quickUserCan( 'read', $user );
 850
 851                 $preventActiveTabs = false;
 852                 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
 853
 854                 // Checks if page is some kind of content
 855                 if ( $title->canExist() ) {
 856                         // Gets page objects for the related namespaces
 857                         $subjectPage = $title->getSubjectPage();
 858                         $talkPage = $title->getTalkPage();
 859
 860                         // Determines if this is a talk page
 861                         $isTalk = $title->isTalkPage();
 862
 863                         // Generates XML IDs from namespace names
 864                         $subjectId = $title->getNamespaceKey( '' );
 865
 866                         if ( $subjectId == 'main' ) {
 867                                 $talkId = 'talk';
 868                         } else {
 869                                 $talkId = "{$subjectId}_talk";
 870                         }
 871
 872                         $skname = $this->skinname;
 873
 874                         // Adds namespace links
 875                         $subjectMsg = array( "nstab-$subjectId" );
 876                         if ( $subjectPage->isMainPage() ) {
 877                                 array_unshift( $subjectMsg, 'mainpage-nstab' );
 878                         }
 879                         $content_navigation['namespaces'][$subjectId] = $this->tabAction(
 880                                 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
 881                         );
 882                         $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
 883                         $content_navigation['namespaces'][$talkId] = $this->tabAction(
 884                                 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
 885                         );
 886                         $content_navigation['namespaces'][$talkId]['context'] = 'talk';
 887
 888                         if ( $userCanRead ) {
 889                                 $isForeignFile = $title->inNamespace( NS_FILE ) && $this->canUseWikiPage() &&
 890                                         $this->getWikiPage() instanceof WikiFilePage && !$this->getWikiPage()->isLocal();
 891
 892                                 // Adds view view link
 893                                 if ( $title->exists() || $isForeignFile ) {
 894                                         $content_navigation['views']['view'] = $this->tabAction(
 895                                                 $isTalk ? $talkPage : $subjectPage,
 896                                                 array( "$skname-view-view", 'view' ),
 897                                                 ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
 898                                         );
 899                                         // signal to hide this from simple content_actions
 900                                         $content_navigation['views']['view']['redundant'] = true;
 901                                 }
 902
 903                                 // If it is a non-local file, show a link to the file in its own repository
 904                                 if ( $isForeignFile ) {
 905                                         $file = $this->getWikiPage()->getFile();
 906                                         $content_navigation['views']['view-foreign'] = array(
 907                                                 'class' => '',
 908                                                 'text' => wfMessageFallback( "$skname-view-foreign", 'view-foreign' )->
 909                                                         setContext( $this->getContext() )->
 910                                                         params( $file->getRepo()->getDisplayName() )->text(),
 911                                                 'href' => $file->getDescriptionUrl(),
 912                                                 'primary' => false,
 913                                         );
 914                                 }
 915
 916                                 wfProfileIn( __METHOD__ . '-edit' );
 917
 918                                 // Checks if user can edit the current page if it exists or create it otherwise
 919                                 if ( $title->quickUserCan( 'edit', $user )
 920                                         && ( $title->exists() || $title->quickUserCan( 'create', $user ) )
 921                                 ) {
 922                                         // Builds CSS class for talk page links
 923                                         $isTalkClass = $isTalk ? ' istalk' : '';
 924                                         // Whether the user is editing the page
 925                                         $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
 926                                         // Whether to show the "Add a new section" tab
 927                                         // Checks if this is a current rev of talk page and is not forced to be hidden
 928                                         $showNewSection = !$out->forceHideNewSectionLink()
 929                                                 && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
 930                                         $section = $request->getVal( 'section' );
 931
 932                                         if ( $title->exists()
 933                                                 || ( $title->getNamespace() == NS_MEDIAWIKI
 934                                                         && $title->getDefaultMessageText() !== false
 935                                                 )
 936                                         ) {
 937                                                 $msgKey = $isForeignFile ? 'edit-local' : 'edit';
 938                                         } else {
 939                                                 $msgKey = $isForeignFile ? 'create-local' : 'create';
 940                                         }
 941                                         $content_navigation['views']['edit'] = array(
 942                                                 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection )
 943                                                         ? 'selected'
 944                                                         : ''
 945                                                 ) . $isTalkClass,
 946                                                 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )
 947                                                         ->setContext( $this->getContext() )->text(),
 948                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 949                                                 'primary' => !$isForeignFile, // don't collapse this in vector
 950                                         );
 951
 952                                         // section link
 953                                         if ( $showNewSection ) {
 954                                                 // Adds new section link
 955                                                 //$content_navigation['actions']['addsection']
 956                                                 $content_navigation['views']['addsection'] = array(
 957                                                         'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
 958                                                         'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )
 959                                                                 ->setContext( $this->getContext() )->text(),
 960                                                         'href' => $title->getLocalURL( 'action=edit&section=new' )
 961                                                 );
 962                                         }
 963                                 // Checks if the page has some kind of viewable content
 964                                 } elseif ( $title->hasSourceText() ) {
 965                                         // Adds view source view link
 966                                         $content_navigation['views']['viewsource'] = array(
 967                                                 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
 968                                                 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )
 969                                                         ->setContext( $this->getContext() )->text(),
 970                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 971                                                 'primary' => true, // don't collapse this in vector
 972                                         );
 973                                 }
 974                                 wfProfileOut( __METHOD__ . '-edit' );
 975
 976                                 wfProfileIn( __METHOD__ . '-live' );
 977                                 // Checks if the page exists
 978                                 if ( $title->exists() ) {
 979                                         // Adds history view link
 980                                         $content_navigation['views']['history'] = array(
 981                                                 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
 982                                                 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )
 983                                                         ->setContext( $this->getContext() )->text(),
 984                                                 'href' => $title->getLocalURL( 'action=history' ),
 985                                                 'rel' => 'archives',
 986                                         );
 987
 988                                         if ( $title->quickUserCan( 'delete', $user ) ) {
 989                                                 $content_navigation['actions']['delete'] = array(
 990                                                         'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
 991                                                         'text' => wfMessageFallback( "$skname-action-delete", 'delete' )
 992                                                                 ->setContext( $this->getContext() )->text(),
 993                                                         'href' => $title->getLocalURL( 'action=delete' )
 994                                                 );
 995                                         }
 996
 997                                         if ( $title->quickUserCan( 'move', $user ) ) {
 998                                                 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
 999                                                 $content_navigation['actions']['move'] = array(
1000                                                         'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
1001                                                         'text' => wfMessageFallback( "$skname-action-move", 'move' )
1002                                                                 ->setContext( $this->getContext() )->text(),
1003                                                         'href' => $moveTitle->getLocalURL()
1004                                                 );
1005                                         }
1006                                 } else {
1007                                         // article doesn't exist or is deleted
1008                                         if ( $user->isAllowed( 'deletedhistory' ) ) {
1009                                                 $n = $title->isDeleted();
1010                                                 if ( $n ) {
1011                                                         $undelTitle = SpecialPage::getTitleFor( 'Undelete' );
1012                                                         // If the user can't undelete but can view deleted
1013                                                         // history show them a "View .. deleted" tab instead.
1014                                                         $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
1015                                                         $content_navigation['actions']['undelete'] = array(
1016                                                                 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1017                                                                 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1018                                                                         ->setContext( $this->getContext() )->numParams( $n )->text(),
1019                                                                 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
1020                                                         );
1021                                                 }
1022                                         }
1023                                 }
1024
1025                                 if ( $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() &&
1026                                         MWNamespace::getRestrictionLevels( $title->getNamespace(), $user ) !== array( '' )
1027                                 ) {
1028                                         $mode = $title->isProtected() ? 'unprotect' : 'protect';
1029                                         $content_navigation['actions'][$mode] = array(
1030                                                 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1031                                                 'text' => wfMessageFallback( "$skname-action-$mode", $mode )
1032                                                         ->setContext( $this->getContext() )->text(),
1033                                                 'href' => $title->getLocalURL( "action=$mode" )
1034                                         );
1035                                 }
1036
1037                                 wfProfileOut( __METHOD__ . '-live' );
1038
1039                                 // Checks if the user is logged in
1040                                 if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1041                                         /**
1042                                          * The following actions use messages which, if made particular to
1043                                          * the any specific skins, would break the Ajax code which makes this
1044                                          * action happen entirely inline. OutputPage::getJSVars
1045                                          * defines a set of messages in a javascript object - and these
1046                                          * messages are assumed to be global for all skins. Without making
1047                                          * a change to that procedure these messages will have to remain as
1048                                          * the global versions.
1049                                          */
1050                                         $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1051                                         $token = WatchAction::getWatchToken( $title, $user, $mode );
1052                                         $content_navigation['actions'][$mode] = array(
1053                                                 'class' => $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : false,
1054                                                 // uses 'watch' or 'unwatch' message
1055                                                 'text' => $this->msg( $mode )->text(),
1056                                                 'href' => $title->getLocalURL( array( 'action' => $mode, 'token' => $token ) )
1057                                         );
1058                                 }
1059                         }
1060
1061                         wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
1062
1063                         if ( $userCanRead && !$wgDisableLangConversion ) {
1064                                 $pageLang = $title->getPageLanguage();
1065                                 // Gets list of language variants
1066                                 $variants = $pageLang->getVariants();
1067                                 // Checks that language conversion is enabled and variants exist
1068                                 // And if it is not in the special namespace
1069                                 if ( count( $variants ) > 1 ) {
1070                                         // Gets preferred variant (note that user preference is
1071                                         // only possible for wiki content language variant)
1072                                         $preferred = $pageLang->getPreferredVariant();
1073                                         if ( Action::getActionName( $this ) === 'view' ) {
1074                                                 $params = $request->getQueryValues();
1075                                                 unset( $params['title'] );
1076                                         } else {
1077                                                 $params = array();
1078                                         }
1079                                         // Loops over each variant
1080                                         foreach ( $variants as $code ) {
1081                                                 // Gets variant name from language code
1082                                                 $varname = $pageLang->getVariantname( $code );
1083                                                 // Appends variant link
1084                                                 $content_navigation['variants'][] = array(
1085                                                         'class' => ( $code == $preferred ) ? 'selected' : false,
1086                                                         'text' => $varname,
1087                                                         'href' => $title->getLocalURL( array( 'variant' => $code ) + $params ),
1088                                                         'lang' => wfBCP47( $code ),
1089                                                         'hreflang' => wfBCP47( $code ),
1090                                                 );
1091                                         }
1092                                 }
1093                         }
1094                 } else {
1095                         // If it's not content, it's got to be a special page
1096                         $content_navigation['namespaces']['special'] = array(
1097                                 'class' => 'selected',
1098                                 'text' => $this->msg( 'nstab-special' )->text(),
1099                                 'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1100                                 'context' => 'subject'
1101                         );
1102
1103                         wfRunHooks( 'SkinTemplateNavigation::SpecialPage',
1104                                 array( &$this, &$content_navigation ) );
1105                 }
1106
1107                 // Equiv to SkinTemplateContentActions
1108                 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1109
1110                 // Setup xml ids and tooltip info
1111                 foreach ( $content_navigation as $section => &$links ) {
1112                         foreach ( $links as $key => &$link ) {
1113                                 $xmlID = $key;
1114                                 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1115                                         $xmlID = 'ca-nstab-' . $xmlID;
1116                                 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1117                                         $xmlID = 'ca-talk';
1118                                 } elseif ( $section == 'variants' ) {
1119                                         $xmlID = 'ca-varlang-' . $xmlID;
1120                                 } else {
1121                                         $xmlID = 'ca-' . $xmlID;
1122                                 }
1123                                 $link['id'] = $xmlID;
1124                         }
1125                 }
1126
1127                 # We don't want to give the watch tab an accesskey if the
1128                 # page is being edited, because that conflicts with the
1129                 # accesskey on the watch checkbox.  We also don't want to
1130                 # give the edit tab an accesskey, because that's fairly
1131                 # superfluous and conflicts with an accesskey (Ctrl-E) often
1132                 # used for editing in Safari.
1133                 if ( in_array( $action, array( 'edit', 'submit' ) ) ) {
1134                         if ( isset( $content_navigation['views']['edit'] ) ) {
1135                                 $content_navigation['views']['edit']['tooltiponly'] = true;
1136                         }
1137                         if ( isset( $content_navigation['actions']['watch'] ) ) {
1138                                 $content_navigation['actions']['watch']['tooltiponly'] = true;
1139                         }
1140                         if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1141                                 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1142                         }
1143                 }
1144
1145                 wfProfileOut( __METHOD__ );
1146
1147                 return $content_navigation;
1148         }
1149
1150         /**
1151          * an array of edit links by default used for the tabs
1152          * @param array $content_navigation
1153          * @return array
1154          */
1155         private function buildContentActionUrls( $content_navigation ) {
1156
1157                 wfProfileIn( __METHOD__ );
1158
1159                 // content_actions has been replaced with content_navigation for backwards
1160                 // compatibility and also for skins that just want simple tabs content_actions
1161                 // is now built by flattening the content_navigation arrays into one
1162
1163                 $content_actions = array();
1164
1165                 foreach ( $content_navigation as $links ) {
1166                         foreach ( $links as $key => $value ) {
1167                                 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1168                                         // Redundant tabs are dropped from content_actions
1169                                         continue;
1170                                 }
1171
1172                                 // content_actions used to have ids built using the "ca-$key" pattern
1173                                 // so the xmlID based id is much closer to the actual $key that we want
1174                                 // for that reason we'll just strip out the ca- if present and use
1175                                 // the latter potion of the "id" as the $key
1176                                 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1177                                         $key = substr( $value['id'], 3 );
1178                                 }
1179
1180                                 if ( isset( $content_actions[$key] ) ) {
1181                                         wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening " .
1182                                                 "content_navigation into content_actions.\n" );
1183                                         continue;
1184                                 }
1185
1186                                 $content_actions[$key] = $value;
1187                         }
1188                 }
1189
1190                 wfProfileOut( __METHOD__ );
1191
1192                 return $content_actions;
1193         }
1194
1195         /**
1196          * build array of common navigation links
1197          * @return array
1198          */
1199         protected function buildNavUrls() {
1200                 global $wgUploadNavigationUrl;
1201
1202                 wfProfileIn( __METHOD__ );
1203
1204                 $out = $this->getOutput();
1205                 $request = $this->getRequest();
1206
1207                 $nav_urls = array();
1208                 $nav_urls['mainpage'] = array( 'href' => self::makeMainPageUrl() );
1209                 if ( $wgUploadNavigationUrl ) {
1210                         $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1211                 } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1212                         $nav_urls['upload'] = array( 'href' => self::makeSpecialUrl( 'Upload' ) );
1213                 } else {
1214                         $nav_urls['upload'] = false;
1215                 }
1216                 $nav_urls['specialpages'] = array( 'href' => self::makeSpecialUrl( 'Specialpages' ) );
1217
1218                 $nav_urls['print'] = false;
1219                 $nav_urls['permalink'] = false;
1220                 $nav_urls['info'] = false;
1221                 $nav_urls['whatlinkshere'] = false;
1222                 $nav_urls['recentchangeslinked'] = false;
1223                 $nav_urls['contributions'] = false;
1224                 $nav_urls['log'] = false;
1225                 $nav_urls['blockip'] = false;
1226                 $nav_urls['emailuser'] = false;
1227                 $nav_urls['userrights'] = false;
1228
1229                 // A print stylesheet is attached to all pages, but nobody ever
1230                 // figures that out. :)  Add a link...
1231                 if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1232                         $nav_urls['print'] = array(
1233                                 'text' => $this->msg( 'printableversion' )->text(),
1234                                 'href' => $this->getTitle()->getLocalURL(
1235                                         $request->appendQueryValue( 'printable', 'yes', true ) )
1236                         );
1237                 }
1238
1239                 if ( $out->isArticle() ) {
1240                         // Also add a "permalink" while we're at it
1241                         $revid = $this->getRevisionId();
1242                         if ( $revid ) {
1243                                 $nav_urls['permalink'] = array(
1244                                         'text' => $this->msg( 'permalink' )->text(),
1245                                         'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1246                                 );
1247                         }
1248
1249                         // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1250                         wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1251                                 array( &$this, &$nav_urls, &$revid, &$revid ) );
1252                 }
1253
1254                 if ( $out->isArticleRelated() ) {
1255                         $nav_urls['whatlinkshere'] = array(
1256                                 'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1257                         );
1258
1259                         $nav_urls['info'] = array(
1260                                 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1261                                 'href' => $this->getTitle()->getLocalURL( "action=info" )
1262                         );
1263
1264                         if ( $this->getTitle()->getArticleID() ) {
1265                                 $nav_urls['recentchangeslinked'] = array(
1266                                         'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1267                                 );
1268                         }
1269                 }
1270
1271                 $user = $this->getRelevantUser();
1272                 if ( $user ) {
1273                         $rootUser = $user->getName();
1274
1275                         $nav_urls['contributions'] = array(
1276                                 'text' => $this->msg( 'contributions', $rootUser )->text(),
1277                                 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1278                         );
1279
1280                         $nav_urls['log'] = array(
1281                                 'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1282                         );
1283
1284                         if ( $this->getUser()->isAllowed( 'block' ) ) {
1285                                 $nav_urls['blockip'] = array(
1286                                         'text' => $this->msg( 'blockip', $rootUser )->text(),
1287                                         'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1288                                 );
1289                         }
1290
1291                         if ( $this->showEmailUser( $user ) ) {
1292                                 $nav_urls['emailuser'] = array(
1293                                         'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1294                                 );
1295                         }
1296
1297                         if ( !$user->isAnon() ) {
1298                                 $sur = new UserrightsPage;
1299                                 $sur->setContext( $this->getContext() );
1300                                 if ( $sur->userCanExecute( $this->getUser() ) ) {
1301                                         $nav_urls['userrights'] = array(
1302                                                 'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1303                                         );
1304                                 }
1305                         }
1306                 }
1307
1308                 wfProfileOut( __METHOD__ );
1309                 return $nav_urls;
1310         }
1311
1312         /**
1313          * Generate strings used for xml 'id' names
1314          * @return string
1315          */
1316         protected function getNameSpaceKey() {
1317                 return $this->getTitle()->getNamespaceKey();
1318         }
1319 }