includes/Title.php

   1 <?php
   2 /**
   3  * Representation of a title within %MediaWiki.
   4  *
   5  * See title.txt
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  */
  24
  25 /**
  26  * Represents a title within MediaWiki.
  27  * Optionally may contain an interwiki designation or namespace.
  28  * @note This class can fetch various kinds of data from the database;
  29  *       however, it does so inefficiently.
  30  * @note Consider using a TitleValue object instead. TitleValue is more lightweight
  31  *       and does not rely on global state or the database.
  32  *
  33  * @internal documentation reviewed 15 Mar 2010
  34  */
  35 class Title {
  36         /** @var MapCacheLRU */
  37         static private $titleCache = null;
  38
  39         /**
  40          * Title::newFromText maintains a cache to avoid expensive re-normalization of
  41          * commonly used titles. On a batch operation this can become a memory leak
  42          * if not bounded. After hitting this many titles reset the cache.
  43          */
  44         const CACHE_MAX = 1000;
  45
  46         /**
  47          * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
  48          * to use the master DB
  49          */
  50         const GAID_FOR_UPDATE = 1;
  51
  52         /**
  53          * @name Private member variables
  54          * Please use the accessor functions instead.
  55          * @private
  56          */
  57         // @{
  58
  59         /** @var string Text form (spaces not underscores) of the main part */
  60         public $mTextform = '';
  61
  62         /** @var string URL-encoded form of the main part */
  63         public $mUrlform = '';
  64
  65         /** @var string Main part with underscores */
  66         public $mDbkeyform = '';
  67
  68         /** @var string Database key with the initial letter in the case specified by the user */
  69         protected $mUserCaseDBKey;
  70
  71         /** @var int Namespace index, i.e. one of the NS_xxxx constants */
  72         public $mNamespace = NS_MAIN;
  73
  74         /** @var string Interwiki prefix */
  75         public $mInterwiki = '';
  76
  77         /** @var bool Was this Title created from a string with a local interwiki prefix? */
  78         private $mLocalInterwiki = false;
  79
  80         /** @var string Title fragment (i.e. the bit after the #) */
  81         public $mFragment = '';
  82
  83         /** @var int Article ID, fetched from the link cache on demand */
  84         public $mArticleID = -1;
  85
  86         /** @var bool|int ID of most recent revision */
  87         protected $mLatestID = false;
  88
  89         /**
  90          * @var bool|string ID of the page's content model, i.e. one of the
  91          *   CONTENT_MODEL_XXX constants
  92          */
  93         public $mContentModel = false;
  94
  95         /** @var int Estimated number of revisions; null of not loaded */
  96         private $mEstimateRevisions;
  97
  98         /** @var array Array of groups allowed to edit this article */
  99         public $mRestrictions = array();
 100
 101         /** @var bool */
 102         protected $mOldRestrictions = false;
 103
 104         /** @var bool Cascade restrictions on this page to included templates and images? */
 105         public $mCascadeRestriction;
 106
 107         /** Caching the results of getCascadeProtectionSources */
 108         public $mCascadingRestrictions;
 109
 110         /** @var array When do the restrictions on this page expire? */
 111         protected $mRestrictionsExpiry = array();
 112
 113         /** @var bool Are cascading restrictions in effect on this page? */
 114         protected $mHasCascadingRestrictions;
 115
 116         /** @var array Where are the cascading restrictions coming from on this page? */
 117         public $mCascadeSources;
 118
 119         /** @var bool Boolean for initialisation on demand */
 120         public $mRestrictionsLoaded = false;
 121
 122         /** @var string Text form including namespace/interwiki, initialised on demand */
 123         protected $mPrefixedText = null;
 124
 125         /** @var mixed Cached value for getTitleProtection (create protection) */
 126         public $mTitleProtection;
 127
 128         /**
 129          * @var int Namespace index when there is no namespace. Don't change the
 130          *   following default, NS_MAIN is hardcoded in several places. See bug 696.
 131          *   Zero except in {{transclusion}} tags.
 132          */
 133         public $mDefaultNamespace = NS_MAIN;
 134
 135         /**
 136          * @var bool Is $wgUser watching this page? null if unfilled, accessed
 137          * through userIsWatching()
 138          */
 139         protected $mWatched = null;
 140
 141         /** @var int The page length, 0 for special pages */
 142         protected $mLength = -1;
 143
 144         /** @var null Is the article at this title a redirect? */
 145         public $mRedirect = null;
 146
 147         /** @var array Associative array of user ID -> timestamp/false */
 148         private $mNotificationTimestamp = array();
 149
 150         /** @var bool Whether a page has any subpages */
 151         private $mHasSubpages;
 152
 153         /** @var bool The (string) language code of the page's language and content code. */
 154         private $mPageLanguage = false;
 155
 156         /** @var string The page language code from the database */
 157         private $mDbPageLanguage = null;
 158
 159         /** @var TitleValue A corresponding TitleValue object */
 160         private $mTitleValue = null;
 161         // @}
 162
 163         /**
 164          * B/C kludge: provide a TitleParser for use by Title.
 165          * Ideally, Title would have no methods that need this.
 166          * Avoid usage of this singleton by using TitleValue
 167          * and the associated services when possible.
 168          *
 169          * @return TitleParser
 170          */
 171         private static function getTitleParser() {
 172                 global $wgContLang, $wgLocalInterwikis;
 173
 174                 static $titleCodec = null;
 175                 static $titleCodecFingerprint = null;
 176
 177                 // $wgContLang and $wgLocalInterwikis may change (especially while testing),
 178                 // make sure we are using the right one. To detect changes over the course
 179                 // of a request, we remember a fingerprint of the config used to create the
 180                 // codec singleton, and re-create it if the fingerprint doesn't match.
 181                 $fingerprint = spl_object_hash( $wgContLang ) . '|' . join( '+', $wgLocalInterwikis );
 182
 183                 if ( $fingerprint !== $titleCodecFingerprint ) {
 184                         $titleCodec = null;
 185                 }
 186
 187                 if ( !$titleCodec ) {
 188                         $titleCodec = new MediaWikiTitleCodec(
 189                                 $wgContLang,
 190                                 GenderCache::singleton(),
 191                                 $wgLocalInterwikis
 192                         );
 193                         $titleCodecFingerprint = $fingerprint;
 194                 }
 195
 196                 return $titleCodec;
 197         }
 198
 199         /**
 200          * B/C kludge: provide a TitleParser for use by Title.
 201          * Ideally, Title would have no methods that need this.
 202          * Avoid usage of this singleton by using TitleValue
 203          * and the associated services when possible.
 204          *
 205          * @return TitleFormatter
 206          */
 207         private static function getTitleFormatter() {
 208                 //NOTE: we know that getTitleParser() returns a MediaWikiTitleCodec,
 209                 //      which implements TitleFormatter.
 210                 return self::getTitleParser();
 211         }
 212
 213         function __construct() {
 214         }
 215
 216         /**
 217          * Create a new Title from a prefixed DB key
 218          *
 219          * @param string $key The database key, which has underscores
 220          *      instead of spaces, possibly including namespace and
 221          *      interwiki prefixes
 222          * @return Title|null Title, or null on an error
 223          */
 224         public static function newFromDBkey( $key ) {
 225                 $t = new Title();
 226                 $t->mDbkeyform = $key;
 227                 if ( $t->secureAndSplit() ) {
 228                         return $t;
 229                 } else {
 230                         return null;
 231                 }
 232         }
 233
 234         /**
 235          * Create a new Title from a TitleValue
 236          *
 237          * @param TitleValue $titleValue Assumed to be safe.
 238          *
 239          * @return Title
 240          */
 241         public static function newFromTitleValue( TitleValue $titleValue ) {
 242                 return self::makeTitle(
 243                         $titleValue->getNamespace(),
 244                         $titleValue->getText(),
 245                         $titleValue->getFragment() );
 246         }
 247
 248         /**
 249          * Create a new Title from text, such as what one would find in a link. De-
 250          * codes any HTML entities in the text.
 251          *
 252          * @param string $text The link text; spaces, prefixes, and an
 253          *   initial ':' indicating the main namespace are accepted.
 254          * @param int $defaultNamespace The namespace to use if none is specified
 255          *   by a prefix.  If you want to force a specific namespace even if
 256          *   $text might begin with a namespace prefix, use makeTitle() or
 257          *   makeTitleSafe().
 258          * @throws MWException
 259          * @return Title|null Title or null on an error.
 260          */
 261         public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
 262                 if ( is_object( $text ) ) {
 263                         throw new MWException( 'Title::newFromText given an object' );
 264                 }
 265
 266                 $cache = self::getTitleCache();
 267
 268                 /**
 269                  * Wiki pages often contain multiple links to the same page.
 270                  * Title normalization and parsing can become expensive on
 271                  * pages with many links, so we can save a little time by
 272                  * caching them.
 273                  *
 274                  * In theory these are value objects and won't get changed...
 275                  */
 276                 if ( $defaultNamespace == NS_MAIN && $cache->has( $text ) ) {
 277                         return $cache->get( $text );
 278                 }
 279
 280                 # Convert things like &eacute; &#257; or &#x3017; into normalized (bug 14952) text
 281                 $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text );
 282
 283                 $t = new Title();
 284                 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
 285                 $t->mDefaultNamespace = intval( $defaultNamespace );
 286
 287                 if ( $t->secureAndSplit() ) {
 288                         if ( $defaultNamespace == NS_MAIN ) {
 289                                 $cache->set( $text, $t );
 290                         }
 291                         return $t;
 292                 } else {
 293                         return null;
 294                 }
 295         }
 296
 297         /**
 298          * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
 299          *
 300          * Example of wrong and broken code:
 301          * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
 302          *
 303          * Example of right code:
 304          * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
 305          *
 306          * Create a new Title from URL-encoded text. Ensures that
 307          * the given title's length does not exceed the maximum.
 308          *
 309          * @param string $url The title, as might be taken from a URL
 310          * @return Title|null The new object, or null on an error
 311          */
 312         public static function newFromURL( $url ) {
 313                 $t = new Title();
 314
 315                 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
 316                 # but some URLs used it as a space replacement and they still come
 317                 # from some external search tools.
 318                 if ( strpos( self::legalChars(), '+' ) === false ) {
 319                         $url = str_replace( '+', ' ', $url );
 320                 }
 321
 322                 $t->mDbkeyform = str_replace( ' ', '_', $url );
 323                 if ( $t->secureAndSplit() ) {
 324                         return $t;
 325                 } else {
 326                         return null;
 327                 }
 328         }
 329
 330         /**
 331          * @return MapCacheLRU
 332          */
 333         private static function getTitleCache() {
 334                 if ( self::$titleCache == null ) {
 335                         self::$titleCache = new MapCacheLRU( self::CACHE_MAX );
 336                 }
 337                 return self::$titleCache;
 338         }
 339
 340         /**
 341          * Returns a list of fields that are to be selected for initializing Title
 342          * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
 343          * whether to include page_content_model.
 344          *
 345          * @return array
 346          */
 347         protected static function getSelectFields() {
 348                 global $wgContentHandlerUseDB;
 349
 350                 $fields = array(
 351                         'page_namespace', 'page_title', 'page_id',
 352                         'page_len', 'page_is_redirect', 'page_latest',
 353                 );
 354
 355                 if ( $wgContentHandlerUseDB ) {
 356                         $fields[] = 'page_content_model';
 357                 }
 358
 359                 return $fields;
 360         }
 361
 362         /**
 363          * Create a new Title from an article ID
 364          *
 365          * @param int $id The page_id corresponding to the Title to create
 366          * @param int $flags Use Title::GAID_FOR_UPDATE to use master
 367          * @return Title|null The new object, or null on an error
 368          */
 369         public static function newFromID( $id, $flags = 0 ) {
 370                 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
 371                 $row = $db->selectRow(
 372                         'page',
 373                         self::getSelectFields(),
 374                         array( 'page_id' => $id ),
 375                         __METHOD__
 376                 );
 377                 if ( $row !== false ) {
 378                         $title = Title::newFromRow( $row );
 379                 } else {
 380                         $title = null;
 381                 }
 382                 return $title;
 383         }
 384
 385         /**
 386          * Make an array of titles from an array of IDs
 387          *
 388          * @param int[] $ids Array of IDs
 389          * @return Title[] Array of Titles
 390          */
 391         public static function newFromIDs( $ids ) {
 392                 if ( !count( $ids ) ) {
 393                         return array();
 394                 }
 395                 $dbr = wfGetDB( DB_SLAVE );
 396
 397                 $res = $dbr->select(
 398                         'page',
 399                         self::getSelectFields(),
 400                         array( 'page_id' => $ids ),
 401                         __METHOD__
 402                 );
 403
 404                 $titles = array();
 405                 foreach ( $res as $row ) {
 406                         $titles[] = Title::newFromRow( $row );
 407                 }
 408                 return $titles;
 409         }
 410
 411         /**
 412          * Make a Title object from a DB row
 413          *
 414          * @param stdClass $row Object database row (needs at least page_title,page_namespace)
 415          * @return Title Corresponding Title
 416          */
 417         public static function newFromRow( $row ) {
 418                 $t = self::makeTitle( $row->page_namespace, $row->page_title );
 419                 $t->loadFromRow( $row );
 420                 return $t;
 421         }
 422
 423         /**
 424          * Load Title object fields from a DB row.
 425          * If false is given, the title will be treated as non-existing.
 426          *
 427          * @param stdClass|bool $row Database row
 428          */
 429         public function loadFromRow( $row ) {
 430                 if ( $row ) { // page found
 431                         if ( isset( $row->page_id ) ) {
 432                                 $this->mArticleID = (int)$row->page_id;
 433                         }
 434                         if ( isset( $row->page_len ) ) {
 435                                 $this->mLength = (int)$row->page_len;
 436                         }
 437                         if ( isset( $row->page_is_redirect ) ) {
 438                                 $this->mRedirect = (bool)$row->page_is_redirect;
 439                         }
 440                         if ( isset( $row->page_latest ) ) {
 441                                 $this->mLatestID = (int)$row->page_latest;
 442                         }
 443                         if ( isset( $row->page_content_model ) ) {
 444                                 $this->mContentModel = strval( $row->page_content_model );
 445                         } else {
 446                                 $this->mContentModel = false; # initialized lazily in getContentModel()
 447                         }
 448                         if ( isset( $row->page_lang ) ) {
 449                                 $this->mDbPageLanguage = (string)$row->page_lang;
 450                         }
 451                 } else { // page not found
 452                         $this->mArticleID = 0;
 453                         $this->mLength = 0;
 454                         $this->mRedirect = false;
 455                         $this->mLatestID = 0;
 456                         $this->mContentModel = false; # initialized lazily in getContentModel()
 457                 }
 458         }
 459
 460         /**
 461          * Create a new Title from a namespace index and a DB key.
 462          * It's assumed that $ns and $title are *valid*, for instance when
 463          * they came directly from the database or a special page name.
 464          * For convenience, spaces are converted to underscores so that
 465          * eg user_text fields can be used directly.
 466          *
 467          * @param int $ns The namespace of the article
 468          * @param string $title The unprefixed database key form
 469          * @param string $fragment The link fragment (after the "#")
 470          * @param string $interwiki The interwiki prefix
 471          * @return Title The new object
 472          */
 473         public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
 474                 $t = new Title();
 475                 $t->mInterwiki = $interwiki;
 476                 $t->mFragment = $fragment;
 477                 $t->mNamespace = $ns = intval( $ns );
 478                 $t->mDbkeyform = str_replace( ' ', '_', $title );
 479                 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
 480                 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
 481                 $t->mTextform = str_replace( '_', ' ', $title );
 482                 $t->mContentModel = false; # initialized lazily in getContentModel()
 483                 return $t;
 484         }
 485
 486         /**
 487          * Create a new Title from a namespace index and a DB key.
 488          * The parameters will be checked for validity, which is a bit slower
 489          * than makeTitle() but safer for user-provided data.
 490          *
 491          * @param int $ns The namespace of the article
 492          * @param string $title Database key form
 493          * @param string $fragment The link fragment (after the "#")
 494          * @param string $interwiki Interwiki prefix
 495          * @return Title The new object, or null on an error
 496          */
 497         public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
 498                 if ( !MWNamespace::exists( $ns ) ) {
 499                         return null;
 500                 }
 501
 502                 $t = new Title();
 503                 $t->mDbkeyform = Title::makeName( $ns, $title, $fragment, $interwiki );
 504                 if ( $t->secureAndSplit() ) {
 505                         return $t;
 506                 } else {
 507                         return null;
 508                 }
 509         }
 510
 511         /**
 512          * Create a new Title for the Main Page
 513          *
 514          * @return Title The new object
 515          */
 516         public static function newMainPage() {
 517                 $title = Title::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
 518                 // Don't give fatal errors if the message is broken
 519                 if ( !$title ) {
 520                         $title = Title::newFromText( 'Main Page' );
 521                 }
 522                 return $title;
 523         }
 524
 525         /**
 526          * Extract a redirect destination from a string and return the
 527          * Title, or null if the text doesn't contain a valid redirect
 528          * This will only return the very next target, useful for
 529          * the redirect table and other checks that don't need full recursion
 530          *
 531          * @param string $text Text with possible redirect
 532          * @return Title The corresponding Title
 533          * @deprecated since 1.21, use Content::getRedirectTarget instead.
 534          */
 535         public static function newFromRedirect( $text ) {
 536                 ContentHandler::deprecated( __METHOD__, '1.21' );
 537
 538                 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
 539                 return $content->getRedirectTarget();
 540         }
 541
 542         /**
 543          * Extract a redirect destination from a string and return the
 544          * Title, or null if the text doesn't contain a valid redirect
 545          * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
 546          * in order to provide (hopefully) the Title of the final destination instead of another redirect
 547          *
 548          * @param string $text Text with possible redirect
 549          * @return Title
 550          * @deprecated since 1.21, use Content::getUltimateRedirectTarget instead.
 551          */
 552         public static function newFromRedirectRecurse( $text ) {
 553                 ContentHandler::deprecated( __METHOD__, '1.21' );
 554
 555                 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
 556                 return $content->getUltimateRedirectTarget();
 557         }
 558
 559         /**
 560          * Extract a redirect destination from a string and return an
 561          * array of Titles, or null if the text doesn't contain a valid redirect
 562          * The last element in the array is the final destination after all redirects
 563          * have been resolved (up to $wgMaxRedirects times)
 564          *
 565          * @param string $text Text with possible redirect
 566          * @return Title[] Array of Titles, with the destination last
 567          * @deprecated since 1.21, use Content::getRedirectChain instead.
 568          */
 569         public static function newFromRedirectArray( $text ) {
 570                 ContentHandler::deprecated( __METHOD__, '1.21' );
 571
 572                 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
 573                 return $content->getRedirectChain();
 574         }
 575
 576         /**
 577          * Get the prefixed DB key associated with an ID
 578          *
 579          * @param int $id The page_id of the article
 580          * @return Title|null An object representing the article, or null if no such article was found
 581          */
 582         public static function nameOf( $id ) {
 583                 $dbr = wfGetDB( DB_SLAVE );
 584
 585                 $s = $dbr->selectRow(
 586                         'page',
 587                         array( 'page_namespace', 'page_title' ),
 588                         array( 'page_id' => $id ),
 589                         __METHOD__
 590                 );
 591                 if ( $s === false ) {
 592                         return null;
 593                 }
 594
 595                 $n = self::makeName( $s->page_namespace, $s->page_title );
 596                 return $n;
 597         }
 598
 599         /**
 600          * Get a regex character class describing the legal characters in a link
 601          *
 602          * @return string The list of characters, not delimited
 603          */
 604         public static function legalChars() {
 605                 global $wgLegalTitleChars;
 606                 return $wgLegalTitleChars;
 607         }
 608
 609         /**
 610          * Returns a simple regex that will match on characters and sequences invalid in titles.
 611          * Note that this doesn't pick up many things that could be wrong with titles, but that
 612          * replacing this regex with something valid will make many titles valid.
 613          *
 614          * @todo move this into MediaWikiTitleCodec
 615          *
 616          * @return string Regex string
 617          */
 618         static function getTitleInvalidRegex() {
 619                 static $rxTc = false;
 620                 if ( !$rxTc ) {
 621                         # Matching titles will be held as illegal.
 622                         $rxTc = '/' .
 623                                 # Any character not allowed is forbidden...
 624                                 '[^' . self::legalChars() . ']' .
 625                                 # URL percent encoding sequences interfere with the ability
 626                                 # to round-trip titles -- you can't link to them consistently.
 627                                 '|%[0-9A-Fa-f]{2}' .
 628                                 # XML/HTML character references produce similar issues.
 629                                 '|&[A-Za-z0-9\x80-\xff]+;' .
 630                                 '|&#[0-9]+;' .
 631                                 '|&#x[0-9A-Fa-f]+;' .
 632                                 '/S';
 633                 }
 634
 635                 return $rxTc;
 636         }
 637
 638         /**
 639          * Utility method for converting a character sequence from bytes to Unicode.
 640          *
 641          * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
 642          * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
 643          *
 644          * @param string $byteClass
 645          * @return string
 646          */
 647         public static function convertByteClassToUnicodeClass( $byteClass ) {
 648                 $length = strlen( $byteClass );
 649                 // Input token queue
 650                 $x0 = $x1 = $x2 = '';
 651                 // Decoded queue
 652                 $d0 = $d1 = $d2 = '';
 653                 // Decoded integer codepoints
 654                 $ord0 = $ord1 = $ord2 = 0;
 655                 // Re-encoded queue
 656                 $r0 = $r1 = $r2 = '';
 657                 // Output
 658                 $out = '';
 659                 // Flags
 660                 $allowUnicode = false;
 661                 for ( $pos = 0; $pos < $length; $pos++ ) {
 662                         // Shift the queues down
 663                         $x2 = $x1;
 664                         $x1 = $x0;
 665                         $d2 = $d1;
 666                         $d1 = $d0;
 667                         $ord2 = $ord1;
 668                         $ord1 = $ord0;
 669                         $r2 = $r1;
 670                         $r1 = $r0;
 671                         // Load the current input token and decoded values
 672                         $inChar = $byteClass[$pos];
 673                         if ( $inChar == '\\' ) {
 674                                 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos + 1 ) ) {
 675                                         $x0 = $inChar . $m[0];
 676                                         $d0 = chr( hexdec( $m[1] ) );
 677                                         $pos += strlen( $m[0] );
 678                                 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos + 1 ) ) {
 679                                         $x0 = $inChar . $m[0];
 680                                         $d0 = chr( octdec( $m[0] ) );
 681                                         $pos += strlen( $m[0] );
 682                                 } elseif ( $pos + 1 >= $length ) {
 683                                         $x0 = $d0 = '\\';
 684                                 } else {
 685                                         $d0 = $byteClass[$pos + 1];
 686                                         $x0 = $inChar . $d0;
 687                                         $pos += 1;
 688                                 }
 689                         } else {
 690                                 $x0 = $d0 = $inChar;
 691                         }
 692                         $ord0 = ord( $d0 );
 693                         // Load the current re-encoded value
 694                         if ( $ord0 < 32 || $ord0 == 0x7f ) {
 695                                 $r0 = sprintf( '\x%02x', $ord0 );
 696                         } elseif ( $ord0 >= 0x80 ) {
 697                                 // Allow unicode if a single high-bit character appears
 698                                 $r0 = sprintf( '\x%02x', $ord0 );
 699                                 $allowUnicode = true;
 700                         } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
 701                                 $r0 = '\\' . $d0;
 702                         } else {
 703                                 $r0 = $d0;
 704                         }
 705                         // Do the output
 706                         if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
 707                                 // Range
 708                                 if ( $ord2 > $ord0 ) {
 709                                         // Empty range
 710                                 } elseif ( $ord0 >= 0x80 ) {
 711                                         // Unicode range
 712                                         $allowUnicode = true;
 713                                         if ( $ord2 < 0x80 ) {
 714                                                 // Keep the non-unicode section of the range
 715                                                 $out .= "$r2-\\x7F";
 716                                         }
 717                                 } else {
 718                                         // Normal range
 719                                         $out .= "$r2-$r0";
 720                                 }
 721                                 // Reset state to the initial value
 722                                 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
 723                         } elseif ( $ord2 < 0x80 ) {
 724                                 // ASCII character
 725                                 $out .= $r2;
 726                         }
 727                 }
 728                 if ( $ord1 < 0x80 ) {
 729                         $out .= $r1;
 730                 }
 731                 if ( $ord0 < 0x80 ) {
 732                         $out .= $r0;
 733                 }
 734                 if ( $allowUnicode ) {
 735                         $out .= '\u0080-\uFFFF';
 736                 }
 737                 return $out;
 738         }
 739
 740         /**
 741          * Make a prefixed DB key from a DB key and a namespace index
 742          *
 743          * @param int $ns Numerical representation of the namespace
 744          * @param string $title The DB key form the title
 745          * @param string $fragment The link fragment (after the "#")
 746          * @param string $interwiki The interwiki prefix
 747          * @return string The prefixed form of the title
 748          */
 749         public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
 750                 global $wgContLang;
 751
 752                 $namespace = $wgContLang->getNsText( $ns );
 753                 $name = $namespace == '' ? $title : "$namespace:$title";
 754                 if ( strval( $interwiki ) != '' ) {
 755                         $name = "$interwiki:$name";
 756                 }
 757                 if ( strval( $fragment ) != '' ) {
 758                         $name .= '#' . $fragment;
 759                 }
 760                 return $name;
 761         }
 762
 763         /**
 764          * Escape a text fragment, say from a link, for a URL
 765          *
 766          * @param string $fragment Containing a URL or link fragment (after the "#")
 767          * @return string Escaped string
 768          */
 769         static function escapeFragmentForURL( $fragment ) {
 770                 # Note that we don't urlencode the fragment.  urlencoded Unicode
 771                 # fragments appear not to work in IE (at least up to 7) or in at least
 772                 # one version of Opera 9.x.  The W3C validator, for one, doesn't seem
 773                 # to care if they aren't encoded.
 774                 return Sanitizer::escapeId( $fragment, 'noninitial' );
 775         }
 776
 777         /**
 778          * Callback for usort() to do title sorts by (namespace, title)
 779          *
 780          * @param Title $a
 781          * @param Title $b
 782          *
 783          * @return int Result of string comparison, or namespace comparison
 784          */
 785         public static function compare( $a, $b ) {
 786                 if ( $a->getNamespace() == $b->getNamespace() ) {
 787                         return strcmp( $a->getText(), $b->getText() );
 788                 } else {
 789                         return $a->getNamespace() - $b->getNamespace();
 790                 }
 791         }
 792
 793         /**
 794          * Determine whether the object refers to a page within
 795          * this project.
 796          *
 797          * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
 798          */
 799         public function isLocal() {
 800                 if ( $this->isExternal() ) {
 801                         $iw = Interwiki::fetch( $this->mInterwiki );
 802                         if ( $iw ) {
 803                                 return $iw->isLocal();
 804                         }
 805                 }
 806                 return true;
 807         }
 808
 809         /**
 810          * Is this Title interwiki?
 811          *
 812          * @return bool
 813          */
 814         public function isExternal() {
 815                 return $this->mInterwiki !== '';
 816         }
 817
 818         /**
 819          * Get the interwiki prefix
 820          *
 821          * Use Title::isExternal to check if a interwiki is set
 822          *
 823          * @return string Interwiki prefix
 824          */
 825         public function getInterwiki() {
 826                 return $this->mInterwiki;
 827         }
 828
 829         /**
 830          * Was this a local interwiki link?
 831          *
 832          * @return bool
 833          */
 834         public function wasLocalInterwiki() {
 835                 return $this->mLocalInterwiki;
 836         }
 837
 838         /**
 839          * Determine whether the object refers to a page within
 840          * this project and is transcludable.
 841          *
 842          * @return bool True if this is transcludable
 843          */
 844         public function isTrans() {
 845                 if ( !$this->isExternal() ) {
 846                         return false;
 847                 }
 848
 849                 return Interwiki::fetch( $this->mInterwiki )->isTranscludable();
 850         }
 851
 852         /**
 853          * Returns the DB name of the distant wiki which owns the object.
 854          *
 855          * @return string The DB name
 856          */
 857         public function getTransWikiID() {
 858                 if ( !$this->isExternal() ) {
 859                         return false;
 860                 }
 861
 862                 return Interwiki::fetch( $this->mInterwiki )->getWikiID();
 863         }
 864
 865         /**
 866          * Get a TitleValue object representing this Title.
 867          *
 868          * @note Not all valid Titles have a corresponding valid TitleValue
 869          * (e.g. TitleValues cannot represent page-local links that have a
 870          * fragment but no title text).
 871          *
 872          * @return TitleValue|null
 873          */
 874         public function getTitleValue() {
 875                 if ( $this->mTitleValue === null ) {
 876                         try {
 877                                 $this->mTitleValue = new TitleValue(
 878                                         $this->getNamespace(),
 879                                         $this->getDBkey(),
 880                                         $this->getFragment() );
 881                         } catch ( InvalidArgumentException $ex ) {
 882                                 wfDebug( __METHOD__ . ': Can\'t create a TitleValue for [[' .
 883                                         $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
 884                         }
 885                 }
 886
 887                 return $this->mTitleValue;
 888         }
 889
 890         /**
 891          * Get the text form (spaces not underscores) of the main part
 892          *
 893          * @return string Main part of the title
 894          */
 895         public function getText() {
 896                 return $this->mTextform;
 897         }
 898
 899         /**
 900          * Get the URL-encoded form of the main part
 901          *
 902          * @return string Main part of the title, URL-encoded
 903          */
 904         public function getPartialURL() {
 905                 return $this->mUrlform;
 906         }
 907
 908         /**
 909          * Get the main part with underscores
 910          *
 911          * @return string Main part of the title, with underscores
 912          */
 913         public function getDBkey() {
 914                 return $this->mDbkeyform;
 915         }
 916
 917         /**
 918          * Get the DB key with the initial letter case as specified by the user
 919          *
 920          * @return string DB key
 921          */
 922         function getUserCaseDBKey() {
 923                 if ( !is_null( $this->mUserCaseDBKey ) ) {
 924                         return $this->mUserCaseDBKey;
 925                 } else {
 926                         // If created via makeTitle(), $this->mUserCaseDBKey is not set.
 927                         return $this->mDbkeyform;
 928                 }
 929         }
 930
 931         /**
 932          * Get the namespace index, i.e. one of the NS_xxxx constants.
 933          *
 934          * @return int Namespace index
 935          */
 936         public function getNamespace() {
 937                 return $this->mNamespace;
 938         }
 939
 940         /**
 941          * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
 942          *
 943          * @throws MWException
 944          * @return string Content model id
 945          */
 946         public function getContentModel() {
 947                 if ( !$this->mContentModel ) {
 948                         $linkCache = LinkCache::singleton();
 949                         $this->mContentModel = $linkCache->getGoodLinkFieldObj( $this, 'model' );
 950                 }
 951
 952                 if ( !$this->mContentModel ) {
 953                         $this->mContentModel = ContentHandler::getDefaultModelFor( $this );
 954                 }
 955
 956                 if ( !$this->mContentModel ) {
 957                         throw new MWException( 'Failed to determine content model!' );
 958                 }
 959
 960                 return $this->mContentModel;
 961         }
 962
 963         /**
 964          * Convenience method for checking a title's content model name
 965          *
 966          * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
 967          * @return bool True if $this->getContentModel() == $id
 968          */
 969         public function hasContentModel( $id ) {
 970                 return $this->getContentModel() == $id;
 971         }
 972
 973         /**
 974          * Get the namespace text
 975          *
 976          * @return string Namespace text
 977          */
 978         public function getNsText() {
 979                 if ( $this->isExternal() ) {
 980                         // This probably shouldn't even happen. ohh man, oh yuck.
 981                         // But for interwiki transclusion it sometimes does.
 982                         // Shit. Shit shit shit.
 983                         //
 984                         // Use the canonical namespaces if possible to try to
 985                         // resolve a foreign namespace.
 986                         if ( MWNamespace::exists( $this->mNamespace ) ) {
 987                                 return MWNamespace::getCanonicalName( $this->mNamespace );
 988                         }
 989                 }
 990
 991                 try {
 992                         $formatter = self::getTitleFormatter();
 993                         return $formatter->getNamespaceName( $this->mNamespace, $this->mDbkeyform );
 994                 } catch ( InvalidArgumentException $ex ) {
 995                         wfDebug( __METHOD__ . ': ' . $ex->getMessage() . "\n" );
 996                         return false;
 997                 }
 998         }
 999
1000         /**
1001          * Get the namespace text of the subject (rather than talk) page
1002          *
1003          * @return string Namespace text
1004          */
1005         public function getSubjectNsText() {
1006                 global $wgContLang;
1007                 return $wgContLang->getNsText( MWNamespace::getSubject( $this->mNamespace ) );
1008         }
1009
1010         /**
1011          * Get the namespace text of the talk page
1012          *
1013          * @return string Namespace text
1014          */
1015         public function getTalkNsText() {
1016                 global $wgContLang;
1017                 return $wgContLang->getNsText( MWNamespace::getTalk( $this->mNamespace ) );
1018         }
1019
1020         /**
1021          * Could this title have a corresponding talk page?
1022          *
1023          * @return bool
1024          */
1025         public function canTalk() {
1026                 return MWNamespace::canTalk( $this->mNamespace );
1027         }
1028
1029         /**
1030          * Is this in a namespace that allows actual pages?
1031          *
1032          * @return bool
1033          * @internal note -- uses hardcoded namespace index instead of constants
1034          */
1035         public function canExist() {
1036                 return $this->mNamespace >= NS_MAIN;
1037         }
1038
1039         /**
1040          * Can this title be added to a user's watchlist?
1041          *
1042          * @return bool
1043          */
1044         public function isWatchable() {
1045                 return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() );
1046         }
1047
1048         /**
1049          * Returns true if this is a special page.
1050          *
1051          * @return bool
1052          */
1053         public function isSpecialPage() {
1054                 return $this->getNamespace() == NS_SPECIAL;
1055         }
1056
1057         /**
1058          * Returns true if this title resolves to the named special page
1059          *
1060          * @param string $name The special page name
1061          * @return bool
1062          */
1063         public function isSpecial( $name ) {
1064                 if ( $this->isSpecialPage() ) {
1065                         list( $thisName, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $this->getDBkey() );
1066                         if ( $name == $thisName ) {
1067                                 return true;
1068                         }
1069                 }
1070                 return false;
1071         }
1072
1073         /**
1074          * If the Title refers to a special page alias which is not the local default, resolve
1075          * the alias, and localise the name as necessary.  Otherwise, return $this
1076          *
1077          * @return Title
1078          */
1079         public function fixSpecialName() {
1080                 if ( $this->isSpecialPage() ) {
1081                         list( $canonicalName, $par ) = SpecialPageFactory::resolveAlias( $this->mDbkeyform );
1082                         if ( $canonicalName ) {
1083                                 $localName = SpecialPageFactory::getLocalNameFor( $canonicalName, $par );
1084                                 if ( $localName != $this->mDbkeyform ) {
1085                                         return Title::makeTitle( NS_SPECIAL, $localName );
1086                                 }
1087                         }
1088                 }
1089                 return $this;
1090         }
1091
1092         /**
1093          * Returns true if the title is inside the specified namespace.
1094          *
1095          * Please make use of this instead of comparing to getNamespace()
1096          * This function is much more resistant to changes we may make
1097          * to namespaces than code that makes direct comparisons.
1098          * @param int $ns The namespace
1099          * @return bool
1100          * @since 1.19
1101          */
1102         public function inNamespace( $ns ) {
1103                 return MWNamespace::equals( $this->getNamespace(), $ns );
1104         }
1105
1106         /**
1107          * Returns true if the title is inside one of the specified namespaces.
1108          *
1109          * @param int $namespaces,... The namespaces to check for
1110          * @return bool
1111          * @since 1.19
1112          */
1113         public function inNamespaces( /* ... */ ) {
1114                 $namespaces = func_get_args();
1115                 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1116                         $namespaces = $namespaces[0];
1117                 }
1118
1119                 foreach ( $namespaces as $ns ) {
1120                         if ( $this->inNamespace( $ns ) ) {
1121                                 return true;
1122                         }
1123                 }
1124
1125                 return false;
1126         }
1127
1128         /**
1129          * Returns true if the title has the same subject namespace as the
1130          * namespace specified.
1131          * For example this method will take NS_USER and return true if namespace
1132          * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1133          * as their subject namespace.
1134          *
1135          * This is MUCH simpler than individually testing for equivalence
1136          * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1137          * @since 1.19
1138          * @param int $ns
1139          * @return bool
1140          */
1141         public function hasSubjectNamespace( $ns ) {
1142                 return MWNamespace::subjectEquals( $this->getNamespace(), $ns );
1143         }
1144
1145         /**
1146          * Is this Title in a namespace which contains content?
1147          * In other words, is this a content page, for the purposes of calculating
1148          * statistics, etc?
1149          *
1150          * @return bool
1151          */
1152         public function isContentPage() {
1153                 return MWNamespace::isContent( $this->getNamespace() );
1154         }
1155
1156         /**
1157          * Would anybody with sufficient privileges be able to move this page?
1158          * Some pages just aren't movable.
1159          *
1160          * @return bool
1161          */
1162         public function isMovable() {
1163                 if ( !MWNamespace::isMovable( $this->getNamespace() ) || $this->isExternal() ) {
1164                         // Interwiki title or immovable namespace. Hooks don't get to override here
1165                         return false;
1166                 }
1167
1168                 $result = true;
1169                 wfRunHooks( 'TitleIsMovable', array( $this, &$result ) );
1170                 return $result;
1171         }
1172
1173         /**
1174          * Is this the mainpage?
1175          * @note Title::newFromText seems to be sufficiently optimized by the title
1176          * cache that we don't need to over-optimize by doing direct comparisons and
1177          * accidentally creating new bugs where $title->equals( Title::newFromText() )
1178          * ends up reporting something differently than $title->isMainPage();
1179          *
1180          * @since 1.18
1181          * @return bool
1182          */
1183         public function isMainPage() {
1184                 return $this->equals( Title::newMainPage() );
1185         }
1186
1187         /**
1188          * Is this a subpage?
1189          *
1190          * @return bool
1191          */
1192         public function isSubpage() {
1193                 return MWNamespace::hasSubpages( $this->mNamespace )
1194                         ? strpos( $this->getText(), '/' ) !== false
1195                         : false;
1196         }
1197
1198         /**
1199          * Is this a conversion table for the LanguageConverter?
1200          *
1201          * @return bool
1202          */
1203         public function isConversionTable() {
1204                 // @todo ConversionTable should become a separate content model.
1205
1206                 return $this->getNamespace() == NS_MEDIAWIKI &&
1207                         strpos( $this->getText(), 'Conversiontable/' ) === 0;
1208         }
1209
1210         /**
1211          * Does that page contain wikitext, or it is JS, CSS or whatever?
1212          *
1213          * @return bool
1214          */
1215         public function isWikitextPage() {
1216                 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT );
1217         }
1218
1219         /**
1220          * Could this page contain custom CSS or JavaScript for the global UI.
1221          * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
1222          * or CONTENT_MODEL_JAVASCRIPT.
1223          *
1224          * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage()
1225          * for that!
1226          *
1227          * Note that this method should not return true for pages that contain and
1228          * show "inactive" CSS or JS.
1229          *
1230          * @return bool
1231          */
1232         public function isCssOrJsPage() {
1233                 $isCssOrJsPage = NS_MEDIAWIKI == $this->mNamespace
1234                         && ( $this->hasContentModel( CONTENT_MODEL_CSS )
1235                                 || $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) );
1236
1237                 # @note This hook is also called in ContentHandler::getDefaultModel.
1238                 #   It's called here again to make sure hook functions can force this
1239                 #   method to return true even outside the mediawiki namespace.
1240
1241                 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$isCssOrJsPage ) );
1242
1243                 return $isCssOrJsPage;
1244         }
1245
1246         /**
1247          * Is this a .css or .js subpage of a user page?
1248          * @return bool
1249          */
1250         public function isCssJsSubpage() {
1251                 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1252                                 && ( $this->hasContentModel( CONTENT_MODEL_CSS )
1253                                         || $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) ) );
1254         }
1255
1256         /**
1257          * Trim down a .css or .js subpage title to get the corresponding skin name
1258          *
1259          * @return string Containing skin name from .css or .js subpage title
1260          */
1261         public function getSkinFromCssJsSubpage() {
1262                 $subpage = explode( '/', $this->mTextform );
1263                 $subpage = $subpage[count( $subpage ) - 1];
1264                 $lastdot = strrpos( $subpage, '.' );
1265                 if ( $lastdot === false ) {
1266                         return $subpage; # Never happens: only called for names ending in '.css' or '.js'
1267                 }
1268                 return substr( $subpage, 0, $lastdot );
1269         }
1270
1271         /**
1272          * Is this a .css subpage of a user page?
1273          *
1274          * @return bool
1275          */
1276         public function isCssSubpage() {
1277                 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1278                         && $this->hasContentModel( CONTENT_MODEL_CSS ) );
1279         }
1280
1281         /**
1282          * Is this a .js subpage of a user page?
1283          *
1284          * @return bool
1285          */
1286         public function isJsSubpage() {
1287                 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1288                         && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) );
1289         }
1290
1291         /**
1292          * Is this a talk page of some sort?
1293          *
1294          * @return bool
1295          */
1296         public function isTalkPage() {
1297                 return MWNamespace::isTalk( $this->getNamespace() );
1298         }
1299
1300         /**
1301          * Get a Title object associated with the talk page of this article
1302          *
1303          * @return Title The object for the talk page
1304          */
1305         public function getTalkPage() {
1306                 return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1307         }
1308
1309         /**
1310          * Get a title object associated with the subject page of this
1311          * talk page
1312          *
1313          * @return Title The object for the subject page
1314          */
1315         public function getSubjectPage() {
1316                 // Is this the same title?
1317                 $subjectNS = MWNamespace::getSubject( $this->getNamespace() );
1318                 if ( $this->getNamespace() == $subjectNS ) {
1319                         return $this;
1320                 }
1321                 return Title::makeTitle( $subjectNS, $this->getDBkey() );
1322         }
1323
1324         /**
1325          * Get the default namespace index, for when there is no namespace
1326          *
1327          * @return int Default namespace index
1328          */
1329         public function getDefaultNamespace() {
1330                 return $this->mDefaultNamespace;
1331         }
1332
1333         /**
1334          * Get the Title fragment (i.e.\ the bit after the #) in text form
1335          *
1336          * Use Title::hasFragment to check for a fragment
1337          *
1338          * @return string Title fragment
1339          */
1340         public function getFragment() {
1341                 return $this->mFragment;
1342         }
1343
1344         /**
1345          * Check if a Title fragment is set
1346          *
1347          * @return bool
1348          * @since 1.23
1349          */
1350         public function hasFragment() {
1351                 return $this->mFragment !== '';
1352         }
1353
1354         /**
1355          * Get the fragment in URL form, including the "#" character if there is one
1356          * @return string Fragment in URL form
1357          */
1358         public function getFragmentForURL() {
1359                 if ( !$this->hasFragment() ) {
1360                         return '';
1361                 } else {
1362                         return '#' . Title::escapeFragmentForURL( $this->getFragment() );
1363                 }
1364         }
1365
1366         /**
1367          * Set the fragment for this title. Removes the first character from the
1368          * specified fragment before setting, so it assumes you're passing it with
1369          * an initial "#".
1370          *
1371          * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1372          * Still in active use privately.
1373          *
1374          * @param string $fragment Text
1375          */
1376         public function setFragment( $fragment ) {
1377                 $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
1378         }
1379
1380         /**
1381          * Prefix some arbitrary text with the namespace or interwiki prefix
1382          * of this object
1383          *
1384          * @param string $name The text
1385          * @return string The prefixed text
1386          */
1387         private function prefix( $name ) {
1388                 $p = '';
1389                 if ( $this->isExternal() ) {
1390                         $p = $this->mInterwiki . ':';
1391                 }
1392
1393                 if ( 0 != $this->mNamespace ) {
1394                         $p .= $this->getNsText() . ':';
1395                 }
1396                 return $p . $name;
1397         }
1398
1399         /**
1400          * Get the prefixed database key form
1401          *
1402          * @return string The prefixed title, with underscores and
1403          *  any interwiki and namespace prefixes
1404          */
1405         public function getPrefixedDBkey() {
1406                 $s = $this->prefix( $this->mDbkeyform );
1407                 $s = str_replace( ' ', '_', $s );
1408                 return $s;
1409         }
1410
1411         /**
1412          * Get the prefixed title with spaces.
1413          * This is the form usually used for display
1414          *
1415          * @return string The prefixed title, with spaces
1416          */
1417         public function getPrefixedText() {
1418                 if ( $this->mPrefixedText === null ) {
1419                         $s = $this->prefix( $this->mTextform );
1420                         $s = str_replace( '_', ' ', $s );
1421                         $this->mPrefixedText = $s;
1422                 }
1423                 return $this->mPrefixedText;
1424         }
1425
1426         /**
1427          * Return a string representation of this title
1428          *
1429          * @return string Representation of this title
1430          */
1431         public function __toString() {
1432                 return $this->getPrefixedText();
1433         }
1434
1435         /**
1436          * Get the prefixed title with spaces, plus any fragment
1437          * (part beginning with '#')
1438          *
1439          * @return string The prefixed title, with spaces and the fragment, including '#'
1440          */
1441         public function getFullText() {
1442                 $text = $this->getPrefixedText();
1443                 if ( $this->hasFragment() ) {
1444                         $text .= '#' . $this->getFragment();
1445                 }
1446                 return $text;
1447         }
1448
1449         /**
1450          * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1451          *
1452          * @par Example:
1453          * @code
1454          * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1455          * # returns: 'Foo'
1456          * @endcode
1457          *
1458          * @return string Root name
1459          * @since 1.20
1460          */
1461         public function getRootText() {
1462                 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1463                         return $this->getText();
1464                 }
1465
1466                 return strtok( $this->getText(), '/' );
1467         }
1468
1469         /**
1470          * Get the root page name title, i.e. the leftmost part before any slashes
1471          *
1472          * @par Example:
1473          * @code
1474          * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1475          * # returns: Title{User:Foo}
1476          * @endcode
1477          *
1478          * @return Title Root title
1479          * @since 1.20
1480          */
1481         public function getRootTitle() {
1482                 return Title::makeTitle( $this->getNamespace(), $this->getRootText() );
1483         }
1484
1485         /**
1486          * Get the base page name without a namespace, i.e. the part before the subpage name
1487          *
1488          * @par Example:
1489          * @code
1490          * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1491          * # returns: 'Foo/Bar'
1492          * @endcode
1493          *
1494          * @return string Base name
1495          */
1496         public function getBaseText() {
1497                 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1498                         return $this->getText();
1499                 }
1500
1501                 $parts = explode( '/', $this->getText() );
1502                 # Don't discard the real title if there's no subpage involved
1503                 if ( count( $parts ) > 1 ) {
1504                         unset( $parts[count( $parts ) - 1] );
1505                 }
1506                 return implode( '/', $parts );
1507         }
1508
1509         /**
1510          * Get the base page name title, i.e. the part before the subpage name
1511          *
1512          * @par Example:
1513          * @code
1514          * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1515          * # returns: Title{User:Foo/Bar}
1516          * @endcode
1517          *
1518          * @return Title Base title
1519          * @since 1.20
1520          */
1521         public function getBaseTitle() {
1522                 return Title::makeTitle( $this->getNamespace(), $this->getBaseText() );
1523         }
1524
1525         /**
1526          * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1527          *
1528          * @par Example:
1529          * @code
1530          * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1531          * # returns: "Baz"
1532          * @endcode
1533          *
1534          * @return string Subpage name
1535          */
1536         public function getSubpageText() {
1537                 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1538                         return $this->mTextform;
1539                 }
1540                 $parts = explode( '/', $this->mTextform );
1541                 return $parts[count( $parts ) - 1];
1542         }
1543
1544         /**
1545          * Get the title for a subpage of the current page
1546          *
1547          * @par Example:
1548          * @code
1549          * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1550          * # returns: Title{User:Foo/Bar/Baz/Asdf}
1551          * @endcode
1552          *
1553          * @param string $text The subpage name to add to the title
1554          * @return Title Subpage title
1555          * @since 1.20
1556          */
1557         public function getSubpage( $text ) {
1558                 return Title::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1559         }
1560
1561         /**
1562          * Get a URL-encoded form of the subpage text
1563          *
1564          * @return string URL-encoded subpage name
1565          */
1566         public function getSubpageUrlForm() {
1567                 $text = $this->getSubpageText();
1568                 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1569                 return $text;
1570         }
1571
1572         /**
1573          * Get a URL-encoded title (not an actual URL) including interwiki
1574          *
1575          * @return string The URL-encoded form
1576          */
1577         public function getPrefixedURL() {
1578                 $s = $this->prefix( $this->mDbkeyform );
1579                 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1580                 return $s;
1581         }
1582
1583         /**
1584          * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1585          * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1586          * second argument named variant. This was deprecated in favor
1587          * of passing an array of option with a "variant" key
1588          * Once $query2 is removed for good, this helper can be dropped
1589          * and the wfArrayToCgi moved to getLocalURL();
1590          *
1591          * @since 1.19 (r105919)
1592          * @param array|string $query
1593          * @param bool $query2
1594          * @return string
1595          */
1596         private static function fixUrlQueryArgs( $query, $query2 = false ) {
1597                 if ( $query2 !== false ) {
1598                         wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1599                                 "method called with a second parameter is deprecated. Add your " .
1600                                 "parameter to an array passed as the first parameter.", "1.19" );
1601                 }
1602                 if ( is_array( $query ) ) {
1603                         $query = wfArrayToCgi( $query );
1604                 }
1605                 if ( $query2 ) {
1606                         if ( is_string( $query2 ) ) {
1607                                 // $query2 is a string, we will consider this to be
1608                                 // a deprecated $variant argument and add it to the query
1609                                 $query2 = wfArrayToCgi( array( 'variant' => $query2 ) );
1610                         } else {
1611                                 $query2 = wfArrayToCgi( $query2 );
1612                         }
1613                         // If we have $query content add a & to it first
1614                         if ( $query ) {
1615                                 $query .= '&';
1616                         }
1617                         // Now append the queries together
1618                         $query .= $query2;
1619                 }
1620                 return $query;
1621         }
1622
1623         /**
1624          * Get a real URL referring to this title, with interwiki link and
1625          * fragment
1626          *
1627          * @see self::getLocalURL for the arguments.
1628          * @see wfExpandUrl
1629          * @param array|string $query
1630          * @param bool $query2
1631          * @param string $proto Protocol type to use in URL
1632          * @return string The URL
1633          */
1634         public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1635                 $query = self::fixUrlQueryArgs( $query, $query2 );
1636
1637                 # Hand off all the decisions on urls to getLocalURL
1638                 $url = $this->getLocalURL( $query );
1639
1640                 # Expand the url to make it a full url. Note that getLocalURL has the
1641                 # potential to output full urls for a variety of reasons, so we use
1642                 # wfExpandUrl instead of simply prepending $wgServer
1643                 $url = wfExpandUrl( $url, $proto );
1644
1645                 # Finally, add the fragment.
1646                 $url .= $this->getFragmentForURL();
1647
1648                 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
1649                 return $url;
1650         }
1651
1652         /**
1653          * Get a URL with no fragment or server name (relative URL) from a Title object.
1654          * If this page is generated with action=render, however,
1655          * $wgServer is prepended to make an absolute URL.
1656          *
1657          * @see self::getFullURL to always get an absolute URL.
1658          * @see self::newFromText to produce a Title object.
1659          *
1660          * @param string|array $query An optional query string,
1661          *   not used for interwiki links. Can be specified as an associative array as well,
1662          *   e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1663          *   Some query patterns will trigger various shorturl path replacements.
1664          * @param array $query2 An optional secondary query array. This one MUST
1665          *   be an array. If a string is passed it will be interpreted as a deprecated
1666          *   variant argument and urlencoded into a variant= argument.
1667          *   This second query argument will be added to the $query
1668          *   The second parameter is deprecated since 1.19. Pass it as a key,value
1669          *   pair in the first parameter array instead.
1670          *
1671          * @return string String of the URL.
1672          */
1673         public function getLocalURL( $query = '', $query2 = false ) {
1674                 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1675
1676                 $query = self::fixUrlQueryArgs( $query, $query2 );
1677
1678                 $interwiki = Interwiki::fetch( $this->mInterwiki );
1679                 if ( $interwiki ) {
1680                         $namespace = $this->getNsText();
1681                         if ( $namespace != '' ) {
1682                                 # Can this actually happen? Interwikis shouldn't be parsed.
1683                                 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1684                                 $namespace .= ':';
1685                         }
1686                         $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1687                         $url = wfAppendQuery( $url, $query );
1688                 } else {
1689                         $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1690                         if ( $query == '' ) {
1691                                 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1692                                 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1693                         } else {
1694                                 global $wgVariantArticlePath, $wgActionPaths, $wgContLang;
1695                                 $url = false;
1696                                 $matches = array();
1697
1698                                 if ( !empty( $wgActionPaths )
1699                                         && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1700                                 ) {
1701                                         $action = urldecode( $matches[2] );
1702                                         if ( isset( $wgActionPaths[$action] ) ) {
1703                                                 $query = $matches[1];
1704                                                 if ( isset( $matches[4] ) ) {
1705                                                         $query .= $matches[4];
1706                                                 }
1707                                                 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1708                                                 if ( $query != '' ) {
1709                                                         $url = wfAppendQuery( $url, $query );
1710                                                 }
1711                                         }
1712                                 }
1713
1714                                 if ( $url === false
1715                                         && $wgVariantArticlePath
1716                                         && $wgContLang->getCode() === $this->getPageLanguage()->getCode()
1717                                         && $this->getPageLanguage()->hasVariants()
1718                                         && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1719                                 ) {
1720                                         $variant = urldecode( $matches[1] );
1721                                         if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1722                                                 // Only do the variant replacement if the given variant is a valid
1723                                                 // variant for the page's language.
1724                                                 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1725                                                 $url = str_replace( '$1', $dbkey, $url );
1726                                         }
1727                                 }
1728
1729                                 if ( $url === false ) {
1730                                         if ( $query == '-' ) {
1731                                                 $query = '';
1732                                         }
1733                                         $url = "{$wgScript}?title={$dbkey}&{$query}";
1734                                 }
1735                         }
1736
1737                         wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1738
1739                         // @todo FIXME: This causes breakage in various places when we
1740                         // actually expected a local URL and end up with dupe prefixes.
1741                         if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1742                                 $url = $wgServer . $url;
1743                         }
1744                 }
1745                 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1746                 return $url;
1747         }
1748
1749         /**
1750          * Get a URL that's the simplest URL that will be valid to link, locally,
1751          * to the current Title.  It includes the fragment, but does not include
1752          * the server unless action=render is used (or the link is external).  If
1753          * there's a fragment but the prefixed text is empty, we just return a link
1754          * to the fragment.
1755          *
1756          * The result obviously should not be URL-escaped, but does need to be
1757          * HTML-escaped if it's being output in HTML.
1758          *
1759          * @param array $query
1760          * @param bool $query2
1761          * @param string $proto Protocol to use; setting this will cause a full URL to be used
1762          * @see self::getLocalURL for the arguments.
1763          * @return string The URL
1764          */
1765         public function getLinkURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1766                 wfProfileIn( __METHOD__ );
1767                 if ( $this->isExternal() || $proto !== PROTO_RELATIVE ) {
1768                         $ret = $this->getFullURL( $query, $query2, $proto );
1769                 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
1770                         $ret = $this->getFragmentForURL();
1771                 } else {
1772                         $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1773                 }
1774                 wfProfileOut( __METHOD__ );
1775                 return $ret;
1776         }
1777
1778         /**
1779          * Get the URL form for an internal link.
1780          * - Used in various Squid-related code, in case we have a different
1781          * internal hostname for the server from the exposed one.
1782          *
1783          * This uses $wgInternalServer to qualify the path, or $wgServer
1784          * if $wgInternalServer is not set. If the server variable used is
1785          * protocol-relative, the URL will be expanded to http://
1786          *
1787          * @see self::getLocalURL for the arguments.
1788          * @return string The URL
1789          */
1790         public function getInternalURL( $query = '', $query2 = false ) {
1791                 global $wgInternalServer, $wgServer;
1792                 $query = self::fixUrlQueryArgs( $query, $query2 );
1793                 $server = $wgInternalServer !== false ? $wgInternalServer : $wgServer;
1794                 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP );
1795                 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1796                 return $url;
1797         }
1798
1799         /**
1800          * Get the URL for a canonical link, for use in things like IRC and
1801          * e-mail notifications. Uses $wgCanonicalServer and the
1802          * GetCanonicalURL hook.
1803          *
1804          * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1805          *
1806          * @see self::getLocalURL for the arguments.
1807          * @return string The URL
1808          * @since 1.18
1809          */
1810         public function getCanonicalURL( $query = '', $query2 = false ) {
1811                 $query = self::fixUrlQueryArgs( $query, $query2 );
1812                 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL );
1813                 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1814                 return $url;
1815         }
1816
1817         /**
1818          * Get the edit URL for this Title
1819          *
1820          * @return string The URL, or a null string if this is an interwiki link
1821          */
1822         public function getEditURL() {
1823                 if ( $this->isExternal() ) {
1824                         return '';
1825                 }
1826                 $s = $this->getLocalURL( 'action=edit' );
1827
1828                 return $s;
1829         }
1830
1831         /**
1832          * Is $wgUser watching this page?
1833          *
1834          * @deprecated since 1.20; use User::isWatched() instead.
1835          * @return bool
1836          */
1837         public function userIsWatching() {
1838                 global $wgUser;
1839
1840                 if ( is_null( $this->mWatched ) ) {
1841                         if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn() ) {
1842                                 $this->mWatched = false;
1843                         } else {
1844                                 $this->mWatched = $wgUser->isWatched( $this );
1845                         }
1846                 }
1847                 return $this->mWatched;
1848         }
1849
1850         /**
1851          * Can $user perform $action on this page?
1852          * This skips potentially expensive cascading permission checks
1853          * as well as avoids expensive error formatting
1854          *
1855          * Suitable for use for nonessential UI controls in common cases, but
1856          * _not_ for functional access control.
1857          *
1858          * May provide false positives, but should never provide a false negative.
1859          *
1860          * @param string $action Action that permission needs to be checked for
1861          * @param User $user User to check (since 1.19); $wgUser will be used if not provided.
1862          * @return bool
1863          */
1864         public function quickUserCan( $action, $user = null ) {
1865                 return $this->userCan( $action, $user, false );
1866         }
1867
1868         /**
1869          * Can $user perform $action on this page?
1870          *
1871          * @param string $action Action that permission needs to be checked for
1872          * @param User $user User to check (since 1.19); $wgUser will be used if not
1873          *   provided.
1874          * @param bool $doExpensiveQueries Set this to false to avoid doing
1875          *   unnecessary queries.
1876          * @return bool
1877          */
1878         public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1879                 if ( !$user instanceof User ) {
1880                         global $wgUser;
1881                         $user = $wgUser;
1882                 }
1883
1884                 return !count( $this->getUserPermissionsErrorsInternal(
1885                         $action, $user, $doExpensiveQueries, true ) );
1886         }
1887
1888         /**
1889          * Can $user perform $action on this page?
1890          *
1891          * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1892          *
1893          * @param string $action Action that permission needs to be checked for
1894          * @param User $user User to check
1895          * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary
1896          *   queries by skipping checks for cascading protections and user blocks.
1897          * @param array $ignoreErrors Array of Strings Set this to a list of message keys
1898          *   whose corresponding errors may be ignored.
1899          * @return array Array of arguments to wfMessage to explain permissions problems.
1900          */
1901         public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true,
1902                 $ignoreErrors = array()
1903         ) {
1904                 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1905
1906                 // Remove the errors being ignored.
1907                 foreach ( $errors as $index => $error ) {
1908                         $error_key = is_array( $error ) ? $error[0] : $error;
1909
1910                         if ( in_array( $error_key, $ignoreErrors ) ) {
1911                                 unset( $errors[$index] );
1912                         }
1913                 }
1914
1915                 return $errors;
1916         }
1917
1918         /**
1919          * Permissions checks that fail most often, and which are easiest to test.
1920          *
1921          * @param string $action The action to check
1922          * @param User $user User to check
1923          * @param array $errors List of current errors
1924          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
1925          * @param bool $short Short circuit on first error
1926          *
1927          * @return array List of errors
1928          */
1929         private function checkQuickPermissions( $action, $user, $errors,
1930                 $doExpensiveQueries, $short
1931         ) {
1932                 if ( !wfRunHooks( 'TitleQuickPermissions',
1933                         array( $this, $user, $action, &$errors, $doExpensiveQueries, $short ) )
1934                 ) {
1935                         return $errors;
1936                 }
1937
1938                 if ( $action == 'create' ) {
1939                         if (
1940                                 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1941                                 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
1942                         ) {
1943                                 $errors[] = $user->isAnon() ? array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1944                         }
1945                 } elseif ( $action == 'move' ) {
1946                         if ( !$user->isAllowed( 'move-rootuserpages' )
1947                                         && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1948                                 // Show user page-specific message only if the user can move other pages
1949                                 $errors[] = array( 'cant-move-user-page' );
1950                         }
1951
1952                         // Check if user is allowed to move files if it's a file
1953                         if ( $this->mNamespace == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
1954                                 $errors[] = array( 'movenotallowedfile' );
1955                         }
1956
1957                         // Check if user is allowed to move category pages if it's a category page
1958                         if ( $this->mNamespace == NS_CATEGORY && !$user->isAllowed( 'move-categorypages' ) ) {
1959                                 $errors[] = array( 'cant-move-category-page' );
1960                         }
1961
1962                         if ( !$user->isAllowed( 'move' ) ) {
1963                                 // User can't move anything
1964                                 $userCanMove = User::groupHasPermission( 'user', 'move' );
1965                                 $autoconfirmedCanMove = User::groupHasPermission( 'autoconfirmed', 'move' );
1966                                 if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) {
1967                                         // custom message if logged-in users without any special rights can move
1968                                         $errors[] = array( 'movenologintext' );
1969                                 } else {
1970                                         $errors[] = array( 'movenotallowed' );
1971                                 }
1972                         }
1973                 } elseif ( $action == 'move-target' ) {
1974                         if ( !$user->isAllowed( 'move' ) ) {
1975                                 // User can't move anything
1976                                 $errors[] = array( 'movenotallowed' );
1977                         } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1978                                         && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1979                                 // Show user page-specific message only if the user can move other pages
1980                                 $errors[] = array( 'cant-move-to-user-page' );
1981                         } elseif ( !$user->isAllowed( 'move-categorypages' )
1982                                         && $this->mNamespace == NS_CATEGORY ) {
1983                                 // Show category page-specific message only if the user can move other pages
1984                                 $errors[] = array( 'cant-move-to-category-page' );
1985                         }
1986                 } elseif ( !$user->isAllowed( $action ) ) {
1987                         $errors[] = $this->missingPermissionError( $action, $short );
1988                 }
1989
1990                 return $errors;
1991         }
1992
1993         /**
1994          * Add the resulting error code to the errors array
1995          *
1996          * @param array $errors List of current errors
1997          * @param array $result Result of errors
1998          *
1999          * @return array List of errors
2000          */
2001         private function resultToError( $errors, $result ) {
2002                 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2003                         // A single array representing an error
2004                         $errors[] = $result;
2005                 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2006                         // A nested array representing multiple errors
2007                         $errors = array_merge( $errors, $result );
2008                 } elseif ( $result !== '' && is_string( $result ) ) {
2009                         // A string representing a message-id
2010                         $errors[] = array( $result );
2011                 } elseif ( $result === false ) {
2012                         // a generic "We don't want them to do that"
2013                         $errors[] = array( 'badaccess-group0' );
2014                 }
2015                 return $errors;
2016         }
2017
2018         /**
2019          * Check various permission hooks
2020          *
2021          * @param string $action The action to check
2022          * @param User $user User to check
2023          * @param array $errors List of current errors
2024          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2025          * @param bool $short Short circuit on first error
2026          *
2027          * @return array List of errors
2028          */
2029         private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
2030                 // Use getUserPermissionsErrors instead
2031                 $result = '';
2032                 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
2033                         return $result ? array() : array( array( 'badaccess-group0' ) );
2034                 }
2035                 // Check getUserPermissionsErrors hook
2036                 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
2037                         $errors = $this->resultToError( $errors, $result );
2038                 }
2039                 // Check getUserPermissionsErrorsExpensive hook
2040                 if (
2041                         $doExpensiveQueries
2042                         && !( $short && count( $errors ) > 0 )
2043                         && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) )
2044                 ) {
2045                         $errors = $this->resultToError( $errors, $result );
2046                 }
2047
2048                 return $errors;
2049         }
2050
2051         /**
2052          * Check permissions on special pages & namespaces
2053          *
2054          * @param string $action The action to check
2055          * @param User $user User to check
2056          * @param array $errors List of current errors
2057          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2058          * @param bool $short Short circuit on first error
2059          *
2060          * @return array List of errors
2061          */
2062         private function checkSpecialsAndNSPermissions( $action, $user, $errors,
2063                 $doExpensiveQueries, $short
2064         ) {
2065                 # Only 'createaccount' can be performed on special pages,
2066                 # which don't actually exist in the DB.
2067                 if ( NS_SPECIAL == $this->mNamespace && $action !== 'createaccount' ) {
2068                         $errors[] = array( 'ns-specialprotected' );
2069                 }
2070
2071                 # Check $wgNamespaceProtection for restricted namespaces
2072                 if ( $this->isNamespaceProtected( $user ) ) {
2073                         $ns = $this->mNamespace == NS_MAIN ?
2074                                 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2075                         $errors[] = $this->mNamespace == NS_MEDIAWIKI ?
2076                                 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
2077                 }
2078
2079                 return $errors;
2080         }
2081
2082         /**
2083          * Check CSS/JS sub-page permissions
2084          *
2085          * @param string $action The action to check
2086          * @param User $user User to check
2087          * @param array $errors List of current errors
2088          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2089          * @param bool $short Short circuit on first error
2090          *
2091          * @return array List of errors
2092          */
2093         private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2094                 # Protect css/js subpages of user pages
2095                 # XXX: this might be better using restrictions
2096                 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
2097                 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' ) ) {
2098                         if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform ) ) {
2099                                 if ( $this->isCssSubpage() && !$user->isAllowedAny( 'editmyusercss', 'editusercss' ) ) {
2100                                         $errors[] = array( 'mycustomcssprotected' );
2101                                 } elseif ( $this->isJsSubpage() && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' ) ) {
2102                                         $errors[] = array( 'mycustomjsprotected' );
2103                                 }
2104                         } else {
2105                                 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
2106                                         $errors[] = array( 'customcssprotected' );
2107                                 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
2108                                         $errors[] = array( 'customjsprotected' );
2109                                 }
2110                         }
2111                 }
2112
2113                 return $errors;
2114         }
2115
2116         /**
2117          * Check against page_restrictions table requirements on this
2118          * page. The user must possess all required rights for this
2119          * action.
2120          *
2121          * @param string $action The action to check
2122          * @param User $user User to check
2123          * @param array $errors List of current errors
2124          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2125          * @param bool $short Short circuit on first error
2126          *
2127          * @return array List of errors
2128          */
2129         private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2130                 foreach ( $this->getRestrictions( $action ) as $right ) {
2131                         // Backwards compatibility, rewrite sysop -> editprotected
2132                         if ( $right == 'sysop' ) {
2133                                 $right = 'editprotected';
2134                         }
2135                         // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2136                         if ( $right == 'autoconfirmed' ) {
2137                                 $right = 'editsemiprotected';
2138                         }
2139                         if ( $right == '' ) {
2140                                 continue;
2141                         }
2142                         if ( !$user->isAllowed( $right ) ) {
2143                                 $errors[] = array( 'protectedpagetext', $right );
2144                         } elseif ( $this->mCascadeRestriction && !$user->isAllowed( 'protect' ) ) {
2145                                 $errors[] = array( 'protectedpagetext', 'protect' );
2146                         }
2147                 }
2148
2149                 return $errors;
2150         }
2151
2152         /**
2153          * Check restrictions on cascading pages.
2154          *
2155          * @param string $action The action to check
2156          * @param User $user User to check
2157          * @param array $errors List of current errors
2158          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2159          * @param bool $short Short circuit on first error
2160          *
2161          * @return array List of errors
2162          */
2163         private function checkCascadingSourcesRestrictions( $action, $user, $errors,
2164                 $doExpensiveQueries, $short
2165         ) {
2166                 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
2167                         # We /could/ use the protection level on the source page, but it's
2168                         # fairly ugly as we have to establish a precedence hierarchy for pages
2169                         # included by multiple cascade-protected pages. So just restrict
2170                         # it to people with 'protect' permission, as they could remove the
2171                         # protection anyway.
2172                         list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2173                         # Cascading protection depends on more than this page...
2174                         # Several cascading protected pages may include this page...
2175                         # Check each cascading level
2176                         # This is only for protection restrictions, not for all actions
2177                         if ( isset( $restrictions[$action] ) ) {
2178                                 foreach ( $restrictions[$action] as $right ) {
2179                                         // Backwards compatibility, rewrite sysop -> editprotected
2180                                         if ( $right == 'sysop' ) {
2181                                                 $right = 'editprotected';
2182                                         }
2183                                         // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2184                                         if ( $right == 'autoconfirmed' ) {
2185                                                 $right = 'editsemiprotected';
2186                                         }
2187                                         if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2188                                                 $pages = '';
2189                                                 foreach ( $cascadingSources as $page ) {
2190                                                         $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2191                                                 }
2192                                                 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
2193                                         }
2194                                 }
2195                         }
2196                 }
2197
2198                 return $errors;
2199         }
2200
2201         /**
2202          * Check action permissions not already checked in checkQuickPermissions
2203          *
2204          * @param string $action The action to check
2205          * @param User $user User to check
2206          * @param array $errors List of current errors
2207          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2208          * @param bool $short Short circuit on first error
2209          *
2210          * @return array List of errors
2211          */
2212         private function checkActionPermissions( $action, $user, $errors,
2213                 $doExpensiveQueries, $short
2214         ) {
2215                 global $wgDeleteRevisionsLimit, $wgLang;
2216
2217                 if ( $action == 'protect' ) {
2218                         if ( count( $this->getUserPermissionsErrorsInternal( 'edit',
2219                                 $user, $doExpensiveQueries, true ) )
2220                         ) {
2221                                 // If they can't edit, they shouldn't protect.
2222                                 $errors[] = array( 'protect-cantedit' );
2223                         }
2224                 } elseif ( $action == 'create' ) {
2225                         $title_protection = $this->getTitleProtection();
2226                         if ( $title_protection ) {
2227                                 if ( $title_protection['pt_create_perm'] == 'sysop' ) {
2228                                         $title_protection['pt_create_perm'] = 'editprotected'; // B/C
2229                                 }
2230                                 if ( $title_protection['pt_create_perm'] == 'autoconfirmed' ) {
2231                                         $title_protection['pt_create_perm'] = 'editsemiprotected'; // B/C
2232                                 }
2233                                 if ( $title_protection['pt_create_perm'] == ''
2234                                         || !$user->isAllowed( $title_protection['pt_create_perm'] )
2235                                 ) {
2236                                         $errors[] = array(
2237                                                 'titleprotected',
2238                                                 User::whoIs( $title_protection['pt_user'] ),
2239                                                 $title_protection['pt_reason']
2240                                         );
2241                                 }
2242                         }
2243                 } elseif ( $action == 'move' ) {
2244                         // Check for immobile pages
2245                         if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2246                                 // Specific message for this case
2247                                 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2248                         } elseif ( !$this->isMovable() ) {
2249                                 // Less specific message for rarer cases
2250                                 $errors[] = array( 'immobile-source-page' );
2251                         }
2252                 } elseif ( $action == 'move-target' ) {
2253                         if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2254                                 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
2255                         } elseif ( !$this->isMovable() ) {
2256                                 $errors[] = array( 'immobile-target-page' );
2257                         }
2258                 } elseif ( $action == 'delete' ) {
2259                         if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
2260                                 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2261                         ) {
2262                                 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
2263                         }
2264                 }
2265                 return $errors;
2266         }
2267
2268         /**
2269          * Check that the user isn't blocked from editing.
2270          *
2271          * @param string $action The action to check
2272          * @param User $user User to check
2273          * @param array $errors List of current errors
2274          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2275          * @param bool $short Short circuit on first error
2276          *
2277          * @return array List of errors
2278          */
2279         private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
2280                 // Account creation blocks handled at userlogin.
2281                 // Unblocking handled in SpecialUnblock
2282                 if ( !$doExpensiveQueries || in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
2283                         return $errors;
2284                 }
2285
2286                 global $wgEmailConfirmToEdit;
2287
2288                 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2289                         $errors[] = array( 'confirmedittext' );
2290                 }
2291
2292                 if ( ( $action == 'edit' || $action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
2293                         // Don't block the user from editing their own talk page unless they've been
2294                         // explicitly blocked from that too.
2295                 } elseif ( $user->isBlocked() && $user->mBlock->prevents( $action ) !== false ) {
2296                         // @todo FIXME: Pass the relevant context into this function.
2297                         $errors[] = $user->getBlock()->getPermissionsError( RequestContext::getMain() );
2298                 }
2299
2300                 return $errors;
2301         }
2302
2303         /**
2304          * Check that the user is allowed to read this page.
2305          *
2306          * @param string $action The action to check
2307          * @param User $user User to check
2308          * @param array $errors List of current errors
2309          * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2310          * @param bool $short Short circuit on first error
2311          *
2312          * @return array List of errors
2313          */
2314         private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2315                 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2316
2317                 $whitelisted = false;
2318                 if ( User::isEveryoneAllowed( 'read' ) ) {
2319                         # Shortcut for public wikis, allows skipping quite a bit of code
2320                         $whitelisted = true;
2321                 } elseif ( $user->isAllowed( 'read' ) ) {
2322                         # If the user is allowed to read pages, he is allowed to read all pages
2323                         $whitelisted = true;
2324                 } elseif ( $this->isSpecial( 'Userlogin' )
2325                         || $this->isSpecial( 'ChangePassword' )
2326                         || $this->isSpecial( 'PasswordReset' )
2327                 ) {
2328                         # Always grant access to the login page.
2329                         # Even anons need to be able to log in.
2330                         $whitelisted = true;
2331                 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2332                         # Time to check the whitelist
2333                         # Only do these checks is there's something to check against
2334                         $name = $this->getPrefixedText();
2335                         $dbName = $this->getPrefixedDBkey();
2336
2337                         // Check for explicit whitelisting with and without underscores
2338                         if ( in_array( $name, $wgWhitelistRead, true ) || in_array( $dbName, $wgWhitelistRead, true ) ) {
2339                                 $whitelisted = true;
2340                         } elseif ( $this->getNamespace() == NS_MAIN ) {
2341                                 # Old settings might have the title prefixed with
2342                                 # a colon for main-namespace pages
2343                                 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2344                                         $whitelisted = true;
2345                                 }
2346                         } elseif ( $this->isSpecialPage() ) {
2347                                 # If it's a special page, ditch the subpage bit and check again
2348                                 $name = $this->getDBkey();
2349                                 list( $name, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $name );
2350                                 if ( $name ) {
2351                                         $pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
2352                                         if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2353                                                 $whitelisted = true;
2354                                         }
2355                                 }
2356                         }
2357                 }
2358
2359                 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2360                         $name = $this->getPrefixedText();
2361                         // Check for regex whitelisting
2362                         foreach ( $wgWhitelistReadRegexp as $listItem ) {
2363                                 if ( preg_match( $listItem, $name ) ) {
2364                                         $whitelisted = true;
2365                                         break;
2366                                 }
2367                         }
2368                 }
2369
2370                 if ( !$whitelisted ) {
2371                         # If the title is not whitelisted, give extensions a chance to do so...
2372                         wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2373                         if ( !$whitelisted ) {
2374                                 $errors[] = $this->missingPermissionError( $action, $short );
2375                         }
2376                 }
2377
2378                 return $errors;
2379         }
2380
2381         /**
2382          * Get a description array when the user doesn't have the right to perform
2383          * $action (i.e. when User::isAllowed() returns false)
2384          *
2385          * @param string $action The action to check
2386          * @param bool $short Short circuit on first error
2387          * @return array List of errors
2388          */
2389         private function missingPermissionError( $action, $short ) {
2390                 // We avoid expensive display logic for quickUserCan's and such
2391                 if ( $short ) {
2392                         return array( 'badaccess-group0' );
2393                 }
2394
2395                 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2396                         User::getGroupsWithPermission( $action ) );
2397
2398                 if ( count( $groups ) ) {
2399                         global $wgLang;
2400                         return array(
2401                                 'badaccess-groups',
2402                                 $wgLang->commaList( $groups ),
2403                                 count( $groups )
2404                         );
2405                 } else {
2406                         return array( 'badaccess-group0' );
2407                 }
2408         }
2409
2410         /**
2411          * Can $user perform $action on this page? This is an internal function,
2412          * which checks ONLY that previously checked by userCan (i.e. it leaves out
2413          * checks on wfReadOnly() and blocks)
2414          *
2415          * @param string $action Action that permission needs to be checked for
2416          * @param User $user User to check
2417          * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
2418          * @param bool $short Set this to true to stop after the first permission error.
2419          * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2420          */
2421         protected function getUserPermissionsErrorsInternal( $action, $user,
2422                 $doExpensiveQueries = true, $short = false
2423         ) {
2424                 wfProfileIn( __METHOD__ );
2425
2426                 # Read has special handling
2427                 if ( $action == 'read' ) {
2428                         $checks = array(
2429                                 'checkPermissionHooks',
2430                                 'checkReadPermissions',
2431                         );
2432                 } else {
2433                         $checks = array(
2434                                 'checkQuickPermissions',
2435                                 'checkPermissionHooks',
2436                                 'checkSpecialsAndNSPermissions',
2437                                 'checkCSSandJSPermissions',
2438                                 'checkPageRestrictions',
2439                                 'checkCascadingSourcesRestrictions',
2440                                 'checkActionPermissions',
2441                                 'checkUserBlock'
2442                         );
2443                 }
2444
2445                 $errors = array();
2446                 while ( count( $checks ) > 0 &&
2447                                 !( $short && count( $errors ) > 0 ) ) {
2448                         $method = array_shift( $checks );
2449                         $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2450                 }
2451
2452                 wfProfileOut( __METHOD__ );
2453                 return $errors;
2454         }
2455
2456         /**
2457          * Get a filtered list of all restriction types supported by this wiki.
2458          * @param bool $exists True to get all restriction types that apply to
2459          * titles that do exist, False for all restriction types that apply to
2460          * titles that do not exist
2461          * @return array
2462          */
2463         public static function getFilteredRestrictionTypes( $exists = true ) {
2464                 global $wgRestrictionTypes;
2465                 $types = $wgRestrictionTypes;
2466                 if ( $exists ) {
2467                         # Remove the create restriction for existing titles
2468                         $types = array_diff( $types, array( 'create' ) );
2469                 } else {
2470                         # Only the create and upload restrictions apply to non-existing titles
2471                         $types = array_intersect( $types, array( 'create', 'upload' ) );
2472                 }
2473                 return $types;
2474         }
2475
2476         /**
2477          * Returns restriction types for the current Title
2478          *
2479          * @return array Applicable restriction types
2480          */
2481         public function getRestrictionTypes() {
2482                 if ( $this->isSpecialPage() ) {
2483                         return array();
2484                 }
2485
2486                 $types = self::getFilteredRestrictionTypes( $this->exists() );
2487
2488                 if ( $this->getNamespace() != NS_FILE ) {
2489                         # Remove the upload restriction for non-file titles
2490                         $types = array_diff( $types, array( 'upload' ) );
2491                 }
2492
2493                 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2494
2495                 wfDebug( __METHOD__ . ': applicable restrictions to [[' .
2496                         $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2497
2498                 return $types;
2499         }
2500
2501         /**
2502          * Is this title subject to title protection?
2503          * Title protection is the one applied against creation of such title.
2504          *
2505          * @return array|bool An associative array representing any existent title
2506          *   protection, or false if there's none.
2507          */
2508         private function getTitleProtection() {
2509                 // Can't protect pages in special namespaces
2510                 if ( $this->getNamespace() < 0 ) {
2511                         return false;
2512                 }
2513
2514                 // Can't protect pages that exist.
2515                 if ( $this->exists() ) {
2516                         return false;
2517                 }
2518
2519                 if ( $this->mTitleProtection === null ) {
2520                         $dbr = wfGetDB( DB_SLAVE );
2521                         $res = $dbr->select(
2522                                 'protected_titles',
2523                                 array( 'pt_user', 'pt_reason', 'pt_expiry', 'pt_create_perm' ),
2524                                 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2525                                 __METHOD__
2526                         );
2527
2528                         // fetchRow returns false if there are no rows.
2529                         $this->mTitleProtection = $dbr->fetchRow( $res );
2530                 }
2531                 return $this->mTitleProtection;
2532         }
2533
2534         /**
2535          * Remove any title protection due to page existing
2536          */
2537         public function deleteTitleProtection() {
2538                 $dbw = wfGetDB( DB_MASTER );
2539
2540                 $dbw->delete(
2541                         'protected_titles',
2542                         array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2543                         __METHOD__
2544                 );
2545                 $this->mTitleProtection = false;
2546         }
2547
2548         /**
2549          * Is this page "semi-protected" - the *only* protection levels are listed
2550          * in $wgSemiprotectedRestrictionLevels?
2551          *
2552          * @param string $action Action to check (default: edit)
2553          * @return bool
2554          */
2555         public function isSemiProtected( $action = 'edit' ) {
2556                 global $wgSemiprotectedRestrictionLevels;
2557
2558                 $restrictions = $this->getRestrictions( $action );
2559                 $semi = $wgSemiprotectedRestrictionLevels;
2560                 if ( !$restrictions || !$semi ) {
2561                         // Not protected, or all protection is full protection
2562                         return false;
2563                 }
2564
2565                 // Remap autoconfirmed to editsemiprotected for BC
2566                 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2567                         $semi[$key] = 'editsemiprotected';
2568                 }
2569                 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2570                         $restrictions[$key] = 'editsemiprotected';
2571                 }
2572
2573                 return !array_diff( $restrictions, $semi );
2574         }
2575
2576         /**
2577          * Does the title correspond to a protected article?
2578          *
2579          * @param string $action The action the page is protected from,
2580          * by default checks all actions.
2581          * @return bool
2582          */
2583         public function isProtected( $action = '' ) {
2584                 global $wgRestrictionLevels;
2585
2586                 $restrictionTypes = $this->getRestrictionTypes();
2587
2588                 # Special pages have inherent protection
2589                 if ( $this->isSpecialPage() ) {
2590                         return true;
2591                 }
2592
2593                 # Check regular protection levels
2594                 foreach ( $restrictionTypes as $type ) {
2595                         if ( $action == $type || $action == '' ) {
2596                                 $r = $this->getRestrictions( $type );
2597                                 foreach ( $wgRestrictionLevels as $level ) {
2598                                         if ( in_array( $level, $r ) && $level != '' ) {
2599                                                 return true;
2600                                         }
2601                                 }
2602                         }
2603                 }
2604
2605                 return false;
2606         }
2607
2608         /**
2609          * Determines if $user is unable to edit this page because it has been protected
2610          * by $wgNamespaceProtection.
2611          *
2612          * @param User $user User object to check permissions
2613          * @return bool
2614          */
2615         public function isNamespaceProtected( User $user ) {
2616                 global $wgNamespaceProtection;
2617
2618                 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
2619                         foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
2620                                 if ( $right != '' && !$user->isAllowed( $right ) ) {
2621                                         return true;
2622                                 }
2623                         }
2624                 }
2625                 return false;
2626         }
2627
2628         /**
2629          * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2630          *
2631          * @return bool If the page is subject to cascading restrictions.
2632          */
2633         public function isCascadeProtected() {
2634                 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2635                 return ( $sources > 0 );
2636         }
2637
2638         /**
2639          * Determines whether cascading protection sources have already been loaded from
2640          * the database.
2641          *
2642          * @param bool $getPages True to check if the pages are loaded, or false to check
2643          * if the status is loaded.
2644          * @return bool Whether or not the specified information has been loaded
2645          * @since 1.23
2646          */
2647         public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2648                 return $getPages ? $this->mCascadeSources !== null : $this->mHasCascadingRestrictions !== null;
2649         }
2650
2651         /**
2652          * Cascading protection: Get the source of any cascading restrictions on this page.
2653          *
2654          * @param bool $getPages Whether or not to retrieve the actual pages
2655          *        that the restrictions have come from and the actual restrictions
2656          *        themselves.
2657          * @return array Two elements: First is an array of Title objects of the
2658          *        pages from which cascading restrictions have come, false for
2659          *        none, or true if such restrictions exist but $getPages was not
2660          *        set. Second is an array like that returned by
2661          *        Title::getAllRestrictions(), or an empty array if $getPages is
2662          *        false.
2663          */
2664         public function getCascadeProtectionSources( $getPages = true ) {
2665                 global $wgContLang;
2666                 $pagerestrictions = array();
2667
2668                 if ( $this->mCascadeSources !== null && $getPages ) {
2669                         return array( $this->mCascadeSources, $this->mCascadingRestrictions );
2670                 } elseif ( $this->mHasCascadingRestrictions !== null && !$getPages ) {
2671                         return array( $this->mHasCascadingRestrictions, $pagerestrictions );
2672                 }
2673
2674                 wfProfileIn( __METHOD__ );
2675
2676                 $dbr = wfGetDB( DB_SLAVE );
2677
2678                 if ( $this->getNamespace() == NS_FILE ) {
2679                         $tables = array( 'imagelinks', 'page_restrictions' );
2680                         $where_clauses = array(
2681                                 'il_to' => $this->getDBkey(),
2682                                 'il_from=pr_page',
2683                                 'pr_cascade' => 1
2684                         );
2685                 } else {
2686                         $tables = array( 'templatelinks', 'page_restrictions' );
2687                         $where_clauses = array(
2688                                 'tl_namespace' => $this->getNamespace(),
2689                                 'tl_title' => $this->getDBkey(),
2690                                 'tl_from=pr_page',
2691                                 'pr_cascade' => 1
2692                         );
2693                 }
2694
2695                 if ( $getPages ) {
2696                         $cols = array( 'pr_page', 'page_namespace', 'page_title',
2697                                 'pr_expiry', 'pr_type', 'pr_level' );
2698                         $where_clauses[] = 'page_id=pr_page';
2699                         $tables[] = 'page';
2700                 } else {
2701                         $cols = array( 'pr_expiry' );
2702                 }
2703
2704                 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2705
2706                 $sources = $getPages ? array() : false;
2707                 $now = wfTimestampNow();
2708                 $purgeExpired = false;
2709
2710                 foreach ( $res as $row ) {
2711                         $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2712                         if ( $expiry > $now ) {
2713                                 if ( $getPages ) {
2714                                         $page_id = $row->pr_page;
2715                                         $page_ns = $row->page_namespace;
2716                                         $page_title = $row->page_title;
2717                                         $sources[$page_id] = Title::makeTitle( $page_ns, $page_title );
2718                                         # Add groups needed for each restriction type if its not already there
2719                                         # Make sure this restriction type still exists
2720
2721                                         if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2722                                                 $pagerestrictions[$row->pr_type] = array();
2723                                         }
2724
2725                                         if (
2726                                                 isset( $pagerestrictions[$row->pr_type] )
2727                                                 && !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] )
2728                                         ) {
2729                                                 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2730                                         }
2731                                 } else {
2732                                         $sources = true;
2733                                 }
2734                         } else {
2735                                 // Trigger lazy purge of expired restrictions from the db
2736                                 $purgeExpired = true;
2737                         }
2738                 }
2739                 if ( $purgeExpired ) {
2740                         Title::purgeExpiredRestrictions();
2741                 }
2742
2743                 if ( $getPages ) {
2744                         $this->mCascadeSources = $sources;
2745                         $this->mCascadingRestrictions = $pagerestrictions;
2746                 } else {
2747                         $this->mHasCascadingRestrictions = $sources;
2748                 }
2749
2750                 wfProfileOut( __METHOD__ );
2751                 return array( $sources, $pagerestrictions );
2752         }
2753
2754         /**
2755          * Accessor for mRestrictionsLoaded
2756          *
2757          * @return bool Whether or not the page's restrictions have already been
2758          * loaded from the database
2759          * @since 1.23
2760          */
2761         public function areRestrictionsLoaded() {
2762                 return $this->mRestrictionsLoaded;
2763         }
2764
2765         /**
2766          * Accessor/initialisation for mRestrictions
2767          *
2768          * @param string $action Action that permission needs to be checked for
2769          * @return array Restriction levels needed to take the action. All levels
2770          *     are required.
2771          */
2772         public function getRestrictions( $action ) {
2773                 if ( !$this->mRestrictionsLoaded ) {
2774                         $this->loadRestrictions();
2775                 }
2776                 return isset( $this->mRestrictions[$action] )
2777                                 ? $this->mRestrictions[$action]
2778                                 : array();
2779         }
2780
2781         /**
2782          * Accessor/initialisation for mRestrictions
2783          *
2784          * @return array Keys are actions, values are arrays as returned by
2785          *     Title::getRestrictions()
2786          * @since 1.23
2787          */
2788         public function getAllRestrictions() {
2789                 if ( !$this->mRestrictionsLoaded ) {
2790                         $this->loadRestrictions();
2791                 }
2792                 return $this->mRestrictions;
2793         }
2794
2795         /**
2796          * Get the expiry time for the restriction against a given action
2797          *
2798          * @param string $action
2799          * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2800          *     or not protected at all, or false if the action is not recognised.
2801          */
2802         public function getRestrictionExpiry( $action ) {
2803                 if ( !$this->mRestrictionsLoaded ) {
2804                         $this->loadRestrictions();
2805                 }
2806                 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
2807         }
2808
2809         /**
2810          * Returns cascading restrictions for the current article
2811          *
2812          * @return bool
2813          */
2814         function areRestrictionsCascading() {
2815                 if ( !$this->mRestrictionsLoaded ) {
2816                         $this->loadRestrictions();
2817                 }
2818
2819                 return $this->mCascadeRestriction;
2820         }
2821
2822         /**
2823          * Loads a string into mRestrictions array
2824          *
2825          * @param ResultWrapper $res Resource restrictions as an SQL result.
2826          * @param string $oldFashionedRestrictions Comma-separated list of page
2827          *        restrictions from page table (pre 1.10)
2828          */
2829         private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2830                 $rows = array();
2831
2832                 foreach ( $res as $row ) {
2833                         $rows[] = $row;
2834                 }
2835
2836                 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2837         }
2838
2839         /**
2840          * Compiles list of active page restrictions from both page table (pre 1.10)
2841          * and page_restrictions table for this existing page.
2842          * Public for usage by LiquidThreads.
2843          *
2844          * @param array $rows Array of db result objects
2845          * @param string $oldFashionedRestrictions Comma-separated list of page
2846          *   restrictions from page table (pre 1.10)
2847          */
2848         public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2849                 global $wgContLang;
2850                 $dbr = wfGetDB( DB_SLAVE );
2851
2852                 $restrictionTypes = $this->getRestrictionTypes();
2853
2854                 foreach ( $restrictionTypes as $type ) {
2855                         $this->mRestrictions[$type] = array();
2856                         $this->mRestrictionsExpiry[$type] = $wgContLang->formatExpiry( '', TS_MW );
2857                 }
2858
2859                 $this->mCascadeRestriction = false;
2860
2861                 # Backwards-compatibility: also load the restrictions from the page record (old format).
2862
2863                 if ( $oldFashionedRestrictions === null ) {
2864                         $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2865                                 array( 'page_id' => $this->getArticleID() ), __METHOD__ );
2866                 }
2867
2868                 if ( $oldFashionedRestrictions != '' ) {
2869
2870                         foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2871                                 $temp = explode( '=', trim( $restrict ) );
2872                                 if ( count( $temp ) == 1 ) {
2873                                         // old old format should be treated as edit/move restriction
2874                                         $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
2875                                         $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
2876                                 } else {
2877                                         $restriction = trim( $temp[1] );
2878                                         if ( $restriction != '' ) { //some old entries are empty
2879                                                 $this->mRestrictions[$temp[0]] = explode( ',', $restriction );
2880                                         }
2881                                 }
2882                         }
2883
2884                         $this->mOldRestrictions = true;
2885
2886                 }
2887
2888                 if ( count( $rows ) ) {
2889                         # Current system - load second to make them override.
2890                         $now = wfTimestampNow();
2891                         $purgeExpired = false;
2892
2893                         # Cycle through all the restrictions.
2894                         foreach ( $rows as $row ) {
2895
2896                                 // Don't take care of restrictions types that aren't allowed
2897                                 if ( !in_array( $row->pr_type, $restrictionTypes ) ) {
2898                                         continue;
2899                                 }
2900
2901                                 // This code should be refactored, now that it's being used more generally,
2902                                 // But I don't really see any harm in leaving it in Block for now -werdna
2903                                 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2904
2905                                 // Only apply the restrictions if they haven't expired!
2906                                 if ( !$expiry || $expiry > $now ) {
2907                                         $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
2908                                         $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
2909
2910                                         $this->mCascadeRestriction |= $row->pr_cascade;
2911                                 } else {
2912                                         // Trigger a lazy purge of expired restrictions
2913                                         $purgeExpired = true;
2914                                 }
2915                         }
2916
2917                         if ( $purgeExpired ) {
2918                                 Title::purgeExpiredRestrictions();
2919                         }
2920                 }
2921
2922                 $this->mRestrictionsLoaded = true;
2923         }
2924
2925         /**
2926          * Load restrictions from the page_restrictions table
2927          *
2928          * @param string $oldFashionedRestrictions Comma-separated list of page
2929          *   restrictions from page table (pre 1.10)
2930          */
2931         public function loadRestrictions( $oldFashionedRestrictions = null ) {
2932                 global $wgContLang;
2933                 if ( !$this->mRestrictionsLoaded ) {
2934                         if ( $this->exists() ) {
2935                                 $dbr = wfGetDB( DB_SLAVE );
2936
2937                                 $res = $dbr->select(
2938                                         'page_restrictions',
2939                                         array( 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ),
2940                                         array( 'pr_page' => $this->getArticleID() ),
2941                                         __METHOD__
2942                                 );
2943
2944                                 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2945                         } else {
2946                                 $title_protection = $this->getTitleProtection();
2947
2948                                 if ( $title_protection ) {
2949                                         $now = wfTimestampNow();
2950                                         $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW );
2951
2952                                         if ( !$expiry || $expiry > $now ) {
2953                                                 // Apply the restrictions
2954                                                 $this->mRestrictionsExpiry['create'] = $expiry;
2955                                                 $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2956                                         } else { // Get rid of the old restrictions
2957                                                 Title::purgeExpiredRestrictions();
2958                                                 $this->mTitleProtection = false;
2959                                         }
2960                                 } else {
2961                                         $this->mRestrictionsExpiry['create'] = $wgContLang->formatExpiry( '', TS_MW );
2962                                 }
2963                                 $this->mRestrictionsLoaded = true;
2964                         }
2965                 }
2966         }
2967
2968         /**
2969          * Flush the protection cache in this object and force reload from the database.
2970          * This is used when updating protection from WikiPage::doUpdateRestrictions().
2971          */
2972         public function flushRestrictions() {
2973                 $this->mRestrictionsLoaded = false;
2974                 $this->mTitleProtection = null;
2975         }
2976
2977         /**
2978          * Purge expired restrictions from the page_restrictions table
2979          */
2980         static function purgeExpiredRestrictions() {
2981                 if ( wfReadOnly() ) {
2982                         return;
2983                 }
2984
2985                 $method = __METHOD__;
2986                 $dbw = wfGetDB( DB_MASTER );
2987                 $dbw->onTransactionIdle( function () use ( $dbw, $method ) {
2988                         $dbw->delete(
2989                                 'page_restrictions',
2990                                 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2991                                 $method
2992                         );
2993                         $dbw->delete(
2994                                 'protected_titles',
2995                                 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2996                                 $method
2997                         );
2998                 } );
2999         }
3000
3001         /**
3002          * Does this have subpages?  (Warning, usually requires an extra DB query.)
3003          *
3004          * @return bool
3005          */
3006         public function hasSubpages() {
3007                 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
3008                         # Duh
3009                         return false;
3010                 }
3011
3012                 # We dynamically add a member variable for the purpose of this method
3013                 # alone to cache the result.  There's no point in having it hanging
3014                 # around uninitialized in every Title object; therefore we only add it
3015                 # if needed and don't declare it statically.
3016                 if ( $this->mHasSubpages === null ) {
3017                         $this->mHasSubpages = false;
3018                         $subpages = $this->getSubpages( 1 );
3019                         if ( $subpages instanceof TitleArray ) {
3020                                 $this->mHasSubpages = (bool)$subpages->count();
3021                         }
3022                 }
3023
3024                 return $this->mHasSubpages;
3025         }
3026
3027         /**
3028          * Get all subpages of this page.
3029          *
3030          * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3031          * @return TitleArray|array TitleArray, or empty array if this page's namespace
3032          *  doesn't allow subpages
3033          */
3034         public function getSubpages( $limit = -1 ) {
3035                 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
3036                         return array();
3037                 }
3038
3039                 $dbr = wfGetDB( DB_SLAVE );
3040                 $conds['page_namespace'] = $this->getNamespace();
3041                 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
3042                 $options = array();
3043                 if ( $limit > -1 ) {
3044                         $options['LIMIT'] = $limit;
3045                 }
3046                 $this->mSubpages = TitleArray::newFromResult(
3047                         $dbr->select( 'page',
3048                                 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
3049                                 $conds,
3050                                 __METHOD__,
3051                                 $options
3052                         )
3053                 );
3054                 return $this->mSubpages;
3055         }
3056
3057         /**
3058          * Is there a version of this page in the deletion archive?
3059          *
3060          * @return int The number of archived revisions
3061          */
3062         public function isDeleted() {
3063                 if ( $this->getNamespace() < 0 ) {
3064                         $n = 0;
3065                 } else {
3066                         $dbr = wfGetDB( DB_SLAVE );
3067
3068                         $n = $dbr->selectField( 'archive', 'COUNT(*)',
3069                                 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3070                                 __METHOD__
3071                         );
3072                         if ( $this->getNamespace() == NS_FILE ) {
3073                                 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
3074                                         array( 'fa_name' => $this->getDBkey() ),
3075                                         __METHOD__
3076                                 );
3077                         }
3078                 }
3079                 return (int)$n;
3080         }
3081
3082         /**
3083          * Is there a version of this page in the deletion archive?
3084          *
3085          * @return bool
3086          */
3087         public function isDeletedQuick() {
3088                 if ( $this->getNamespace() < 0 ) {
3089                         return false;
3090                 }
3091                 $dbr = wfGetDB( DB_SLAVE );
3092                 $deleted = (bool)$dbr->selectField( 'archive', '1',
3093                         array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3094                         __METHOD__
3095                 );
3096                 if ( !$deleted && $this->getNamespace() == NS_FILE ) {
3097                         $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3098                                 array( 'fa_name' => $this->getDBkey() ),
3099                                 __METHOD__
3100                         );
3101                 }
3102                 return $deleted;
3103         }
3104
3105         /**
3106          * Get the article ID for this Title from the link cache,
3107          * adding it if necessary
3108          *
3109          * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3110          *  for update
3111          * @return int The ID
3112          */
3113         public function getArticleID( $flags = 0 ) {
3114                 if ( $this->getNamespace() < 0 ) {
3115                         $this->mArticleID = 0;
3116                         return $this->mArticleID;
3117                 }
3118                 $linkCache = LinkCache::singleton();
3119                 if ( $flags & self::GAID_FOR_UPDATE ) {
3120                         $oldUpdate = $linkCache->forUpdate( true );
3121                         $linkCache->clearLink( $this );
3122                         $this->mArticleID = $linkCache->addLinkObj( $this );
3123                         $linkCache->forUpdate( $oldUpdate );
3124                 } else {
3125                         if ( -1 == $this->mArticleID ) {
3126                                 $this->mArticleID = $linkCache->addLinkObj( $this );
3127                         }
3128                 }
3129                 return $this->mArticleID;
3130         }
3131
3132         /**
3133          * Is this an article that is a redirect page?
3134          * Uses link cache, adding it if necessary
3135          *
3136          * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3137          * @return bool
3138          */
3139         public function isRedirect( $flags = 0 ) {
3140                 if ( !is_null( $this->mRedirect ) ) {
3141                         return $this->mRedirect;
3142                 }
3143                 # Calling getArticleID() loads the field from cache as needed
3144                 if ( !$this->getArticleID( $flags ) ) {
3145                         $this->mRedirect = false;
3146                         return $this->mRedirect;
3147                 }
3148
3149                 $linkCache = LinkCache::singleton();
3150                 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3151                 if ( $cached === null ) {
3152                         # Trust LinkCache's state over our own
3153                         # LinkCache is telling us that the page doesn't exist, despite there being cached
3154                         # data relating to an existing page in $this->mArticleID. Updaters should clear
3155                         # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3156                         # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3157                         # LinkCache to refresh its data from the master.
3158                         $this->mRedirect = false;
3159                         return $this->mRedirect;
3160                 }
3161
3162                 $this->mRedirect = (bool)$cached;
3163
3164                 return $this->mRedirect;
3165         }
3166
3167         /**
3168          * What is the length of this page?
3169          * Uses link cache, adding it if necessary
3170          *
3171          * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3172          * @return int
3173          */
3174         public function getLength( $flags = 0 ) {
3175                 if ( $this->mLength != -1 ) {
3176                         return $this->mLength;
3177                 }
3178                 # Calling getArticleID() loads the field from cache as needed
3179                 if ( !$this->getArticleID( $flags ) ) {
3180                         $this->mLength = 0;
3181                         return $this->mLength;
3182                 }
3183                 $linkCache = LinkCache::singleton();
3184                 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3185                 if ( $cached === null ) {
3186                         # Trust LinkCache's state over our own, as for isRedirect()
3187                         $this->mLength = 0;
3188                         return $this->mLength;
3189                 }
3190
3191                 $this->mLength = intval( $cached );
3192
3193                 return $this->mLength;
3194         }
3195
3196         /**
3197          * What is the page_latest field for this page?
3198          *
3199          * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3200          * @return int Int or 0 if the page doesn't exist
3201          */
3202         public function getLatestRevID( $flags = 0 ) {
3203                 if ( !( $flags & Title::GAID_FOR_UPDATE ) && $this->mLatestID !== false ) {
3204                         return intval( $this->mLatestID );
3205                 }
3206                 # Calling getArticleID() loads the field from cache as needed
3207                 if ( !$this->getArticleID( $flags ) ) {
3208                         $this->mLatestID = 0;
3209                         return $this->mLatestID;
3210                 }
3211                 $linkCache = LinkCache::singleton();
3212                 $linkCache->addLinkObj( $this );
3213                 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3214                 if ( $cached === null ) {
3215                         # Trust LinkCache's state over our own, as for isRedirect()
3216                         $this->mLatestID = 0;
3217                         return $this->mLatestID;
3218                 }
3219
3220                 $this->mLatestID = intval( $cached );
3221
3222                 return $this->mLatestID;
3223         }
3224
3225         /**
3226          * This clears some fields in this object, and clears any associated
3227          * keys in the "bad links" section of the link cache.
3228          *
3229          * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
3230          * loading of the new page_id. It's also called from
3231          * WikiPage::doDeleteArticleReal()
3232          *
3233          * @param int $newid The new Article ID
3234          */
3235         public function resetArticleID( $newid ) {
3236                 $linkCache = LinkCache::singleton();
3237                 $linkCache->clearLink( $this );
3238
3239                 if ( $newid === false ) {
3240                         $this->mArticleID = -1;
3241                 } else {
3242                         $this->mArticleID = intval( $newid );
3243                 }
3244                 $this->mRestrictionsLoaded = false;
3245                 $this->mRestrictions = array();
3246                 $this->mRedirect = null;
3247                 $this->mLength = -1;
3248                 $this->mLatestID = false;
3249                 $this->mContentModel = false;
3250                 $this->mEstimateRevisions = null;
3251                 $this->mPageLanguage = false;
3252                 $this->mDbPageLanguage = null;
3253         }
3254
3255         /**
3256          * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3257          *
3258          * @param string $text Containing title to capitalize
3259          * @param int $ns Namespace index, defaults to NS_MAIN
3260          * @return string Containing capitalized title
3261          */
3262         public static function capitalize( $text, $ns = NS_MAIN ) {
3263                 global $wgContLang;
3264
3265                 if ( MWNamespace::isCapitalized( $ns ) ) {
3266                         return $wgContLang->ucfirst( $text );
3267                 } else {
3268                         return $text;
3269                 }
3270         }
3271
3272         /**
3273          * Secure and split - main initialisation function for this object
3274          *
3275          * Assumes that mDbkeyform has been set, and is urldecoded
3276          * and uses underscores, but not otherwise munged.  This function
3277          * removes illegal characters, splits off the interwiki and
3278          * namespace prefixes, sets the other forms, and canonicalizes
3279          * everything.
3280          *
3281          * @return bool True on success
3282          */
3283         private function secureAndSplit() {
3284                 # Initialisation
3285                 $this->mInterwiki = '';
3286                 $this->mFragment = '';
3287                 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
3288
3289                 $dbkey = $this->mDbkeyform;
3290
3291                 try {
3292                         // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3293                         //        the parsing code with Title, while avoiding massive refactoring.
3294                         // @todo: get rid of secureAndSplit, refactor parsing code.
3295                         $parser = self::getTitleParser();
3296                         $parts = $parser->splitTitleString( $dbkey, $this->getDefaultNamespace() );
3297                 } catch ( MalformedTitleException $ex ) {
3298                         return false;
3299                 }
3300
3301                 # Fill fields
3302                 $this->setFragment( '#' . $parts['fragment'] );
3303                 $this->mInterwiki = $parts['interwiki'];
3304                 $this->mLocalInterwiki = $parts['local_interwiki'];
3305                 $this->mNamespace = $parts['namespace'];
3306                 $this->mUserCaseDBKey = $parts['user_case_dbkey'];
3307
3308                 $this->mDbkeyform = $parts['dbkey'];
3309                 $this->mUrlform = wfUrlencode( $this->mDbkeyform );
3310                 $this->mTextform = str_replace( '_', ' ', $this->mDbkeyform );
3311
3312                 # We already know that some pages won't be in the database!
3313                 if ( $this->isExternal() || $this->mNamespace == NS_SPECIAL ) {
3314                         $this->mArticleID = 0;
3315                 }
3316
3317                 return true;
3318         }
3319
3320         /**
3321          * Get an array of Title objects linking to this Title
3322          * Also stores the IDs in the link cache.
3323          *
3324          * WARNING: do not use this function on arbitrary user-supplied titles!
3325          * On heavily-used templates it will max out the memory.
3326          *
3327          * @param array $options May be FOR UPDATE
3328          * @param string $table Table name
3329          * @param string $prefix Fields prefix
3330          * @return Title[] Array of Title objects linking here
3331          */
3332         public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3333                 if ( count( $options ) > 0 ) {
3334                         $db = wfGetDB( DB_MASTER );
3335                 } else {
3336                         $db = wfGetDB( DB_SLAVE );
3337                 }
3338
3339                 $res = $db->select(
3340                         array( 'page', $table ),
3341                         self::getSelectFields(),
3342                         array(
3343                                 "{$prefix}_from=page_id",
3344                                 "{$prefix}_namespace" => $this->getNamespace(),
3345                                 "{$prefix}_title" => $this->getDBkey() ),
3346                         __METHOD__,
3347                         $options
3348                 );
3349
3350                 $retVal = array();
3351                 if ( $res->numRows() ) {
3352                         $linkCache = LinkCache::singleton();
3353                         foreach ( $res as $row ) {
3354                                 $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title );
3355                                 if ( $titleObj ) {
3356                                         $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3357                                         $retVal[] = $titleObj;
3358                                 }
3359                         }
3360                 }
3361                 return $retVal;
3362         }
3363
3364         /**
3365          * Get an array of Title objects using this Title as a template
3366          * Also stores the IDs in the link cache.
3367          *
3368          * WARNING: do not use this function on arbitrary user-supplied titles!
3369          * On heavily-used templates it will max out the memory.
3370          *
3371          * @param array $options May be FOR UPDATE
3372          * @return Title[] Array of Title the Title objects linking here
3373          */
3374         public function getTemplateLinksTo( $options = array() ) {
3375                 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3376         }
3377
3378         /**
3379          * Get an array of Title objects linked from this Title
3380          * Also stores the IDs in the link cache.
3381          *
3382          * WARNING: do not use this function on arbitrary user-supplied titles!
3383          * On heavily-used templates it will max out the memory.
3384          *
3385          * @param array $options May be FOR UPDATE
3386          * @param string $table Table name
3387          * @param string $prefix Fields prefix
3388          * @return array Array of Title objects linking here
3389          */
3390         public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3391                 global $wgContentHandlerUseDB;
3392
3393                 $id = $this->getArticleID();
3394
3395                 # If the page doesn't exist; there can't be any link from this page
3396                 if ( !$id ) {
3397                         return array();
3398                 }
3399
3400                 if ( count( $options ) > 0 ) {
3401                         $db = wfGetDB( DB_MASTER );
3402                 } else {
3403                         $db = wfGetDB( DB_SLAVE );
3404                 }
3405
3406                 $namespaceFiled = "{$prefix}_namespace";
3407                 $titleField = "{$prefix}_title";
3408
3409                 $fields = array(
3410                         $namespaceFiled,
3411                         $titleField,
3412                         'page_id',
3413                         'page_len',
3414                         'page_is_redirect',
3415                         'page_latest'
3416                 );
3417
3418                 if ( $wgContentHandlerUseDB ) {
3419                         $fields[] = 'page_content_model';
3420                 }
3421
3422                 $res = $db->select(
3423                         array( $table, 'page' ),
3424                         $fields,
3425                         array( "{$prefix}_from" => $id ),
3426                         __METHOD__,
3427                         $options,
3428                         array( 'page' => array(
3429                                 'LEFT JOIN',
3430                                 array( "page_namespace=$namespaceFiled", "page_title=$titleField" )
3431                         ) )
3432                 );
3433
3434                 $retVal = array();
3435                 if ( $res->numRows() ) {
3436                         $linkCache = LinkCache::singleton();
3437                         foreach ( $res as $row ) {
3438                                 $titleObj = Title::makeTitle( $row->$namespaceFiled, $row->$titleField );
3439                                 if ( $titleObj ) {
3440                                         if ( $row->page_id ) {
3441                                                 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3442                                         } else {
3443                                                 $linkCache->addBadLinkObj( $titleObj );
3444                                         }
3445                                         $retVal[] = $titleObj;
3446                                 }
3447                         }
3448                 }
3449                 return $retVal;
3450         }
3451
3452         /**
3453          * Get an array of Title objects used on this Title as a template
3454          * Also stores the IDs in the link cache.
3455          *
3456          * WARNING: do not use this function on arbitrary user-supplied titles!
3457          * On heavily-used templates it will max out the memory.
3458          *
3459          * @param array $options May be FOR UPDATE
3460          * @return Title[] Array of Title the Title objects used here
3461          */
3462         public function getTemplateLinksFrom( $options = array() ) {
3463                 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3464         }
3465
3466         /**
3467          * Get an array of Title objects referring to non-existent articles linked
3468          * from this page.
3469          *
3470          * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3471          *   should use redirect table in this case).
3472          * @return Title[] Array of Title the Title objects
3473          */
3474         public function getBrokenLinksFrom() {
3475                 if ( $this->getArticleID() == 0 ) {
3476                         # All links from article ID 0 are false positives
3477                         return array();
3478                 }
3479
3480                 $dbr = wfGetDB( DB_SLAVE );
3481                 $res = $dbr->select(
3482                         array( 'page', 'pagelinks' ),
3483                         array( 'pl_namespace', 'pl_title' ),
3484                         array(
3485                                 'pl_from' => $this->getArticleID(),
3486                                 'page_namespace IS NULL'
3487                         ),
3488                         __METHOD__, array(),
3489                         array(
3490                                 'page' => array(
3491                                         'LEFT JOIN',
3492                                         array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3493                                 )
3494                         )
3495                 );
3496
3497                 $retVal = array();
3498                 foreach ( $res as $row ) {
3499                         $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
3500                 }
3501                 return $retVal;
3502         }
3503
3504         /**
3505          * Get a list of URLs to purge from the Squid cache when this
3506          * page changes
3507          *
3508          * @return string[] Array of String the URLs
3509          */
3510         public function getSquidURLs() {
3511                 $urls = array(
3512                         $this->getInternalURL(),
3513                         $this->getInternalURL( 'action=history' )
3514                 );
3515
3516                 $pageLang = $this->getPageLanguage();
3517                 if ( $pageLang->hasVariants() ) {
3518                         $variants = $pageLang->getVariants();
3519                         foreach ( $variants as $vCode ) {
3520                                 $urls[] = $this->getInternalURL( '', $vCode );
3521                         }
3522                 }
3523
3524                 // If we are looking at a css/js user subpage, purge the action=raw.
3525                 if ( $this->isJsSubpage() ) {
3526                         $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/javascript' );
3527                 } elseif ( $this->isCssSubpage() ) {
3528                         $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/css' );
3529                 }
3530
3531                 wfRunHooks( 'TitleSquidURLs', array( $this, &$urls ) );
3532                 return $urls;
3533         }
3534
3535         /**
3536          * Purge all applicable Squid URLs
3537          */
3538         public function purgeSquid() {
3539                 global $wgUseSquid;
3540                 if ( $wgUseSquid ) {
3541                         $urls = $this->getSquidURLs();
3542                         $u = new SquidUpdate( $urls );
3543                         $u->doUpdate();
3544                 }
3545         }
3546
3547         /**
3548          * Move this page without authentication
3549          *
3550          * @param Title $nt The new page Title
3551          * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3552          */
3553         public function moveNoAuth( &$nt ) {
3554                 return $this->moveTo( $nt, false );
3555         }
3556
3557         /**
3558          * Check whether a given move operation would be valid.
3559          * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3560          *
3561          * @param Title $nt The new title
3562          * @param bool $auth Indicates whether $wgUser's permissions
3563          *  should be checked
3564          * @param string $reason Is the log summary of the move, used for spam checking
3565          * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3566          */
3567         public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3568                 global $wgUser, $wgContentHandlerUseDB;
3569
3570                 $errors = array();
3571                 if ( !$nt ) {
3572                         // Normally we'd add this to $errors, but we'll get
3573                         // lots of syntax errors if $nt is not an object
3574                         return array( array( 'badtitletext' ) );
3575                 }
3576                 if ( $this->equals( $nt ) ) {
3577                         $errors[] = array( 'selfmove' );
3578                 }
3579                 if ( !$this->isMovable() ) {
3580                         $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3581                 }
3582                 if ( $nt->isExternal() ) {
3583                         $errors[] = array( 'immobile-target-namespace-iw' );
3584                 }
3585                 if ( !$nt->isMovable() ) {
3586                         $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3587                 }
3588
3589                 $oldid = $this->getArticleID();
3590                 $newid = $nt->getArticleID();
3591
3592                 if ( strlen( $nt->getDBkey() ) < 1 ) {
3593                         $errors[] = array( 'articleexists' );
3594                 }
3595                 if (
3596                         ( $this->getDBkey() == '' ) ||
3597                         ( !$oldid ) ||
3598                         ( $nt->getDBkey() == '' )
3599                 ) {
3600                         $errors[] = array( 'badarticleerror' );
3601                 }
3602
3603                 // Content model checks
3604                 if ( !$wgContentHandlerUseDB &&
3605                                 $this->getContentModel() !== $nt->getContentModel() ) {
3606                         // can't move a page if that would change the page's content model
3607                         $errors[] = array(
3608                                 'bad-target-model',
3609                                 ContentHandler::getLocalizedName( $this->getContentModel() ),
3610                                 ContentHandler::getLocalizedName( $nt->getContentModel() )
3611                         );
3612                 }
3613
3614                 // Image-specific checks
3615                 if ( $this->getNamespace() == NS_FILE ) {
3616                         $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3617                 }
3618
3619                 if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) {
3620                         $errors[] = array( 'nonfile-cannot-move-to-file' );
3621                 }
3622
3623                 if ( $auth ) {
3624                         $errors = wfMergeErrorArrays( $errors,
3625                                 $this->getUserPermissionsErrors( 'move', $wgUser ),
3626                                 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3627                                 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3628                                 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3629                 }
3630
3631                 $match = EditPage::matchSummarySpamRegex( $reason );
3632                 if ( $match !== false ) {
3633                         // This is kind of lame, won't display nice
3634                         $errors[] = array( 'spamprotectiontext' );
3635                 }
3636
3637                 $err = null;
3638                 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3639                         $errors[] = array( 'hookaborted', $err );
3640                 }
3641
3642                 # The move is allowed only if (1) the target doesn't exist, or
3643                 # (2) the target is a redirect to the source, and has no history
3644                 # (so we can undo bad moves right after they're done).
3645
3646                 if ( 0 != $newid ) { # Target exists; check for validity
3647                         if ( !$this->isValidMoveTarget( $nt ) ) {
3648                                 $errors[] = array( 'articleexists' );
3649                         }
3650                 } else {
3651                         $tp = $nt->getTitleProtection();
3652                         $right = $tp['pt_create_perm'];
3653                         if ( $right == 'sysop' ) {
3654                                 $right = 'editprotected'; // B/C
3655                         }
3656                         if ( $right == 'autoconfirmed' ) {
3657                                 $right = 'editsemiprotected'; // B/C
3658                         }
3659                         if ( $tp and !$wgUser->isAllowed( $right ) ) {
3660                                 $errors[] = array( 'cantmove-titleprotected' );
3661                         }
3662                 }
3663                 if ( empty( $errors ) ) {
3664                         return true;
3665                 }
3666                 return $errors;
3667         }
3668
3669         /**
3670          * Check if the requested move target is a valid file move target
3671          * @param Title $nt Target title
3672          * @return array List of errors
3673          */
3674         protected function validateFileMoveOperation( $nt ) {
3675                 global $wgUser;
3676
3677                 $errors = array();
3678
3679                 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3680
3681                 $file = wfLocalFile( $this );
3682                 if ( $file->exists() ) {
3683                         if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3684                                 $errors[] = array( 'imageinvalidfilename' );
3685                         }
3686                         if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3687                                 $errors[] = array( 'imagetypemismatch' );
3688                         }
3689                 }
3690
3691                 if ( $nt->getNamespace() != NS_FILE ) {
3692                         $errors[] = array( 'imagenocrossnamespace' );
3693                         // From here we want to do checks on a file object, so if we can't
3694                         // create one, we must return.
3695                         return $errors;
3696                 }
3697
3698                 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3699
3700                 $destFile = wfLocalFile( $nt );
3701                 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3702                         $errors[] = array( 'file-exists-sharedrepo' );
3703                 }
3704
3705                 return $errors;
3706         }
3707
3708         /**
3709          * Move a title to a new location
3710          *
3711          * @param Title $nt The new title
3712          * @param bool $auth Indicates whether $wgUser's permissions
3713          *  should be checked
3714          * @param string $reason The reason for the move
3715          * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3716          *  Ignored if the user doesn't have the suppressredirect right.
3717          * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3718          */
3719         public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3720                 global $wgUser;
3721                 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3722                 if ( is_array( $err ) ) {
3723                         // Auto-block user's IP if the account was "hard" blocked
3724                         $wgUser->spreadAnyEditBlock();
3725                         return $err;
3726                 }
3727                 // Check suppressredirect permission
3728                 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3729                         $createRedirect = true;
3730                 }
3731
3732                 wfRunHooks( 'TitleMove', array( $this, $nt, $wgUser ) );
3733
3734                 // If it is a file, move it first.
3735                 // It is done before all other moving stuff is done because it's hard to revert.
3736                 $dbw = wfGetDB( DB_MASTER );
3737                 if ( $this->getNamespace() == NS_FILE ) {
3738                         $file = wfLocalFile( $this );
3739                         if ( $file->exists() ) {
3740                                 $status = $file->move( $nt );
3741                                 if ( !$status->isOk() ) {
3742                                         return $status->getErrorsArray();
3743                                 }
3744                         }
3745                         // Clear RepoGroup process cache
3746                         RepoGroup::singleton()->clearCache( $this );
3747                         RepoGroup::singleton()->clearCache( $nt ); # clear false negative cache
3748                 }
3749
3750                 $dbw->begin( __METHOD__ ); # If $file was a LocalFile, its transaction would have closed our own.
3751                 $pageid = $this->getArticleID( self::GAID_FOR_UPDATE );
3752                 $protected = $this->isProtected();
3753
3754                 // Do the actual move
3755                 $this->moveToInternal( $nt, $reason, $createRedirect );
3756
3757                 // Refresh the sortkey for this row.  Be careful to avoid resetting
3758                 // cl_timestamp, which may disturb time-based lists on some sites.
3759                 $prefixes = $dbw->select(
3760                         'categorylinks',
3761                         array( 'cl_sortkey_prefix', 'cl_to' ),
3762                         array( 'cl_from' => $pageid ),
3763                         __METHOD__
3764                 );
3765                 foreach ( $prefixes as $prefixRow ) {
3766                         $prefix = $prefixRow->cl_sortkey_prefix;
3767                         $catTo = $prefixRow->cl_to;
3768                         $dbw->update( 'categorylinks',
3769                                 array(
3770                                         'cl_sortkey' => Collation::singleton()->getSortKey(
3771                                                 $nt->getCategorySortkey( $prefix ) ),
3772                                         'cl_timestamp=cl_timestamp' ),
3773                                 array(
3774                                         'cl_from' => $pageid,
3775                                         'cl_to' => $catTo ),
3776                                 __METHOD__
3777                         );
3778                 }
3779
3780                 $redirid = $this->getArticleID();
3781
3782                 if ( $protected ) {
3783                         # Protect the redirect title as the title used to be...
3784                         $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3785                                 array(
3786                                         'pr_page' => $redirid,
3787                                         'pr_type' => 'pr_type',
3788                                         'pr_level' => 'pr_level',
3789                                         'pr_cascade' => 'pr_cascade',
3790                                         'pr_user' => 'pr_user',
3791                                         'pr_expiry' => 'pr_expiry'
3792                                 ),
3793                                 array( 'pr_page' => $pageid ),
3794                                 __METHOD__,
3795                                 array( 'IGNORE' )
3796                         );
3797                         # Update the protection log
3798                         $log = new LogPage( 'protect' );
3799                         $comment = wfMessage(
3800                                 'prot_1movedto2',
3801                                 $this->getPrefixedText(),
3802                                 $nt->getPrefixedText()
3803                         )->inContentLanguage()->text();
3804                         if ( $reason ) {
3805                                 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3806                         }
3807                         // @todo FIXME: $params?
3808                         $logId = $log->addEntry(
3809                                 'move_prot',
3810                                 $nt,
3811                                 $comment,
3812                                 array( $this->getPrefixedText() ),
3813                                 $wgUser
3814                         );
3815
3816                         // reread inserted pr_ids for log relation
3817                         $insertedPrIds = $dbw->select(
3818                                 'page_restrictions',
3819                                 'pr_id',
3820                                 array( 'pr_page' => $redirid ),
3821                                 __METHOD__
3822                         );
3823                         $logRelationsValues = array();
3824                         foreach ( $insertedPrIds as $prid ) {
3825                                 $logRelationsValues[] = $prid->pr_id;
3826                         }
3827                         $log->addRelations( 'pr_id', $logRelationsValues, $logId );
3828                 }
3829
3830                 // Update *_from_namespace fields as needed
3831                 if ( $this->getNamespace() != $nt->getNamespace() ) {
3832                         $dbw->update( 'pagelinks',
3833                                 array( 'pl_from_namespace' => $nt->getNamespace() ),
3834                                 array( 'pl_from' => $pageid ),
3835                                 __METHOD__
3836                         );
3837                         $dbw->update( 'templatelinks',
3838                                 array( 'tl_from_namespace' => $nt->getNamespace() ),
3839                                 array( 'tl_from' => $pageid ),
3840                                 __METHOD__
3841                         );
3842                         $dbw->update( 'imagelinks',
3843                                 array( 'il_from_namespace' => $nt->getNamespace() ),
3844                                 array( 'il_from' => $pageid ),
3845                                 __METHOD__
3846                         );
3847                 }
3848
3849                 # Update watchlists
3850                 $oldtitle = $this->getDBkey();
3851                 $newtitle = $nt->getDBkey();
3852                 $oldsnamespace = MWNamespace::getSubject( $this->getNamespace() );
3853                 $newsnamespace = MWNamespace::getSubject( $nt->getNamespace() );
3854                 if ( $oldsnamespace != $newsnamespace || $oldtitle != $newtitle ) {
3855                         WatchedItem::duplicateEntries( $this, $nt );
3856                 }
3857
3858                 $dbw->commit( __METHOD__ );
3859
3860                 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid, $reason ) );
3861                 return true;
3862         }
3863
3864         /**
3865          * Move page to a title which is either a redirect to the
3866          * source page or nonexistent
3867          *
3868          * @param Title $nt The page to move to, which should be a redirect or nonexistent
3869          * @param string $reason The reason for the move
3870          * @param bool $createRedirect Whether to leave a redirect at the old title. Does not check
3871          *   if the user has the suppressredirect right
3872          * @throws MWException
3873          */
3874         private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3875                 global $wgUser, $wgContLang;
3876
3877                 if ( $nt->exists() ) {
3878                         $moveOverRedirect = true;
3879                         $logType = 'move_redir';
3880                 } else {
3881                         $moveOverRedirect = false;
3882                         $logType = 'move';
3883                 }
3884
3885                 if ( $createRedirect ) {
3886                         if ( $this->getNamespace() == NS_CATEGORY
3887                                 && !wfMessage( 'category-move-redirect-override' )->inContentLanguage()->isDisabled()
3888                         ) {
3889                                 $redirectContent = new WikitextContent(
3890                                         wfMessage( 'category-move-redirect-override' )
3891                                                 ->params( $nt->getPrefixedText() )->inContentLanguage()->plain() );
3892                         } else {
3893                                 $contentHandler = ContentHandler::getForTitle( $this );
3894                                 $redirectContent = $contentHandler->makeRedirectContent( $nt,
3895                                         wfMessage( 'move-redirect-text' )->inContentLanguage()->plain() );
3896                         }
3897
3898                         // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
3899                 } else {
3900                         $redirectContent = null;
3901                 }
3902
3903                 $logEntry = new ManualLogEntry( 'move', $logType );
3904                 $logEntry->setPerformer( $wgUser );
3905                 $logEntry->setTarget( $this );
3906                 $logEntry->setComment( $reason );
3907                 $logEntry->setParameters( array(
3908                         '4::target' => $nt->getPrefixedText(),
3909                         '5::noredir' => $redirectContent ? '0': '1',
3910                 ) );
3911
3912                 $formatter = LogFormatter::newFromEntry( $logEntry );
3913                 $formatter->setContext( RequestContext::newExtraneousContext( $this ) );
3914                 $comment = $formatter->getPlainActionText();
3915                 if ( $reason ) {
3916                         $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3917                 }
3918                 # Truncate for whole multibyte characters.
3919                 $comment = $wgContLang->truncate( $comment, 255 );
3920
3921                 $oldid = $this->getArticleID();
3922
3923                 $dbw = wfGetDB( DB_MASTER );
3924
3925                 $newpage = WikiPage::factory( $nt );
3926
3927                 if ( $moveOverRedirect ) {
3928                         $newid = $nt->getArticleID();
3929                         $newcontent = $newpage->getContent();
3930
3931                         # Delete the old redirect. We don't save it to history since
3932                         # by definition if we've got here it's rather uninteresting.
3933                         # We have to remove it so that the next step doesn't trigger
3934                         # a conflict on the unique namespace+title index...
3935                         $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ );
3936
3937                         $newpage->doDeleteUpdates( $newid, $newcontent );
3938                 }
3939
3940                 # Save a null revision in the page's history notifying of the move
3941                 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true, $wgUser );
3942                 if ( !is_object( $nullRevision ) ) {
3943                         throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
3944                 }
3945
3946                 $nullRevision->insertOn( $dbw );
3947
3948                 # Change the name of the target page:
3949                 $dbw->update( 'page',
3950                         /* SET */ array(
3951                                 'page_namespace' => $nt->getNamespace(),
3952                                 'page_title' => $nt->getDBkey(),
3953                         ),
3954                         /* WHERE */ array( 'page_id' => $oldid ),
3955                         __METHOD__
3956                 );
3957
3958                 // clean up the old title before reset article id - bug 45348
3959                 if ( !$redirectContent ) {
3960                         WikiPage::onArticleDelete( $this );
3961                 }
3962
3963                 $this->resetArticleID( 0 ); // 0 == non existing
3964                 $nt->resetArticleID( $oldid );
3965                 $newpage->loadPageData( WikiPage::READ_LOCKING ); // bug 46397
3966
3967                 $newpage->updateRevisionOn( $dbw, $nullRevision );
3968
3969                 wfRunHooks( 'NewRevisionFromEditComplete',
3970                         array( $newpage, $nullRevision, $nullRevision->getParentId(), $wgUser ) );
3971
3972                 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3973
3974                 if ( !$moveOverRedirect ) {
3975                         WikiPage::onArticleCreate( $nt );
3976                 }
3977
3978                 # Recreate the redirect, this time in the other direction.
3979                 if ( $redirectContent ) {
3980                         $redirectArticle = WikiPage::factory( $this );
3981                         $redirectArticle->loadFromRow( false, WikiPage::READ_LOCKING ); // bug 46397
3982                         $newid = $redirectArticle->insertOn( $dbw );
3983                         if ( $newid ) { // sanity
3984                                 $this->resetArticleID( $newid );
3985                                 $redirectRevision = new Revision( array(
3986                                         'title' => $this, // for determining the default content model
3987                                         'page' => $newid,
3988                                         'user_text' => $wgUser->getName(),
3989                                         'user' => $wgUser->getId(),
3990                                         'comment' => $comment,
3991                                         'content' => $redirectContent ) );
3992                                 $redirectRevision->insertOn( $dbw );
3993                                 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3994
3995                                 wfRunHooks( 'NewRevisionFromEditComplete',
3996                                         array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3997
3998                                 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3999                         }
4000                 }
4001
4002                 # Log the move
4003                 $logid = $logEntry->insert();
4004                 $logEntry->publish( $logid );
4005         }
4006
4007         /**
4008          * Move this page's subpages to be subpages of $nt
4009          *
4010          * @param Title $nt Move target
4011          * @param bool $auth Whether $wgUser's permissions should be checked
4012          * @param string $reason The reason for the move
4013          * @param bool $createRedirect Whether to create redirects from the old subpages to
4014          *     the new ones Ignored if the user doesn't have the 'suppressredirect' right
4015          * @return array Array with old page titles as keys, and strings (new page titles) or
4016          *     arrays (errors) as values, or an error array with numeric indices if no pages
4017          *     were moved
4018          */
4019         public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
4020                 global $wgMaximumMovedPages;
4021                 // Check permissions
4022                 if ( !$this->userCan( 'move-subpages' ) ) {
4023                         return array( 'cant-move-subpages' );
4024                 }
4025                 // Do the source and target namespaces support subpages?
4026                 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
4027                         return array( 'namespace-nosubpages',
4028                                 MWNamespace::getCanonicalName( $this->getNamespace() ) );
4029                 }
4030                 if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) {
4031                         return array( 'namespace-nosubpages',
4032                                 MWNamespace::getCanonicalName( $nt->getNamespace() ) );
4033                 }
4034
4035                 $subpages = $this->getSubpages( $wgMaximumMovedPages + 1 );
4036                 $retval = array();
4037                 $count = 0;
4038                 foreach ( $subpages as $oldSubpage ) {
4039                         $count++;
4040                         if ( $count > $wgMaximumMovedPages ) {
4041                                 $retval[$oldSubpage->getPrefixedText()] =
4042                                                 array( 'movepage-max-pages',
4043                                                         $wgMaximumMovedPages );
4044                                 break;
4045                         }
4046
4047                         // We don't know whether this function was called before
4048                         // or after moving the root page, so check both
4049                         // $this and $nt
4050                         if ( $oldSubpage->getArticleID() == $this->getArticleID()
4051                                 || $oldSubpage->getArticleID() == $nt->getArticleID()
4052                         ) {
4053                                 // When moving a page to a subpage of itself,
4054                                 // don't move it twice
4055                                 continue;
4056                         }
4057                         $newPageName = preg_replace(
4058                                         '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
4059                                         StringUtils::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
4060                                         $oldSubpage->getDBkey() );
4061                         if ( $oldSubpage->isTalkPage() ) {
4062                                 $newNs = $nt->getTalkPage()->getNamespace();
4063                         } else {
4064                                 $newNs = $nt->getSubjectPage()->getNamespace();
4065                         }
4066                         # Bug 14385: we need makeTitleSafe because the new page names may
4067                         # be longer than 255 characters.
4068                         $newSubpage = Title::makeTitleSafe( $newNs, $newPageName );
4069
4070                         $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
4071                         if ( $success === true ) {
4072                                 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
4073                         } else {
4074                                 $retval[$oldSubpage->getPrefixedText()] = $success;
4075                         }
4076                 }
4077                 return $retval;
4078         }
4079
4080         /**
4081          * Checks if this page is just a one-rev redirect.
4082          * Adds lock, so don't use just for light purposes.
4083          *
4084          * @return bool
4085          */
4086         public function isSingleRevRedirect() {
4087                 global $wgContentHandlerUseDB;
4088
4089                 $dbw = wfGetDB( DB_MASTER );
4090
4091                 # Is it a redirect?
4092                 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
4093                 if ( $wgContentHandlerUseDB ) {
4094                         $fields[] = 'page_content_model';
4095                 }
4096
4097                 $row = $dbw->selectRow( 'page',
4098                         $fields,
4099                         $this->pageCond(),
4100                         __METHOD__,
4101                         array( 'FOR UPDATE' )
4102                 );
4103                 # Cache some fields we may want
4104                 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
4105                 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
4106                 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
4107                 $this->mContentModel = $row && isset( $row->page_content_model )
4108                         ? strval( $row->page_content_model )
4109                         : false;
4110
4111                 if ( !$this->mRedirect ) {
4112                         return false;
4113                 }
4114                 # Does the article have a history?
4115                 $row = $dbw->selectField( array( 'page', 'revision' ),
4116                         'rev_id',
4117                         array( 'page_namespace' => $this->getNamespace(),
4118                                 'page_title' => $this->getDBkey(),
4119                                 'page_id=rev_page',
4120                                 'page_latest != rev_id'
4121                         ),
4122                         __METHOD__,
4123                         array( 'FOR UPDATE' )
4124                 );
4125                 # Return true if there was no history
4126                 return ( $row === false );
4127         }
4128
4129         /**
4130          * Checks if $this can be moved to a given Title
4131          * - Selects for update, so don't call it unless you mean business
4132          *
4133          * @param Title $nt The new title to check
4134          * @return bool
4135          */
4136         public function isValidMoveTarget( $nt ) {
4137                 # Is it an existing file?
4138                 if ( $nt->getNamespace() == NS_FILE ) {
4139                         $file = wfLocalFile( $nt );
4140                         if ( $file->exists() ) {
4141                                 wfDebug( __METHOD__ . ": file exists\n" );
4142                                 return false;
4143                         }
4144                 }
4145                 # Is it a redirect with no history?
4146                 if ( !$nt->isSingleRevRedirect() ) {
4147                         wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
4148                         return false;
4149                 }
4150                 # Get the article text
4151                 $rev = Revision::newFromTitle( $nt, false, Revision::READ_LATEST );
4152                 if ( !is_object( $rev ) ) {
4153                         return false;
4154                 }
4155                 $content = $rev->getContent();
4156                 # Does the redirect point to the source?
4157                 # Or is it a broken self-redirect, usually caused by namespace collisions?
4158                 $redirTitle = $content ? $content->getRedirectTarget() : null;
4159
4160                 if ( $redirTitle ) {
4161                         if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
4162                                 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
4163                                 wfDebug( __METHOD__ . ": redirect points to other page\n" );
4164                                 return false;
4165                         } else {
4166                                 return true;
4167                         }
4168                 } else {
4169                         # Fail safe (not a redirect after all. strange.)
4170                         wfDebug( __METHOD__ . ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4171                                                 " is a redirect, but it doesn't contain a valid redirect.\n" );
4172                         return false;
4173                 }
4174         }
4175
4176         /**
4177          * Get categories to which this Title belongs and return an array of
4178          * categories' names.
4179          *
4180          * @return array Array of parents in the form:
4181          *        $parent => $currentarticle
4182          */
4183         public function getParentCategories() {
4184                 global $wgContLang;
4185
4186                 $data = array();
4187
4188                 $titleKey = $this->getArticleID();
4189
4190                 if ( $titleKey === 0 ) {
4191                         return $data;
4192                 }
4193
4194                 $dbr = wfGetDB( DB_SLAVE );
4195
4196                 $res = $dbr->select(
4197                         'categorylinks',
4198                         'cl_to',
4199                         array( 'cl_from' => $titleKey ),
4200                         __METHOD__
4201                 );
4202
4203                 if ( $res->numRows() > 0 ) {
4204                         foreach ( $res as $row ) {
4205                                 // $data[] = Title::newFromText($wgContLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
4206                                 $data[$wgContLang->getNsText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText();
4207                         }
4208                 }
4209                 return $data;
4210         }
4211
4212         /**
4213          * Get a tree of parent categories
4214          *
4215          * @param array $children Array with the children in the keys, to check for circular refs
4216          * @return array Tree of parent categories
4217          */
4218         public function getParentCategoryTree( $children = array() ) {
4219                 $stack = array();
4220                 $parents = $this->getParentCategories();
4221
4222                 if ( $parents ) {
4223                         foreach ( $parents as $parent => $current ) {
4224                                 if ( array_key_exists( $parent, $children ) ) {
4225                                         # Circular reference
4226                                         $stack[$parent] = array();
4227                                 } else {
4228                                         $nt = Title::newFromText( $parent );
4229                                         if ( $nt ) {
4230                                                 $stack[$parent] = $nt->getParentCategoryTree( $children + array( $parent => 1 ) );
4231                                         }
4232                                 }
4233                         }
4234                 }
4235
4236                 return $stack;
4237         }
4238
4239         /**
4240          * Get an associative array for selecting this title from
4241          * the "page" table
4242          *
4243          * @return array Array suitable for the $where parameter of DB::select()
4244          */
4245         public function pageCond() {
4246                 if ( $this->mArticleID > 0 ) {
4247                         // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4248                         return array( 'page_id' => $this->mArticleID );
4249                 } else {
4250                         return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
4251                 }
4252         }
4253
4254         /**
4255          * Get the revision ID of the previous revision
4256          *
4257          * @param int $revId Revision ID. Get the revision that was before this one.
4258          * @param int $flags Title::GAID_FOR_UPDATE
4259          * @return int|bool Old revision ID, or false if none exists
4260          */
4261         public function getPreviousRevisionID( $revId, $flags = 0 ) {
4262                 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4263                 $revId = $db->selectField( 'revision', 'rev_id',
4264                         array(
4265                                 'rev_page' => $this->getArticleID( $flags ),
4266                                 'rev_id < ' . intval( $revId )
4267                         ),
4268                         __METHOD__,
4269                         array( 'ORDER BY' => 'rev_id DESC' )
4270                 );
4271
4272                 if ( $revId === false ) {
4273                         return false;
4274                 } else {
4275                         return intval( $revId );
4276                 }
4277         }
4278
4279         /**
4280          * Get the revision ID of the next revision
4281          *
4282          * @param int $revId Revision ID. Get the revision that was after this one.
4283          * @param int $flags Title::GAID_FOR_UPDATE
4284          * @return int|bool Next revision ID, or false if none exists
4285          */
4286         public function getNextRevisionID( $revId, $flags = 0 ) {
4287                 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4288                 $revId = $db->selectField( 'revision', 'rev_id',
4289                         array(
4290                                 'rev_page' => $this->getArticleID( $flags ),
4291                                 'rev_id > ' . intval( $revId )
4292                         ),
4293                         __METHOD__,
4294                         array( 'ORDER BY' => 'rev_id' )
4295                 );
4296
4297                 if ( $revId === false ) {
4298                         return false;
4299                 } else {
4300                         return intval( $revId );
4301                 }
4302         }
4303
4304         /**
4305          * Get the first revision of the page
4306          *
4307          * @param int $flags Title::GAID_FOR_UPDATE
4308          * @return Revision|null If page doesn't exist
4309          */
4310         public function getFirstRevision( $flags = 0 ) {
4311                 $pageId = $this->getArticleID( $flags );
4312                 if ( $pageId ) {
4313                         $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4314                         $row = $db->selectRow( 'revision', Revision::selectFields(),
4315                                 array( 'rev_page' => $pageId ),
4316                                 __METHOD__,
4317                                 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
4318                         );
4319                         if ( $row ) {
4320                                 return new Revision( $row );
4321                         }
4322                 }
4323                 return null;
4324         }
4325
4326         /**
4327          * Get the oldest revision timestamp of this page
4328          *
4329          * @param int $flags Title::GAID_FOR_UPDATE
4330          * @return string MW timestamp
4331          */
4332         public function getEarliestRevTime( $flags = 0 ) {
4333                 $rev = $this->getFirstRevision( $flags );
4334                 return $rev ? $rev->getTimestamp() : null;
4335         }
4336
4337         /**
4338          * Check if this is a new page
4339          *
4340          * @return bool
4341          */
4342         public function isNewPage() {
4343                 $dbr = wfGetDB( DB_SLAVE );
4344                 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
4345         }
4346
4347         /**
4348          * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4349          *
4350          * @return bool
4351          */
4352         public function isBigDeletion() {
4353                 global $wgDeleteRevisionsLimit;
4354
4355                 if ( !$wgDeleteRevisionsLimit ) {
4356                         return false;
4357                 }
4358
4359                 $revCount = $this->estimateRevisionCount();
4360                 return $revCount > $wgDeleteRevisionsLimit;
4361         }
4362
4363         /**
4364          * Get the  approximate revision count of this page.
4365          *
4366          * @return int
4367          */
4368         public function estimateRevisionCount() {
4369                 if ( !$this->exists() ) {
4370                         return 0;
4371                 }
4372
4373                 if ( $this->mEstimateRevisions === null ) {
4374                         $dbr = wfGetDB( DB_SLAVE );
4375                         $this->mEstimateRevisions = $dbr->estimateRowCount( 'revision', '*',
4376                                 array( 'rev_page' => $this->getArticleID() ), __METHOD__ );
4377                 }
4378
4379                 return $this->mEstimateRevisions;
4380         }
4381
4382         /**
4383          * Get the number of revisions between the given revision.
4384          * Used for diffs and other things that really need it.
4385          *
4386          * @param int|Revision $old Old revision or rev ID (first before range)
4387          * @param int|Revision $new New revision or rev ID (first after range)
4388          * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4389          * @return int Number of revisions between these revisions.
4390          */
4391         public function countRevisionsBetween( $old, $new, $max = null ) {
4392                 if ( !( $old instanceof Revision ) ) {
4393                         $old = Revision::newFromTitle( $this, (int)$old );
4394                 }
4395                 if ( !( $new instanceof Revision ) ) {
4396                         $new = Revision::newFromTitle( $this, (int)$new );
4397                 }
4398                 if ( !$old || !$new ) {
4399                         return 0; // nothing to compare
4400                 }
4401                 $dbr = wfGetDB( DB_SLAVE );
4402                 $conds = array(
4403                         'rev_page' => $this->getArticleID(),
4404                         'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4405                         'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4406                 );
4407                 if ( $max !== null ) {
4408                         $res = $dbr->select( 'revision', '1',
4409                                 $conds,
4410                                 __METHOD__,
4411                                 array( 'LIMIT' => $max + 1 ) // extra to detect truncation
4412                         );
4413                         return $res->numRows();
4414                 } else {
4415                         return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__ );
4416                 }
4417         }
4418
4419         /**
4420          * Get the authors between the given revisions or revision IDs.
4421          * Used for diffs and other things that really need it.
4422          *
4423          * @since 1.23
4424          *
4425          * @param int|Revision $old Old revision or rev ID (first before range by default)
4426          * @param int|Revision $new New revision or rev ID (first after range by default)
4427          * @param int $limit Maximum number of authors
4428          * @param string|array $options (Optional): Single option, or an array of options:
4429          *     'include_old' Include $old in the range; $new is excluded.
4430          *     'include_new' Include $new in the range; $old is excluded.
4431          *     'include_both' Include both $old and $new in the range.
4432          *     Unknown option values are ignored.
4433          * @return array|null Names of revision authors in the range; null if not both revisions exist
4434          */
4435         public function getAuthorsBetween( $old, $new, $limit, $options = array() ) {
4436                 if ( !( $old instanceof Revision ) ) {
4437                         $old = Revision::newFromTitle( $this, (int)$old );
4438                 }
4439                 if ( !( $new instanceof Revision ) ) {
4440                         $new = Revision::newFromTitle( $this, (int)$new );
4441                 }
4442                 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4443                 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4444                 // in the sanity check below?
4445                 if ( !$old || !$new ) {
4446                         return null; // nothing to compare
4447                 }
4448                 $authors = array();
4449                 $old_cmp = '>';
4450                 $new_cmp = '<';
4451                 $options = (array)$options;
4452                 if ( in_array( 'include_old', $options ) ) {
4453                         $old_cmp = '>=';
4454                 }
4455                 if ( in_array( 'include_new', $options ) ) {
4456                         $new_cmp = '<=';
4457                 }
4458                 if ( in_array( 'include_both', $options ) ) {
4459                         $old_cmp = '>=';
4460                         $new_cmp = '<=';
4461                 }
4462                 // No DB query needed if $old and $new are the same or successive revisions:
4463                 if ( $old->getId() === $new->getId() ) {
4464                         return ( $old_cmp === '>' && $new_cmp === '<' ) ? array() : array( $old->getRawUserText() );
4465                 } elseif ( $old->getId() === $new->getParentId() ) {
4466                         if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4467                                 $authors[] = $old->getRawUserText();
4468                                 if ( $old->getRawUserText() != $new->getRawUserText() ) {
4469                                         $authors[] = $new->getRawUserText();
4470                                 }
4471                         } elseif ( $old_cmp === '>=' ) {
4472                                 $authors[] = $old->getRawUserText();
4473                         } elseif ( $new_cmp === '<=' ) {
4474                                 $authors[] = $new->getRawUserText();
4475                         }
4476                         return $authors;
4477                 }
4478                 $dbr = wfGetDB( DB_SLAVE );
4479                 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4480                         array(
4481                                 'rev_page' => $this->getArticleID(),
4482                                 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4483                                 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4484                         ), __METHOD__,
4485                         array( 'LIMIT' => $limit + 1 ) // add one so caller knows it was truncated
4486                 );
4487                 foreach ( $res as $row ) {
4488                         $authors[] = $row->rev_user_text;
4489                 }
4490                 return $authors;
4491         }
4492
4493         /**
4494          * Get the number of authors between the given revisions or revision IDs.
4495          * Used for diffs and other things that really need it.
4496          *
4497          * @param int|Revision $old Old revision or rev ID (first before range by default)
4498          * @param int|Revision $new New revision or rev ID (first after range by default)
4499          * @param int $limit Maximum number of authors
4500          * @param string|array $options (Optional): Single option, or an array of options:
4501          *     'include_old' Include $old in the range; $new is excluded.
4502          *     'include_new' Include $new in the range; $old is excluded.
4503          *     'include_both' Include both $old and $new in the range.
4504          *     Unknown option values are ignored.
4505          * @return int Number of revision authors in the range; zero if not both revisions exist
4506          */
4507         public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4508                 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4509                 return $authors ? count( $authors ) : 0;
4510         }
4511
4512         /**
4513          * Compare with another title.
4514          *
4515          * @param Title $title
4516          * @return bool
4517          */
4518         public function equals( Title $title ) {
4519                 // Note: === is necessary for proper matching of number-like titles.
4520                 return $this->getInterwiki() === $title->getInterwiki()
4521                         && $this->getNamespace() == $title->getNamespace()
4522                         && $this->getDBkey() === $title->getDBkey();
4523         }
4524
4525         /**
4526          * Check if this title is a subpage of another title
4527          *
4528          * @param Title $title
4529          * @return bool
4530          */
4531         public function isSubpageOf( Title $title ) {
4532                 return $this->getInterwiki() === $title->getInterwiki()
4533                         && $this->getNamespace() == $title->getNamespace()
4534                         && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4535         }
4536
4537         /**
4538          * Check if page exists.  For historical reasons, this function simply
4539          * checks for the existence of the title in the page table, and will
4540          * thus return false for interwiki links, special pages and the like.
4541          * If you want to know if a title can be meaningfully viewed, you should
4542          * probably call the isKnown() method instead.
4543          *
4544          * @return bool
4545          */
4546         public function exists() {
4547                 return $this->getArticleID() != 0;
4548         }
4549
4550         /**
4551          * Should links to this title be shown as potentially viewable (i.e. as
4552          * "bluelinks"), even if there's no record by this title in the page
4553          * table?
4554          *
4555          * This function is semi-deprecated for public use, as well as somewhat
4556          * misleadingly named.  You probably just want to call isKnown(), which
4557          * calls this function internally.
4558          *
4559          * (ISSUE: Most of these checks are cheap, but the file existence check
4560          * can potentially be quite expensive.  Including it here fixes a lot of
4561          * existing code, but we might want to add an optional parameter to skip
4562          * it and any other expensive checks.)
4563          *
4564          * @return bool
4565          */
4566         public function isAlwaysKnown() {
4567                 $isKnown = null;
4568
4569                 /**
4570                  * Allows overriding default behavior for determining if a page exists.
4571                  * If $isKnown is kept as null, regular checks happen. If it's
4572                  * a boolean, this value is returned by the isKnown method.
4573                  *
4574                  * @since 1.20
4575                  *
4576                  * @param Title $title
4577                  * @param bool|null $isKnown
4578                  */
4579                 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4580
4581                 if ( !is_null( $isKnown ) ) {
4582                         return $isKnown;
4583                 }
4584
4585                 if ( $this->isExternal() ) {
4586                         return true;  // any interwiki link might be viewable, for all we know
4587                 }
4588
4589                 switch ( $this->mNamespace ) {
4590                         case NS_MEDIA:
4591                         case NS_FILE:
4592                                 // file exists, possibly in a foreign repo
4593                                 return (bool)wfFindFile( $this );
4594                         case NS_SPECIAL:
4595                                 // valid special page
4596                                 return SpecialPageFactory::exists( $this->getDBkey() );
4597                         case NS_MAIN:
4598                                 // selflink, possibly with fragment
4599                                 return $this->mDbkeyform == '';
4600                         case NS_MEDIAWIKI:
4601                                 // known system message
4602                                 return $this->hasSourceText() !== false;
4603                         default:
4604                                 return false;
4605                 }
4606         }
4607
4608         /**
4609          * Does this title refer to a page that can (or might) be meaningfully
4610          * viewed?  In particular, this function may be used to determine if
4611          * links to the title should be rendered as "bluelinks" (as opposed to
4612          * "redlinks" to non-existent pages).
4613          * Adding something else to this function will cause inconsistency
4614          * since LinkHolderArray calls isAlwaysKnown() and does its own
4615          * page existence check.
4616          *
4617          * @return bool
4618          */
4619         public function isKnown() {
4620                 return $this->isAlwaysKnown() || $this->exists();
4621         }
4622
4623         /**
4624          * Does this page have source text?
4625          *
4626          * @return bool
4627          */
4628         public function hasSourceText() {
4629                 if ( $this->exists() ) {
4630                         return true;
4631                 }
4632
4633                 if ( $this->mNamespace == NS_MEDIAWIKI ) {
4634                         // If the page doesn't exist but is a known system message, default
4635                         // message content will be displayed, same for language subpages-
4636                         // Use always content language to avoid loading hundreds of languages
4637                         // to get the link color.
4638                         global $wgContLang;
4639                         list( $name, ) = MessageCache::singleton()->figureMessage(
4640                                 $wgContLang->lcfirst( $this->getText() )
4641                         );
4642                         $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4643                         return $message->exists();
4644                 }
4645
4646                 return false;
4647         }
4648
4649         /**
4650          * Get the default message text or false if the message doesn't exist
4651          *
4652          * @return string|bool
4653          */
4654         public function getDefaultMessageText() {
4655                 global $wgContLang;
4656
4657                 if ( $this->getNamespace() != NS_MEDIAWIKI ) { // Just in case
4658                         return false;
4659                 }
4660
4661                 list( $name, $lang ) = MessageCache::singleton()->figureMessage(
4662                         $wgContLang->lcfirst( $this->getText() )
4663                 );
4664                 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4665
4666                 if ( $message->exists() ) {
4667                         return $message->plain();
4668                 } else {
4669                         return false;
4670                 }
4671         }
4672
4673         /**
4674          * Updates page_touched for this page; called from LinksUpdate.php
4675          *
4676          * @return bool True if the update succeeded
4677          */
4678         public function invalidateCache() {
4679                 if ( wfReadOnly() ) {
4680                         return false;
4681                 }
4682
4683                 if ( $this->mArticleID === 0 ) {
4684                         return true; // avoid gap locking if we know it's not there
4685                 }
4686
4687                 $method = __METHOD__;
4688                 $dbw = wfGetDB( DB_MASTER );
4689                 $conds = $this->pageCond();
4690                 $dbw->onTransactionIdle( function () use ( $dbw, $conds, $method ) {
4691                         $dbw->update(
4692                                 'page',
4693                                 array( 'page_touched' => $dbw->timestamp() ),
4694                                 $conds,
4695                                 $method
4696                         );
4697                 } );
4698
4699                 return true;
4700         }
4701
4702         /**
4703          * Update page_touched timestamps and send squid purge messages for
4704          * pages linking to this title. May be sent to the job queue depending
4705          * on the number of links. Typically called on create and delete.
4706          */
4707         public function touchLinks() {
4708                 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4709                 $u->doUpdate();
4710
4711                 if ( $this->getNamespace() == NS_CATEGORY ) {
4712                         $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4713                         $u->doUpdate();
4714                 }
4715         }
4716
4717         /**
4718          * Get the last touched timestamp
4719          *
4720          * @param DatabaseBase $db Optional db
4721          * @return string Last-touched timestamp
4722          */
4723         public function getTouched( $db = null ) {
4724                 if ( $db === null ) {
4725                         $db = wfGetDB( DB_SLAVE );
4726                 }
4727                 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
4728                 return $touched;
4729         }
4730
4731         /**
4732          * Get the timestamp when this page was updated since the user last saw it.
4733          *
4734          * @param User $user
4735          * @return string|null
4736          */
4737         public function getNotificationTimestamp( $user = null ) {
4738                 global $wgUser, $wgShowUpdatedMarker;
4739                 // Assume current user if none given
4740                 if ( !$user ) {
4741                         $user = $wgUser;
4742                 }
4743                 // Check cache first
4744                 $uid = $user->getId();
4745                 // avoid isset here, as it'll return false for null entries
4746                 if ( array_key_exists( $uid, $this->mNotificationTimestamp ) ) {
4747                         return $this->mNotificationTimestamp[$uid];
4748                 }
4749                 if ( !$uid || !$wgShowUpdatedMarker || !$user->isAllowed( 'viewmywatchlist' ) ) {
4750                         $this->mNotificationTimestamp[$uid] = false;
4751                         return $this->mNotificationTimestamp[$uid];
4752                 }
4753                 // Don't cache too much!
4754                 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
4755                         $this->mNotificationTimestamp = array();
4756                 }
4757                 $dbr = wfGetDB( DB_SLAVE );
4758                 $this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
4759                         'wl_notificationtimestamp',
4760                         array(
4761                                 'wl_user' => $user->getId(),
4762                                 'wl_namespace' => $this->getNamespace(),
4763                                 'wl_title' => $this->getDBkey(),
4764                         ),
4765                         __METHOD__
4766                 );
4767                 return $this->mNotificationTimestamp[$uid];
4768         }
4769
4770         /**
4771          * Generate strings used for xml 'id' names in monobook tabs
4772          *
4773          * @param string $prepend Defaults to 'nstab-'
4774          * @return string XML 'id' name
4775          */
4776         public function getNamespaceKey( $prepend = 'nstab-' ) {
4777                 global $wgContLang;
4778                 // Gets the subject namespace if this title
4779                 $namespace = MWNamespace::getSubject( $this->getNamespace() );
4780                 // Checks if canonical namespace name exists for namespace
4781                 if ( MWNamespace::exists( $this->getNamespace() ) ) {
4782                         // Uses canonical namespace name
4783                         $namespaceKey = MWNamespace::getCanonicalName( $namespace );
4784                 } else {
4785                         // Uses text of namespace
4786                         $namespaceKey = $this->getSubjectNsText();
4787                 }
4788                 // Makes namespace key lowercase
4789                 $namespaceKey = $wgContLang->lc( $namespaceKey );
4790                 // Uses main
4791                 if ( $namespaceKey == '' ) {
4792                         $namespaceKey = 'main';
4793                 }
4794                 // Changes file to image for backwards compatibility
4795                 if ( $namespaceKey == 'file' ) {
4796                         $namespaceKey = 'image';
4797                 }
4798                 return $prepend . $namespaceKey;
4799         }
4800
4801         /**
4802          * Get all extant redirects to this Title
4803          *
4804          * @param int|null $ns Single namespace to consider; null to consider all namespaces
4805          * @return Title[] Array of Title redirects to this title
4806          */
4807         public function getRedirectsHere( $ns = null ) {
4808                 $redirs = array();
4809
4810                 $dbr = wfGetDB( DB_SLAVE );
4811                 $where = array(
4812                         'rd_namespace' => $this->getNamespace(),
4813                         'rd_title' => $this->getDBkey(),
4814                         'rd_from = page_id'
4815                 );
4816                 if ( $this->isExternal() ) {
4817                         $where['rd_interwiki'] = $this->getInterwiki();
4818                 } else {
4819                         $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4820                 }
4821                 if ( !is_null( $ns ) ) {
4822                         $where['page_namespace'] = $ns;
4823                 }
4824
4825                 $res = $dbr->select(
4826                         array( 'redirect', 'page' ),
4827                         array( 'page_namespace', 'page_title' ),
4828                         $where,
4829                         __METHOD__
4830                 );
4831
4832                 foreach ( $res as $row ) {
4833                         $redirs[] = self::newFromRow( $row );
4834                 }
4835                 return $redirs;
4836         }
4837
4838         /**
4839          * Check if this Title is a valid redirect target
4840          *
4841          * @return bool
4842          */
4843         public function isValidRedirectTarget() {
4844                 global $wgInvalidRedirectTargets;
4845
4846                 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4847                 if ( $this->isSpecial( 'Userlogout' ) ) {
4848                         return false;
4849                 }
4850
4851                 foreach ( $wgInvalidRedirectTargets as $target ) {
4852                         if ( $this->isSpecial( $target ) ) {
4853                                 return false;
4854                         }
4855                 }
4856
4857                 return true;
4858         }
4859
4860         /**
4861          * Get a backlink cache object
4862          *
4863          * @return BacklinkCache
4864          */
4865         public function getBacklinkCache() {
4866                 return BacklinkCache::get( $this );
4867         }
4868
4869         /**
4870          * Whether the magic words __INDEX__ and __NOINDEX__ function for  this page.
4871          *
4872          * @return bool
4873          */
4874         public function canUseNoindex() {
4875                 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4876
4877                 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4878                         ? $wgContentNamespaces
4879                         : $wgExemptFromUserRobotsControl;
4880
4881                 return !in_array( $this->mNamespace, $bannedNamespaces );
4882
4883         }
4884
4885         /**
4886          * Returns the raw sort key to be used for categories, with the specified
4887          * prefix.  This will be fed to Collation::getSortKey() to get a
4888          * binary sortkey that can be used for actual sorting.
4889          *
4890          * @param string $prefix The prefix to be used, specified using
4891          *   {{defaultsort:}} or like [[Category:Foo|prefix]].  Empty for no
4892          *   prefix.
4893          * @return string
4894          */
4895         public function getCategorySortkey( $prefix = '' ) {
4896                 $unprefixed = $this->getText();
4897
4898                 // Anything that uses this hook should only depend
4899                 // on the Title object passed in, and should probably
4900                 // tell the users to run updateCollations.php --force
4901                 // in order to re-sort existing category relations.
4902                 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4903                 if ( $prefix !== '' ) {
4904                         # Separate with a line feed, so the unprefixed part is only used as
4905                         # a tiebreaker when two pages have the exact same prefix.
4906                         # In UCA, tab is the only character that can sort above LF
4907                         # so we strip both of them from the original prefix.
4908                         $prefix = strtr( $prefix, "\n\t", '  ' );
4909                         return "$prefix\n$unprefixed";
4910                 }
4911                 return $unprefixed;
4912         }
4913
4914         /**
4915          * Get the language in which the content of this page is written in
4916          * wikitext. Defaults to $wgContLang, but in certain cases it can be
4917          * e.g. $wgLang (such as special pages, which are in the user language).
4918          *
4919          * @since 1.18
4920          * @return Language
4921          */
4922         public function getPageLanguage() {
4923                 global $wgLang, $wgLanguageCode;
4924                 wfProfileIn( __METHOD__ );
4925                 if ( $this->isSpecialPage() ) {
4926                         // special pages are in the user language
4927                         wfProfileOut( __METHOD__ );
4928                         return $wgLang;
4929                 }
4930
4931                 // Checking if DB language is set
4932                 if ( $this->mDbPageLanguage ) {
4933                         wfProfileOut( __METHOD__ );
4934                         return wfGetLangObj( $this->mDbPageLanguage );
4935                 }
4936
4937                 if ( !$this->mPageLanguage || $this->mPageLanguage[1] !== $wgLanguageCode ) {
4938                         // Note that this may depend on user settings, so the cache should
4939                         // be only per-request.
4940                         // NOTE: ContentHandler::getPageLanguage() may need to load the
4941                         // content to determine the page language!
4942                         // Checking $wgLanguageCode hasn't changed for the benefit of unit
4943                         // tests.
4944                         $contentHandler = ContentHandler::getForTitle( $this );
4945                         $langObj = wfGetLangObj( $contentHandler->getPageLanguage( $this ) );
4946                         $this->mPageLanguage = array( $langObj->getCode(), $wgLanguageCode );
4947                 } else {
4948                         $langObj = wfGetLangObj( $this->mPageLanguage[0] );
4949                 }
4950
4951                 wfProfileOut( __METHOD__ );
4952                 return $langObj;
4953         }
4954
4955         /**
4956          * Get the language in which the content of this page is written when
4957          * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4958          * e.g. $wgLang (such as special pages, which are in the user language).
4959          *
4960          * @since 1.20
4961          * @return Language
4962          */
4963         public function getPageViewLanguage() {
4964                 global $wgLang;
4965
4966                 if ( $this->isSpecialPage() ) {
4967                         // If the user chooses a variant, the content is actually
4968                         // in a language whose code is the variant code.
4969                         $variant = $wgLang->getPreferredVariant();
4970                         if ( $wgLang->getCode() !== $variant ) {
4971                                 return Language::factory( $variant );
4972                         }
4973
4974                         return $wgLang;
4975                 }
4976
4977                 // @note Can't be cached persistently, depends on user settings.
4978                 // @note ContentHandler::getPageViewLanguage() may need to load the
4979                 //   content to determine the page language!
4980                 $contentHandler = ContentHandler::getForTitle( $this );
4981                 $pageLang = $contentHandler->getPageViewLanguage( $this );
4982                 return $pageLang;
4983         }
4984
4985         /**
4986          * Get a list of rendered edit notices for this page.
4987          *
4988          * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4989          * they will already be wrapped in paragraphs.
4990          *
4991          * @since 1.21
4992          * @param int $oldid Revision ID that's being edited
4993          * @return array
4994          */
4995         public function getEditNotices( $oldid = 0 ) {
4996                 $notices = array();
4997
4998                 # Optional notices on a per-namespace and per-page basis
4999                 $editnotice_ns = 'editnotice-' . $this->getNamespace();
5000                 $editnotice_ns_message = wfMessage( $editnotice_ns );
5001                 if ( $editnotice_ns_message->exists() ) {
5002                         $notices[$editnotice_ns] = $editnotice_ns_message->parseAsBlock();
5003                 }
5004                 if ( MWNamespace::hasSubpages( $this->getNamespace() ) ) {
5005                         $parts = explode( '/', $this->getDBkey() );
5006                         $editnotice_base = $editnotice_ns;
5007                         while ( count( $parts ) > 0 ) {
5008                                 $editnotice_base .= '-' . array_shift( $parts );
5009                                 $editnotice_base_msg = wfMessage( $editnotice_base );
5010                                 if ( $editnotice_base_msg->exists() ) {
5011                                         $notices[$editnotice_base] = $editnotice_base_msg->parseAsBlock();
5012                                 }
5013                         }
5014                 } else {
5015                         # Even if there are no subpages in namespace, we still don't want / in MW ns.
5016                         $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->getDBkey() );
5017                         $editnoticeMsg = wfMessage( $editnoticeText );
5018                         if ( $editnoticeMsg->exists() ) {
5019                                 $notices[$editnoticeText] = $editnoticeMsg->parseAsBlock();
5020                         }
5021                 }
5022
5023                 wfRunHooks( 'TitleGetEditNotices', array( $this, $oldid, &$notices ) );
5024                 return $notices;
5025         }
5026 }