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