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