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