includes/Skin.php

   1 <?php
   2 /**
   3  * Base class for all skins.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * @defgroup Skins Skins
  25  */
  26
  27 /**
  28  * The main skin class that provide methods and properties for all other skins.
  29  * This base class is also the "Standard" skin.
  30  *
  31  * See docs/skin.txt for more information.
  32  *
  33  * @ingroup Skins
  34  */
  35 abstract class Skin extends ContextSource {
  36         protected $skinname = 'standard';
  37         protected $mRelevantTitle = null;
  38         protected $mRelevantUser = null;
  39
  40         /**
  41          * Fetch the set of available skins.
  42          * @return array associative array of strings
  43          */
  44         static function getSkinNames() {
  45                 global $wgValidSkinNames;
  46                 static $skinsInitialised = false;
  47
  48                 if ( !$skinsInitialised || !count( $wgValidSkinNames ) ) {
  49                         # Get a list of available skins
  50                         # Build using the regular expression '^(.*).php$'
  51                         # Array keys are all lower case, array value keep the case used by filename
  52                         #
  53                         wfProfileIn( __METHOD__ . '-init' );
  54
  55                         global $wgStyleDirectory;
  56
  57                         $skinDir = dir( $wgStyleDirectory );
  58
  59                         # while code from www.php.net
  60                         while ( false !== ( $file = $skinDir->read() ) ) {
  61                                 // Skip non-PHP files, hidden files, and '.dep' includes
  62                                 $matches = array();
  63
  64                                 if ( preg_match( '/^([^.]*)\.php$/', $file, $matches ) ) {
  65                                         $aSkin = $matches[1];
  66                                         $wgValidSkinNames[strtolower( $aSkin )] = $aSkin;
  67                                 }
  68                         }
  69                         $skinDir->close();
  70                         $skinsInitialised = true;
  71                         wfProfileOut( __METHOD__ . '-init' );
  72                 }
  73                 return $wgValidSkinNames;
  74         }
  75
  76         /**
  77          * Fetch the skinname messages for available skins.
  78          * @return array of strings
  79          */
  80         static function getSkinNameMessages() {
  81                 $messages = array();
  82                 foreach( self::getSkinNames() as $skinKey => $skinName ) {
  83                         $messages[] = "skinname-$skinKey";
  84                 }
  85                 return $messages;
  86         }
  87
  88         /**
  89          * Fetch the list of usable skins in regards to $wgSkipSkins.
  90          * Useful for Special:Preferences and other places where you
  91          * only want to show skins users _can_ use.
  92          * @return array of strings
  93          */
  94         public static function getUsableSkins() {
  95                 global $wgSkipSkins;
  96
  97                 $usableSkins = self::getSkinNames();
  98
  99                 foreach ( $wgSkipSkins as $skip ) {
 100                         unset( $usableSkins[$skip] );
 101                 }
 102
 103                 return $usableSkins;
 104         }
 105
 106         /**
 107          * Normalize a skin preference value to a form that can be loaded.
 108          * If a skin can't be found, it will fall back to the configured
 109          * default (or the old 'Classic' skin if that's broken).
 110          * @param $key String: 'monobook', 'standard', etc.
 111          * @return string
 112          */
 113         static function normalizeKey( $key ) {
 114                 global $wgDefaultSkin;
 115
 116                 $skinNames = Skin::getSkinNames();
 117
 118                 if ( $key == '' || $key == 'default' ) {
 119                         // Don't return the default immediately;
 120                         // in a misconfiguration we need to fall back.
 121                         $key = $wgDefaultSkin;
 122                 }
 123
 124                 if ( isset( $skinNames[$key] ) ) {
 125                         return $key;
 126                 }
 127
 128                 // Older versions of the software used a numeric setting
 129                 // in the user preferences.
 130                 $fallback = array(
 131                         0 => $wgDefaultSkin,
 132                         1 => 'nostalgia',
 133                         2 => 'cologneblue'
 134                 );
 135
 136                 if ( isset( $fallback[$key] ) ) {
 137                         $key = $fallback[$key];
 138                 }
 139
 140                 if ( isset( $skinNames[$key] ) ) {
 141                         return $key;
 142                 } elseif ( isset( $skinNames[$wgDefaultSkin] ) ) {
 143                         return $wgDefaultSkin;
 144                 } else {
 145                         return 'vector';
 146                 }
 147         }
 148
 149         /**
 150          * Factory method for loading a skin of a given type
 151          * @param $key String: 'monobook', 'standard', etc.
 152          * @return Skin
 153          */
 154         static function &newFromKey( $key ) {
 155                 global $wgStyleDirectory;
 156
 157                 $key = Skin::normalizeKey( $key );
 158
 159                 $skinNames = Skin::getSkinNames();
 160                 $skinName = $skinNames[$key];
 161                 $className = "Skin{$skinName}";
 162
 163                 # Grab the skin class and initialise it.
 164                 if ( !MWInit::classExists( $className ) ) {
 165
 166                         if ( !defined( 'MW_COMPILED' ) ) {
 167                                 require_once( "{$wgStyleDirectory}/{$skinName}.php" );
 168                         }
 169
 170                         # Check if we got if not failback to default skin
 171                         if ( !MWInit::classExists( $className ) ) {
 172                                 # DO NOT die if the class isn't found. This breaks maintenance
 173                                 # scripts and can cause a user account to be unrecoverable
 174                                 # except by SQL manipulation if a previously valid skin name
 175                                 # is no longer valid.
 176                                 wfDebug( "Skin class does not exist: $className\n" );
 177                                 $className = 'SkinVector';
 178                                 if ( !defined( 'MW_COMPILED' ) ) {
 179                                         require_once( "{$wgStyleDirectory}/Vector.php" );
 180                                 }
 181                         }
 182                 }
 183                 $skin = new $className( $key );
 184                 return $skin;
 185         }
 186
 187         /** @return string skin name */
 188         public function getSkinName() {
 189                 return $this->skinname;
 190         }
 191
 192         /**
 193          * @param $out OutputPage
 194          */
 195         function initPage( OutputPage $out ) {
 196                 wfProfileIn( __METHOD__ );
 197
 198                 $this->preloadExistence();
 199
 200                 wfProfileOut( __METHOD__ );
 201         }
 202
 203         /**
 204          * Preload the existence of three commonly-requested pages in a single query
 205          */
 206         function preloadExistence() {
 207                 $user = $this->getUser();
 208
 209                 // User/talk link
 210                 $titles = array( $user->getUserPage(), $user->getTalkPage() );
 211
 212                 // Other tab link
 213                 if ( $this->getTitle()->isSpecialPage() ) {
 214                         // nothing
 215                 } elseif ( $this->getTitle()->isTalkPage() ) {
 216                         $titles[] = $this->getTitle()->getSubjectPage();
 217                 } else {
 218                         $titles[] = $this->getTitle()->getTalkPage();
 219                 }
 220
 221                 $lb = new LinkBatch( $titles );
 222                 $lb->setCaller( __METHOD__ );
 223                 $lb->execute();
 224         }
 225
 226         /**
 227          * Get the current revision ID
 228          *
 229          * @return Integer
 230          */
 231         public function getRevisionId() {
 232                 return $this->getOutput()->getRevisionId();
 233         }
 234
 235         /**
 236          * Whether the revision displayed is the latest revision of the page
 237          *
 238          * @return Boolean
 239          */
 240         public function isRevisionCurrent() {
 241                 $revID = $this->getRevisionId();
 242                 return $revID == 0 || $revID == $this->getTitle()->getLatestRevID();
 243         }
 244
 245         /**
 246          * Set the "relevant" title
 247          * @see self::getRelevantTitle()
 248          * @param $t Title object to use
 249          */
 250         public function setRelevantTitle( $t ) {
 251                 $this->mRelevantTitle = $t;
 252         }
 253
 254         /**
 255          * Return the "relevant" title.
 256          * A "relevant" title is not necessarily the actual title of the page.
 257          * Special pages like Special:MovePage use set the page they are acting on
 258          * as their "relevant" title, this allows the skin system to display things
 259          * such as content tabs which belong to to that page instead of displaying
 260          * a basic special page tab which has almost no meaning.
 261          *
 262          * @return Title
 263          */
 264         public function getRelevantTitle() {
 265                 if ( isset($this->mRelevantTitle) ) {
 266                         return $this->mRelevantTitle;
 267                 }
 268                 return $this->getTitle();
 269         }
 270
 271         /**
 272          * Set the "relevant" user
 273          * @see self::getRelevantUser()
 274          * @param $u User object to use
 275          */
 276         public function setRelevantUser( $u ) {
 277                 $this->mRelevantUser = $u;
 278         }
 279
 280         /**
 281          * Return the "relevant" user.
 282          * A "relevant" user is similar to a relevant title. Special pages like
 283          * Special:Contributions mark the user which they are relevant to so that
 284          * things like the toolbox can display the information they usually are only
 285          * able to display on a user's userpage and talkpage.
 286          * @return User
 287          */
 288         public function getRelevantUser() {
 289                 if ( isset($this->mRelevantUser) ) {
 290                         return $this->mRelevantUser;
 291                 }
 292                 $title = $this->getRelevantTitle();
 293                 if( $title->getNamespace() == NS_USER || $title->getNamespace() == NS_USER_TALK ) {
 294                         $rootUser = strtok( $title->getText(), '/' );
 295                         if ( User::isIP( $rootUser ) ) {
 296                                 $this->mRelevantUser = User::newFromName( $rootUser, false );
 297                         } else {
 298                                 $user = User::newFromName( $rootUser, false );
 299                                 if ( $user && $user->isLoggedIn() ) {
 300                                         $this->mRelevantUser = $user;
 301                                 }
 302                         }
 303                         return $this->mRelevantUser;
 304                 }
 305                 return null;
 306         }
 307
 308         /**
 309          * Outputs the HTML generated by other functions.
 310          * @param $out OutputPage
 311          */
 312         abstract function outputPage( OutputPage $out = null );
 313
 314         /**
 315          * @param $data array
 316          * @return string
 317          */
 318         static function makeVariablesScript( $data ) {
 319                 if ( $data ) {
 320                         return Html::inlineScript(
 321                                 ResourceLoader::makeLoaderConditionalScript( ResourceLoader::makeConfigSetScript( $data ) )
 322                         );
 323                 } else {
 324                         return '';
 325                 }
 326         }
 327
 328         /**
 329          * Make a <script> tag containing global variables
 330          *
 331          * @deprecated in 1.19
 332          * @param $unused
 333          * @return string HTML fragment
 334          */
 335         public static function makeGlobalVariablesScript( $unused ) {
 336                 global $wgOut;
 337
 338                 wfDeprecated( __METHOD__, '1.19' );
 339
 340                 return self::makeVariablesScript( $wgOut->getJSVars() );
 341         }
 342
 343         /**
 344          * Get the query to generate a dynamic stylesheet
 345          *
 346          * @return array
 347          */
 348         public static function getDynamicStylesheetQuery() {
 349                 global $wgSquidMaxage;
 350
 351                 return array(
 352                                 'action' => 'raw',
 353                                 'maxage' => $wgSquidMaxage,
 354                                 'usemsgcache' => 'yes',
 355                                 'ctype' => 'text/css',
 356                                 'smaxage' => $wgSquidMaxage,
 357                         );
 358         }
 359
 360         /**
 361          * Add skin specific stylesheets
 362          * Calling this method with an $out of anything but the same OutputPage
 363          * inside ->getOutput() is deprecated. The $out arg is kept
 364          * for compatibility purposes with skins.
 365          * @param $out OutputPage
 366          * @delete
 367          */
 368         abstract function setupSkinUserCss( OutputPage $out );
 369
 370         /**
 371          * TODO: document
 372          * @param $title Title
 373          * @return String
 374          */
 375         function getPageClasses( $title ) {
 376                 $numeric = 'ns-' . $title->getNamespace();
 377
 378                 if ( $title->isSpecialPage() ) {
 379                         $type = 'ns-special';
 380                         // bug 23315: provide a class based on the canonical special page name without subpages
 381                         list( $canonicalName ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
 382                         if ( $canonicalName ) {
 383                                 $type .= ' ' . Sanitizer::escapeClass( "mw-special-$canonicalName" );
 384                         } else {
 385                                 $type .= ' mw-invalidspecialpage';
 386                         }
 387                 } elseif ( $title->isTalkPage() ) {
 388                         $type = 'ns-talk';
 389                 } else {
 390                         $type = 'ns-subject';
 391                 }
 392
 393                 $name = Sanitizer::escapeClass( 'page-' . $title->getPrefixedText() );
 394
 395                 return "$numeric $type $name";
 396         }
 397
 398         /**
 399          * This will be called by OutputPage::headElement when it is creating the
 400          * <body> tag, skins can override it if they have a need to add in any
 401          * body attributes or classes of their own.
 402          * @param $out OutputPage
 403          * @param $bodyAttrs Array
 404          */
 405         function addToBodyAttributes( $out, &$bodyAttrs ) {
 406                 // does nothing by default
 407         }
 408
 409         /**
 410          * URL to the logo
 411          * @return String
 412          */
 413         function getLogo() {
 414                 global $wgLogo;
 415                 return $wgLogo;
 416         }
 417
 418         /**
 419          * @return string
 420          */
 421         function getCategoryLinks() {
 422                 global $wgUseCategoryBrowser;
 423
 424                 $out = $this->getOutput();
 425                 $allCats = $out->getCategoryLinks();
 426
 427                 if ( !count( $allCats ) ) {
 428                         return '';
 429                 }
 430
 431                 $embed = "<li>";
 432                 $pop = "</li>";
 433
 434                 $s = '';
 435                 $colon = $this->msg( 'colon-separator' )->escaped();
 436
 437                 if ( !empty( $allCats['normal'] ) ) {
 438                         $t = $embed . implode( "{$pop}{$embed}" , $allCats['normal'] ) . $pop;
 439
 440                         $msg = $this->msg( 'pagecategories', count( $allCats['normal'] ) )->escaped();
 441                         $linkPage = wfMessage( 'pagecategorieslink' )->inContentLanguage()->text();
 442                         $s .= '<div id="mw-normal-catlinks" class="mw-normal-catlinks">' .
 443                                 Linker::link( Title::newFromText( $linkPage ), $msg )
 444                                 . $colon . '<ul>' . $t . '</ul>' . '</div>';
 445                 }
 446
 447                 # Hidden categories
 448                 if ( isset( $allCats['hidden'] ) ) {
 449                         if ( $this->getUser()->getBoolOption( 'showhiddencats' ) ) {
 450                                 $class = ' mw-hidden-cats-user-shown';
 451                         } elseif ( $this->getTitle()->getNamespace() == NS_CATEGORY ) {
 452                                 $class = ' mw-hidden-cats-ns-shown';
 453                         } else {
 454                                 $class = ' mw-hidden-cats-hidden';
 455                         }
 456
 457                         $s .= "<div id=\"mw-hidden-catlinks\" class=\"mw-hidden-catlinks$class\">" .
 458                                 $this->msg( 'hidden-categories', count( $allCats['hidden'] ) )->escaped() .
 459                                 $colon . '<ul>' . $embed . implode( "{$pop}{$embed}" , $allCats['hidden'] ) . $pop . '</ul>' .
 460                                 '</div>';
 461                 }
 462
 463                 # optional 'dmoz-like' category browser. Will be shown under the list
 464                 # of categories an article belong to
 465                 if ( $wgUseCategoryBrowser ) {
 466                         $s .= '<br /><hr />';
 467
 468                         # get a big array of the parents tree
 469                         $parenttree = $this->getTitle()->getParentCategoryTree();
 470                         # Skin object passed by reference cause it can not be
 471                         # accessed under the method subfunction drawCategoryBrowser
 472                         $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) );
 473                         # Clean out bogus first entry and sort them
 474                         unset( $tempout[0] );
 475                         asort( $tempout );
 476                         # Output one per line
 477                         $s .= implode( "<br />\n", $tempout );
 478                 }
 479
 480                 return $s;
 481         }
 482
 483         /**
 484          * Render the array as a serie of links.
 485          * @param $tree Array: categories tree returned by Title::getParentCategoryTree
 486          * @return String separated by &gt;, terminate with "\n"
 487          */
 488         function drawCategoryBrowser( $tree ) {
 489                 $return = '';
 490
 491                 foreach ( $tree as $element => $parent ) {
 492                         if ( empty( $parent ) ) {
 493                                 # element start a new list
 494                                 $return .= "\n";
 495                         } else {
 496                                 # grab the others elements
 497                                 $return .= $this->drawCategoryBrowser( $parent ) . ' &gt; ';
 498                         }
 499
 500                         # add our current element to the list
 501                         $eltitle = Title::newFromText( $element );
 502                         $return .=  Linker::link( $eltitle, htmlspecialchars( $eltitle->getText() ) );
 503                 }
 504
 505                 return $return;
 506         }
 507
 508         /**
 509          * @return string
 510          */
 511         function getCategories() {
 512                 $out = $this->getOutput();
 513
 514                 $catlinks = $this->getCategoryLinks();
 515
 516                 $classes = 'catlinks';
 517
 518                 // Check what we're showing
 519                 $allCats = $out->getCategoryLinks();
 520                 $showHidden = $this->getUser()->getBoolOption( 'showhiddencats' ) ||
 521                                                 $this->getTitle()->getNamespace() == NS_CATEGORY;
 522
 523                 if ( empty( $allCats['normal'] ) && !( !empty( $allCats['hidden'] ) && $showHidden ) ) {
 524                         $classes .= ' catlinks-allhidden';
 525                 }
 526
 527                 return "<div id='catlinks' class='$classes'>{$catlinks}</div>";
 528         }
 529
 530         /**
 531          * This runs a hook to allow extensions placing their stuff after content
 532          * and article metadata (e.g. categories).
 533          * Note: This function has nothing to do with afterContent().
 534          *
 535          * This hook is placed here in order to allow using the same hook for all
 536          * skins, both the SkinTemplate based ones and the older ones, which directly
 537          * use this class to get their data.
 538          *
 539          * The output of this function gets processed in SkinTemplate::outputPage() for
 540          * the SkinTemplate based skins, all other skins should directly echo it.
 541          *
 542          * @return String, empty by default, if not changed by any hook function.
 543          */
 544         protected function afterContentHook() {
 545                 $data = '';
 546
 547                 if ( wfRunHooks( 'SkinAfterContent', array( &$data, $this ) ) ) {
 548                         // adding just some spaces shouldn't toggle the output
 549                         // of the whole <div/>, so we use trim() here
 550                         if ( trim( $data ) != '' ) {
 551                                 // Doing this here instead of in the skins to
 552                                 // ensure that the div has the same ID in all
 553                                 // skins
 554                                 $data = "<div id='mw-data-after-content'>\n" .
 555                                         "\t$data\n" .
 556                                         "</div>\n";
 557                         }
 558                 } else {
 559                         wfDebug( "Hook SkinAfterContent changed output processing.\n" );
 560                 }
 561
 562                 return $data;
 563         }
 564
 565         /**
 566          * Generate debug data HTML for displaying at the bottom of the main content
 567          * area.
 568          * @return String HTML containing debug data, if enabled (otherwise empty).
 569          */
 570         protected function generateDebugHTML() {
 571                 global $wgShowDebug;
 572
 573                 $html = MWDebug::getDebugHTML( $this->getContext() );
 574
 575                 if ( $wgShowDebug ) {
 576                         $listInternals = $this->formatDebugHTML( $this->getOutput()->mDebugtext );
 577                         $html .= "\n<hr />\n<strong>Debug data:</strong><ul id=\"mw-debug-html\">" .
 578                                 $listInternals . "</ul>\n";
 579                 }
 580
 581                 return $html;
 582         }
 583
 584         /**
 585          * @param $debugText string
 586          * @return string
 587          */
 588         private function formatDebugHTML( $debugText ) {
 589                 global $wgDebugTimestamps;
 590
 591                 $lines = explode( "\n", $debugText );
 592                 $curIdent = 0;
 593                 $ret = '<li>';
 594
 595                 foreach ( $lines as $line ) {
 596                         $pre = '';
 597                         if ( $wgDebugTimestamps ) {
 598                                 $matches = array();
 599                                 if ( preg_match( '/^(\d+\.\d+ {1,3}\d+.\dM\s{2})/', $line, $matches ) ) {
 600                                         $pre = $matches[1];
 601                                         $line = substr( $line, strlen( $pre ) );
 602                                 }
 603                         }
 604                         $display = ltrim( $line );
 605                         $ident = strlen( $line ) - strlen( $display );
 606                         $diff = $ident - $curIdent;
 607
 608                         $display = $pre . $display;
 609                         if ( $display == '' ) {
 610                                 $display = "\xc2\xa0";
 611                         }
 612
 613                         if ( !$ident && $diff < 0 && substr( $display, 0, 9 ) != 'Entering ' && substr( $display, 0, 8 ) != 'Exiting ' ) {
 614                                 $ident = $curIdent;
 615                                 $diff = 0;
 616                                 $display = '<span style="background:yellow;">' . htmlspecialchars( $display ) . '</span>';
 617                         } else {
 618                                 $display = htmlspecialchars( $display );
 619                         }
 620
 621                         if ( $diff < 0 ) {
 622                                 $ret .= str_repeat( "</li></ul>\n", -$diff ) . "</li><li>\n";
 623                         } elseif ( $diff == 0 ) {
 624                                 $ret .= "</li><li>\n";
 625                         } else {
 626                                 $ret .= str_repeat( "<ul><li>\n", $diff );
 627                         }
 628                         $ret .= "<tt>$display</tt>\n";
 629
 630                         $curIdent = $ident;
 631                 }
 632
 633                 $ret .= str_repeat( '</li></ul>', $curIdent ) . '</li>';
 634
 635                 return $ret;
 636         }
 637
 638         /**
 639          * This gets called shortly before the </body> tag.
 640          *
 641          * @return String HTML-wrapped JS code to be put before </body>
 642          */
 643         function bottomScripts() {
 644                 // TODO and the suckage continues. This function is really just a wrapper around
 645                 // OutputPage::getBottomScripts() which takes a Skin param. This should be cleaned
 646                 // up at some point
 647                 $bottomScriptText = $this->getOutput()->getBottomScripts();
 648                 wfRunHooks( 'SkinAfterBottomScripts', array( $this, &$bottomScriptText ) );
 649
 650                 return $bottomScriptText;
 651         }
 652
 653         /**
 654          * Text with the permalink to the source page,
 655          * usually shown on the footer of a printed page
 656          *
 657          * @return string HTML text with an URL
 658          */
 659         function printSource() {
 660                 $oldid = $this->getRevisionId();
 661                 if ( $oldid ) {
 662                         $url = htmlspecialchars( wfExpandIRI( $this->getTitle()->getCanonicalURL( 'oldid=' . $oldid ) ) );
 663                 } else {
 664                         // oldid not available for non existing pages
 665                         $url = htmlspecialchars( wfExpandIRI( $this->getTitle()->getCanonicalURL() ) );
 666                 }
 667                 return $this->msg( 'retrievedfrom', '<a href="' . $url . '">' . $url . '</a>' )->text();
 668         }
 669
 670         /**
 671          * @return String
 672          */
 673         function getUndeleteLink() {
 674                 $action = $this->getRequest()->getVal( 'action', 'view' );
 675
 676                 if ( $this->getUser()->isAllowed( 'deletedhistory' ) &&
 677                         ( $this->getTitle()->getArticleID() == 0 || $action == 'history' ) ) {
 678                         $n = $this->getTitle()->isDeleted();
 679
 680
 681                         if ( $n ) {
 682                                 if ( $this->getUser()->isAllowed( 'undelete' ) ) {
 683                                         $msg = 'thisisdeleted';
 684                                 } else {
 685                                         $msg = 'viewdeleted';
 686                                 }
 687
 688                                 return $this->msg( $msg )->rawParams(
 689                                         Linker::linkKnown(
 690                                                 SpecialPage::getTitleFor( 'Undelete', $this->getTitle()->getPrefixedDBkey() ),
 691                                                 $this->msg( 'restorelink' )->numParams( $n )->escaped() )
 692                                         )->text();
 693                         }
 694                 }
 695
 696                 return '';
 697         }
 698
 699         /**
 700          * @return string
 701          */
 702         function subPageSubtitle() {
 703                 global $wgLang;
 704                 $out = $this->getOutput();
 705                 $subpages = '';
 706
 707                 if ( !wfRunHooks( 'SkinSubPageSubtitle', array( &$subpages, $this, $out ) ) ) {
 708                         return $subpages;
 709                 }
 710
 711                 if ( $out->isArticle() && MWNamespace::hasSubpages( $out->getTitle()->getNamespace() ) ) {
 712                         $ptext = $this->getTitle()->getPrefixedText();
 713                         if ( preg_match( '/\//', $ptext ) ) {
 714                                 $links = explode( '/', $ptext );
 715                                 array_pop( $links );
 716                                 $c = 0;
 717                                 $growinglink = '';
 718                                 $display = '';
 719
 720                                 foreach ( $links as $link ) {
 721                                         $growinglink .= $link;
 722                                         $display .= $link;
 723                                         $linkObj = Title::newFromText( $growinglink );
 724
 725                                         if ( is_object( $linkObj ) && $linkObj->isKnown() ) {
 726                                                 $getlink = Linker::linkKnown(
 727                                                         $linkObj,
 728                                                         htmlspecialchars( $display )
 729                                                 );
 730
 731                                                 $c++;
 732
 733                                                 if ( $c > 1 ) {
 734                                                         $subpages .= $wgLang->getDirMarkEntity() . $this->msg( 'pipe-separator' )->escaped();
 735                                                 } else  {
 736                                                         $subpages .= '&lt; ';
 737                                                 }
 738
 739                                                 $subpages .= $getlink;
 740                                                 $display = '';
 741                                         } else {
 742                                                 $display .= '/';
 743                                         }
 744                                         $growinglink .= '/';
 745                                 }
 746                         }
 747                 }
 748
 749                 return $subpages;
 750         }
 751
 752         /**
 753          * Returns true if the IP should be shown in the header
 754          * @return Bool
 755          */
 756         function showIPinHeader() {
 757                 global $wgShowIPinHeader;
 758                 return $wgShowIPinHeader && session_id() != '';
 759         }
 760
 761         /**
 762          * @return String
 763          */
 764         function getSearchLink() {
 765                 $searchPage = SpecialPage::getTitleFor( 'Search' );
 766                 return $searchPage->getLocalURL();
 767         }
 768
 769         /**
 770          * @return string
 771          */
 772         function escapeSearchLink() {
 773                 return htmlspecialchars( $this->getSearchLink() );
 774         }
 775
 776         /**
 777          * @param $type string
 778          * @return string
 779          */
 780         function getCopyright( $type = 'detect' ) {
 781                 global $wgRightsPage, $wgRightsUrl, $wgRightsText, $wgContLang;
 782
 783                 if ( $type == 'detect' ) {
 784                         if ( !$this->isRevisionCurrent() && !$this->msg( 'history_copyright' )->inContentLanguage()->isDisabled() ) {
 785                                 $type = 'history';
 786                         } else {
 787                                 $type = 'normal';
 788                         }
 789                 }
 790
 791                 if ( $type == 'history' ) {
 792                         $msg = 'history_copyright';
 793                 } else {
 794                         $msg = 'copyright';
 795                 }
 796
 797                 if ( $wgRightsPage ) {
 798                         $title = Title::newFromText( $wgRightsPage );
 799                         $link = Linker::linkKnown( $title, $wgRightsText );
 800                 } elseif ( $wgRightsUrl ) {
 801                         $link = Linker::makeExternalLink( $wgRightsUrl, $wgRightsText );
 802                 } elseif ( $wgRightsText ) {
 803                         $link = $wgRightsText;
 804                 } else {
 805                         # Give up now
 806                         return '';
 807                 }
 808
 809                 // Allow for site and per-namespace customization of copyright notice.
 810                 $forContent = true;
 811
 812                 wfRunHooks( 'SkinCopyrightFooter', array( $this->getTitle(), $type, &$msg, &$link, &$forContent ) );
 813
 814                 $msgObj = $this->msg( $msg )->rawParams( $link );
 815                 if ( $forContent ) {
 816                         $msg = $msgObj->inContentLanguage()->text();
 817                         if ( $this->getLanguage()->getCode() !== $wgContLang->getCode() ) {
 818                                 $msg = Html::rawElement( 'span', array( 'lang' => $wgContLang->getHtmlCode(), 'dir' => $wgContLang->getDir() ), $msg );
 819                         }
 820                         return $msg;
 821                 } else {
 822                         return $msgObj->text();
 823                 }
 824         }
 825
 826         /**
 827          * @return null|string
 828          */
 829         function getCopyrightIcon() {
 830                 global $wgRightsUrl, $wgRightsText, $wgRightsIcon, $wgCopyrightIcon;
 831
 832                 $out = '';
 833
 834                 if ( isset( $wgCopyrightIcon ) && $wgCopyrightIcon ) {
 835                         $out = $wgCopyrightIcon;
 836                 } elseif ( $wgRightsIcon ) {
 837                         $icon = htmlspecialchars( $wgRightsIcon );
 838
 839                         if ( $wgRightsUrl ) {
 840                                 $url = htmlspecialchars( $wgRightsUrl );
 841                                 $out .= '<a href="' . $url . '">';
 842                         }
 843
 844                         $text = htmlspecialchars( $wgRightsText );
 845                         $out .= "<img src=\"$icon\" alt=\"$text\" width=\"88\" height=\"31\" />";
 846
 847                         if ( $wgRightsUrl ) {
 848                                 $out .= '</a>';
 849                         }
 850                 }
 851
 852                 return $out;
 853         }
 854
 855         /**
 856          * Gets the powered by MediaWiki icon.
 857          * @return string
 858          */
 859         function getPoweredBy() {
 860                 global $wgStylePath;
 861
 862                 $url = htmlspecialchars( "$wgStylePath/common/images/poweredby_mediawiki_88x31.png" );
 863                 $text = '<a href="//www.mediawiki.org/"><img src="' . $url . '" height="31" width="88" alt="Powered by MediaWiki" /></a>';
 864                 wfRunHooks( 'SkinGetPoweredBy', array( &$text, $this ) );
 865                 return $text;
 866         }
 867
 868         /**
 869          * Get the timestamp of the latest revision, formatted in user language
 870          *
 871          * @return String
 872          */
 873         protected function lastModified() {
 874                 $timestamp = $this->getOutput()->getRevisionTimestamp();
 875
 876                 # No cached timestamp, load it from the database
 877                 if ( $timestamp === null ) {
 878                         $timestamp = Revision::getTimestampFromId( $this->getTitle(), $this->getRevisionId() );
 879                 }
 880
 881                 if ( $timestamp ) {
 882                         $d = $this->getLanguage()->userDate( $timestamp, $this->getUser() );
 883                         $t = $this->getLanguage()->userTime( $timestamp, $this->getUser() );
 884                         $s = ' ' . $this->msg( 'lastmodifiedat', $d, $t )->text();
 885                 } else {
 886                         $s = '';
 887                 }
 888
 889                 if ( wfGetLB()->getLaggedSlaveMode() ) {
 890                         $s .= ' <strong>' . $this->msg( 'laggedslavemode' )->text() . '</strong>';
 891                 }
 892
 893                 return $s;
 894         }
 895
 896         /**
 897          * @param $align string
 898          * @return string
 899          */
 900         function logoText( $align = '' ) {
 901                 if ( $align != '' ) {
 902                         $a = " align='{$align}'";
 903                 } else {
 904                         $a = '';
 905                 }
 906
 907                 $mp = $this->msg( 'mainpage' )->escaped();
 908                 $mptitle = Title::newMainPage();
 909                 $url = ( is_object( $mptitle ) ? htmlspecialchars( $mptitle->getLocalURL() ) : '' );
 910
 911                 $logourl = $this->getLogo();
 912                 $s = "<a href='{$url}'><img{$a} src='{$logourl}' alt='[{$mp}]' /></a>";
 913
 914                 return $s;
 915         }
 916
 917         /**
 918          * Renders a $wgFooterIcons icon acording to the method's arguments
 919          * @param $icon Array: The icon to build the html for, see $wgFooterIcons for the format of this array
 920          * @param $withImage Bool|String: Whether to use the icon's image or output a text-only footericon
 921          * @return String HTML
 922          */
 923         function makeFooterIcon( $icon, $withImage = 'withImage' ) {
 924                 if ( is_string( $icon ) ) {
 925                         $html = $icon;
 926                 } else { // Assuming array
 927                         $url = isset($icon["url"]) ? $icon["url"] : null;
 928                         unset( $icon["url"] );
 929                         if ( isset( $icon["src"] ) && $withImage === 'withImage' ) {
 930                                 $html = Html::element( 'img', $icon ); // do this the lazy way, just pass icon data as an attribute array
 931                         } else {
 932                                 $html = htmlspecialchars( $icon["alt"] );
 933                         }
 934                         if ( $url ) {
 935                                 $html = Html::rawElement( 'a', array( "href" => $url ), $html );
 936                         }
 937                 }
 938                 return $html;
 939         }
 940
 941         /**
 942          * Gets the link to the wiki's main page.
 943          * @return string
 944          */
 945         function mainPageLink() {
 946                 $s = Linker::linkKnown(
 947                         Title::newMainPage(),
 948                         $this->msg( 'mainpage' )->escaped()
 949                 );
 950
 951                 return $s;
 952         }
 953
 954         /**
 955          * @param $desc
 956          * @param $page
 957          * @return string
 958          */
 959         public function footerLink( $desc, $page ) {
 960                 // if the link description has been set to "-" in the default language,
 961                 if ( $this->msg( $desc )->inContentLanguage()->isDisabled() ) {
 962                         // then it is disabled, for all languages.
 963                         return '';
 964                 } else {
 965                         // Otherwise, we display the link for the user, described in their
 966                         // language (which may or may not be the same as the default language),
 967                         // but we make the link target be the one site-wide page.
 968                         $title = Title::newFromText( $this->msg( $page )->inContentLanguage()->text() );
 969
 970                         return Linker::linkKnown(
 971                                 $title,
 972                                 $this->msg( $desc )->escaped()
 973                         );
 974                 }
 975         }
 976
 977         /**
 978          * Gets the link to the wiki's privacy policy page.
 979          * @return String HTML
 980          */
 981         function privacyLink() {
 982                 return $this->footerLink( 'privacy', 'privacypage' );
 983         }
 984
 985         /**
 986          * Gets the link to the wiki's about page.
 987          * @return String HTML
 988          */
 989         function aboutLink() {
 990                 return $this->footerLink( 'aboutsite', 'aboutpage' );
 991         }
 992
 993         /**
 994          * Gets the link to the wiki's general disclaimers page.
 995          * @return String HTML
 996          */
 997         function disclaimerLink() {
 998                 return $this->footerLink( 'disclaimers', 'disclaimerpage' );
 999         }
