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                         Action::getActionName( $this ) === 'view' &&
 402                         ( $title->exists() || $title->getNamespace() == NS_MEDIAWIKI ) ) {
 403                         $pageLang = $title->getPageViewLanguage();
 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->formatLanguageName( $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          * Format language name for use in sidebar interlanguage links list.
 503          * By default it is capitalized.
 504          *
 505          * @param $name string Language name, e.g. "English" or "español"
 506          * @return string
 507          * @private
 508          */
 509         function formatLanguageName( $name ) {
 510                 return $this->getLanguage()->ucfirst( $name );
 511         }
 512
 513         /**
 514          * Output the string, or print error message if it's
 515          * an error object of the appropriate type.
 516          * For the base class, assume strings all around.
 517          *
 518          * @param $str Mixed
 519          * @private
 520          */
 521         function printOrError( $str ) {
 522                 echo $str;
 523         }
 524
 525         /**
 526          * Output a boolean indiciating if buildPersonalUrls should output separate
 527          * login and create account links or output a combined link
 528          * By default we simply return a global config setting that affects most skins
 529          * This is setup as a method so that like with $wgLogo and getLogo() a skin
 530          * can override this setting and always output one or the other if it has
 531          * a reason it can't output one of the two modes.
 532          * @return bool
 533          */
 534         function useCombinedLoginLink() {
 535                 global $wgUseCombinedLoginLink;
 536                 return $wgUseCombinedLoginLink;
 537         }
 538
 539         /**
 540          * build array of urls for personal toolbar
 541          * @return array
 542          */
 543         protected function buildPersonalUrls() {
 544                 global $wgSecureLogin;
 545
 546                 $title = $this->getTitle();
 547                 $request = $this->getRequest();
 548                 $pageurl = $title->getLocalURL();
 549                 wfProfileIn( __METHOD__ );
 550
 551                 /* set up the default links for the personal toolbar */
 552                 $personal_urls = array();
 553
 554                 # Due to bug 32276, if a user does not have read permissions,
 555                 # $this->getTitle() will just give Special:Badtitle, which is
 556                 # not especially useful as a returnto parameter. Use the title
 557                 # from the request instead, if there was one.
 558                 if ( $this->getUser()->isAllowed( 'read' ) ) {
 559                         $page = $this->getTitle();
 560                 } else {
 561                         $page = Title::newFromText( $request->getVal( 'title', '' ) );
 562                 }
 563                 $page = $request->getVal( 'returnto', $page );
 564                 $a = array();
 565                 if ( strval( $page ) !== '' ) {
 566                         $a['returnto'] = $page;
 567                         $query = $request->getVal( 'returntoquery', $this->thisquery );
 568                         if( $query != '' ) {
 569                                 $a['returntoquery'] = $query;
 570                         }
 571                 }
 572
 573                 if ( $wgSecureLogin && $request->detectProtocol() === 'https' ) {
 574                         $a['wpStickHTTPS'] = true;
 575                 }
 576
 577                 $returnto = wfArrayToCGI( $a );
 578                 if( $this->loggedin ) {
 579                         $personal_urls['userpage'] = array(
 580                                 'text' => $this->username,
 581                                 'href' => &$this->userpageUrlDetails['href'],
 582                                 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 583                                 'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
 584                                 'dir' => 'auto'
 585                         );
 586                         $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 587                         $personal_urls['mytalk'] = array(
 588                                 'text' => $this->msg( 'mytalk' )->text(),
 589                                 'href' => &$usertalkUrlDetails['href'],
 590                                 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 591                                 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
 592                         );
 593                         $href = self::makeSpecialUrl( 'Preferences' );
 594                         $personal_urls['preferences'] = array(
 595                                 'text' => $this->msg( 'mypreferences' )->text(),
 596                                 'href' => $href,
 597                                 'active' => ( $href == $pageurl )
 598                         );
 599                         $href = self::makeSpecialUrl( 'Watchlist' );
 600                         $personal_urls['watchlist'] = array(
 601                                 'text' => $this->msg( 'mywatchlist' )->text(),
 602                                 'href' => $href,
 603                                 'active' => ( $href == $pageurl )
 604                         );
 605
 606                         # We need to do an explicit check for Special:Contributions, as we
 607                         # have to match both the title, and the target, which could come
 608                         # from request values (Special:Contributions?target=Jimbo_Wales)
 609                         # or be specified in "sub page" form
 610                         # (Special:Contributions/Jimbo_Wales). The plot
 611                         # thickens, because the Title object is altered for special pages,
 612                         # so it doesn't contain the original alias-with-subpage.
 613                         $origTitle = Title::newFromText( $request->getText( 'title' ) );
 614                         if( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
 615                                 list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
 616                                 $active = $spName == 'Contributions'
 617                                         && ( ( $spPar && $spPar == $this->username )
 618                                                 || $request->getText( 'target' ) == $this->username );
 619                         } else {
 620                                 $active = false;
 621                         }
 622
 623                         $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
 624                         $personal_urls['mycontris'] = array(
 625                                 'text' => $this->msg( 'mycontris' )->text(),
 626                                 'href' => $href,
 627                                 'active' => $active
 628                         );
 629                         $personal_urls['logout'] = array(
 630                                 'text' => $this->msg( 'userlogout' )->text(),
 631                                 'href' => self::makeSpecialUrl( 'Userlogout',
 632                                         // userlogout link must always contain an & character, otherwise we might not be able
 633                                         // to detect a buggy precaching proxy (bug 17790)
 634                                         $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto
 635                                 ),
 636                                 'active' => false
 637                         );
 638                 } else {
 639                         $useCombinedLoginLink = $this->useCombinedLoginLink();
 640                         $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
 641                                 ? 'nav-login-createaccount'
 642                                 : 'login';
 643                         $is_signup = $request->getText( 'type' ) == 'signup';
 644
 645                         # anonlogin & login are the same
 646                         global $wgSecureLogin;
 647                         $proto = $wgSecureLogin ? PROTO_HTTPS : null;
 648
 649                         $login_id = $this->showIPinHeader() ? 'anonlogin' : 'login';
 650                         $login_url = array(
 651                                 'text' => $this->msg( $loginlink )->text(),
 652                                 'href' => self::makeSpecialUrl( 'Userlogin', $returnto, $proto ),
 653                                 'active' => $title->isSpecial( 'Userlogin' ) && ( $loginlink == 'nav-login-createaccount' || !$is_signup ),
 654                                 'class' => $wgSecureLogin ? 'link-https' : ''
 655                         );
 656                         $createaccount_url = array(
 657                                 'text' => $this->msg( 'createaccount' )->text(),
 658                                 'href' => self::makeSpecialUrl( 'Userlogin', "$returnto&type=signup", $proto ),
 659                                 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup,
 660                                 'class' => $wgSecureLogin ? 'link-https' : ''
 661                         );
 662
 663                         if( $this->showIPinHeader() ) {
 664                                 $href = &$this->userpageUrlDetails['href'];
 665                                 $personal_urls['anonuserpage'] = array(
 666                                         'text' => $this->username,
 667                                         'href' => $href,
 668                                         'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
 669                                         'active' => ( $pageurl == $href )
 670                                 );
 671                                 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
 672                                 $href = &$usertalkUrlDetails['href'];
 673                                 $personal_urls['anontalk'] = array(
 674                                         'text' => $this->msg( 'anontalk' )->text(),
 675                                         'href' => $href,
 676                                         'class' => $usertalkUrlDetails['exists'] ? false : 'new',
 677                                         'active' => ( $pageurl == $href )
 678                                 );
 679                         }
 680
 681                         if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
 682                                 $personal_urls['createaccount'] = $createaccount_url;
 683                         }
 684
 685                         $personal_urls[$login_id] = $login_url;
 686                 }
 687
 688                 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title ) );
 689                 wfProfileOut( __METHOD__ );
 690                 return $personal_urls;
 691         }
 692
 693         /**
 694          * TODO document
 695          * @param  $title Title
 696          * @param  $message String message key
 697          * @param  $selected Bool
 698          * @param  $query String
 699          * @param  $checkEdit Bool
 700          * @return array
 701          */
 702         function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
 703                 $classes = array();
 704                 if( $selected ) {
 705                         $classes[] = 'selected';
 706                 }
 707                 if( $checkEdit && !$title->isKnown() ) {
 708                         $classes[] = 'new';
 709                         $query = 'action=edit&redlink=1';
 710                 }
 711
 712                 // wfMessageFallback will nicely accept $message as an array of fallbacks
 713                 // or just a single key
 714                 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
 715                 if ( is_array( $message ) ) {
 716                         // for hook compatibility just keep the last message name
 717                         $message = end( $message );
 718                 }
 719                 if ( $msg->exists() ) {
 720                         $text = $msg->text();
 721                 } else {
 722                         global $wgContLang;
 723                         $text = $wgContLang->getFormattedNsText(
 724                                 MWNamespace::getSubject( $title->getNamespace() ) );
 725                 }
 726
 727                 $result = array();
 728                 if( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
 729                                 $title, $message, $selected, $checkEdit,
 730                                 &$classes, &$query, &$text, &$result ) ) ) {
 731                         return $result;
 732                 }
 733
 734                 return array(
 735                         'class' => implode( ' ', $classes ),
 736                         'text' => $text,
 737                         'href' => $title->getLocalUrl( $query ),
 738                         'primary' => true );
 739         }
 740
 741         function makeTalkUrlDetails( $name, $urlaction = '' ) {
 742                 $title = Title::newFromText( $name );
 743                 if( !is_object( $title ) ) {
 744                         throw new MWException( __METHOD__ . " given invalid pagename $name" );
 745                 }
 746                 $title = $title->getTalkPage();
 747                 self::checkTitle( $title, $name );
 748                 return array(
 749                         'href' => $title->getLocalURL( $urlaction ),
 750                         'exists' => $title->getArticleID() != 0,
 751                 );
 752         }
 753
 754         function makeArticleUrlDetails( $name, $urlaction = '' ) {
 755                 $title = Title::newFromText( $name );
 756                 $title= $title->getSubjectPage();
 757                 self::checkTitle( $title, $name );
 758                 return array(
 759                         'href' => $title->getLocalURL( $urlaction ),
 760                         'exists' => $title->getArticleID() != 0,
 761                 );
 762         }
 763
 764         /**
 765          * a structured array of links usually used for the tabs in a skin
 766          *
 767          * There are 4 standard sections
 768          * namespaces: Used for namespace tabs like special, page, and talk namespaces
 769          * views: Used for primary page views like read, edit, history
 770          * actions: Used for most extra page actions like deletion, protection, etc...
 771          * variants: Used to list the language variants for the page
 772          *
 773          * Each section's value is a key/value array of links for that section.
 774          * The links themseves have these common keys:
 775          * - class: The css classes to apply to the tab
 776          * - text: The text to display on the tab
 777          * - href: The href for the tab to point to
 778          * - rel: An optional rel= for the tab's link
 779          * - redundant: If true the tab will be dropped in skins using content_actions
 780          *   this is useful for tabs like "Read" which only have meaning in skins that
 781          *   take special meaning from the grouped structure of content_navigation
 782          *
 783          * Views also have an extra key which can be used:
 784          * - primary: If this is not true skins like vector may try to hide the tab
 785          *            when the user has limited space in their browser window
 786          *
 787          * content_navigation using code also expects these ids to be present on the
 788          * links, however these are usually automatically generated by SkinTemplate
 789          * itself and are not necessary when using a hook. The only things these may
 790          * matter to are people modifying content_navigation after it's initial creation:
 791          * - id: A "preferred" id, most skins are best off outputting this preferred id for best compatibility
 792          * - tooltiponly: This is set to true for some tabs in cases where the system
 793          *                believes that the accesskey should not be added to the tab.
 794          *
 795          * @return array
 796          */
 797         protected function buildContentNavigationUrls() {
 798                 global $wgDisableLangConversion;
 799
 800                 wfProfileIn( __METHOD__ );
 801
 802                 // Display tabs for the relevant title rather than always the title itself
 803                 $title = $this->getRelevantTitle();
 804                 $onPage = $title->equals( $this->getTitle() );
 805
 806                 $out = $this->getOutput();
 807                 $request = $this->getRequest();
 808                 $user = $this->getUser();
 809
 810                 $content_navigation = array(
 811                         'namespaces' => array(),
 812                         'views' => array(),
 813                         'actions' => array(),
 814                         'variants' => array()
 815                 );
 816
 817                 // parameters
 818                 $action = $request->getVal( 'action', 'view' );
 819
 820                 $userCanRead = $title->quickUserCan( 'read', $user );
 821
 822                 $preventActiveTabs = false;
 823                 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
 824
 825                 // Checks if page is some kind of content
 826                 if( $title->canExist() ) {
 827                         // Gets page objects for the related namespaces
 828                         $subjectPage = $title->getSubjectPage();
 829                         $talkPage = $title->getTalkPage();
 830
 831                         // Determines if this is a talk page
 832                         $isTalk = $title->isTalkPage();
 833
 834                         // Generates XML IDs from namespace names
 835                         $subjectId = $title->getNamespaceKey( '' );
 836
 837                         if ( $subjectId == 'main' ) {
 838                                 $talkId = 'talk';
 839                         } else {
 840                                 $talkId = "{$subjectId}_talk";
 841                         }
 842
 843                         $skname = $this->skinname;
 844
 845                         // Adds namespace links
 846                         $subjectMsg = array( "nstab-$subjectId" );
 847                         if ( $subjectPage->isMainPage() ) {
 848                                 array_unshift( $subjectMsg, 'mainpage-nstab' );
 849                         }
 850                         $content_navigation['namespaces'][$subjectId] = $this->tabAction(
 851                                 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
 852                         );
 853                         $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
 854                         $content_navigation['namespaces'][$talkId] = $this->tabAction(
 855                                 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
 856                         );
 857                         $content_navigation['namespaces'][$talkId]['context'] = 'talk';
 858
 859                         if ( $userCanRead ) {
 860                                 // Adds view view link
 861                                 if ( $title->exists() ) {
 862                                         $content_navigation['views']['view'] = $this->tabAction(
 863                                                 $isTalk ? $talkPage : $subjectPage,
 864                                                 array( "$skname-view-view", 'view' ),
 865                                                 ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
 866                                         );
 867                                         // signal to hide this from simple content_actions
 868                                         $content_navigation['views']['view']['redundant'] = true;
 869                                 }
 870
 871                                 wfProfileIn( __METHOD__ . '-edit' );
 872
 873                                 // Checks if user can edit the current page if it exists or create it otherwise
 874                                 if ( $title->quickUserCan( 'edit', $user ) && ( $title->exists() || $title->quickUserCan( 'create', $user ) ) ) {
 875                                         // Builds CSS class for talk page links
 876                                         $isTalkClass = $isTalk ? ' istalk' : '';
 877                                         // Whether the user is editing the page
 878                                         $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
 879                                         // Whether to show the "Add a new section" tab
 880                                         // Checks if this is a current rev of talk page and is not forced to be hidden
 881                                         $showNewSection = !$out->forceHideNewSectionLink()
 882                                                 && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
 883                                         $section = $request->getVal( 'section' );
 884
 885                                         $msgKey = $title->exists() || ( $title->getNamespace() == NS_MEDIAWIKI && $title->getDefaultMessageText() !== false ) ?
 886                                                 'edit' : 'create';
 887                                         $content_navigation['views']['edit'] = array(
 888                                                 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection ) ? 'selected' : '' ) . $isTalkClass,
 889                                                 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )->setContext( $this->getContext() )->text(),
 890                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 891                                                 'primary' => true, // don't collapse this in vector
 892                                         );
 893
 894                                         // section link
 895                                         if ( $showNewSection ) {
 896                                                 // Adds new section link
 897                                                 //$content_navigation['actions']['addsection']
 898                                                 $content_navigation['views']['addsection'] = array(
 899                                                         'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
 900                                                         'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )->setContext( $this->getContext() )->text(),
 901                                                         'href' => $title->getLocalURL( 'action=edit&section=new' )
 902                                                 );
 903                                         }
 904                                 // Checks if the page has some kind of viewable content
 905                                 } elseif ( $title->hasSourceText() ) {
 906                                         // Adds view source view link
 907                                         $content_navigation['views']['viewsource'] = array(
 908                                                 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
 909                                                 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )->setContext( $this->getContext() )->text(),
 910                                                 'href' => $title->getLocalURL( $this->editUrlOptions() ),
 911                                                 'primary' => true, // don't collapse this in vector
 912                                         );
 913                                 }
 914                                 wfProfileOut( __METHOD__ . '-edit' );
 915
 916                                 wfProfileIn( __METHOD__ . '-live' );
 917                                 // Checks if the page exists
 918                                 if ( $title->exists() ) {
 919                                         // Adds history view link
 920                                         $content_navigation['views']['history'] = array(
 921                                                 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
 922                                                 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )->setContext( $this->getContext() )->text(),
 923                                                 'href' => $title->getLocalURL( 'action=history' ),
 924                                                 'rel' => 'archives',
 925                                         );
 926
 927                                         if ( $title->quickUserCan( 'delete', $user ) ) {
 928                                                 $content_navigation['actions']['delete'] = array(
 929                                                         'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
 930                                                         'text' => wfMessageFallback( "$skname-action-delete", 'delete' )->setContext( $this->getContext() )->text(),
 931                                                         'href' => $title->getLocalURL( 'action=delete' )
 932                                                 );
 933                                         }
 934
 935                                         if ( $title->quickUserCan( 'move', $user ) ) {
 936                                                 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
 937                                                 $content_navigation['actions']['move'] = array(
 938                                                         'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
 939                                                         'text' => wfMessageFallback( "$skname-action-move", 'move' )->setContext( $this->getContext() )->text(),
 940                                                         'href' => $moveTitle->getLocalURL()
 941                                                 );
 942                                         }
 943                                 } else {
 944                                         // article doesn't exist or is deleted
 945                                         if ( $user->isAllowed( 'deletedhistory' ) ) {
 946                                                 $n = $title->isDeleted();
 947                                                 if ( $n ) {
 948                                                         $undelTitle = SpecialPage::getTitleFor( 'Undelete' );
 949                                                         // If the user can't undelete but can view deleted history show them a "View .. deleted" tab instead
 950                                                         $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
 951                                                         $content_navigation['actions']['undelete'] = array(
 952                                                                 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
 953                                                                 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
 954                                                                         ->setContext( $this->getContext() )->numParams( $n )->text(),
 955                                                                 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
 956                                                         );
 957                                                 }
 958                                         }
 959                                 }
 960
 961                                 if ( $title->getNamespace() !== NS_MEDIAWIKI && $title->quickUserCan( 'protect', $user ) ) {
 962                                         $mode = $title->isProtected() ? 'unprotect' : 'protect';
 963                                         $content_navigation['actions'][$mode] = array(
 964                                                 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
 965                                                 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->setContext( $this->getContext() )->text(),
 966                                                 'href' => $title->getLocalURL( "action=$mode" )
 967                                         );
 968                                 }
 969
 970                                 wfProfileOut( __METHOD__ . '-live' );
 971
 972                                 // Checks if the user is logged in
 973                                 if ( $this->loggedin ) {
 974                                         /**
 975                                          * The following actions use messages which, if made particular to
 976                                          * the any specific skins, would break the Ajax code which makes this
 977                                          * action happen entirely inline. Skin::makeGlobalVariablesScript
 978                                          * defines a set of messages in a javascript object - and these
 979                                          * messages are assumed to be global for all skins. Without making
 980                                          * a change to that procedure these messages will have to remain as
 981                                          * the global versions.
 982                                          */
 983                                         $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
 984                                         $token = WatchAction::getWatchToken( $title, $user, $mode );
 985                                         $content_navigation['actions'][$mode] = array(
 986                                                 'class' => $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : false,
 987                                                 // uses 'watch' or 'unwatch' message
 988                                                 'text' => $this->msg( $mode )->text(),
 989                                                 'href' => $title->getLocalURL( array( 'action' => $mode, 'token' => $token ) )
 990                                         );
 991                                 }
 992                         }
 993
 994                         wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
 995
 996                         if ( $userCanRead && !$wgDisableLangConversion ) {
 997                                 $pageLang = $title->getPageLanguage();
 998                                 // Gets list of language variants
 999                                 $variants = $pageLang->getVariants();
1000                                 // Checks that language conversion is enabled and variants exist
1001                                 // And if it is not in the special namespace
1002                                 if ( count( $variants ) > 1 ) {
1003                                         // Gets preferred variant (note that user preference is
1004                                         // only possible for wiki content language variant)
1005                                         $preferred = $pageLang->getPreferredVariant();
1006                                         // Loops over each variant
1007                                         foreach( $variants as $code ) {
1008                                                 // Gets variant name from language code
1009                                                 $varname = $pageLang->getVariantname( $code );
1010                                                 // Checks if the variant is marked as disabled
1011                                                 if( $varname == 'disable' ) {
1012                                                         // Skips this variant
1013                                                         continue;
1014                                                 }
1015                                                 // Appends variant link
1016                                                 $content_navigation['variants'][] = array(
1017                                                         'class' => ( $code == $preferred ) ? 'selected' : false,
1018                                                         'text' => $varname,
1019                                                         'href' => $title->getLocalURL( array( 'variant' => $code ) ),
1020                                                         'lang' => $code,
1021                                                         'hreflang' => $code
1022                                                 );
1023                                         }
1024                                 }
1025                         }
1026                 } else {
1027                         // If it's not content, it's got to be a special page
1028                         $content_navigation['namespaces']['special'] = array(
1029                                 'class' => 'selected',
1030                                 'text' => $this->msg( 'nstab-special' )->text(),
1031                                 'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1032                                 'context' => 'subject'
1033                         );
1034
1035                         wfRunHooks( 'SkinTemplateNavigation::SpecialPage',
1036                                 array( &$this, &$content_navigation ) );
1037                 }
1038
1039                 // Equiv to SkinTemplateContentActions
1040                 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this,  &$content_navigation ) );
1041
1042                 // Setup xml ids and tooltip info
1043                 foreach ( $content_navigation as $section => &$links ) {
1044                         foreach ( $links as $key => &$link ) {
1045                                 $xmlID = $key;
1046                                 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1047                                         $xmlID = 'ca-nstab-' . $xmlID;
1048                                 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1049                                         $xmlID = 'ca-talk';
1050                                 } elseif ( $section == 'variants' ) {
1051                                         $xmlID = 'ca-varlang-' . $xmlID;
1052                                 } else {
1053                                         $xmlID = 'ca-' . $xmlID;
1054                                 }
1055                                 $link['id'] = $xmlID;
1056                         }
1057                 }
1058
1059                 # We don't want to give the watch tab an accesskey if the
1060                 # page is being edited, because that conflicts with the
1061                 # accesskey on the watch checkbox.  We also don't want to
1062                 # give the edit tab an accesskey, because that's fairly su-
1063                 # perfluous and conflicts with an accesskey (Ctrl-E) often
1064                 # used for editing in Safari.
1065                 if ( in_array( $action, array( 'edit', 'submit' ) ) ) {
1066                         if ( isset( $content_navigation['views']['edit'] ) ) {
1067                                 $content_navigation['views']['edit']['tooltiponly'] = true;
1068                         }
1069                         if ( isset( $content_navigation['actions']['watch'] ) ) {
1070                                 $content_navigation['actions']['watch']['tooltiponly'] = true;
1071                         }
1072                         if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1073                                 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1074                         }
1075                 }
1076
1077                 wfProfileOut( __METHOD__ );
1078
1079                 return $content_navigation;
1080         }
1081
1082         /**
1083          * an array of edit links by default used for the tabs
1084          * @return array
1085          * @private
1086          */
1087         function buildContentActionUrls( $content_navigation ) {
1088
1089                 wfProfileIn( __METHOD__ );
1090
1091                 // content_actions has been replaced with content_navigation for backwards
1092                 // compatibility and also for skins that just want simple tabs content_actions
1093                 // is now built by flattening the content_navigation arrays into one
1094
1095                 $content_actions = array();
1096
1097                 foreach ( $content_navigation as $links ) {
1098
1099                         foreach ( $links as $key => $value ) {
1100
1101                                 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1102                                         // Redundant tabs are dropped from content_actions
1103                                         continue;
1104                                 }
1105
1106                                 // content_actions used to have ids built using the "ca-$key" pattern
1107                                 // so the xmlID based id is much closer to the actual $key that we want
1108                                 // for that reason we'll just strip out the ca- if present and use
1109                                 // the latter potion of the "id" as the $key
1110                                 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1111                                         $key = substr( $value['id'], 3 );
1112                                 }
1113
1114                                 if ( isset( $content_actions[$key] ) ) {
1115                                         wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening content_navigation into content_actions." );
1116                                         continue;
1117                                 }
1118
1119                                 $content_actions[$key] = $value;
1120
1121                         }
1122
1123                 }
1124
1125                 wfProfileOut( __METHOD__ );
1126
1127                 return $content_actions;
1128         }
1129
1130         /**
1131          * build array of common navigation links
1132          * @return array
1133          * @private
1134          */
1135         protected function buildNavUrls() {
1136                 global $wgUploadNavigationUrl;
1137
1138                 wfProfileIn( __METHOD__ );
1139
1140                 $out = $this->getOutput();
1141                 $request = $this->getRequest();
1142
1143                 $nav_urls = array();
1144                 $nav_urls['mainpage'] = array( 'href' => self::makeMainPageUrl() );
1145                 if( $wgUploadNavigationUrl ) {
1146                         $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1147                 } elseif( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1148                         $nav_urls['upload'] = array( 'href' => self::makeSpecialUrl( 'Upload' ) );
1149                 } else {
1150                         $nav_urls['upload'] = false;
1151                 }
1152                 $nav_urls['specialpages'] = array( 'href' => self::makeSpecialUrl( 'Specialpages' ) );
1153
1154                 $nav_urls['print'] = false;
1155                 $nav_urls['permalink'] = false;
1156                 $nav_urls['info'] = false;
1157                 $nav_urls['whatlinkshere'] = false;
1158                 $nav_urls['recentchangeslinked'] = false;
1159                 $nav_urls['contributions'] = false;
1160                 $nav_urls['log'] = false;
1161                 $nav_urls['blockip'] = false;
1162                 $nav_urls['emailuser'] = false;
1163
1164                 // A print stylesheet is attached to all pages, but nobody ever
1165                 // figures that out. :)  Add a link...
1166                 if ( $out->isArticle() ) {
1167                         if ( !$out->isPrintable() ) {
1168                                 $nav_urls['print'] = array(
1169                                         'text' => $this->msg( 'printableversion' )->text(),
1170                                         'href' => $this->getTitle()->getLocalURL(
1171                                                 $request->appendQueryValue( 'printable', 'yes', true ) )
1172                                 );
1173                         }
1174
1175                         // Also add a "permalink" while we're at it
1176                         $revid = $this->getRevisionId();
1177                         if ( $revid ) {
1178                                 $nav_urls['permalink'] = array(
1179                                         'text' => $this->msg( 'permalink' )->text(),
1180                                         'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1181                                 );
1182                         }
1183
1184                         // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1185                         wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1186                                 array( &$this, &$nav_urls, &$revid, &$revid ) );
1187                 }
1188
1189                 if ( $out->isArticleRelated() ) {
1190                         $nav_urls['whatlinkshere'] = array(
1191                                 'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalUrl()
1192                         );
1193
1194                         $nav_urls['info'] = array(
1195                                 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1196                                 'href' => $this->getTitle()->getLocalURL( "action=info" )
1197                         );
1198
1199                         if ( $this->getTitle()->getArticleID() ) {
1200                                 $nav_urls['recentchangeslinked'] = array(
1201                                         'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalUrl()
1202                                 );
1203                         }
1204                 }
1205
1206                 $user = $this->getRelevantUser();
1207                 if ( $user ) {
1208                         $rootUser = $user->getName();
1209
1210                         $nav_urls['contributions'] = array(
1211                                 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1212                         );
1213
1214                         $nav_urls['log'] = array(
1215                                 'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1216                         );
1217
1218                         if ( $this->getUser()->isAllowed( 'block' ) ) {
1219                                 $nav_urls['blockip'] = array(
1220                                         'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1221                                 );
1222                         }
1223
1224                         if ( $this->showEmailUser( $user ) ) {
1225                                 $nav_urls['emailuser'] = array(
1226                                         'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1227                                 );
1228                         }
1229                 }
1230
1231                 wfProfileOut( __METHOD__ );
1232                 return $nav_urls;
1233         }
1234
1235         /**
1236          * Generate strings used for xml 'id' names
1237          * @return string
1238          * @private
1239          */
1240         function getNameSpaceKey() {
1241                 return $this->getTitle()->getNamespaceKey();
1242         }
1243
1244         public function commonPrintStylesheet() {
1245                 return false;
1246         }
1247 }
1248
1249 /**
1250  * Generic wrapper for template functions, with interface
1251  * compatible with what we use of PHPTAL 0.7.
1252  * @ingroup Skins
1253  */
1254 abstract class QuickTemplate {
1255         /**
1256          * Constructor
1257          */
1258         function __construct() {
1259                 $this->data = array();
1260                 $this->translator = new MediaWiki_I18N();
1261         }
1262
1263         /**
1264          * Sets the value $value to $name
1265          * @param $name
1266          * @param $value
1267          */
1268         public function set( $name, $value ) {
1269                 $this->data[$name] = $value;
1270         }
1271
1272         /**
1273          * @param $name
1274          * @param $value
1275          */
1276         public function setRef( $name, &$value ) {
1277                 $this->data[$name] =& $value;
1278         }
1279
1280         /**
1281          * @param $t
1282          */
1283         public function setTranslator( &$t ) {
1284                 $this->translator = &$t;
1285         }
1286
1287         /**
1288          * Main function, used by classes that subclass QuickTemplate
1289          * to show the actual HTML output
1290          */
1291         abstract public function execute();
1292
1293         /**
1294          * @private
1295          */
1296         function text( $str ) {
1297                 echo htmlspecialchars( $this->data[$str] );
1298         }
1299
1300         /**
1301          * @private
1302          */
1303         function jstext( $str ) {
1304                 echo Xml::escapeJsString( $this->data[$str] );
1305         }
1306
1307         /**
1308          * @private
1309          */
1310         function html( $str ) {
1311                 echo $this->data[$str];
1312         }
1313
1314         /**
1315          * @private
1316          */
1317         function msg( $str ) {
1318                 echo htmlspecialchars( $this->translator->translate( $str ) );
1319         }
1320
1321         /**
1322          * @private
1323          */
1324         function msgHtml( $str ) {
1325                 echo $this->translator->translate( $str );
1326         }
1327
1328         /**
1329          * An ugly, ugly hack.
1330          * @private
1331          */
1332         function msgWiki( $str ) {
1333                 global $wgOut;
1334
1335                 $text = $this->translator->translate( $str );
1336                 echo $wgOut->parse( $text );
1337         }
1338
1339         /**
1340          * @private
1341          * @return bool
1342          */
1343         function haveData( $str ) {
1344                 return isset( $this->data[$str] );
1345         }
1346
1347         /**
1348          * @private
1349          *
1350          * @return bool
1351          */
1352         function haveMsg( $str ) {
1353                 $msg = $this->translator->translate( $str );
1354                 return ( $msg != '-' ) && ( $msg != '' ); # ????
1355         }
1356
1357         /**
1358          * Get the Skin object related to this object
1359          *
1360          * @return Skin object
1361          */
1362         public function getSkin() {
1363                 return $this->data['skin'];
1364         }
1365 }
1366
1367 /**
1368  * New base template for a skin's template extended from QuickTemplate
1369  * this class features helper methods that provide common ways of interacting
1370  * with the data stored in the QuickTemplate
1371  */
1372 abstract class BaseTemplate extends QuickTemplate {
1373
1374         /**
1375          * Get a Message object with its context set
1376          *
1377          * @param $name string message name
1378          * @return Message
1379          */
1380         public function getMsg( $name ) {
1381                 return $this->getSkin()->msg( $name );
1382         }
1383
1384         function msg( $str ) {
1385                 echo $this->getMsg( $str )->escaped();
1386         }
1387
1388         function msgHtml( $str ) {
1389                 echo $this->getMsg( $str )->text();
1390         }
1391
1392         function msgWiki( $str ) {
1393                 echo $this->getMsg( $str )->parseAsBlock();
1394         }
1395
1396         /**
1397          * Create an array of common toolbox items from the data in the quicktemplate
1398          * stored by SkinTemplate.
1399          * The resulting array is built acording to a format intended to be passed
1400          * through makeListItem to generate the html.
1401          * @return array
1402          */
1403         function getToolbox() {
1404                 wfProfileIn( __METHOD__ );
1405
1406                 $toolbox = array();
1407                 if ( isset( $this->data['nav_urls']['whatlinkshere'] ) && $this->data['nav_urls']['whatlinkshere'] ) {
1408                         $toolbox['whatlinkshere'] = $this->data['nav_urls']['whatlinkshere'];
1409                         $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
1410                 }
1411                 if ( isset( $this->data['nav_urls']['recentchangeslinked'] ) && $this->data['nav_urls']['recentchangeslinked'] ) {
1412                         $toolbox['recentchangeslinked'] = $this->data['nav_urls']['recentchangeslinked'];
1413                         $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
1414                         $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
1415                 }
1416                 if ( isset( $this->data['feeds'] ) && $this->data['feeds'] ) {
1417                         $toolbox['feeds']['id'] = 'feedlinks';
1418                         $toolbox['feeds']['links'] = array();
1419                         foreach ( $this->data['feeds'] as $key => $feed ) {
1420                                 $toolbox['feeds']['links'][$key] = $feed;
1421                                 $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
1422                                 $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
1423                                 $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
1424                                 $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
1425                         }
1426                 }
1427                 foreach ( array( 'contributions', 'log', 'blockip', 'emailuser', 'upload', 'specialpages' ) as $special ) {
1428                         if ( isset( $this->data['nav_urls'][$special] ) && $this->data['nav_urls'][$special] ) {
1429                                 $toolbox[$special] = $this->data['nav_urls'][$special];
1430                                 $toolbox[$special]['id'] = "t-$special";
1431                         }
1432                 }
1433                 if ( isset( $this->data['nav_urls']['print'] ) && $this->data['nav_urls']['print'] ) {
1434                         $toolbox['print'] = $this->data['nav_urls']['print'];
1435                         $toolbox['print']['id'] = 't-print';
1436                         $toolbox['print']['rel'] = 'alternate';
1437                         $toolbox['print']['msg'] = 'printableversion';
1438                 }
1439                 if ( isset( $this->data['nav_urls']['permalink'] ) && $this->data['nav_urls']['permalink'] ) {
1440                         $toolbox['permalink'] = $this->data['nav_urls']['permalink'];
1441                         if ( $toolbox['permalink']['href'] === '' ) {
1442                                 unset( $toolbox['permalink']['href'] );
1443                                 $toolbox['ispermalink']['tooltiponly'] = true;
1444                                 $toolbox['ispermalink']['id'] = 't-ispermalink';
1445                                 $toolbox['ispermalink']['msg'] = 'permalink';
1446                         } else {
1447                                 $toolbox['permalink']['id'] = 't-permalink';
1448                         }
1449                 }
1450                 if ( isset( $this->data['nav_urls']['info'] ) && $this->data['nav_urls']['info'] ) {
1451                         $toolbox['info'] = $this->data['nav_urls']['info'];
1452                         $toolbox['info']['id'] = 't-info';
1453                 }
1454
1455                 wfRunHooks( 'BaseTemplateToolbox', array( &$this, &$toolbox ) );
1456                 wfProfileOut( __METHOD__ );
1457                 return $toolbox;
1458         }
1459
1460         /**
1461          * Create an array of personal tools items from the data in the quicktemplate
1462          * stored by SkinTemplate.
1463          * The resulting array is built acording to a format intended to be passed
1464          * through makeListItem to generate the html.
1465          * This is in reality the same list as already stored in personal_urls
1466          * however it is reformatted so that you can just pass the individual items
1467          * to makeListItem instead of hardcoding the element creation boilerplate.
1468          * @return array
1469          */
1470         function getPersonalTools() {
1471                 $personal_tools = array();
1472                 foreach ( $this->data['personal_urls'] as $key => $plink ) {
1473                         # The class on a personal_urls item is meant to go on the <a> instead
1474                         # of the <li> so we have to use a single item "links" array instead
1475                         # of using most of the personal_url's keys directly.
1476                         $ptool = array(
1477                                 'links' => array(
1478                                         array( 'single-id' => "pt-$key" ),
1479                                 ),
1480                                 'id' => "pt-$key",
1481                         );
1482                         if ( isset( $plink['active'] ) ) {
1483                                 $ptool['active'] = $plink['active'];
1484                         }
1485                         foreach ( array( 'href', 'class', 'text' ) as $k ) {
1486                                 if ( isset( $plink[$k] ) )
1487                                         $ptool['links'][0][$k] = $plink[$k];
1488                         }
1489                         $personal_tools[$key] = $ptool;
1490                 }
1491                 return $personal_tools;
1492         }
1493
1494         function getSidebar( $options = array() ) {
1495                 // Force the rendering of the following portals
1496                 $sidebar = $this->data['sidebar'];
1497                 if ( !isset( $sidebar['SEARCH'] ) ) {
1498                         $sidebar['SEARCH'] = true;
1499                 }
1500                 if ( !isset( $sidebar['TOOLBOX'] ) ) {
1501                         $sidebar['TOOLBOX'] = true;
1502                 }
1503                 if ( !isset( $sidebar['LANGUAGES'] ) ) {
1504                         $sidebar['LANGUAGES'] = true;
1505                 }
1506
1507                 if ( !isset( $options['search'] ) || $options['search'] !== true ) {
1508                         unset( $sidebar['SEARCH'] );
1509                 }
1510                 if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
1511                         unset( $sidebar['TOOLBOX'] );
1512                 }
1513                 if ( isset( $options['languages'] ) && $options['languages'] === false ) {
1514                         unset( $sidebar['LANGUAGES'] );
1515                 }
1516
1517                 $boxes = array();
1518                 foreach ( $sidebar as $boxName => $content ) {
1519                         if ( $content === false ) {
1520                                 continue;
1521                         }
1522                         switch ( $boxName ) {
1523                         case 'SEARCH':
1524                                 // Search is a special case, skins should custom implement this
1525                                 $boxes[$boxName] = array(
1526                                         'id'        => 'p-search',
1527                                         'header'    => $this->getMsg( 'search' )->text(),
1528                                         'generated' => false,
1529                                         'content'   => true,
1530                                 );
1531                                 break;
1532                         case 'TOOLBOX':
1533                                 $msgObj = $this->getMsg( 'toolbox' );
1534                                 $boxes[$boxName] = array(
1535                                         'id'        => 'p-tb',
1536                                         'header'    => $msgObj->exists() ? $msgObj->text() : 'toolbox',
1537                                         'generated' => false,
1538                                         'content'   => $this->getToolbox(),
1539                                 );
1540                                 break;
1541                         case 'LANGUAGES':
1542                                 if ( $this->data['language_urls'] ) {
1543                                         $msgObj = $this->getMsg( 'otherlanguages' );
1544                                         $boxes[$boxName] = array(
1545                                                 'id'        => 'p-lang',
1546                                                 'header'    => $msgObj->exists() ? $msgObj->text() : 'otherlanguages',
1547                                                 'generated' => false,
1548                                                 'content'   => $this->data['language_urls'],
1549                                         );
1550                                 }
1551                                 break;
1552                         default:
1553                                 $msgObj = $this->getMsg( $boxName );
1554                                 $boxes[$boxName] = array(
1555                                         'id'        => "p-$boxName",
1556                                         'header'    => $msgObj->exists() ? $msgObj->text() : $boxName,
1557                                         'generated' => true,
1558                                         'content'   => $content,
1559                                 );
1560                                 break;
1561                         }
1562                 }
1563
1564                 // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
1565                 $hookContents = null;
1566                 if ( isset( $boxes['TOOLBOX'] ) ) {
1567                         ob_start();
1568                         // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
1569                         // can abort and avoid outputting double toolbox links
1570                         wfRunHooks( 'SkinTemplateToolboxEnd', array( &$this, true ) );
1571                         $hookContents = ob_get_contents();
1572                         ob_end_clean();
1573                         if ( !trim( $hookContents ) ) {
1574                                 $hookContents = null;
1575                         }
1576                 }
1577                 // END hack
1578
1579                 if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
1580                         foreach ( $boxes as $boxName => $box ) {
1581                                 if ( is_array( $box['content'] ) ) {
1582                                         $content = '<ul>';
1583                                         foreach ( $box['content'] as $key => $val ) {
1584                                                 $content .= "\n " . $this->makeListItem( $key, $val );
1585                                         }
1586                                         // HACK, shove the toolbox end onto the toolbox if we're rendering itself
1587                                         if ( $hookContents ) {
1588                                                 $content .= "\n $hookContents";
1589                                         }
1590                                         // END hack
1591                                         $content .= "\n</ul>\n";
1592                                         $boxes[$boxName]['content'] = $content;
1593                                 }
1594                         }
1595                 } else {
1596                         if ( $hookContents ) {
1597                                 $boxes['TOOLBOXEND'] = array(
1598                                         'id'        => 'p-toolboxend',
1599                                         'header'    => $boxes['TOOLBOX']['header'],
1600                                         'generated' => false,
1601                                         'content'   => "<ul>{$hookContents}</ul>",
1602                                 );
1603                                 // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
1604                                 $boxes2 = array();
1605                                 foreach ( $boxes as $key => $box ) {
1606                                         if ( $key === 'TOOLBOXEND' ) {
1607                                                 continue;
1608                                         }
1609                                         $boxes2[$key] = $box;
1610                                         if ( $key === 'TOOLBOX' ) {
1611                                                 $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
1612                                         }
1613                                 }
1614                                 $boxes = $boxes2;
1615                                 // END hack
1616                         }
1617                 }
1618
1619                 return $boxes;
1620         }
1621
1622         /**
1623          * Makes a link, usually used by makeListItem to generate a link for an item
1624          * in a list used in navigation lists, portlets, portals, sidebars, etc...
1625          *
1626          * @param $key string usually a key from the list you are generating this
1627          * link from.
1628          * @param $item array contains some of a specific set of keys.
1629          *
1630          * The text of the link will be generated either from the contents of the
1631          * "text" key in the $item array, if a "msg" key is present a message by
1632          * that name will be used, and if neither of those are set the $key will be
1633          * used as a message name.
1634          *
1635          * If a "href" key is not present makeLink will just output htmlescaped text.
1636          * The "href", "id", "class", "rel", and "type" keys are used as attributes
1637          * for the link if present.
1638          *
1639          * If an "id" or "single-id" (if you don't want the actual id to be output
1640          * on the link) is present it will be used to generate a tooltip and
1641          * accesskey for the link.
1642          *
1643          * If you don't want an accesskey, set $item['tooltiponly'] = true;
1644          *
1645          * @param $options array can be used to affect the output of a link.
1646          * Possible options are:
1647          *   - 'text-wrapper' key to specify a list of elements to wrap the text of
1648          *   a link in. This should be an array of arrays containing a 'tag' and
1649          *   optionally an 'attributes' key. If you only have one element you don't
1650          *   need to wrap it in another array. eg: To use <a><span>...</span></a>
1651          *   in all links use array( 'text-wrapper' => array( 'tag' => 'span' ) )
1652          *   for your options.
1653          *   - 'link-class' key can be used to specify additional classes to apply
1654          *   to all links.
1655          *   - 'link-fallback' can be used to specify a tag to use instead of "<a>"
1656          *   if there is no link. eg: If you specify 'link-fallback' => 'span' than
1657          *   any non-link will output a "<span>" instead of just text.
1658          *
1659          * @return string
1660          */
1661         function makeLink( $key, $item, $options = array() ) {
1662                 if ( isset( $item['text'] ) ) {
1663                         $text = $item['text'];
1664                 } else {
1665                         $text = $this->translator->translate( isset( $item['msg'] ) ? $item['msg'] : $key );
1666                 }
1667
1668                 $html = htmlspecialchars( $text );
1669
1670                 if ( isset( $options['text-wrapper'] ) ) {
1671                         $wrapper = $options['text-wrapper'];
1672                         if ( isset( $wrapper['tag'] ) ) {
1673                                 $wrapper = array( $wrapper );
1674                         }
1675                         while ( count( $wrapper ) > 0 ) {
1676                                 $element = array_pop( $wrapper );
1677                                 $html = Html::rawElement( $element['tag'], isset( $element['attributes'] ) ? $element['attributes'] : null, $html );
1678                         }
1679                 }
1680
1681                 if ( isset( $item['href'] ) || isset( $options['link-fallback'] ) ) {
1682                         $attrs = $item;
1683                         foreach ( array( 'single-id', 'text', 'msg', 'tooltiponly' ) as $k ) {
1684                                 unset( $attrs[$k] );
1685                         }
1686
1687                         if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
1688                                 $item['single-id'] = $item['id'];
1689                         }
1690                         if ( isset( $item['single-id'] ) ) {
1691                                 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
1692                                         $title = Linker::titleAttrib( $item['single-id'] );
1693                                         if ( $title !== false ) {
1694                                                 $attrs['title'] = $title;
1695                                         }
1696                                 } else {
1697                                         $tip = Linker::tooltipAndAccesskeyAttribs( $item['single-id'] );
1698                                         if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
1699                                                 $attrs['title'] = $tip['title'];
1700                                         }
1701                                         if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
1702                                                 $attrs['accesskey'] = $tip['accesskey'];
1703                                         }
1704                                 }
1705                         }
1706                         if ( isset( $options['link-class'] ) ) {
1707                                 if ( isset( $attrs['class'] ) ) {
1708                                         $attrs['class'] .= " {$options['link-class']}";
1709                                 } else {
1710                                         $attrs['class'] = $options['link-class'];
1711                                 }
1712                         }
1713                         $html = Html::rawElement( isset( $attrs['href'] ) ? 'a' : $options['link-fallback'], $attrs, $html );
1714                 }
1715
1716                 return $html;
1717         }
1718
1719         /**
1720          * Generates a list item for a navigation, portlet, portal, sidebar... list
1721          *
1722          * @param $key string, usually a key from the list you are generating this link from.
1723          * @param $item array, of list item data containing some of a specific set of keys.
1724          * The "id" and "class" keys will be used as attributes for the list item,
1725          * if "active" contains a value of true a "active" class will also be appended to class.
1726          *
1727          * @param $options array
1728          *
1729          * If you want something other than a "<li>" you can pass a tag name such as
1730          * "tag" => "span" in the $options array to change the tag used.
1731          * link/content data for the list item may come in one of two forms
1732          * A "links" key may be used, in which case it should contain an array with
1733          * a list of links to include inside the list item, see makeLink for the
1734          * format of individual links array items.
1735          *
1736          * Otherwise the relevant keys from the list item $item array will be passed
1737          * to makeLink instead. Note however that "id" and "class" are used by the
1738          * list item directly so they will not be passed to makeLink
1739          * (however the link will still support a tooltip and accesskey from it)
1740          * If you need an id or class on a single link you should include a "links"
1741          * array with just one link item inside of it.
1742          * $options is also passed on to makeLink calls
1743          *
1744          * @return string
1745          */
1746         function makeListItem( $key, $item, $options = array() ) {
1747                 if ( isset( $item['links'] ) ) {
1748                         $html = '';
1749                         foreach ( $item['links'] as $linkKey => $link ) {
1750                                 $html .= $this->makeLink( $linkKey, $link, $options );
1751                         }
1752                 } else {
1753                         $link = $item;
1754                         // These keys are used by makeListItem and shouldn't be passed on to the link
1755                         foreach ( array( 'id', 'class', 'active', 'tag' ) as $k ) {
1756                                 unset( $link[$k] );
1757                         }
1758                         if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
1759                                 // The id goes on the <li> not on the <a> for single links
1760                                 // but makeSidebarLink still needs to know what id to use when
1761                                 // generating tooltips and accesskeys.
1762                                 $link['single-id'] = $item['id'];
1763                         }
1764                         $html = $this->makeLink( $key, $link, $options );
1765                 }
1766
1767                 $attrs = array();
1768                 foreach ( array( 'id', 'class' ) as $attr ) {
1769                         if ( isset( $item[$attr] ) ) {
1770                                 $attrs[$attr] = $item[$attr];
1771                         }
1772                 }
1773                 if ( isset( $item['active'] ) && $item['active'] ) {
1774                         if ( !isset( $attrs['class'] ) ) {
1775                                 $attrs['class'] = '';
1776                         }
1777                         $attrs['class'] .= ' active';
1778                         $attrs['class'] = trim( $attrs['class'] );
1779                 }
1780                 return Html::rawElement( isset( $options['tag'] ) ? $options['tag'] : 'li', $attrs, $html );
1781         }
1782
1783         function makeSearchInput( $attrs = array() ) {
1784                 $realAttrs = array(
1785                         'type' => 'search',
1786                         'name' => 'search',
1787                         'value' => isset( $this->data['search'] ) ? $this->data['search'] : '',
1788                 );
1789                 $realAttrs = array_merge( $realAttrs, Linker::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
1790                 return Html::element( 'input', $realAttrs );
1791         }
1792
1793         function makeSearchButton( $mode, $attrs = array() ) {
1794                 switch( $mode ) {
1795                         case 'go':
1796                         case 'fulltext':
1797                                 $realAttrs = array(
1798                                         'type' => 'submit',
1799                                         'name' => $mode,
1800                                         'value' => $this->translator->translate(
1801                                                 $mode == 'go' ? 'searcharticle' : 'searchbutton' ),
1802                                 );
1803                                 $realAttrs = array_merge(
1804                                         $realAttrs,
1805                                         Linker::tooltipAndAccesskeyAttribs( "search-$mode" ),
1806                                         $attrs
1807                                 );
1808                                 return Html::element( 'input', $realAttrs );
1809                         case 'image':
1810                                 $buttonAttrs = array(
1811                                         'type' => 'submit',
1812                                         'name' => 'button',
1813                                 );
1814                                 $buttonAttrs = array_merge(
1815                                         $buttonAttrs,
1816                                         Linker::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
1817                                         $attrs
1818                                 );
1819                                 unset( $buttonAttrs['src'] );
1820                                 unset( $buttonAttrs['alt'] );
1821                                 unset( $buttonAttrs['width'] );
1822                                 unset( $buttonAttrs['height'] );
1823                                 $imgAttrs = array(
1824                                         'src' => $attrs['src'],
1825                                         'alt' => isset( $attrs['alt'] )
1826                                                 ? $attrs['alt']
1827                                                 : $this->translator->translate( 'searchbutton' ),
1828                                         'width' => isset( $attrs['width'] ) ? $attrs['width'] : null,
1829                                         'height' => isset( $attrs['height'] ) ? $attrs['height'] : null,
1830                                 );
1831                                 return Html::rawElement( 'button', $buttonAttrs, Html::element( 'img', $imgAttrs ) );
1832                         default:
1833                                 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
1834                 }
1835         }
1836
1837         /**
1838          * Returns an array of footerlinks trimmed down to only those footer links that
1839          * are valid.
1840          * If you pass "flat" as an option then the returned array will be a flat array
1841          * of footer icons instead of a key/value array of footerlinks arrays broken
1842          * up into categories.
1843          * @return array|mixed
1844          */
1845         function getFooterLinks( $option = null ) {
1846                 $footerlinks = $this->data['footerlinks'];
1847
1848                 // Reduce footer links down to only those which are being used
1849                 $validFooterLinks = array();
1850                 foreach( $footerlinks as $category => $links ) {
1851                         $validFooterLinks[$category] = array();
1852                         foreach( $links as $link ) {
1853                                 if( isset( $this->data[$link] ) && $this->data[$link] ) {
1854                                         $validFooterLinks[$category][] = $link;
1855                                 }
1856                         }
1857                         if ( count( $validFooterLinks[$category] ) <= 0 ) {
1858                                 unset( $validFooterLinks[$category] );
1859                         }
1860                 }
1861
1862                 if ( $option == 'flat' ) {
1863                         // fold footerlinks into a single array using a bit of trickery
1864                         $validFooterLinks = call_user_func_array(
1865                                 'array_merge',
1866                                 array_values( $validFooterLinks )
1867                         );
1868                 }
1869
1870                 return $validFooterLinks;
1871         }
1872
1873         /**
1874          * Returns an array of footer icons filtered down by options relevant to how
1875          * the skin wishes to display them.
1876          * If you pass "icononly" as the option all footer icons which do not have an
1877          * image icon set will be filtered out.
1878          * If you pass "nocopyright" then MediaWiki's copyright icon will not be included
1879          * in the list of footer icons. This is mostly useful for skins which only
1880          * display the text from footericons instead of the images and don't want a
1881          * duplicate copyright statement because footerlinks already rendered one.
1882          * @return
1883          */
1884         function getFooterIcons( $option = null ) {
1885                 // Generate additional footer icons
1886                 $footericons = $this->data['footericons'];
1887
1888                 if ( $option == 'icononly' ) {
1889                         // Unset any icons which don't have an image
1890                         foreach ( $footericons as &$footerIconsBlock ) {
1891                                 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
1892                                         if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
1893                                                 unset( $footerIconsBlock[$footerIconKey] );
1894                                         }
1895                                 }
1896                         }
1897                         // Redo removal of any empty blocks
1898                         foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
1899                                 if ( count( $footerIconsBlock ) <= 0 ) {
1900                                         unset( $footericons[$footerIconsKey] );
1901                                 }
1902                         }
1903                 } elseif ( $option == 'nocopyright' ) {
1904                         unset( $footericons['copyright']['copyright'] );
1905                         if ( count( $footericons['copyright'] ) <= 0 ) {
1906                                 unset( $footericons['copyright'] );
1907                         }
1908                 }
1909
1910                 return $footericons;
1911         }
1912
1913         /**
1914          * Output the basic end-page trail including bottomscripts, reporttime, and
1915          * debug stuff. This should be called right before outputting the closing
1916          * body and html tags.
1917          */
1918         function printTrail() { ?>
1919 <?php $this->html( 'bottomscripts' ); /* JS call to runBodyOnloadHook */ ?>
1920 <?php $this->html( 'reporttime' ) ?>
1921 <?php echo MWDebug::getDebugHTML( $this->getSkin()->getContext() );
1922         }
1923
1924 }