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