1000
1001         /**
1002          * Return URL options for the 'edit page' link.
1003          * This may include an 'oldid' specifier, if the current page view is such.
1004          *
1005          * @return array
1006          * @private
1007          */
1008         function editUrlOptions() {
1009                 $options = array( 'action' => 'edit' );
1010
1011                 if ( !$this->isRevisionCurrent() ) {
1012                         $options['oldid'] = intval( $this->getRevisionId() );
1013                 }
1014
1015                 return $options;
1016         }
1017
1018         /**
1019          * @param $id User|int
1020          * @return bool
1021          */
1022         function showEmailUser( $id ) {
1023                 if ( $id instanceof User ) {
1024                         $targetUser = $id;
1025                 } else {
1026                         $targetUser = User::newFromId( $id );
1027                 }
1028                 return $this->getUser()->canSendEmail() && # the sending user must have a confirmed email address
1029                         $targetUser->canReceiveEmail(); # the target user must have a confirmed email address and allow emails from users
1030         }
1031
1032         /**
1033          * Return a fully resolved style path url to images or styles stored in the common folder.
1034          * This method returns a url resolved using the configured skin style path
1035          * and includes the style version inside of the url.
1036          * @param $name String: The name or path of a skin resource file
1037          * @return String The fully resolved style path url including styleversion
1038          */
1039         function getCommonStylePath( $name ) {
1040                 global $wgStylePath, $wgStyleVersion;
1041                 return "$wgStylePath/common/$name?$wgStyleVersion";
1042         }
1043
1044         /**
1045          * Return a fully resolved style path url to images or styles stored in the curent skins's folder.
1046          * This method returns a url resolved using the configured skin style path
1047          * and includes the style version inside of the url.
1048          * @param $name String: The name or path of a skin resource file
1049          * @return String The fully resolved style path url including styleversion
1050          */
1051         function getSkinStylePath( $name ) {
1052                 global $wgStylePath, $wgStyleVersion;
1053                 return "$wgStylePath/{$this->stylename}/$name?$wgStyleVersion";
1054         }
1055
1056         /* these are used extensively in SkinTemplate, but also some other places */
1057
1058         /**
1059          * @param $urlaction string
1060          * @return String
1061          */
1062         static function makeMainPageUrl( $urlaction = '' ) {
1063                 $title = Title::newMainPage();
1064                 self::checkTitle( $title, '' );
1065
1066                 return $title->getLocalURL( $urlaction );
1067         }
1068
1069         /**
1070          * @param $name string
1071          * @param $urlaction string
1072          * @return String
1073          */
1074         static function makeSpecialUrl( $name, $urlaction = '' ) {
1075                 $title = SpecialPage::getSafeTitleFor( $name );
1076                 return $title->getLocalURL( $urlaction );
1077         }
1078
1079         /**
1080          * @param $name string
1081          * @param $subpage string
1082          * @param $urlaction string
1083          * @return String
1084          */
1085         static function makeSpecialUrlSubpage( $name, $subpage, $urlaction = '' ) {
1086                 $title = SpecialPage::getSafeTitleFor( $name, $subpage );
1087                 return $title->getLocalURL( $urlaction );
1088         }
1089
1090         /**
1091          * @param $name string
1092          * @param $urlaction string
1093          * @return String
1094          */
1095         static function makeI18nUrl( $name, $urlaction = '' ) {
1096                 $title = Title::newFromText( wfMsgForContent( $name ) );
1097                 self::checkTitle( $title, $name );
1098                 return $title->getLocalURL( $urlaction );
1099         }
1100
1101         /**
1102          * @param $name string
1103          * @param $urlaction string
1104          * @return String
1105          */
1106         static function makeUrl( $name, $urlaction = '' ) {
1107                 $title = Title::newFromText( $name );
1108                 self::checkTitle( $title, $name );
1109
1110                 return $title->getLocalURL( $urlaction );
1111         }
1112
1113         /**
1114          * If url string starts with http, consider as external URL, else
1115          * internal
1116          * @param $name String
1117          * @return String URL
1118          */
1119         static function makeInternalOrExternalUrl( $name ) {
1120                 if ( preg_match( '/^(?:' . wfUrlProtocols() . ')/', $name ) ) {
1121                         return $name;
1122                 } else {
1123                         return self::makeUrl( $name );
1124                 }
1125         }
1126
1127         /**
1128          * this can be passed the NS number as defined in Language.php
1129          * @param $name
1130          * @param $urlaction string
1131          * @param $namespace int
1132          * @return String
1133          */
1134         static function makeNSUrl( $name, $urlaction = '', $namespace = NS_MAIN ) {
1135                 $title = Title::makeTitleSafe( $namespace, $name );
1136                 self::checkTitle( $title, $name );
1137
1138                 return $title->getLocalURL( $urlaction );
1139         }
1140
1141         /**
1142          * these return an array with the 'href' and boolean 'exists'
1143          * @param $name
1144          * @param $urlaction string
1145          * @return array
1146          */
1147         static function makeUrlDetails( $name, $urlaction = '' ) {
1148                 $title = Title::newFromText( $name );
1149                 self::checkTitle( $title, $name );
1150
1151                 return array(
1152                         'href' => $title->getLocalURL( $urlaction ),
1153                         'exists' => $title->getArticleID() != 0,
1154                 );
1155         }
1156
1157         /**
1158          * Make URL details where the article exists (or at least it's convenient to think so)
1159          * @param $name String Article name
1160          * @param $urlaction String
1161          * @return Array
1162          */
1163         static function makeKnownUrlDetails( $name, $urlaction = '' ) {
1164                 $title = Title::newFromText( $name );
1165                 self::checkTitle( $title, $name );
1166
1167                 return array(
1168                         'href' => $title->getLocalURL( $urlaction ),
1169                         'exists' => true
1170                 );
1171         }
1172
1173         /**
1174          * make sure we have some title to operate on
1175          *
1176          * @param $title Title
1177          * @param $name string
1178          */
1179         static function checkTitle( &$title, $name ) {
1180                 if ( !is_object( $title ) ) {
1181                         $title = Title::newFromText( $name );
1182                         if ( !is_object( $title ) ) {
1183                                 $title = Title::newFromText( '--error: link target missing--' );
1184                         }
1185                 }
1186         }
1187
1188         /**
1189          * Build an array that represents the sidebar(s), the navigation bar among them
1190          *
1191          * @return array
1192          */
1193         function buildSidebar() {
1194                 global $wgMemc, $wgEnableSidebarCache, $wgSidebarCacheExpiry;
1195                 wfProfileIn( __METHOD__ );
1196
1197                 $key = wfMemcKey( 'sidebar', $this->getLanguage()->getCode() );
1198
1199                 if ( $wgEnableSidebarCache ) {
1200                         $cachedsidebar = $wgMemc->get( $key );
1201                         if ( $cachedsidebar ) {
1202                                 wfProfileOut( __METHOD__ );
1203                                 return $cachedsidebar;
1204                         }
1205                 }
1206
1207                 $bar = array();
1208                 $this->addToSidebar( $bar, 'sidebar' );
1209
1210                 wfRunHooks( 'SkinBuildSidebar', array( $this, &$bar ) );
1211                 if ( $wgEnableSidebarCache ) {
1212                         $wgMemc->set( $key, $bar, $wgSidebarCacheExpiry );
1213                 }
1214
1215                 wfProfileOut( __METHOD__ );
1216                 return $bar;
1217         }
1218         /**
1219          * Add content from a sidebar system message
1220          * Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
1221          *
1222          * This is just a wrapper around addToSidebarPlain() for backwards compatibility
1223          *
1224          * @param $bar array
1225          * @param $message String
1226          */
1227         function addToSidebar( &$bar, $message ) {
1228                 $this->addToSidebarPlain( $bar, wfMsgForContentNoTrans( $message ) );
1229         }
1230
1231         /**
1232          * Add content from plain text
1233          * @since 1.17
1234          * @param $bar array
1235          * @param $text string
1236          * @return Array
1237          */
1238         function addToSidebarPlain( &$bar, $text ) {
1239                 $lines = explode( "\n", $text );
1240
1241                 $heading = '';
1242
1243                 foreach ( $lines as $line ) {
1244                         if ( strpos( $line, '*' ) !== 0 ) {
1245                                 continue;
1246                         }
1247                         $line = rtrim( $line, "\r" ); // for Windows compat
1248
1249                         if ( strpos( $line, '**' ) !== 0 ) {
1250                                 $heading = trim( $line, '* ' );
1251                                 if ( !array_key_exists( $heading, $bar ) ) {
1252                                         $bar[$heading] = array();
1253                                 }
1254                         } else {
1255                                 $line = trim( $line, '* ' );
1256
1257                                 if ( strpos( $line, '|' ) !== false ) { // sanity check
1258                                         $line = MessageCache::singleton()->transform( $line, false, null, $this->getTitle() );
1259                                         $line = array_map( 'trim', explode( '|', $line, 2 ) );
1260                                         if ( count( $line ) !== 2 ) {
1261                                                 // Second sanity check, could be hit by people doing
1262                                                 // funky stuff with parserfuncs... (bug 33321)
1263                                                 continue;
1264                                         }
1265
1266                                         $extraAttribs = array();
1267
1268                                         $msgLink = $this->msg( $line[0] )->inContentLanguage();
1269                                         if ( $msgLink->exists() ) {
1270                                                 $link = $msgLink->text();
1271                                                 if ( $link == '-' ) {
1272                                                         continue;
1273                                                 }
1274                                         } else {
1275                                                 $link = $line[0];
1276                                         }
1277                                         $msgText = $this->msg( $line[1] );
1278                                         if ( $msgText->exists() ) {
1279                                                 $text = $msgText->text();
1280                                         } else {
1281                                                 $text = $line[1];
1282                                         }
1283
1284                                         if ( preg_match( '/^(?:' . wfUrlProtocols() . ')/', $link ) ) {
1285                                                 $href = $link;
1286
1287                                                 // Parser::getExternalLinkAttribs won't work here because of the Namespace things
1288                                                 global $wgNoFollowLinks, $wgNoFollowDomainExceptions;
1289                                                 if ( $wgNoFollowLinks && !wfMatchesDomainList( $href, $wgNoFollowDomainExceptions ) ) {
1290                                                         $extraAttribs['rel'] = 'nofollow';
1291                                                 }
1292
1293                                                 global $wgExternalLinkTarget;
1294                                                 if ( $wgExternalLinkTarget) {
1295                                                         $extraAttribs['target'] = $wgExternalLinkTarget;
1296                                                 }
1297                                         } else {
1298                                                 $title = Title::newFromText( $link );
1299
1300                                                 if ( $title ) {
1301                                                         $title = $title->fixSpecialName();
1302                                                         $href = $title->getLinkURL();
1303                                                 } else {
1304                                                         $href = 'INVALID-TITLE';
1305                                                 }
1306                                         }
1307
1308                                         $bar[$heading][] = array_merge( array(
1309                                                 'text' => $text,
1310                                                 'href' => $href,
1311                                                 'id' => 'n-' . Sanitizer::escapeId( strtr( $line[1], ' ', '-' ), 'noninitial' ),
1312                                                 'active' => false
1313                                         ), $extraAttribs );
1314                                 } else {
1315                                         continue;
1316                                 }
1317                         }
1318                 }
1319
1320                 return $bar;
1321         }
1322
1323         /**
1324          * Should we load mediawiki.legacy.wikiprintable?  Skins that have their own
1325          * print stylesheet should override this and return false.  (This is an
1326          * ugly hack to get Monobook to play nicely with OutputPage::headElement().)
1327          *
1328          * @return bool
1329          */
1330         public function commonPrintStylesheet() {
1331                 return true;
1332         }
1333
1334         /**
1335          * Gets new talk page messages for the current user.
1336          * @return MediaWiki message or if no new talk page messages, nothing
1337          */
1338         function getNewtalks() {
1339                 $out = $this->getOutput();
1340
1341                 $newtalks = $this->getUser()->getNewMessageLinks();
1342                 $ntl = '';
1343
1344                 if ( count( $newtalks ) == 1 && $newtalks[0]['wiki'] === wfWikiID() ) {
1345                         $userTitle = $this->getUser()->getUserPage();
1346                         $userTalkTitle = $userTitle->getTalkPage();
1347
1348                         if ( !$userTalkTitle->equals( $out->getTitle() ) ) {
1349                                 $newMessagesLink = Linker::linkKnown(
1350                                         $userTalkTitle,
1351                                         $this->msg( 'newmessageslink' )->escaped(),
1352                                         array(),
1353                                         array( 'redirect' => 'no' )
1354                                 );
1355
1356                                 $newMessagesDiffLink = Linker::linkKnown(
1357                                         $userTalkTitle,
1358                                         $this->msg( 'newmessagesdifflink' )->escaped(),
1359                                         array(),
1360                                         array( 'diff' => 'cur' )
1361                                 );
1362
1363                                 $ntl = $this->msg(
1364                                         'youhavenewmessages',
1365                                         $newMessagesLink,
1366                                         $newMessagesDiffLink
1367                                 )->text();
1368                                 # Disable Squid cache
1369                                 $out->setSquidMaxage( 0 );
1370                         }
1371                 } elseif ( count( $newtalks ) ) {
1372                         // _>" " for BC <= 1.16
1373                         $sep = str_replace( '_', ' ', $this->msg( 'newtalkseparator' )->escaped() );
1374                         $msgs = array();
1375
1376                         foreach ( $newtalks as $newtalk ) {
1377                                 $msgs[] = Xml::element(
1378                                         'a',
1379                                         array( 'href' => $newtalk['link'] ), $newtalk['wiki']
1380                                 );
1381                         }
1382                         $parts = implode( $sep, $msgs );
1383                         $ntl = $this->msg( 'youhavenewmessagesmulti' )->rawParams( $parts )->escaped();
1384                         $out->setSquidMaxage( 0 );
1385                 }
1386
1387                 return $ntl;
1388         }
1389
1390         /**
1391          * Get a cached notice
1392          *
1393          * @param $name String: message name, or 'default' for $wgSiteNotice
1394          * @return String: HTML fragment
1395          */
1396         private function getCachedNotice( $name ) {
1397                 global $wgRenderHashAppend, $parserMemc, $wgContLang;
1398
1399                 wfProfileIn( __METHOD__ );
1400
1401                 $needParse = false;
1402
1403                 if( $name === 'default' ) {
1404                         // special case
1405                         global $wgSiteNotice;
1406                         $notice = $wgSiteNotice;
1407                         if( empty( $notice ) ) {
1408                                 wfProfileOut( __METHOD__ );
1409                                 return false;
1410                         }
1411                 } else {
1412                         $msg = $this->msg( $name )->inContentLanguage();
1413                         if( $msg->isDisabled() ) {
1414                                 wfProfileOut( __METHOD__ );
1415                                 return false;
1416                         }
1417                         $notice = $msg->plain();
1418                 }
1419
1420                 // Use the extra hash appender to let eg SSL variants separately cache.
1421                 $key = wfMemcKey( $name . $wgRenderHashAppend );
1422                 $cachedNotice = $parserMemc->get( $key );
1423                 if( is_array( $cachedNotice ) ) {
1424                         if( md5( $notice ) == $cachedNotice['hash'] ) {
1425                                 $notice = $cachedNotice['html'];
1426                         } else {
1427                                 $needParse = true;
1428                         }
1429                 } else {
1430                         $needParse = true;
1431                 }
1432
1433                 if ( $needParse ) {
1434                         $parsed = $this->getOutput()->parse( $notice );
1435                         $parserMemc->set( $key, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
1436                         $notice = $parsed;
1437                 }
1438
1439                 $notice = Html::rawElement( 'div', array( 'id' => 'localNotice',
1440                         'lang' => $wgContLang->getHtmlCode(), 'dir' => $wgContLang->getDir() ), $notice );
1441                 wfProfileOut( __METHOD__ );
1442                 return $notice;
1443         }
1444
1445         /**
1446          * Get a notice based on page's namespace
1447          *
1448          * @return String: HTML fragment
1449          */
1450         function getNamespaceNotice() {
1451                 wfProfileIn( __METHOD__ );
1452
1453                 $key = 'namespacenotice-' . $this->getTitle()->getNsText();
1454                 $namespaceNotice = $this->getCachedNotice( $key );
1455                 if ( $namespaceNotice && substr( $namespaceNotice, 0, 7 ) != '<p>&lt;' ) {
1456                         $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . '</div>';
1457                 } else {
1458                         $namespaceNotice = '';
1459                 }
1460
1461                 wfProfileOut( __METHOD__ );
1462                 return $namespaceNotice;
1463         }
1464
1465         /**
1466          * Get the site notice
1467          *
1468          * @return String: HTML fragment
1469          */
1470         function getSiteNotice() {
1471                 wfProfileIn( __METHOD__ );
1472                 $siteNotice = '';
1473
1474                 if ( wfRunHooks( 'SiteNoticeBefore', array( &$siteNotice, $this ) ) ) {
1475                         if ( is_object( $this->getUser() ) && $this->getUser()->isLoggedIn() ) {
1476                                 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1477                         } else {
1478                                 $anonNotice = $this->getCachedNotice( 'anonnotice' );
1479                                 if ( !$anonNotice ) {
1480                                         $siteNotice = $this->getCachedNotice( 'sitenotice' );
1481                                 } else {
1482                                         $siteNotice = $anonNotice;
1483                                 }
1484                         }
1485                         if ( !$siteNotice ) {
1486                                 $siteNotice = $this->getCachedNotice( 'default' );
1487                         }
1488                 }
1489
1490                 wfRunHooks( 'SiteNoticeAfter', array( &$siteNotice, $this ) );
1491                 wfProfileOut( __METHOD__ );
1492                 return $siteNotice;
1493         }
1494
1495         /**
1496          * Create a section edit link.  This supersedes editSectionLink() and
1497          * editSectionLinkForOther().
1498          *
1499          * @param $nt      Title  The title being linked to (may not be the same as
1500          *   $wgTitle, if the section is included from a template)
1501          * @param $section string The designation of the section being pointed to,
1502          *   to be included in the link, like "&section=$section"
1503          * @param $tooltip string The tooltip to use for the link: will be escaped
1504          *   and wrapped in the 'editsectionhint' message
1505          * @param $lang    string Language code
1506          * @return         string HTML to use for edit link
1507          */
1508         public function doEditSectionLink( Title $nt, $section, $tooltip = null, $lang = false ) {
1509                 // HTML generated here should probably have userlangattributes
1510                 // added to it for LTR text on RTL pages
1511                 $attribs = array();
1512                 if ( !is_null( $tooltip ) ) {
1513                         # Bug 25462: undo double-escaping.
1514                         $tooltip = Sanitizer::decodeCharReferences( $tooltip );
1515                         $attribs['title'] = wfMsgExt( 'editsectionhint', array( 'language' => $lang, 'parsemag', 'replaceafter' ), $tooltip );
1516                 }
1517                 $link = Linker::link( $nt, wfMsgExt( 'editsection', array( 'language' => $lang ) ),
1518                         $attribs,
1519                         array( 'action' => 'edit', 'section' => $section ),
1520                         array( 'noclasses', 'known' )
1521                 );
1522
1523                 # Run the old hook.  This takes up half of the function . . . hopefully
1524                 # we can rid of it someday.
1525                 $attribs = '';
1526                 if ( $tooltip ) {
1527                         $attribs = wfMsgExt( 'editsectionhint', array( 'language' => $lang, 'parsemag', 'escape', 'replaceafter' ), $tooltip );
1528                         $attribs = " title=\"$attribs\"";
1529                 }
1530                 $result = null;
1531                 wfRunHooks( 'EditSectionLink', array( &$this, $nt, $section, $attribs, $link, &$result, $lang ) );
1532                 if ( !is_null( $result ) ) {
1533                         # For reverse compatibility, add the brackets *after* the hook is
1534                         # run, and even add them to hook-provided text.  (This is the main
1535                         # reason that the EditSectionLink hook is deprecated in favor of
1536                         # DoEditSectionLink: it can't change the brackets or the span.)
1537                         $result = wfMsgExt( 'editsection-brackets', array( 'escape', 'replaceafter', 'language' => $lang ), $result );
1538                         return "<span class=\"editsection\">$result</span>";
1539                 }
1540
1541                 # Add the brackets and the span, and *then* run the nice new hook, with
1542                 # clean and non-redundant arguments.
1543                 $result = wfMsgExt( 'editsection-brackets', array( 'escape', 'replaceafter', 'language' => $lang ), $link );
1544                 $result = "<span class=\"editsection\">$result</span>";
1545
1546                 wfRunHooks( 'DoEditSectionLink', array( $this, $nt, $section, $tooltip, &$result, $lang ) );
1547                 return $result;
1548         }
1549
1550         /**
1551          * Use PHP's magic __call handler to intercept legacy calls to the linker
1552          * for backwards compatibility.
1553          *
1554          * @param $fname String Name of called method
1555          * @param $args Array Arguments to the method
1556          * @return mixed
1557          */
1558         function __call( $fname, $args ) {
1559                 $realFunction = array( 'Linker', $fname );
1560                 if ( is_callable( $realFunction ) ) {
1561                         return call_user_func_array( $realFunction, $args );
1562                 } else {
1563                         $className = get_class( $this );
1564                         throw new MWException( "Call to undefined method $className::$fname" );
1565                 }
1566         }
1567
1568 }