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