includes/SkinTemplate.php

   1 <?php
   2 /**
   3  * Base class for template-based skins.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Wrapper object for MediaWiki's localization functions,
  25  * to be passed to the template engine.
  26  *
  27  * @private
  28  * @ingroup Skins
  29  */
  30 class MediaWiki_I18N {
  31         var $_context = array();
  32
  33         function set( $varName, $value ) {
  34                 $this->_context[$varName] = $value;
  35         }
  36
  37         function translate( $value ) {
  38                 wfProfileIn( __METHOD__ );
  39
  40                 // Hack for i18n:attributes in PHPTAL 1.0.0 dev version as of 2004-10-23
  41                 $value = preg_replace( '/^string:/', '', $value );
  42
  43                 $value = wfMessage( $value )->text();
  44                 // interpolate variables
  45                 $m = array();
  46                 while ( preg_match( '/\$([0-9]*?)/sm', $value, $m ) ) {
  47                         list( $src, $var ) = $m;
  48                         wfSuppressWarnings();
  49                         $varValue = $this->_context[$var];
  50                         wfRestoreWarnings();
  51                         $value = str_replace( $src, $varValue, $value );
  52                 }
  53                 wfProfileOut( __METHOD__ );
  54                 return $value;
  55         }
  56 }
  57
  58 /**
  59  * Template-filler skin base class
  60  * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
  61  * Based on Brion's smarty skin
  62  * @copyright Copyright © Gabriel Wicke -- http://www.aulinx.de/
  63  *
  64  * @todo Needs some serious refactoring into functions that correspond
  65  * to the computations individual esi snippets need. Most importantly no body
  66  * parsing for most of those of course.
  67  *
  68  * @ingroup Skins
  69  */
  70 class SkinTemplate extends Skin {
  71         /**#@+
  72          * @private
  73          */
  74
  75         /**
  76          * Name of our skin, it probably needs to be all lower case.  Child classes
  77          * should override the default.
  78          */
  79         var $skinname = 'monobook';
  80
  81         /**
  82          * Stylesheets set to use.  Subdirectory in skins/ where various stylesheets
  83          * are located.  Child classes should override the default.
  84          */
  85         var $stylename = 'monobook';
  86
  87         /**
  88          * For QuickTemplate, the name of the subclass which will actually fill the
  89          * template.  Child classes should override the default.
  90          */
  91         var $template = 'QuickTemplate';
  92
  93         /**
  94          * Whether this skin use OutputPage::headElement() to generate the "<head>"
  95          * tag
  96          */
  97         var $useHeadElement = false;
  98
  99         /**#@-*/
 100
 101         /**
 102          * Add specific styles for this skin
 103          *
 104          * @param $out OutputPage
 105          */
 106         function setupSkinUserCss( OutputPage $out ) {
 107                 $out->addModuleStyles( array( 'mediawiki.legacy.shared', 'mediawiki.legacy.commonPrint' ) );
 108         }
 109
 110         /**
 111          * Create the template engine object; we feed it a bunch of data
 112          * and eventually it spits out some HTML. Should have interface
 113          * roughly equivalent to PHPTAL 0.7.
 114          *
 115          * @param $classname String
 116          * @param string $repository subdirectory where we keep template files
 117          * @param $cache_dir string
 118          * @return QuickTemplate
 119          * @private
 120          */
 121         function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
 122                 return new $classname();
 123         }
 124
 125         /**
 126          * Generates array of language links for the current page
 127          *
 128          * @return array
 129          * @public
 130          */
 131         public function getLanguages() {
 132                 global $wgHideInterlanguageLinks;
 133                 $out = $this->getOutput();
 134
 135                 # Language links
 136                 $language_urls = array();
 137
 138                 if ( !$wgHideInterlanguageLinks ) {
 139                         foreach ( $out->getLanguageLinks() as $languageLinkText ) {
 140                                 $languageLinkParts = explode( ':', $languageLinkText, 2 );
 141                                 $class = 'interwiki-' . $languageLinkParts[0];
 142                                 unset( $languageLinkParts );
 143                                 $languageLinkTitle = Title::newFromText( $languageLinkText );
 144                                 if ( $languageLinkTitle ) {
 145                                         $ilInterwikiCode = $languageLinkTitle->getInterwiki();
 146                                         $ilLangName = Language::fetchLanguageName( $ilInterwikiCode );
 147
 148                                         if ( strval( $ilLangName ) === '' ) {
 149                                                 $ilLangName = $languageLinkText;
 150                                         } else {
 151                                                 $ilLangName = $this->formatLanguageName( $ilLangName );
 152                                         }
 153
 154                                         $language_urls[] = array(
 155                                                 'href' => $languageLinkTitle->getFullURL(),
 156                                                 'text' => $ilLangName,
 157                                                 'title' => $languageLinkTitle->getText(),
 158                                                 'class' => $class,
 159                                                 'lang' => wfBCP47( $ilInterwikiCode ),
 160                                                 'hreflang' => wfBCP47( $ilInterwikiCode ),
 161                                         );
 162                                 }
 163                         }
 164                 }
 165                 return $language_urls;
 166         }
 167
 168         protected function setupTemplateForOutput() {
 169                 wfProfileIn( __METHOD__ );
 170
 171                 $request = $this->getRequest();
 172                 $user = $this->getUser();
 173                 $title = $this->getTitle();
 174
 175                 wfProfileIn( __METHOD__ . '-init' );
 176                 $tpl = $this->setupTemplate( $this->template, 'skins' );
 177                 wfProfileOut( __METHOD__ . '-init' );
 178
 179                 wfProfileIn( __METHOD__ . '-stuff' );
 180                 $this->thispage = $title->getPrefixedDBkey();
 181                 $this->titletxt = $title->getPrefixedText();
 182                 $this->userpage = $user->getUserPage()->getPrefixedText();
 183                 $query = array();
 184                 if ( !$request->wasPosted() ) {
 185                         $query = $request->getValues();
 186                         unset( $query['title'] );
 187                         unset( $query['returnto'] );
 188                         unset( $query['returntoquery'] );
 189                 }
 190                 $this->thisquery = wfArrayToCgi( $query );
 191                 $this->loggedin = $user->isLoggedIn();
 192                 $this->username = $user->getName();
 193
 194                 if ( $this->loggedin || $this->showIPinHeader() ) {
 195                         $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
 196                 } else {
 197                         # This won't be used in the standard skins, but we define it to preserve the interface
 198                         # To save time, we check for existence
 199                         $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
 200                 }
 201
 202                 wfProfileOut( __METHOD__ . '-stuff' );
 203
 204                 wfProfileOut( __METHOD__ );
 205
 206                 return $tpl;
 207         }
 208
 209         /**
 210          * initialize various variables and generate the template
 211          *
 212          * @param $out OutputPage
 213          */
 214         function outputPage( OutputPage $out = null ) {
 215                 global $wgContLang;
 216                 global $wgScript, $wgStylePath;
 217                 global $wgMimeType, $wgJsMimeType;
 218                 global $wgXhtmlNamespaces, $wgHtml5Version;
 219                 global $wgDisableCounters, $wgSitename, $wgLogo;
 220                 global $wgMaxCredits, $wgShowCreditsIfMax;
 221                 global $wgPageShowWatchingUsers;
 222                 global $wgArticlePath, $wgScriptPath, $wgServer;
 223
 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                 $request = $this->getRequest();
 236                 $user = $this->getUser();
 237                 $title = $this->getTitle();
 238
 239                 wfProfileIn( __METHOD__ . '-init' );
 240                 $this->initPage( $out );
 241                 wfProfileOut( __METHOD__ . '-init' );
 242
 243                 $tpl = $this->setupTemplateForOutput();
 244
 245                 wfProfileIn( __METHOD__ . '-stuff-head' );
 246                 if ( !$this->useHeadElement ) {
 247                         $tpl->set( 'pagecss', false );
 248                         $tpl->set( 'usercss', false );
 249
 250                         $tpl->set( 'userjs', false );
 251                         $tpl->set( 'userjsprev', false );
 252
 253                         $tpl->set( 'jsvarurl', false );
 254
 255                         $tpl->set( 'xhtmldefaultnamespace', 'http://www.w3.org/1999/xhtml' );
 256                         $tpl->set( 'xhtmlnamespaces', $wgXhtmlNamespaces );
 257                         $tpl->set( 'html5version', $wgHtml5Version );
 258                         $tpl->set( 'headlinks', $out->getHeadLinks() );
 259                         $tpl->set( 'csslinks', $out->buildCssLinks() );
 260                         $tpl->set( 'pageclass', $this->getPageClasses( $title ) );
 261                         $tpl->set( 'skinnameclass', ( 'skin-' . Sanitizer::escapeClass( $this->getSkinName() ) ) );
 262                 }
 263                 wfProfileOut( __METHOD__ . '-stuff-head' );
 264
 265                 wfProfileIn( __METHOD__ . '-stuff2' );
 266                 $tpl->set( 'title', $out->getPageTitle() );
 267                 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
 268                 $tpl->set( 'displaytitle', $out->mPageLinkTitle );
 269
 270                 $tpl->setRef( 'thispage', $this->thispage );
 271                 $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
 272                 $tpl->set( 'titletext', $title->getText() );
 273                 $tpl->set( 'articleid', $title->getArticleID() );
 274
 275                 $tpl->set( 'isarticle', $out->isArticle() );
 276
 277                 $subpagestr = $this->subPageSubtitle();
 278                 if ( $subpagestr !== '' ) {
 279                         $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
 280                 }
 281                 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
 282
 283                 $undelete = $this->getUndeleteLink();
 284                 if ( $undelete === '' ) {
 285                         $tpl->set( 'undelete', '' );
 286                 } else {
 287                         $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
 288                 }
 289
 290                 $tpl->set( 'catlinks', $this->getCategories() );
 291                 if ( $out->isSyndicated() ) {
 292                         $feeds = array();
 293                         foreach ( $out->getSyndicationLinks() as $format => $link ) {
 294                                 // Give grep a chance to find the usages: feed-atom, feed-rss
 295                                 $feeds[$format] = array(
 296                                         'text' => $this->msg( "feed-$format" )->text(),
 297                                         'href' => $link
 298                                 );
 299                         }
 300                         $tpl->setRef( 'feeds', $feeds );
 301                 } else {
 302                         $tpl->set( 'feeds', false );
 303                 }
 304
 305                 $tpl->setRef( 'mimetype', $wgMimeType );
 306                 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
 307                 $tpl->set( 'charset', 'UTF-8' );
 308                 $tpl->setRef( 'wgScript', $wgScript );
 309                 $tpl->setRef( 'skinname', $this->skinname );
 310                 $tpl->set( 'skinclass', get_class( $this ) );
 311                 $tpl->setRef( 'skin', $this );
 312                 $tpl->setRef( 'stylename', $this->stylename );
 313                 $tpl->set( 'printable', $out->isPrintable() );
 314                 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
 315                 $tpl->setRef( 'loggedin', $this->loggedin );
 316                 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
 317                 /* XXX currently unused, might get useful later
 318                 $tpl->set( 'editable', ( !$title->isSpecialPage() ) );
 319                 $tpl->set( 'exists', $title->getArticleID() != 0 );
 320                 $tpl->set( 'watch', $user->isWatched( $title ) ? 'unwatch' : 'watch' );
 321                 $tpl->set( 'protect', count( $title->isProtected() ) ? 'unprotect' : 'protect' );
 322                 $tpl->set( 'helppage', $this->msg( 'helppage' )->text() );
 323                 */
 324                 $tpl->set( 'searchaction', $this->escapeSearchLink() );
 325                 $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
 326                 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
 327                 $tpl->setRef( 'stylepath', $wgStylePath );
 328                 $tpl->setRef( 'articlepath', $wgArticlePath );
 329                 $tpl->setRef( 'scriptpath', $wgScriptPath );
 330                 $tpl->setRef( 'serverurl', $wgServer );
 331                 $tpl->setRef( 'logopath', $wgLogo );
 332                 $tpl->setRef( 'sitename', $wgSitename );
 333
 334                 $userLang = $this->getLanguage();
 335                 $userLangCode = $userLang->getHtmlCode();
 336                 $userLangDir = $userLang->getDir();
 337
 338                 $tpl->set( 'lang', $userLangCode );
 339                 $tpl->set( 'dir', $userLangDir );
 340                 $tpl->set( 'rtl', $userLang->isRTL() );
 341
 342                 $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
 343                 $tpl->set( 'showjumplinks', true ); // showjumplinks preference has been removed
 344                 $tpl->set( 'username', $this->loggedin ? $this->username : null );
 345                 $tpl->setRef( 'userpage', $this->userpage );
 346                 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
 347                 $tpl->set( 'userlang', $userLangCode );
 348
 349                 // Users can have their language set differently than the
 350                 // content of the wiki. For these users, tell the web browser
 351                 // that interface elements are in a different language.
 352                 $tpl->set( 'userlangattributes', '' );
 353                 $tpl->set( 'specialpageattributes', '' ); # obsolete
 354
 355                 if ( $userLangCode !== $wgContLang->getHtmlCode() || $userLangDir !== $wgContLang->getDir() ) {
 356                         $escUserlang = htmlspecialchars( $userLangCode );
 357                         $escUserdir = htmlspecialchars( $userLangDir );
 358                         // Attributes must be in double quotes because htmlspecialchars() doesn't
 359                         // escape single quotes
 360                         $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
 361                         $tpl->set( 'userlangattributes', $attrs );
 362                 }
 363
 364                 wfProfileOut( __METHOD__ . '-stuff2' );
 365
 366                 wfProfileIn( __METHOD__ . '-stuff3' );
 367                 $tpl->set( 'newtalk', $this->getNewtalks() );
 368                 $tpl->set( 'logo', $this->logoText() );
 369
 370                 $tpl->set( 'copyright', false );
 371                 $tpl->set( 'viewcount', false );
 372                 $tpl->set( 'lastmod', false );
 373                 $tpl->set( 'credits', false );
 374                 $tpl->set( 'numberofwatchingusers', false );
 375                 if ( $out->isArticle() && $title->exists() ) {
 376                         if ( $this->isRevisionCurrent() ) {
 377                                 if ( !$wgDisableCounters ) {
 378                                         $viewcount = $this->getWikiPage()->getCount();
 379                                         if ( $viewcount ) {
 380                                                 $tpl->set( 'viewcount', $this->msg( 'viewcount' )->numParams( $viewcount )->parse() );
 381                                         }
 382                                 }
 383
 384                                 if ( $wgPageShowWatchingUsers ) {
 385                                         $dbr = wfGetDB( DB_SLAVE );
 386                                         $num = $dbr->selectField( 'watchlist', 'COUNT(*)',
 387                                                 array( 'wl_title' => $title->getDBkey(), 'wl_namespace' => $title->getNamespace() ),
 388                                                 __METHOD__
 389                                         );
 390                                         if ( $num > 0 ) {
 391                                                 $tpl->set( 'numberofwatchingusers',
 392                                                         $this->msg( 'number_of_watching_users_pageview' )->numParams( $num )->parse()
 393                                                 );
 394                                         }
 395                                 }
 396
 397                                 if ( $wgMaxCredits != 0 ) {
 398                                         $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
 399                                                 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
 400                                 } else {
 401                                         $tpl->set( 'lastmod', $this->lastModified() );
 402                                 }
 403                         }
 404                         $tpl->set( 'copyright', $this->getCopyright() );
 405                 }
 406                 wfProfileOut( __METHOD__ . '-stuff3' );
 407
 408                 wfProfileIn( __METHOD__ . '-stuff4' );
 409                 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
 410                 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
 411                 $tpl->set( 'disclaimer', $this->disclaimerLink() );
 412                 $tpl->set( 'privacy', $this->privacyLink() );
 413                 $tpl->set( 'about', $this->aboutLink() );
 414
 415                 $tpl->set( 'footerlinks', array(
 416                         'info' => array(
 417                                 'lastmod',
 418                                 'viewcount',
 419                                 'numberofwatchingusers',
 420                                 'credits',
 421                                 'copyright',
 422                         ),
 423                         'places' => array(
 424                                 'privacy',
 425                                 'about',
 426                                 'disclaimer',
 427                         ),
 428                 ) );
 429
 430                 global $wgFooterIcons;
 431                 $tpl->set( 'footericons', $wgFooterIcons );
 432                 foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
 433                         if ( count( $footerIconsBlock ) > 0 ) {
 434                                 foreach ( $footerIconsBlock as &$footerIcon ) {
 435                                         if ( isset( $footerIcon['src'] ) ) {
 436                                                 if ( !isset( $footerIcon['width'] ) ) {
 437                                                         $footerIcon['width'] = 88;
 438                                                 }
 439                                                 if ( !isset( $footerIcon['height'] ) ) {
 440                                                         $footerIcon['height'] = 31;
 441                                                 }
 442                                         }
 443                                 }
 444                         } else {
 445                                 unset( $tpl->data['footericons'][$footerIconsKey] );
 446                         }
 447                 }
 448
 449                 $tpl->set( 'sitenotice', $this->getSiteNotice() );
 450                 $tpl->set( 'bottomscripts', $this->bottomScripts() );
 451                 $tpl->set( 'printfooter', $this->printSource() );
 452
 453                 # An ID that includes the actual body text; without categories, contentSub, ...
 454                 $realBodyAttribs = array( 'id' => 'mw-content-text' );
 455
 456                 # Add a mw-content-ltr/rtl class to be able to style based on text direction
 457                 # when the content is different from the UI language, i.e.:
 458                 # not for special pages or file pages AND only when viewing AND if the page exists
 459                 # (or is in MW namespace, because that has default content)
 460                 if ( !in_array( $title->getNamespace(), array( NS_SPECIAL, NS_FILE ) ) &&
 461                         Action::getActionName( $this ) === 'view' &&
 462                         ( $title->exists() || $title->getNamespace() == NS_MEDIAWIKI ) ) {
 463                         $pageLang = $title->getPageViewLanguage();
 464                         $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
 465                         $realBodyAttribs['dir'] = $pageLang->getDir();
 466                         $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
 467                 }
 468
 469                 $out->mBodytext = Html::rawElement( 'div', $realBodyAttribs, $out->mBodytext );
 470                 $tpl->setRef( 'bodytext', $out->mBodytext );
 471
 472                 $language_urls = $this->getLanguages();
 473                 if ( count( $language_urls ) ) {
 474                         $tpl->setRef( 'language_urls', $language_urls );
 475                 } else {
 476                         $tpl->set( 'language_urls', false );
 477                 }
 478                 wfProfileOut( __METHOD__ . '-stuff4' );
 479
 480                 wfProfileIn( __METHOD__ . '-stuff5' );
 481                 # Personal toolbar
 482                 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
 483                 $content_navigation = $this->buildContentNavigationUrls();
 484                 $content_actions = $this->buildContentActionUrls( $content_navigation );
 485                 $tpl->setRef( 'content_navigation', $content_navigation );
 486                 $tpl->setRef( 'content_actions', $content_actions );
 487
 488                 $tpl->set( 'sidebar', $this->buildSidebar() );
 489                 $tpl->set( 'nav_urls', $this->buildNavUrls() );
 490
 491                 // Set the head scripts near the end, in case the above actions resulted in added scripts
 492                 if ( $this->useHeadElement ) {
 493                         $tpl->set( 'headelement', $out->headElement( $this ) );
 494                 } else {
 495                         $tpl->set( 'headscripts', $out->getHeadScripts() . $out->getHeadItems() );
 496                 }
 497
 498                 $tpl->set( 'debug', '' );
 499                 $tpl->set( 'debughtml', $this->generateDebugHTML() );
 500                 $tpl->set( 'reporttime', wfReportTime() );
 501
 502                 // original version by hansm
 503                 if ( !wfRunHooks( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
 504                         wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
 505                 }
 506
 507                 // Set the bodytext to another key so that skins can just output it on it's own
 508                 // and output printfooter and debughtml separately
 509                 $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
 510
 511                 // Append printfooter and debughtml onto bodytext so that skins that were already
 512                 // using bodytext before they were split out don't suddenly start not outputting information
 513                 $tpl->data['bodytext'] .= Html::rawElement( 'div', array( 'class' => 'printfooter' ), "\n{$tpl->data['printfooter']}" ) . "\n";
 514                 $tpl->data['bodytext'] .= $tpl->data['debughtml'];
 515
 516                 // allow extensions adding stuff after the page content.
 517                 // See Skin::afterContentHook() for further documentation.
 518                 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
 519                 wfProfileOut( __METHOD__ . '-stuff5' );
 520
 521                 // execute template
 522                 wfProfileIn( __METHOD__ . '-execute' );
 523                 $res = $tpl->execute();
 524                 wfProfileOut( __METHOD__ . '-execute' );
 525
 526                 // result may be an error
 527                 $this->printOrError( $res );
 528
 529                 if ( $oldContext ) {
 530                         $this->setContext( $oldContext );
 531                 }
 532                 wfProfileOut( __METHOD__ );
 533         }
 534
 535         /**
 536          * Get the HTML for the p-personal list
 537          * @return string
 538          */
 539         public function getPersonalToolsList() {
 540                 $tpl = $this->setupTemplateForOutput();
 541                 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
 542                 $html = '';
 543                 foreach ( $tpl->getPersonalTools() as $key => $item ) {
 544                         $html .= $tpl->makeListItem( $key, $item );
 545                 }
 546                 return $html;
 547         }
 548
 549         /**
 550          * Format language name for use in sidebar interlanguage links list.
 551          * By default it is capitalized.
 552          *
 553          * @param string $name Language name, e.g. "English" or "español"
 554          * @return string
 555          * @private
 556          */
 557         function formatLanguageName( $name ) {
 558                 return $this->getLanguage()->ucfirst( $name );
 559         }
 560
 561         /**
 562          * Output the string, or print error message if it's
 563          * an error object of the appropriate type.
 564          * For the base class, assume strings all around.
 565          *
 566          * @param $str Mixed
 567          * @private
 568          */
 569         function printOrError( $str ) {
 570                 echo $str;
 571         }
 572
 573         /**
 574          * Output a boolean indicating if buildPersonalUrls should output separate
 575          * login and create account links or output a combined link
 576          * By default we simply return a global config setting that affects most skins
 577          * This is setup as a method so that like with $wgLogo and getLogo() a skin
 578          * can override this setting and always output one or the other if it has
 579          * a reason it can't output one of the two modes.
 580          * @return bool
 581          */
 582         function useCombinedLoginLink() {
 583                 global $wgUseCombinedLoginLink;
 584                 return $wgUseCombinedLoginLink;
 585         }
 586
 587         /**
 588          * build array of urls for personal toolbar
 589          * @return array
 590          */
 591         protected function buildPersonalUrls() {
 592                 global $wgSecureLogin;
 593
 594                 $title = $this->getTitle();
 595                 $request = $this->getRequest();
 596                 $pageurl = $title->getLocalURL();
 597                 wfProfileIn( __METHOD__ );
 598
 599                 /* set up the default links for the personal toolbar */
 600                 $personal_urls = array();
 601
 602                 # Due to bug 32276, if a user does not have read permissions,
 603                 # $this->getTitle() will just give Special:Badtitle, which is
 604                 # not especially useful as a returnto parameter. Use the title
 605                 # from the request instead, if there was one.
 606                 if ( $this->getUser()->isAllowed( 'read' ) ) {
 607                         $page = $this->getTitle();
 608                 } else {
 609                         $page = Title::newFromText( $request->getVal( 'title', '' ) );
 610                 }
 611                 $page = $request->getVal( 'returnto', $page );
 612                 $a = array();
 613                 if ( strval( $page ) !== '' ) {
 614                         $a['returnto'] = $page;
 615                         $query = $request->getVal( 'returntoquery', $this->thisquery );
 616                         if ( $query != '' ) {
 617                                 $a['returntoquery'] = $query;
 618                         }
 619                 }
 620
 621                 if ( $wgSecureLogin && $request->detectProtocol() === 'https' ) {
 622                         $a['wpStickHTTPS'] = true;
 623                 }
 624
 625                 $returnto = wfArrayToCgi( $a );
 626                 if ( $this->loggedin ) {
 627                         $personal_urls['userpage'] = array(
 628                                 'text' => $this->username,
 629                                 'href' => &$this->userpageUrlDetails['href'],
 630                                 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 631                                 'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
 632                                 'dir' => 'auto'
 633                         );
 634                         $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 635                         $personal_urls['mytalk'] = array(
 636                                 'text' => $this->msg( 'mytalk' )->text(),
 637                                 'href' => &$usertalkUrlDetails['href'],
 638                                 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 639                                 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
 640                         );
 641                         $href = self::makeSpecialUrl( 'Preferences' );
 642                         $personal_urls['preferences'] = array(
 643                                 'text' => $this->msg( 'mypreferences' )->text(),
 644                                 'href' => $href,
 645                                 'active' => ( $href == $pageurl )
 646                         );
 647
 648                         if ( $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
 649                                 $href = self::makeSpecialUrl( 'Watchlist' );
 650                                 $personal_urls['watchlist'] = array(
 651                                         'text' => $this->msg( 'mywatchlist' )->text(),
 652                                         'href' => $href,
 653                                         'active' => ( $href == $pageurl )
 654                                 );
 655                         }
 656
 657                         # We need to do an explicit check for Special:Contributions, as we
 658                         # have to match both the title, and the target, which could come
 659                         # from request values (Special:Contributions?target=Jimbo_Wales)
 660                         # or be specified in "sub page" form
 661                         # (Special:Contributions/Jimbo_Wales). The plot
 662                         # thickens, because the Title object is altered for special pages,
 663                         # so it doesn't contain the original alias-with-subpage.
 664                         $origTitle = Title::newFromText( $request->getText( 'title' ) );
 665                         if ( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
 666                                 list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
 667                                 $active = $spName == 'Contributions'
 668                                         && ( ( $spPar && $spPar == $this->username )
 669                                                 || $request->getText( 'target' ) == $this->username );
 670                         } else {
 671                                 $active = false;
 672                         }
 673
 674                         $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
 675                         $personal_urls['mycontris'] = array(
 676                                 'text' => $this->msg( 'mycontris' )->text(),
 677                                 'href' => $href,
 678                                 'active' => $active
 679                         );
 680                         $personal_urls['logout'] = array(
 681                                 'text' => $this->msg( 'userlogout' )->text(),
 682                                 'href' => self::makeSpecialUrl( 'Userlogout',
 683                                         // userlogout link must always contain an & character, otherwise we might not be able
 684                                         // to detect a buggy precaching proxy (bug 17790)
 685                                         $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto
 686                                 ),
 687                                 'active' => false
 688                         );
 689                 } else {
 690                         $useCombinedLoginLink = $this->useCombinedLoginLink();
 691                         $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
 692                                 ? 'nav-login-createaccount'
 693                                 : 'login';
 694                         $is_signup = $request->getText( 'type' ) == 'signup';
 695
 696                         $login_id = $this->showIPinHeader() ? 'anonlogin' : 'login';
 697                         $login_url = array(
 698                                 'text' => $this->msg( $loginlink )->text(),
 699                                 'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
 700                                 'active' => $title->isSpecial( 'Userlogin' ) && ( $loginlink == 'nav-login-createaccount' || !$is_signup ),
 701                         );
 702                         $createaccount_url = array(
 703                                 'text' => $this->msg( 'createaccount' )->text(),
 704                                 'href' => self::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
 705                                 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup,
 706                         );
 707
 708                         if ( $this->showIPinHeader() ) {
 709                                 $href = &$this->userpageUrlDetails['href'];
 710                                 $personal_urls['anonuserpage'] = array(
 711                                         'text' => $this->username,
 712                                         'href' => $href,
 713                                         'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 714                                         'active' => ( $pageurl == $href )
 715                                 );
 716                                 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 717                                 $href = &$usertalkUrlDetails['href'];
 718                                 $personal_urls['anontalk'] = array(
 719                                         'text' => $this->msg( 'anontalk' )->text(),
 720                                         'href' => $href,
 721                                         'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 722                                         'active' => ( $pageurl == $href )
 723                                 );
 724                         }
 725
 726                         if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
 727                                 $personal_urls['createaccount'] = $createaccount_url;
 728                         }
 729
 730                         $personal_urls[$login_id] = $login_url;
 731                 }
 732
 733                 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title ) );
 734                 wfProfileOut( __METHOD__ );
 735                 return $personal_urls;
 736         }
 737
 738         /**
 739          * Builds an array with tab definition
 740          *
 741          * @param Title $title page where the tab links to
 742          * @param string|array $message message key or an array of message keys (will fall back)
 743          * @param boolean $selected display the tab as selected
 744          * @param string $query query string attached to tab URL
 745          * @param boolean $checkEdit check if $title exists and mark with .new if one doesn't
 746          *
 747          * @return array
 748          */
 749         function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
 750                 $classes = array();
 751                 if ( $selected ) {
 752                         $classes[] = 'selected';
 753                 }
 754                 if ( $checkEdit && !$title->isKnown() ) {
 755                         $classes[] = 'new';
 756                         if ( $query !== '' ) {
 757                                 $query = 'action=edit&redlink=1&' . $query;
 758                         } else {
 759                                 $query = 'action=edit&redlink=1';
 760                         }
 761                 }
 762
 763                 // wfMessageFallback will nicely accept $message as an array of fallbacks
 764                 // or just a single key
 765                 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
 766                 if ( is_array( $message ) ) {
 767                         // for hook compatibility just keep the last message name
 768                         $message = end( $message );
 769                 }
 770                 if ( $msg->exists() ) {
 771                         $text = $msg->text();
 772                 } else {
 773                         global $wgContLang;
 774                         $text = $wgContLang->getFormattedNsText(
 775                                 MWNamespace::getSubject( $title->getNamespace() ) );
 776                 }
 777
 778                 $result = array();
 779                 if ( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
 780                                 $title, $message, $selected, $checkEdit,
 781                                 &$classes, &$query, &$text, &$result ) ) ) {
 782                         return $result;
 783                 }
 784
 785                 return array(
 786                         'class' => implode( ' ', $classes ),
 787                         'text' => $text,
 788                         'href' => $title->getLocalURL( $query ),
 789                         'primary' => true );
 790         }
 791
 792         function makeTalkUrlDetails( $name, $urlaction = '' ) {
 793                 $title = Title::newFromText( $name );
 794                 if ( !is_object( $title ) ) {
 795                         throw new MWException( __METHOD__ . " given invalid pagename $name" );
 796                 }
 797                 $title = $title->getTalkPage();
 798                 self::checkTitle( $title, $name );
 799                 return array(
 800                         'href' => $title->getLocalURL( $urlaction ),
 801                         'exists' => $title->getArticleID() != 0,
 802                 );
 803         }
 804
 805         function makeArticleUrlDetails( $name, $urlaction = '' ) {
 806                 $title = Title::newFromText( $name );
 807                 $title = $title->getSubjectPage();
 808                 self::checkTitle( $title, $name );
 809                 return array(
 810                         'href' => $title->getLocalURL( $urlaction ),
 811                         'exists' => $title->getArticleID() != 0,
 812                 );
 813         }
 814
 815         /**
 816          * a structured array of links usually used for the tabs in a skin
 817          *
 818          * There are 4 standard sections
 819          * namespaces: Used for namespace tabs like special, page, and talk namespaces
 820          * views: Used for primary page views like read, edit, history
 821          * actions: Used for most extra page actions like deletion, protection, etc...
 822          * variants: Used to list the language variants for the page
 823          *
 824          * Each section's value is a key/value array of links for that section.
 825          * The links themselves have these common keys:
 826          * - class: The css classes to apply to the tab
 827          * - text: The text to display on the tab
 828          * - href: The href for the tab to point to
 829          * - rel: An optional rel= for the tab's link
 830          * - redundant: If true the tab will be dropped in skins using content_actions
 831          *   this is useful for tabs like "Read" which only have meaning in skins that
 832          *   take special meaning from the grouped structure of content_navigation
 833          *
 834          * Views also have an extra key which can be used:
 835          * - primary: If this is not true skins like vector may try to hide the tab
 836          *            when the user has limited space in their browser window
 837          *
 838          * content_navigation using code also expects these ids to be present on the
 839          * links, however these are usually automatically generated by SkinTemplate
 840          * itself and are not necessary when using a hook. The only things these may
 841          * matter to are people modifying content_navigation after it's initial creation:
 842          * - id: A "preferred" id, most skins are best off outputting this preferred id for best compatibility
 843          * - tooltiponly: This is set to true for some tabs in cases where the system
 844          *                believes that the accesskey should not be added to the tab.
 845          *
 846          * @return array
 847          */
 848         protected function buildContentNavigationUrls() {
 849                 global $wgDisableLangConversion;
 850
 851                 wfProfileIn( __METHOD__ );
 852
 853                 // Display tabs for the relevant title rather than always the title itself
 854                 $title = $this->getRelevantTitle();
 855                 $onPage = $title->equals( $this->getTitle() );
 856
 857                 $out = $this->getOutput();
 858                 $request = $this->getRequest();
 859                 $user = $this->getUser();
 860
 861                 $content_navigation = array(
 862                         'namespaces' => array(),
 863                         'views' => array(),
 864                         'actions' => array(),
 865                         'variants' => array()
 866                 );
 867
 868                 // parameters
 869                 $action = $request->getVal( 'action', 'view' );
 870
 871                 $userCanRead = $title->quickUserCan( 'read', $user );
 872
 873                 $preventActiveTabs = false;
 874                 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
 875
 876                 // Checks if page is some kind of content
 877                 if ( $title->canExist() ) {
 878                         // Gets page objects for the related namespaces
 879                         $subjectPage = $title->getSubjectPage();
 880                         $talkPage = $title->getTalkPage();
 881
 882                         // Determines if this is a talk page
 883                         $isTalk = $title->isTalkPage();
 884
 885                         // Generates XML IDs from namespace names
 886                         $subjectId = $title->getNamespaceKey( '' );
 887
 888                         if ( $subjectId == 'main' ) {
 889                                 $talkId = 'talk';
 890                         } else {
 891                                 $talkId = "{$subjectId}_talk";
 892                         }
 893
 894                         $skname = $this->skinname;
 895
 896                         // Adds namespace links
 897                         $subjectMsg = array( "nstab-$subjectId" );
 898                         if ( $subjectPage->isMainPage() ) {
 899                                 array_unshift( $subjectMsg, 'mainpage-nstab' );
 900                         }
 901                         $content_navigation['namespaces'][$subjectId] = $this->tabAction(
 902                                 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
 903                         );
 904                         $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
 905                         $content_navigation['namespaces'][$talkId] = $this->tabAction(
 906                                 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
 907                         );
 908                         $content_navigation['namespaces'][$talkId]['context'] = 'talk';
 909
 910                         if ( $userCanRead ) {
 911                                 // Adds view view link
 912                                 if ( $title->exists() ) {
 913                                         $content_navigation['views']['view'] = $this->tabAction(
 914                                                 $isTalk ? $talkPage : $subjectPage,
 915                                                 array( "$skname-view-view", 'view' ),
 916                                                 ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
 917                                         );
 918                                         // signal to hide this from simple content_actions
 919                                         $content_navigation['views']['view']['redundant'] = true;
 920                                 }
 921
 922                                 wfProfileIn( __METHOD__ . '-edit' );
 923
 924                                 // Checks if user can edit the current page if it exists or create it otherwise
 925                                 if ( $title->quickUserCan( 'edit', $user ) && ( $title->exists() || $title->quickUserCan( 'create', $user ) ) ) {
 926                                         // Builds CSS class for talk page links
 927                                         $isTalkClass = $isTalk ? ' istalk' : '';
 928                                         // Whether the user is editing the page
 929                                         $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
 930                                         // Whether to show the "Add a new section" tab
 931                                         // Checks if this is a current rev of talk page and is not forced to be hidden
 932                                         $showNewSection = !$out->forceHideNewSectionLink()
 933                                                 && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
 934                                         $section = $request->getVal( 'section' );
 935
 936                                         $msgKey = $title->exists() || ( $title->getNamespace() == NS_MEDIAWIKI && $title->getDefaultMessageText() !== false ) ?
 937                                                 'edit' : 'create';
 938                                         $content_navigation['views']['edit'] = array(
 939                                                 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection ) ? 'selected' : '' ) . $isTalkClass,
 940                                                 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )->setContext( $this->getContext() )->text(),
 941                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 942                                                 'primary' => true, // don't collapse this in vector
 943                                         );
 944
 945                                         // section link
 946                                         if ( $showNewSection ) {
 947                                                 // Adds new section link
 948                                                 //$content_navigation['actions']['addsection']
 949                                                 $content_navigation['views']['addsection'] = array(
 950                                                         'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
 951                                                         'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )->setContext( $this->getContext() )->text(),
 952                                                         'href' => $title->getLocalURL( 'action=edit&section=new' )
 953                                                 );
 954                                         }
 955                                 // Checks if the page has some kind of viewable content
 956                                 } elseif ( $title->hasSourceText() ) {
 957                                         // Adds view source view link
 958                                         $content_navigation['views']['viewsource'] = array(
 959                                                 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
 960                                                 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )->setContext( $this->getContext() )->text(),
 961                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 962                                                 'primary' => true, // don't collapse this in vector
 963                                         );
 964                                 }
 965                                 wfProfileOut( __METHOD__ . '-edit' );
 966
 967                                 wfProfileIn( __METHOD__ . '-live' );
 968                                 // Checks if the page exists
 969                                 if ( $title->exists() ) {
 970                                         // Adds history view link
 971                                         $content_navigation['views']['history'] = array(
 972                                                 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
 973                                                 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )->setContext( $this->getContext() )->text(),
 974                                                 'href' => $title->getLocalURL( 'action=history' ),
 975                                                 'rel' => 'archives',
 976                                         );
 977
 978                                         if ( $title->quickUserCan( 'delete', $user ) ) {
 979                                                 $content_navigation['actions']['delete'] = array(
 980                                                         'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
 981                                                         'text' => wfMessageFallback( "$skname-action-delete", 'delete' )->setContext( $this->getContext() )->text(),
 982                                                         'href' => $title->getLocalURL( 'action=delete' )
 983                                                 );
 984                                         }
 985
 986                                         if ( $title->quickUserCan( 'move', $user ) ) {
 987                                                 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
 988                                                 $content_navigation['actions']['move'] = array(
 989                                                         'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
 990                                                         'text' => wfMessageFallback( "$skname-action-move", 'move' )->setContext( $this->getContext() )->text(),
 991                                                         'href' => $moveTitle->getLocalURL()
 992                                                 );
 993                                         }
 994                                 } else {
 995                                         // article doesn't exist or is deleted
 996                                         if ( $user->isAllowed( 'deletedhistory' ) ) {
 997                                                 $n = $title->isDeleted();
 998                                                 if ( $n ) {
 999                                                         $undelTitle = SpecialPage::getTitleFor( 'Undelete' );
1000                                                         // If the user can't undelete but can view deleted history show them a "View .. deleted" tab instead
1001                                                         $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
1002                                                         $content_navigation['actions']['undelete'] = array(
1003                                                                 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
1004                                                                 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
1005                                                                         ->setContext( $this->getContext() )->numParams( $n )->text(),
1006                                                                 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
1007                                                         );
1008                                                 }
1009                                         }
1010                                 }
1011
1012                                 if ( $title->getNamespace() !== NS_MEDIAWIKI && $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() ) {
1013                                         $mode = $title->isProtected() ? 'unprotect' : 'protect';
1014                                         $content_navigation['actions'][$mode] = array(
1015                                                 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
1016                                                 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->setContext( $this->getContext() )->text(),
1017                                                 'href' => $title->getLocalURL( "action=$mode" )
1018                                         );
1019                                 }
1020
1021                                 wfProfileOut( __METHOD__ . '-live' );
1022
1023                                 // Checks if the user is logged in
1024                                 if ( $this->loggedin && $user->isAllowedAll( 'viewmywatchlist', 'editmywatchlist' ) ) {
1025                                         /**
1026                                          * The following actions use messages which, if made particular to
1027                                          * the any specific skins, would break the Ajax code which makes this
1028                                          * action happen entirely inline. Skin::makeGlobalVariablesScript
1029                                          * defines a set of messages in a javascript object - and these
1030                                          * messages are assumed to be global for all skins. Without making
1031                                          * a change to that procedure these messages will have to remain as
1032                                          * the global versions.
1033                                          */
1034                                         $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
1035                                         $token = WatchAction::getWatchToken( $title, $user, $mode );
1036                                         $content_navigation['actions'][$mode] = array(
1037                                                 'class' => $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : false,
1038                                                 // uses 'watch' or 'unwatch' message
1039                                                 'text' => $this->msg( $mode )->text(),
1040                                                 'href' => $title->getLocalURL( array( 'action' => $mode, 'token' => $token ) )
1041                                         );
1042                                 }
1043                         }
1044
1045                         wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
1046
1047                         if ( $userCanRead && !$wgDisableLangConversion ) {
1048                                 $pageLang = $title->getPageLanguage();
1049                                 // Gets list of language variants
1050                                 $variants = $pageLang->getVariants();
1051                                 // Checks that language conversion is enabled and variants exist
1052                                 // And if it is not in the special namespace
1053                                 if ( count( $variants ) > 1 ) {
1054                                         // Gets preferred variant (note that user preference is
1055                                         // only possible for wiki content language variant)
1056                                         $preferred = $pageLang->getPreferredVariant();
1057                                         if ( Action::getActionName( $this ) === 'view' ) {
1058                                                 $params = $request->getQueryValues();
1059                                                 unset( $params['title'] );
1060                                         } else {
1061                                                 $params = array();
1062                                         }
1063                                         // Loops over each variant
1064                                         foreach ( $variants as $code ) {
1065                                                 // Gets variant name from language code
1066                                                 $varname = $pageLang->getVariantname( $code );
1067                                                 // Appends variant link
1068                                                 $content_navigation['variants'][] = array(
1069                                                         'class' => ( $code == $preferred ) ? 'selected' : false,
1070                                                         'text' => $varname,
1071                                                         'href' => $title->getLocalURL( array( 'variant' => $code ) + $params ),
1072                                                         'lang' => wfBCP47( $code ),
1073                                                         'hreflang' => wfBCP47( $code ),
1074                                                 );
1075                                         }
1076                                 }
1077                         }
1078                 } else {
1079                         // If it's not content, it's got to be a special page
1080                         $content_navigation['namespaces']['special'] = array(
1081                                 'class' => 'selected',
1082                                 'text' => $this->msg( 'nstab-special' )->text(),
1083                                 'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1084                                 'context' => 'subject'
1085                         );
1086
1087                         wfRunHooks( 'SkinTemplateNavigation::SpecialPage',
1088                                 array( &$this, &$content_navigation ) );
1089                 }
1090
1091                 // Equiv to SkinTemplateContentActions
1092                 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1093
1094                 // Setup xml ids and tooltip info
1095                 foreach ( $content_navigation as $section => &$links ) {
1096                         foreach ( $links as $key => &$link ) {
1097                                 $xmlID = $key;
1098                                 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1099                                         $xmlID = 'ca-nstab-' . $xmlID;
1100                                 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1101                                         $xmlID = 'ca-talk';
1102                                 } elseif ( $section == 'variants' ) {
1103                                         $xmlID = 'ca-varlang-' . $xmlID;
1104                                 } else {
1105                                         $xmlID = 'ca-' . $xmlID;
1106                                 }
1107                                 $link['id'] = $xmlID;
1108                         }
1109                 }
1110
1111                 # We don't want to give the watch tab an accesskey if the
1112                 # page is being edited, because that conflicts with the
1113                 # accesskey on the watch checkbox.  We also don't want to
1114                 # give the edit tab an accesskey, because that's fairly
1115                 # superfluous and conflicts with an accesskey (Ctrl-E) often
1116                 # used for editing in Safari.
1117                 if ( in_array( $action, array( 'edit', 'submit' ) ) ) {
1118                         if ( isset( $content_navigation['views']['edit'] ) ) {
1119                                 $content_navigation['views']['edit']['tooltiponly'] = true;
1120                         }
1121                         if ( isset( $content_navigation['actions']['watch'] ) ) {
1122                                 $content_navigation['actions']['watch']['tooltiponly'] = true;
1123                         }
1124                         if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1125                                 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1126                         }
1127                 }
1128
1129                 wfProfileOut( __METHOD__ );
1130
1131                 return $content_navigation;
1132         }
1133
1134         /**
1135          * an array of edit links by default used for the tabs
1136          * @return array
1137          * @private
1138          */
1139         function buildContentActionUrls( $content_navigation ) {
1140
1141                 wfProfileIn( __METHOD__ );
1142
1143                 // content_actions has been replaced with content_navigation for backwards
1144                 // compatibility and also for skins that just want simple tabs content_actions
1145                 // is now built by flattening the content_navigation arrays into one
1146
1147                 $content_actions = array();
1148
1149                 foreach ( $content_navigation as $links ) {
1150
1151                         foreach ( $links as $key => $value ) {
1152
1153                                 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1154                                         // Redundant tabs are dropped from content_actions
1155                                         continue;
1156                                 }
1157
1158                                 // content_actions used to have ids built using the "ca-$key" pattern
1159                                 // so the xmlID based id is much closer to the actual $key that we want
1160                                 // for that reason we'll just strip out the ca- if present and use
1161                                 // the latter potion of the "id" as the $key
1162                                 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1163                                         $key = substr( $value['id'], 3 );
1164                                 }
1165
1166                                 if ( isset( $content_actions[$key] ) ) {
1167                                         wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening content_navigation into content_actions." );
1168                                         continue;
1169                                 }
1170
1171                                 $content_actions[$key] = $value;
1172
1173                         }
1174
1175                 }
1176
1177                 wfProfileOut( __METHOD__ );
1178
1179                 return $content_actions;
1180         }
1181
1182         /**
1183          * build array of common navigation links
1184          * @return array
1185          * @private
1186          */
1187         protected function buildNavUrls() {
1188                 global $wgUploadNavigationUrl;
1189
1190                 wfProfileIn( __METHOD__ );
1191
1192                 $out = $this->getOutput();
1193                 $request = $this->getRequest();
1194
1195                 $nav_urls = array();
1196                 $nav_urls['mainpage'] = array( 'href' => self::makeMainPageUrl() );
1197                 if ( $wgUploadNavigationUrl ) {
1198                         $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1199                 } elseif ( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1200                         $nav_urls['upload'] = array( 'href' => self::makeSpecialUrl( 'Upload' ) );
1201                 } else {
1202                         $nav_urls['upload'] = false;
1203                 }
1204                 $nav_urls['specialpages'] = array( 'href' => self::makeSpecialUrl( 'Specialpages' ) );
1205
1206                 $nav_urls['print'] = false;
1207                 $nav_urls['permalink'] = false;
1208                 $nav_urls['info'] = false;
1209                 $nav_urls['whatlinkshere'] = false;
1210                 $nav_urls['recentchangeslinked'] = false;
1211                 $nav_urls['contributions'] = false;
1212                 $nav_urls['log'] = false;
1213                 $nav_urls['blockip'] = false;
1214                 $nav_urls['emailuser'] = false;
1215                 $nav_urls['userrights'] = false;
1216
1217                 // A print stylesheet is attached to all pages, but nobody ever
1218                 // figures that out. :)  Add a link...
1219                 if ( !$out->isPrintable() && ( $out->isArticle() || $this->getTitle()->isSpecialPage() ) ) {
1220                         $nav_urls['print'] = array(
1221                                 'text' => $this->msg( 'printableversion' )->text(),
1222                                 'href' => $this->getTitle()->getLocalURL(
1223                                         $request->appendQueryValue( 'printable', 'yes', true ) )
1224                         );
1225                 }
1226
1227                 if ( $out->isArticle() ) {
1228                         // Also add a "permalink" while we're at it
1229                         $revid = $this->getRevisionId();
1230                         if ( $revid ) {
1231                                 $nav_urls['permalink'] = array(
1232                                         'text' => $this->msg( 'permalink' )->text(),
1233                                         'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1234                                 );
1235                         }
1236
1237                         // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1238                         wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1239                                 array( &$this, &$nav_urls, &$revid, &$revid ) );
1240                 }
1241
1242                 if ( $out->isArticleRelated() ) {
1243                         $nav_urls['whatlinkshere'] = array(
1244                                 'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1245                         );
1246
1247                         $nav_urls['info'] = array(
1248                                 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1249                                 'href' => $this->getTitle()->getLocalURL( "action=info" )
1250                         );
1251
1252                         if ( $this->getTitle()->getArticleID() ) {
1253                                 $nav_urls['recentchangeslinked'] = array(
1254                                         'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1255                                 );
1256                         }
1257                 }
1258
1259                 $user = $this->getRelevantUser();
1260                 if ( $user ) {
1261                         $rootUser = $user->getName();
1262
1263                         $nav_urls['contributions'] = array(
1264                                 'text' => $this->msg( 'contributions', $rootUser )->text(),
1265                                 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1266                         );
1267
1268                         $nav_urls['log'] = array(
1269                                 'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1270                         );
1271
1272                         if ( $this->getUser()->isAllowed( 'block' ) ) {
1273                                 $nav_urls['blockip'] = array(
1274                                         'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1275                                 );
1276                         }
1277
1278                         if ( $this->showEmailUser( $user ) ) {
1279                                 $nav_urls['emailuser'] = array(
1280                                         'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1281                                 );
1282                         }
1283
1284                         $sur = new UserrightsPage;
1285                         $sur->setContext( $this->getContext() );
1286                         if ( $sur->userCanExecute( $this->getUser() ) ) {
1287                                 $nav_urls['userrights'] = array(
1288                                         'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1289                                 );
1290                         }
1291                 }
1292
1293                 wfProfileOut( __METHOD__ );
1294                 return $nav_urls;
1295         }
1296
1297         /**
1298          * Generate strings used for xml 'id' names
1299          * @return string
1300          * @private
1301          */
1302         function getNameSpaceKey() {
1303                 return $this->getTitle()->getNamespaceKey();
1304         }
1305
1306         public function commonPrintStylesheet() {
1307                 return false;
1308         }
1309 }
1310
1311 /**
1312  * Generic wrapper for template functions, with interface
1313  * compatible with what we use of PHPTAL 0.7.
1314  * @ingroup Skins
1315  */
1316 abstract class QuickTemplate {
1317         /**
1318          * Constructor
1319          */
1320         function __construct() {
1321                 $this->data = array();
1322                 $this->translator = new MediaWiki_I18N();
1323         }
1324
1325         /**
1326          * Sets the value $value to $name
1327          * @param $name
1328          * @param $value
1329          */
1330         public function set( $name, $value ) {
1331                 $this->data[$name] = $value;
1332         }
1333
1334         /**
1335          * Gets the template data requested
1336          * @since 1.22
1337          * @param string $name Key for the data
1338          * @param mixed $default Optional default (or null)
1339          * @return mixed The value of the data requested or the deafult
1340          */
1341         public function get( $name, $default = null ) {
1342                 if ( isset( $this->data[$name] ) ) {
1343                         return $this->data[$name];
1344                 } else {
1345                         return $default;
1346                 }
1347         }
1348
1349         /**
1350          * @param $name
1351          * @param $value
1352          */
1353         public function setRef( $name, &$value ) {
1354                 $this->data[$name] =& $value;
1355         }
1356
1357         /**
1358          * @param $t
1359          */
1360         public function setTranslator( &$t ) {
1361                 $this->translator = &$t;
1362         }
1363
1364         /**
1365          * Main function, used by classes that subclass QuickTemplate
1366          * to show the actual HTML output
1367          */
1368         abstract public function execute();
1369
1370         /**
1371          * @private
1372          */
1373         function text( $str ) {
1374                 echo htmlspecialchars( $this->data[$str] );
1375         }
1376
1377         /**
1378          * @private
1379          * @deprecated since 1.21; use Xml::encodeJsVar() or Xml::encodeJsCall() instead
1380          */
1381         function jstext( $str ) {
1382                 wfDeprecated( __METHOD__, '1.21' );
1383                 echo Xml::escapeJsString( $this->data[$str] );
1384         }
1385
1386         /**
1387          * @private
1388          */
1389         function html( $str ) {
1390                 echo $this->data[$str];
1391         }
1392
1393         /**
1394          * @private
1395          */
1396         function msg( $str ) {
1397                 echo htmlspecialchars( $this->translator->translate( $str ) );
1398         }
1399
1400         /**
1401          * @private
1402          */
1403         function msgHtml( $str ) {
1404                 echo $this->translator->translate( $str );
1405         }
1406
1407         /**
1408          * An ugly, ugly hack.
1409          * @private
1410          */
1411         function msgWiki( $str ) {
1412                 global $wgOut;
1413
1414                 $text = $this->translator->translate( $str );
1415                 echo $wgOut->parse( $text );
1416         }
1417
1418         /**
1419          * @private
1420          * @return bool
1421          */
1422         function haveData( $str ) {
1423                 return isset( $this->data[$str] );
1424         }
1425
1426         /**
1427          * @private
1428          *
1429          * @return bool
1430          */
1431         function haveMsg( $str ) {
1432                 $msg = $this->translator->translate( $str );
1433                 return ( $msg != '-' ) && ( $msg != '' ); # ????
1434         }
1435
1436         /**
1437          * Get the Skin object related to this object
1438          *
1439          * @return Skin object
1440          */
1441         public function getSkin() {
1442                 return $this->data['skin'];
1443         }
1444 }
1445
1446 /**
1447  * New base template for a skin's template extended from QuickTemplate
1448  * this class features helper methods that provide common ways of interacting
1449  * with the data stored in the QuickTemplate
1450  */
1451 abstract class BaseTemplate extends QuickTemplate {
1452
1453         /**
1454          * Get a Message object with its context set
1455          *
1456          * @param string $name message name
1457          * @return Message
1458          */
1459         public function getMsg( $name ) {
1460                 return $this->getSkin()->msg( $name );
1461         }
1462
1463         function msg( $str ) {
1464                 echo $this->getMsg( $str )->escaped();
1465         }
1466
1467         function msgHtml( $str ) {
1468                 echo $this->getMsg( $str )->text();
1469         }
1470
1471         function msgWiki( $str ) {
1472                 echo $this->getMsg( $str )->parseAsBlock();
1473         }
1474
1475         /**
1476          * Create an array of common toolbox items from the data in the quicktemplate
1477          * stored by SkinTemplate.
1478          * The resulting array is built according to a format intended to be passed
1479          * through makeListItem to generate the html.
1480          * @return array
1481          */
1482         function getToolbox() {
1483                 wfProfileIn( __METHOD__ );
1484
1485                 $toolbox = array();
1486                 if ( isset( $this->data['nav_urls']['whatlinkshere'] ) && $this->data['nav_urls']['whatlinkshere'] ) {
1487                         $toolbox['whatlinkshere'] = $this->data['nav_urls']['whatlinkshere'];
1488                         $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
1489                 }
1490                 if ( isset( $this->data['nav_urls']['recentchangeslinked'] ) && $this->data['nav_urls']['recentchangeslinked'] ) {
1491                         $toolbox['recentchangeslinked'] = $this->data['nav_urls']['recentchangeslinked'];
1492                         $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
1493                         $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
1494                 }
1495                 if ( isset( $this->data['feeds'] ) && $this->data['feeds'] ) {
1496                         $toolbox['feeds']['id'] = 'feedlinks';
1497                         $toolbox['feeds']['links'] = array();
1498                         foreach ( $this->data['feeds'] as $key => $feed ) {
1499                                 $toolbox['feeds']['links'][$key] = $feed;
1500                                 $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
1501                                 $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
1502                                 $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
1503                                 $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
1504                         }
1505                 }
1506                 foreach ( array( 'contributions', 'log', 'blockip', 'emailuser', 'userrights', 'upload', 'specialpages' ) as $special ) {
1507                         if ( isset( $this->data['nav_urls'][$special] ) && $this->data['nav_urls'][$special] ) {
1508                                 $toolbox[$special] = $this->data['nav_urls'][$special];
1509                                 $toolbox[$special]['id'] = "t-$special";
1510                         }
1511                 }
1512                 if ( isset( $this->data['nav_urls']['print'] ) && $this->data['nav_urls']['print'] ) {
1513                         $toolbox['print'] = $this->data['nav_urls']['print'];
1514                         $toolbox['print']['id'] = 't-print';
1515                         $toolbox['print']['rel'] = 'alternate';
1516                         $toolbox['print']['msg'] = 'printableversion';
1517                 }
1518                 if ( isset( $this->data['nav_urls']['permalink'] ) && $this->data['nav_urls']['permalink'] ) {
1519                         $toolbox['permalink'] = $this->data['nav_urls']['permalink'];
1520                         if ( $toolbox['permalink']['href'] === '' ) {
1521                                 unset( $toolbox['permalink']['href'] );
1522                                 $toolbox['ispermalink']['tooltiponly'] = true;
1523                                 $toolbox['ispermalink']['id'] = 't-ispermalink';
1524                                 $toolbox['ispermalink']['msg'] = 'permalink';
1525                         } else {
1526                                 $toolbox['permalink']['id'] = 't-permalink';
1527                         }
1528                 }
1529                 if ( isset( $this->data['nav_urls']['info'] ) && $this->data['nav_urls']['info'] ) {
1530                         $toolbox['info'] = $this->data['nav_urls']['info'];
1531                         $toolbox['info']['id'] = 't-info';
1532                 }
1533
1534                 wfRunHooks( 'BaseTemplateToolbox', array( &$this, &$toolbox ) );
1535                 wfProfileOut( __METHOD__ );
1536                 return $toolbox;
1537         }
1538
1539         /**
1540          * Create an array of personal tools items from the data in the quicktemplate
1541          * stored by SkinTemplate.
1542          * The resulting array is built according to a format intended to be passed
1543          * through makeListItem to generate the html.
1544          * This is in reality the same list as already stored in personal_urls
1545          * however it is reformatted so that you can just pass the individual items
1546          * to makeListItem instead of hardcoding the element creation boilerplate.
1547          * @return array
1548          */
1549         function getPersonalTools() {
1550                 $personal_tools = array();
1551                 foreach ( $this->get( 'personal_urls' ) as $key => $plink ) {
1552                         # The class on a personal_urls item is meant to go on the <a> instead
1553                         # of the <li> so we have to use a single item "links" array instead
1554                         # of using most of the personal_url's keys directly.
1555                         $ptool = array(
1556                                 'links' => array(
1557                                         array( 'single-id' => "pt-$key" ),
1558                                 ),
1559                                 'id' => "pt-$key",
1560                         );
1561                         if ( isset( $plink['active'] ) ) {
1562                                 $ptool['active'] = $plink['active'];
1563                         }
1564                         foreach ( array( 'href', 'class', 'text' ) as $k ) {
1565                                 if ( isset( $plink[$k] ) ) {
1566                                         $ptool['links'][0][$k] = $plink[$k];
1567                                 }
1568                         }
1569                         $personal_tools[$key] = $ptool;
1570                 }
1571                 return $personal_tools;
1572         }
1573
1574         function getSidebar( $options = array() ) {
1575                 // Force the rendering of the following portals
1576                 $sidebar = $this->data['sidebar'];
1577                 if ( !isset( $sidebar['SEARCH'] ) ) {
1578                         $sidebar['SEARCH'] = true;
1579                 }
1580                 if ( !isset( $sidebar['TOOLBOX'] ) ) {
1581                         $sidebar['TOOLBOX'] = true;
1582                 }
1583                 if ( !isset( $sidebar['LANGUAGES'] ) ) {
1584                         $sidebar['LANGUAGES'] = true;
1585                 }
1586
1587                 if ( !isset( $options['search'] ) || $options['search'] !== true ) {
1588                         unset( $sidebar['SEARCH'] );
1589                 }
1590                 if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
1591                         unset( $sidebar['TOOLBOX'] );
1592                 }
1593                 if ( isset( $options['languages'] ) && $options['languages'] === false ) {
1594                         unset( $sidebar['LANGUAGES'] );
1595                 }
1596
1597                 $boxes = array();
1598                 foreach ( $sidebar as $boxName => $content ) {
1599                         if ( $content === false ) {
1600                                 continue;
1601                         }
1602                         switch ( $boxName ) {
1603                         case 'SEARCH':
1604                                 // Search is a special case, skins should custom implement this
1605                                 $boxes[$boxName] = array(
1606                                         'id' => 'p-search',
1607                                         'header' => $this->getMsg( 'search' )->text(),
1608                                         'generated' => false,
1609                                         'content' => true,
1610                                 );
1611                                 break;
1612                         case 'TOOLBOX':
1613                                 $msgObj = $this->getMsg( 'toolbox' );
1614                                 $boxes[$boxName] = array(
1615                                         'id' => 'p-tb',
1616                                         'header' => $msgObj->exists() ? $msgObj->text() : 'toolbox',
1617                                         'generated' => false,
1618                                         'content' => $this->getToolbox(),
1619                                 );
1620                                 break;
1621                         case 'LANGUAGES':
1622                                 if ( $this->data['language_urls'] ) {
1623                                         $msgObj = $this->getMsg( 'otherlanguages' );
1624                                         $boxes[$boxName] = array(
1625                                                 'id' => 'p-lang',
1626                                                 'header' => $msgObj->exists() ? $msgObj->text() : 'otherlanguages',
1627                                                 'generated' => false,
1628                                                 'content' => $this->data['language_urls'],
1629                                         );
1630                                 }
1631                                 break;
1632                         default:
1633                                 $msgObj = $this->getMsg( $boxName );
1634                                 $boxes[$boxName] = array(
1635                                         'id' => "p-$boxName",
1636                                         'header' => $msgObj->exists() ? $msgObj->text() : $boxName,
1637                                         'generated' => true,
1638                                         'content' => $content,
1639                                 );
1640                                 break;
1641                         }
1642                 }
1643
1644                 // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
1645                 $hookContents = null;
1646                 if ( isset( $boxes['TOOLBOX'] ) ) {
1647                         ob_start();
1648                         // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
1649                         // can abort and avoid outputting double toolbox links
1650                         wfRunHooks( 'SkinTemplateToolboxEnd', array( &$this, true ) );
1651                         $hookContents = ob_get_contents();
1652                         ob_end_clean();
1653                         if ( !trim( $hookContents ) ) {
1654                                 $hookContents = null;
1655                         }
1656                 }
1657                 // END hack
1658
1659                 if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
1660                         foreach ( $boxes as $boxName => $box ) {
1661                                 if ( is_array( $box['content'] ) ) {
1662                                         $content = '<ul>';
1663                                         foreach ( $box['content'] as $key => $val ) {
1664                                                 $content .= "\n " . $this->makeListItem( $key, $val );
1665                                         }
1666                                         // HACK, shove the toolbox end onto the toolbox if we're rendering itself
1667                                         if ( $hookContents ) {
1668                                                 $content .= "\n $hookContents";
1669                                         }
1670                                         // END hack
1671                                         $content .= "\n</ul>\n";
1672                                         $boxes[$boxName]['content'] = $content;
1673                                 }
1674                         }
1675                 } else {
1676                         if ( $hookContents ) {
1677                                 $boxes['TOOLBOXEND'] = array(
1678                                         'id' => 'p-toolboxend',
1679                                         'header' => $boxes['TOOLBOX']['header'],
1680                                         'generated' => false,
1681                                         'content' => "<ul>{$hookContents}</ul>",
1682                                 );
1683                                 // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
1684                                 $boxes2 = array();
1685                                 foreach ( $boxes as $key => $box ) {
1686                                         if ( $key === 'TOOLBOXEND' ) {
1687                                                 continue;
1688                                         }
1689                                         $boxes2[$key] = $box;
1690                                         if ( $key === 'TOOLBOX' ) {
1691                                                 $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
1692                                         }
1693                                 }
1694                                 $boxes = $boxes2;
1695                                 // END hack
1696                         }
1697                 }
1698
1699                 return $boxes;
1700         }
1701
1702         /**
1703          * Makes a link, usually used by makeListItem to generate a link for an item
1704          * in a list used in navigation lists, portlets, portals, sidebars, etc...
1705          *
1706          * @param string $key usually a key from the list you are generating this
1707          * link from.
1708          * @param array $item contains some of a specific set of keys.
1709          *
1710          * The text of the link will be generated either from the contents of the
1711          * "text" key in the $item array, if a "msg" key is present a message by
1712          * that name will be used, and if neither of those are set the $key will be
1713          * used as a message name.
1714          *
1715          * If a "href" key is not present makeLink will just output htmlescaped text.
1716          * The "href", "id", "class", "rel", and "type" keys are used as attributes
1717          * for the link if present.
1718          *
1719          * If an "id" or "single-id" (if you don't want the actual id to be output
1720          * on the link) is present it will be used to generate a tooltip and
1721          * accesskey for the link.
1722          *
1723          * If you don't want an accesskey, set $item['tooltiponly'] = true;
1724          *
1725          * @param array $options can be used to affect the output of a link.
1726          * Possible options are:
1727          *   - 'text-wrapper' key to specify a list of elements to wrap the text of
1728          *   a link in. This should be an array of arrays containing a 'tag' and
1729          *   optionally an 'attributes' key. If you only have one element you don't
1730          *   need to wrap it in another array. eg: To use <a><span>...</span></a>
1731          *   in all links use array( 'text-wrapper' => array( 'tag' => 'span' ) )
1732          *   for your options.
1733          *   - 'link-class' key can be used to specify additional classes to apply
1734          *   to all links.
1735          *   - 'link-fallback' can be used to specify a tag to use instead of "<a>"
1736          *   if there is no link. eg: If you specify 'link-fallback' => 'span' than
1737          *   any non-link will output a "<span>" instead of just text.
1738          *
1739          * @return string
1740          */
1741         function makeLink( $key, $item, $options = array() ) {
1742                 if ( isset( $item['text'] ) ) {
1743                         $text = $item['text'];
1744                 } else {
1745                         $text = $this->translator->translate( isset( $item['msg'] ) ? $item['msg'] : $key );
1746                 }
1747
1748                 $html = htmlspecialchars( $text );
1749
1750                 if ( isset( $options['text-wrapper'] ) ) {
1751                         $wrapper = $options['text-wrapper'];
1752                         if ( isset( $wrapper['tag'] ) ) {
1753                                 $wrapper = array( $wrapper );
1754                         }
1755                         while ( count( $wrapper ) > 0 ) {
1756                                 $element = array_pop( $wrapper );
1757                                 $html = Html::rawElement( $element['tag'], isset( $element['attributes'] ) ? $element['attributes'] : null, $html );
1758                         }
1759                 }
1760
1761                 if ( isset( $item['href'] ) || isset( $options['link-fallback'] ) ) {
1762                         $attrs = $item;
1763                         foreach ( array( 'single-id', 'text', 'msg', 'tooltiponly' ) as $k ) {
1764                                 unset( $attrs[$k] );
1765                         }
1766
1767                         if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
1768                                 $item['single-id'] = $item['id'];
1769                         }
1770                         if ( isset( $item['single-id'] ) ) {
1771                                 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
1772                                         $title = Linker::titleAttrib( $item['single-id'] );
1773                                         if ( $title !== false ) {
1774                                                 $attrs['title'] = $title;
1775                                         }
1776                                 } else {
1777                                         $tip = Linker::tooltipAndAccesskeyAttribs( $item['single-id'] );
1778                                         if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
1779                                                 $attrs['title'] = $tip['title'];
1780                                         }
1781                                         if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
1782                                                 $attrs['accesskey'] = $tip['accesskey'];
1783                                         }
1784                                 }
1785                         }
1786                         if ( isset( $options['link-class'] ) ) {
1787                                 if ( isset( $attrs['class'] ) ) {
1788                                         $attrs['class'] .= " {$options['link-class']}";
1789                                 } else {
1790                                         $attrs['class'] = $options['link-class'];
1791                                 }
1792                         }
1793                         $html = Html::rawElement( isset( $attrs['href'] ) ? 'a' : $options['link-fallback'], $attrs, $html );
1794                 }
1795
1796                 return $html;
1797         }
1798
1799         /**
1800          * Generates a list item for a navigation, portlet, portal, sidebar... list
1801          *
1802          * @param $key string, usually a key from the list you are generating this link from.
1803          * @param $item array, of list item data containing some of a specific set of keys.
1804          * The "id" and "class" keys will be used as attributes for the list item,
1805          * if "active" contains a value of true a "active" class will also be appended to class.
1806          *
1807          * @param $options array
1808          *
1809          * If you want something other than a "<li>" you can pass a tag name such as
1810          * "tag" => "span" in the $options array to change the tag used.
1811          * link/content data for the list item may come in one of two forms
1812          * A "links" key may be used, in which case it should contain an array with
1813          * a list of links to include inside the list item, see makeLink for the
1814          * format of individual links array items.
1815          *
1816          * Otherwise the relevant keys from the list item $item array will be passed
1817          * to makeLink instead. Note however that "id" and "class" are used by the
1818          * list item directly so they will not be passed to makeLink
1819          * (however the link will still support a tooltip and accesskey from it)
1820          * If you need an id or class on a single link you should include a "links"
1821          * array with just one link item inside of it.
1822          * $options is also passed on to makeLink calls
1823          *
1824          * @return string
1825          */
1826         function makeListItem( $key, $item, $options = array() ) {
1827                 if ( isset( $item['links'] ) ) {
1828                         $html = '';
1829                         foreach ( $item['links'] as $linkKey => $link ) {
1830                                 $html .= $this->makeLink( $linkKey, $link, $options );
1831                         }
1832                 } else {
1833                         $link = $item;
1834                         // These keys are used by makeListItem and shouldn't be passed on to the link
1835                         foreach ( array( 'id', 'class', 'active', 'tag' ) as $k ) {
1836                                 unset( $link[$k] );
1837                         }
1838                         if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
1839                                 // The id goes on the <li> not on the <a> for single links
1840                                 // but makeSidebarLink still needs to know what id to use when
1841                                 // generating tooltips and accesskeys.
1842                                 $link['single-id'] = $item['id'];
1843                         }
1844                         $html = $this->makeLink( $key, $link, $options );
1845                 }
1846
1847                 $attrs = array();
1848                 foreach ( array( 'id', 'class' ) as $attr ) {
1849                         if ( isset( $item[$attr] ) ) {
1850                                 $attrs[$attr] = $item[$attr];
1851                         }
1852                 }
1853                 if ( isset( $item['active'] ) && $item['active'] ) {
1854                         if ( !isset( $attrs['class'] ) ) {
1855                                 $attrs['class'] = '';
1856                         }
1857                         $attrs['class'] .= ' active';
1858                         $attrs['class'] = trim( $attrs['class'] );
1859                 }
1860                 return Html::rawElement( isset( $options['tag'] ) ? $options['tag'] : 'li', $attrs, $html );
1861         }
1862
1863         function makeSearchInput( $attrs = array() ) {
1864                 $realAttrs = array(
1865                         'type' => 'search',
1866                         'name' => 'search',
1867                         'placeholder' => wfMessage( 'searchsuggest-search' )->text(),
1868                         'value' => $this->get( 'search', '' ),
1869                 );
1870                 $realAttrs = array_merge( $realAttrs, Linker::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
1871                 return Html::element( 'input', $realAttrs );
1872         }
1873
1874         function makeSearchButton( $mode, $attrs = array() ) {
1875                 switch ( $mode ) {
1876                         case 'go':
1877                         case 'fulltext':
1878                                 $realAttrs = array(
1879                                         'type' => 'submit',
1880                                         'name' => $mode,
1881                                         'value' => $this->translator->translate(
1882                                                 $mode == 'go' ? 'searcharticle' : 'searchbutton' ),
1883                                 );
1884                                 $realAttrs = array_merge(
1885                                         $realAttrs,
1886                                         Linker::tooltipAndAccesskeyAttribs( "search-$mode" ),
1887                                         $attrs
1888                                 );
1889                                 return Html::element( 'input', $realAttrs );
1890                         case 'image':
1891                                 $buttonAttrs = array(
1892                                         'type' => 'submit',
1893                                         'name' => 'button',
1894                                 );
1895                                 $buttonAttrs = array_merge(
1896                                         $buttonAttrs,
1897                                         Linker::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
1898                                         $attrs
1899                                 );
1900                                 unset( $buttonAttrs['src'] );
1901                                 unset( $buttonAttrs['alt'] );
1902                                 unset( $buttonAttrs['width'] );
1903                                 unset( $buttonAttrs['height'] );
1904                                 $imgAttrs = array(
1905                                         'src' => $attrs['src'],
1906                                         'alt' => isset( $attrs['alt'] )
1907                                                 ? $attrs['alt']
1908                                                 : $this->translator->translate( 'searchbutton' ),
1909                                         'width' => isset( $attrs['width'] ) ? $attrs['width'] : null,
1910                                         'height' => isset( $attrs['height'] ) ? $attrs['height'] : null,
1911                                 );
1912                                 return Html::rawElement( 'button', $buttonAttrs, Html::element( 'img', $imgAttrs ) );
1913                         default:
1914                                 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
1915                 }
1916         }
1917
1918         /**
1919          * Returns an array of footerlinks trimmed down to only those footer links that
1920          * are valid.
1921          * If you pass "flat" as an option then the returned array will be a flat array
1922          * of footer icons instead of a key/value array of footerlinks arrays broken
1923          * up into categories.
1924          * @return array|mixed
1925          */
1926         function getFooterLinks( $option = null ) {
1927                 $footerlinks = $this->get( 'footerlinks' );
1928
1929                 // Reduce footer links down to only those which are being used
1930                 $validFooterLinks = array();
1931                 foreach ( $footerlinks as $category => $links ) {
1932                         $validFooterLinks[$category] = array();
1933                         foreach ( $links as $link ) {
1934                                 if ( isset( $this->data[$link] ) && $this->data[$link] ) {
1935                                         $validFooterLinks[$category][] = $link;
1936                                 }
1937                         }
1938                         if ( count( $validFooterLinks[$category] ) <= 0 ) {
1939                                 unset( $validFooterLinks[$category] );
1940                         }
1941                 }
1942
1943                 if ( $option == 'flat' ) {
1944                         // fold footerlinks into a single array using a bit of trickery
1945                         $validFooterLinks = call_user_func_array(
1946                                 'array_merge',
1947                                 array_values( $validFooterLinks )
1948                         );
1949                 }
1950
1951                 return $validFooterLinks;
1952         }
1953
1954         /**
1955          * Returns an array of footer icons filtered down by options relevant to how
1956          * the skin wishes to display them.
1957          * If you pass "icononly" as the option all footer icons which do not have an
1958          * image icon set will be filtered out.
1959          * If you pass "nocopyright" then MediaWiki's copyright icon will not be included
1960          * in the list of footer icons. This is mostly useful for skins which only
1961          * display the text from footericons instead of the images and don't want a
1962          * duplicate copyright statement because footerlinks already rendered one.
1963          * @return
1964          */
1965         function getFooterIcons( $option = null ) {
1966                 // Generate additional footer icons
1967                 $footericons = $this->get( 'footericons' );
1968
1969                 if ( $option == 'icononly' ) {
1970                         // Unset any icons which don't have an image
1971                         foreach ( $footericons as &$footerIconsBlock ) {
1972                                 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
1973                                         if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
1974                                                 unset( $footerIconsBlock[$footerIconKey] );
1975                                         }
1976                                 }
1977                         }
1978                         // Redo removal of any empty blocks
1979                         foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
1980                                 if ( count( $footerIconsBlock ) <= 0 ) {
1981                                         unset( $footericons[$footerIconsKey] );
1982                                 }
1983                         }
1984                 } elseif ( $option == 'nocopyright' ) {
1985                         unset( $footericons['copyright']['copyright'] );
1986                         if ( count( $footericons['copyright'] ) <= 0 ) {
1987                                 unset( $footericons['copyright'] );
1988                         }
1989                 }
1990
1991                 return $footericons;
1992         }
1993
1994         /**
1995          * Output the basic end-page trail including bottomscripts, reporttime, and
1996          * debug stuff. This should be called right before outputting the closing
1997          * body and html tags.
1998          */
1999         function printTrail() { ?>
2000 <?php $this->html( 'bottomscripts' ); /* JS call to runBodyOnloadHook */ ?>
2001 <?php $this->html( 'reporttime' ) ?>
2002 <?php echo MWDebug::getDebugHTML( $this->getSkin()->getContext() );
2003         }
2004
2005 }