includes/Title.php

   1 <?php
   2 /**
   3  * See title.txt
   4  *
   5  * @package MediaWiki
   6  */
   7
   8 /** */
   9 require_once( 'normal/UtfNormal.php' );
  10
  11 define ( 'GAID_FOR_UPDATE', 1 );
  12
  13 # Title::newFromTitle maintains a cache to avoid
  14 # expensive re-normalization of commonly used titles.
  15 # On a batch operation this can become a memory leak
  16 # if not bounded. After hitting this many titles,
  17 # reset the cache.
  18 define( 'MW_TITLECACHE_MAX', 1000 );
  19
  20 /**
  21  * Title class
  22  * - Represents a title, which may contain an interwiki designation or namespace
  23  * - Can fetch various kinds of data from the database, albeit inefficiently.
  24  *
  25  * @package MediaWiki
  26  */
  27 class Title {
  28         /**
  29          * Static cache variables
  30          */
  31         static private $titleCache=array();
  32         static private $interwikiCache=array();
  33
  34
  35         /**
  36          * All member variables should be considered private
  37          * Please use the accessor functions
  38          */
  39
  40          /**#@+
  41          * @private
  42          */
  43
  44         var $mTextform;           # Text form (spaces not underscores) of the main part
  45         var $mUrlform;            # URL-encoded form of the main part
  46         var $mDbkeyform;          # Main part with underscores
  47         var $mNamespace;          # Namespace index, i.e. one of the NS_xxxx constants
  48         var $mInterwiki;          # Interwiki prefix (or null string)
  49         var $mFragment;           # Title fragment (i.e. the bit after the #)
  50         var $mArticleID;          # Article ID, fetched from the link cache on demand
  51         var $mLatestID;         # ID of most recent revision
  52         var $mRestrictions;       # Array of groups allowed to edit this article
  53                                 # Only null or "sysop" are supported
  54         var $mRestrictionsLoaded; # Boolean for initialisation on demand
  55         var $mPrefixedText;       # Text form including namespace/interwiki, initialised on demand
  56         var $mDefaultNamespace;   # Namespace index when there is no namespace
  57                             # Zero except in {{transclusion}} tags
  58         var $mWatched;      # Is $wgUser watching this page? NULL if unfilled, accessed through userIsWatching()
  59         /**#@-*/
  60
  61
  62         /**
  63          * Constructor
  64          * @private
  65          */
  66         /* private */ function Title() {
  67                 $this->mInterwiki = $this->mUrlform =
  68                 $this->mTextform = $this->mDbkeyform = '';
  69                 $this->mArticleID = -1;
  70                 $this->mNamespace = NS_MAIN;
  71                 $this->mRestrictionsLoaded = false;
  72                 $this->mRestrictions = array();
  73                 # Dont change the following, NS_MAIN is hardcoded in several place
  74                 # See bug #696
  75                 $this->mDefaultNamespace = NS_MAIN;
  76                 $this->mWatched = NULL;
  77                 $this->mLatestID = false;
  78         }
  79
  80         /**
  81          * Create a new Title from a prefixed DB key
  82          * @param string $key The database key, which has underscores
  83          *      instead of spaces, possibly including namespace and
  84          *      interwiki prefixes
  85          * @return Title the new object, or NULL on an error
  86          * @static
  87          * @access public
  88          */
  89         /* static */ function newFromDBkey( $key ) {
  90                 $t = new Title();
  91                 $t->mDbkeyform = $key;
  92                 if( $t->secureAndSplit() )
  93                         return $t;
  94                 else
  95                         return NULL;
  96         }
  97
  98         /**
  99          * Create a new Title from text, such as what one would
 100          * find in a link. Decodes any HTML entities in the text.
 101          *
 102          * @param string $text the link text; spaces, prefixes,
 103          *      and an initial ':' indicating the main namespace
 104          *      are accepted
 105          * @param int $defaultNamespace the namespace to use if
 106          *      none is specified by a prefix
 107          * @return Title the new object, or NULL on an error
 108          * @static
 109          * @access public
 110          */
 111         public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
 112                 if( is_object( $text ) ) {
 113                         throw new MWException( 'Title::newFromText given an object' );
 114                 }
 115
 116                 /**
 117                  * Wiki pages often contain multiple links to the same page.
 118                  * Title normalization and parsing can become expensive on
 119                  * pages with many links, so we can save a little time by
 120                  * caching them.
 121                  *
 122                  * In theory these are value objects and won't get changed...
 123                  */
 124                 if( $defaultNamespace == NS_MAIN && isset( Title::$titleCache[$text] ) ) {
 125                         return Title::$titleCache[$text];
 126                 }
 127
 128                 /**
 129                  * Convert things like &eacute; &#257; or &#x3017; into real text...
 130                  */
 131                 $filteredText = Sanitizer::decodeCharReferences( $text );
 132
 133                 $t = new Title();
 134                 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
 135                 $t->mDefaultNamespace = $defaultNamespace;
 136
 137                 static $cachedcount = 0 ;
 138                 if( $t->secureAndSplit() ) {
 139                         if( $defaultNamespace == NS_MAIN ) {
 140                                 if( $cachedcount >= MW_TITLECACHE_MAX ) {
 141                                         # Avoid memory leaks on mass operations...
 142                                         Title::$titleCache = array();
 143                                         $cachedcount=0;
 144                                 }
 145                                 $cachedcount++;
 146                                 Title::$titleCache[$text] =& $t;
 147                         }
 148                         return $t;
 149                 } else {
 150                         $ret = NULL;
 151                         return $ret;
 152                 }
 153         }
 154
 155         /**
 156          * Create a new Title from URL-encoded text. Ensures that
 157          * the given title's length does not exceed the maximum.
 158          * @param string $url the title, as might be taken from a URL
 159          * @return Title the new object, or NULL on an error
 160          * @static
 161          * @access public
 162          */
 163         public static function newFromURL( $url ) {
 164                 global $wgLegalTitleChars;
 165                 $t = new Title();
 166
 167                 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
 168                 # but some URLs used it as a space replacement and they still come
 169                 # from some external search tools.
 170                 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
 171                         $url = str_replace( '+', ' ', $url );
 172                 }
 173
 174                 $t->mDbkeyform = str_replace( ' ', '_', $url );
 175                 if( $t->secureAndSplit() ) {
 176                         return $t;
 177                 } else {
 178                         return NULL;
 179                 }
 180         }
 181
 182         /**
 183          * Create a new Title from an article ID
 184          *
 185          * @todo This is inefficiently implemented, the page row is requested
 186          *       but not used for anything else
 187          *
 188          * @param int $id the page_id corresponding to the Title to create
 189          * @return Title the new object, or NULL on an error
 190          * @access public
 191          * @static
 192          */
 193         function newFromID( $id ) {
 194                 $fname = 'Title::newFromID';
 195                 $dbr =& wfGetDB( DB_SLAVE );
 196                 $row = $dbr->selectRow( 'page', array( 'page_namespace', 'page_title' ),
 197                         array( 'page_id' => $id ), $fname );
 198                 if ( $row !== false ) {
 199                         $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 200                 } else {
 201                         $title = NULL;
 202                 }
 203                 return $title;
 204         }
 205
 206         /**
 207          * Make an array of titles from an array of IDs
 208          */
 209         function newFromIDs( $ids ) {
 210                 $dbr =& wfGetDB( DB_SLAVE );
 211                 $res = $dbr->select( 'page', array( 'page_namespace', 'page_title' ),
 212                         'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__ );
 213
 214                 $titles = array();
 215                 while ( $row = $dbr->fetchObject( $res ) ) {
 216                         $titles[] = Title::makeTitle( $row->page_namespace, $row->page_title );
 217                 }
 218                 return $titles;
 219         }
 220
 221         /**
 222          * Create a new Title from a namespace index and a DB key.
 223          * It's assumed that $ns and $title are *valid*, for instance when
 224          * they came directly from the database or a special page name.
 225          * For convenience, spaces are converted to underscores so that
 226          * eg user_text fields can be used directly.
 227          *
 228          * @param int $ns the namespace of the article
 229          * @param string $title the unprefixed database key form
 230          * @return Title the new object
 231          * @static
 232          * @access public
 233          */
 234         public static function &makeTitle( $ns, $title ) {
 235                 $t = new Title();
 236                 $t->mInterwiki = '';
 237                 $t->mFragment = '';
 238                 $t->mNamespace = intval( $ns );
 239                 $t->mDbkeyform = str_replace( ' ', '_', $title );
 240                 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
 241                 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
 242                 $t->mTextform = str_replace( '_', ' ', $title );
 243                 return $t;
 244         }
 245
 246         /**
 247          * Create a new Title from a namespace index and a DB key.
 248          * The parameters will be checked for validity, which is a bit slower
 249          * than makeTitle() but safer for user-provided data.
 250          *
 251          * @param int $ns the namespace of the article
 252          * @param string $title the database key form
 253          * @return Title the new object, or NULL on an error
 254          * @static
 255          * @access public
 256          */
 257         public static function makeTitleSafe( $ns, $title ) {
 258                 $t = new Title();
 259                 $t->mDbkeyform = Title::makeName( $ns, $title );
 260                 if( $t->secureAndSplit() ) {
 261                         return $t;
 262                 } else {
 263                         return NULL;
 264                 }
 265         }
 266
 267         /**
 268          * Create a new Title for the Main Page
 269          *
 270          * @static
 271          * @return Title the new object
 272          * @access public
 273          */
 274         public static function newMainPage() {
 275                 return Title::newFromText( wfMsgForContent( 'mainpage' ) );
 276         }
 277
 278         /**
 279          * Create a new Title for a redirect
 280          * @param string $text the redirect title text
 281          * @return Title the new object, or NULL if the text is not a
 282          *      valid redirect
 283          * @static
 284          * @access public
 285          */
 286         public static function newFromRedirect( $text ) {
 287                 $mwRedir = MagicWord::get( 'redirect' );
 288                 $rt = NULL;
 289                 if ( $mwRedir->matchStart( $text ) ) {
 290                         $m = array();
 291                         if ( preg_match( '/\[{2}(.*?)(?:\||\]{2})/', $text, $m ) ) {
 292                                 # categories are escaped using : for example one can enter:
 293                                 # #REDIRECT [[:Category:Music]]. Need to remove it.
 294                                 if ( substr($m[1],0,1) == ':') {
 295                                         # We don't want to keep the ':'
 296                                         $m[1] = substr( $m[1], 1 );
 297                                 }
 298
 299                                 $rt = Title::newFromText( $m[1] );
 300                                 # Disallow redirects to Special:Userlogout
 301                                 if ( !is_null($rt) && $rt->isSpecial( 'Userlogout' ) ) {
 302                                         $rt = NULL;
 303                                 }
 304                         }
 305                 }
 306                 return $rt;
 307         }
 308
 309 #----------------------------------------------------------------------------
 310 #       Static functions
 311 #----------------------------------------------------------------------------
 312
 313         /**
 314          * Get the prefixed DB key associated with an ID
 315          * @param int $id the page_id of the article
 316          * @return Title an object representing the article, or NULL
 317          *      if no such article was found
 318          * @static
 319          * @access public
 320          */
 321         function nameOf( $id ) {
 322                 $fname = 'Title::nameOf';
 323                 $dbr =& wfGetDB( DB_SLAVE );
 324
 325                 $s = $dbr->selectRow( 'page', array( 'page_namespace','page_title' ),  array( 'page_id' => $id ), $fname );
 326                 if ( $s === false ) { return NULL; }
 327
 328                 $n = Title::makeName( $s->page_namespace, $s->page_title );
 329                 return $n;
 330         }
 331
 332         /**
 333          * Get a regex character class describing the legal characters in a link
 334          * @return string the list of characters, not delimited
 335          * @static
 336          * @access public
 337          */
 338         public static function legalChars() {
 339                 global $wgLegalTitleChars;
 340                 return $wgLegalTitleChars;
 341         }
 342
 343         /**
 344          * Get a string representation of a title suitable for
 345          * including in a search index
 346          *
 347          * @param int $ns a namespace index
 348          * @param string $title text-form main part
 349          * @return string a stripped-down title string ready for the
 350          *      search index
 351          */
 352         /* static */ function indexTitle( $ns, $title ) {
 353                 global $wgContLang;
 354
 355                 $lc = SearchEngine::legalSearchChars() . '&#;';
 356                 $t = $wgContLang->stripForSearch( $title );
 357                 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
 358                 $t = $wgContLang->lc( $t );
 359
 360                 # Handle 's, s'
 361                 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
 362                 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
 363
 364                 $t = preg_replace( "/\\s+/", ' ', $t );
 365
 366                 if ( $ns == NS_IMAGE ) {
 367                         $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
 368                 }
 369                 return trim( $t );
 370         }
 371
 372         /*
 373          * Make a prefixed DB key from a DB key and a namespace index
 374          * @param int $ns numerical representation of the namespace
 375          * @param string $title the DB key form the title
 376          * @return string the prefixed form of the title
 377          */
 378         public static function makeName( $ns, $title ) {
 379                 global $wgContLang;
 380
 381                 $n = $wgContLang->getNsText( $ns );
 382                 return $n == '' ? $title : "$n:$title";
 383         }
 384
 385         /**
 386          * Returns the URL associated with an interwiki prefix
 387          * @param string $key the interwiki prefix (e.g. "MeatBall")
 388          * @return the associated URL, containing "$1", which should be
 389          *      replaced by an article title
 390          * @static (arguably)
 391          * @access public
 392          */
 393         function getInterwikiLink( $key )  {
 394                 global $wgMemc, $wgInterwikiExpiry;
 395                 global $wgInterwikiCache, $wgContLang;
 396                 $fname = 'Title::getInterwikiLink';
 397
 398                 $key = $wgContLang->lc( $key );
 399
 400                 $k = wfMemcKey( 'interwiki', $key );
 401                 if( array_key_exists( $k, Title::$interwikiCache ) ) {
 402                         return Title::$interwikiCache[$k]->iw_url;
 403                 }
 404
 405                 if ($wgInterwikiCache) {
 406                         return Title::getInterwikiCached( $key );
 407                 }
 408
 409                 $s = $wgMemc->get( $k );
 410                 # Ignore old keys with no iw_local
 411                 if( $s && isset( $s->iw_local ) && isset($s->iw_trans)) {
 412                         Title::$interwikiCache[$k] = $s;
 413                         return $s->iw_url;
 414                 }
 415
 416                 $dbr =& wfGetDB( DB_SLAVE );
 417                 $res = $dbr->select( 'interwiki',
 418                         array( 'iw_url', 'iw_local', 'iw_trans' ),
 419                         array( 'iw_prefix' => $key ), $fname );
 420                 if( !$res ) {
 421                         return '';
 422                 }
 423
 424                 $s = $dbr->fetchObject( $res );
 425                 if( !$s ) {
 426                         # Cache non-existence: create a blank object and save it to memcached
 427                         $s = (object)false;
 428                         $s->iw_url = '';
 429                         $s->iw_local = 0;
 430                         $s->iw_trans = 0;
 431                 }
 432                 $wgMemc->set( $k, $s, $wgInterwikiExpiry );
 433                 Title::$interwikiCache[$k] = $s;
 434
 435                 return $s->iw_url;
 436         }
 437
 438         /**
 439          * Fetch interwiki prefix data from local cache in constant database
 440          *
 441          * More logic is explained in DefaultSettings
 442          *
 443          * @return string URL of interwiki site
 444          * @access public
 445          */
 446         function getInterwikiCached( $key ) {
 447                 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
 448                 static $db, $site;
 449
 450                 if (!$db)
 451                         $db=dba_open($wgInterwikiCache,'r','cdb');
 452                 /* Resolve site name */
 453                 if ($wgInterwikiScopes>=3 and !$site) {
 454                         $site = dba_fetch('__sites:' . wfWikiID(), $db);
 455                         if ($site=="")
 456                                 $site = $wgInterwikiFallbackSite;
 457                 }
 458                 $value = dba_fetch( wfMemcKey( $key ), $db);
 459                 if ($value=='' and $wgInterwikiScopes>=3) {
 460                         /* try site-level */
 461                         $value = dba_fetch("_{$site}:{$key}", $db);
 462                 }
 463                 if ($value=='' and $wgInterwikiScopes>=2) {
 464                         /* try globals */
 465                         $value = dba_fetch("__global:{$key}", $db);
 466                 }
 467                 if ($value=='undef')
 468                         $value='';
 469                 $s = (object)false;
 470                 $s->iw_url = '';
 471                 $s->iw_local = 0;
 472                 $s->iw_trans = 0;
 473                 if ($value!='') {
 474                         list($local,$url)=explode(' ',$value,2);
 475                         $s->iw_url=$url;
 476                         $s->iw_local=(int)$local;
 477                 }
 478                 Title::$interwikiCache[wfMemcKey( 'interwiki', $key )] = $s;
 479                 return $s->iw_url;
 480         }
 481         /**
 482          * Determine whether the object refers to a page within
 483          * this project.
 484          *
 485          * @return bool TRUE if this is an in-project interwiki link
 486          *      or a wikilink, FALSE otherwise
 487          * @access public
 488          */
 489         function isLocal() {
 490                 if ( $this->mInterwiki != '' ) {
 491                         # Make sure key is loaded into cache
 492                         $this->getInterwikiLink( $this->mInterwiki );
 493                         $k = wfMemcKey( 'interwiki', $this->mInterwiki );
 494                         return (bool)(Title::$interwikiCache[$k]->iw_local);
 495                 } else {
 496                         return true;
 497                 }
 498         }
 499
 500         /**
 501          * Determine whether the object refers to a page within
 502          * this project and is transcludable.
 503          *
 504          * @return bool TRUE if this is transcludable
 505          * @access public
 506          */
 507         function isTrans() {
 508                 if ($this->mInterwiki == '')
 509                         return false;
 510                 # Make sure key is loaded into cache
 511                 $this->getInterwikiLink( $this->mInterwiki );
 512                 $k = wfMemcKey( 'interwiki', $this->mInterwiki );
 513                 return (bool)(Title::$interwikiCache[$k]->iw_trans);
 514         }
 515
 516         /**
 517          * Update the page_touched field for an array of title objects
 518          * @todo Inefficient unless the IDs are already loaded into the
 519          *      link cache
 520          * @param array $titles an array of Title objects to be touched
 521          * @param string $timestamp the timestamp to use instead of the
 522          *      default current time
 523          * @static
 524          * @access public
 525          */
 526         function touchArray( $titles, $timestamp = '' ) {
 527
 528                 if ( count( $titles ) == 0 ) {
 529                         return;
 530                 }
 531                 $dbw =& wfGetDB( DB_MASTER );
 532                 if ( $timestamp == '' ) {
 533                         $timestamp = $dbw->timestamp();
 534                 }
 535                 /*
 536                 $page = $dbw->tableName( 'page' );
 537                 $sql = "UPDATE $page SET page_touched='{$timestamp}' WHERE page_id IN (";
 538                 $first = true;
 539
 540                 foreach ( $titles as $title ) {
 541                         if ( $wgUseFileCache ) {
 542                                 $cm = new HTMLFileCache($title);
 543                                 @unlink($cm->fileCacheName());
 544                         }
 545
 546                         if ( ! $first ) {
 547                                 $sql .= ',';
 548                         }
 549                         $first = false;
 550                         $sql .= $title->getArticleID();
 551                 }
 552                 $sql .= ')';
 553                 if ( ! $first ) {
 554                         $dbw->query( $sql, 'Title::touchArray' );
 555                 }
 556                 */
 557                 // hack hack hack -- brion 2005-07-11. this was unfriendly to db.
 558                 // do them in small chunks:
 559                 $fname = 'Title::touchArray';
 560                 foreach( $titles as $title ) {
 561                         $dbw->update( 'page',
 562                                 array( 'page_touched' => $timestamp ),
 563                                 array(
 564                                         'page_namespace' => $title->getNamespace(),
 565                                         'page_title'     => $title->getDBkey() ),
 566                                 $fname );
 567                 }
 568         }
 569
 570         /**
 571          * Escape a text fragment, say from a link, for a URL
 572          */
 573         static function escapeFragmentForURL( $fragment ) {
 574                 $fragment = str_replace( ' ', '_', $fragment );
 575                 $fragment = urlencode( Sanitizer::decodeCharReferences( $fragment ) );
 576                 $replaceArray = array(
 577                         '%3A' => ':',
 578                         '%' => '.'
 579                 );
 580                 return strtr( $fragment, $replaceArray );
 581         }
 582
 583 #----------------------------------------------------------------------------
 584 #       Other stuff
 585 #----------------------------------------------------------------------------
 586
 587         /** Simple accessors */
 588         /**
 589          * Get the text form (spaces not underscores) of the main part
 590          * @return string
 591          * @access public
 592          */
 593         function getText() { return $this->mTextform; }
 594         /**
 595          * Get the URL-encoded form of the main part
 596          * @return string
 597          * @access public
 598          */
 599         function getPartialURL() { return $this->mUrlform; }
 600         /**
 601          * Get the main part with underscores
 602          * @return string
 603          * @access public
 604          */
 605         function getDBkey() { return $this->mDbkeyform; }
 606         /**
 607          * Get the namespace index, i.e. one of the NS_xxxx constants
 608          * @return int
 609          * @access public
 610          */
 611         function getNamespace() { return $this->mNamespace; }
 612         /**
 613          * Get the namespace text
 614          * @return string
 615          * @access public
 616          */
 617         function getNsText() {
 618                 global $wgContLang;
 619                 return $wgContLang->getNsText( $this->mNamespace );
 620         }
 621         /**
 622          * Get the namespace text of the subject (rather than talk) page
 623          * @return string
 624          * @access public
 625          */
 626         function getSubjectNsText() {
 627                 global $wgContLang;
 628                 return $wgContLang->getNsText( Namespace::getSubject( $this->mNamespace ) );
 629         }
 630
 631         /**
 632          * Get the namespace text of the talk page
 633          * @return string
 634          */
 635         function getTalkNsText() {
 636                 global $wgContLang;
 637                 return( $wgContLang->getNsText( Namespace::getTalk( $this->mNamespace ) ) );
 638         }
 639
 640         /**
 641          * Could this title have a corresponding talk page?
 642          * @return bool
 643          */
 644         function canTalk() {
 645                 return( Namespace::canTalk( $this->mNamespace ) );
 646         }
 647
 648         /**
 649          * Get the interwiki prefix (or null string)
 650          * @return string
 651          * @access public
 652          */
 653         function getInterwiki() { return $this->mInterwiki; }
 654         /**
 655          * Get the Title fragment (i.e. the bit after the #) in text form
 656          * @return string
 657          * @access public
 658          */
 659         function getFragment() { return $this->mFragment; }
 660         /**
 661          * Get the fragment in URL form, including the "#" character if there is one
 662          *
 663          * @return string
 664          * @access public
 665          */
 666         function getFragmentForURL() {
 667                 if ( $this->mFragment == '' ) {
 668                         return '';
 669                 } else {
 670                         return '#' . Title::escapeFragmentForURL( $this->mFragment );
 671                 }
 672         }
 673         /**
 674          * Get the default namespace index, for when there is no namespace
 675          * @return int
 676          * @access public
 677          */
 678         function getDefaultNamespace() { return $this->mDefaultNamespace; }
 679
 680         /**
 681          * Get title for search index
 682          * @return string a stripped-down title string ready for the
 683          *      search index
 684          */
 685         function getIndexTitle() {
 686                 return Title::indexTitle( $this->mNamespace, $this->mTextform );
 687         }
 688
 689         /**
 690          * Get the prefixed database key form
 691          * @return string the prefixed title, with underscores and
 692          *      any interwiki and namespace prefixes
 693          * @access public
 694          */
 695         function getPrefixedDBkey() {
 696                 $s = $this->prefix( $this->mDbkeyform );
 697                 $s = str_replace( ' ', '_', $s );
 698                 return $s;
 699         }
 700
 701         /**
 702          * Get the prefixed title with spaces.
 703          * This is the form usually used for display
 704          * @return string the prefixed title, with spaces
 705          * @access public
 706          */
 707         function getPrefixedText() {
 708                 if ( empty( $this->mPrefixedText ) ) { // FIXME: bad usage of empty() ?
 709                         $s = $this->prefix( $this->mTextform );
 710                         $s = str_replace( '_', ' ', $s );
 711                         $this->mPrefixedText = $s;
 712                 }
 713                 return $this->mPrefixedText;
 714         }
 715
 716         /**
 717          * Get the prefixed title with spaces, plus any fragment
 718          * (part beginning with '#')
 719          * @return string the prefixed title, with spaces and
 720          *      the fragment, including '#'
 721          * @access public
 722          */
 723         function getFullText() {
 724                 $text = $this->getPrefixedText();
 725                 if( '' != $this->mFragment ) {
 726                         $text .= '#' . $this->mFragment;
 727                 }
 728                 return $text;
 729         }
 730
 731         /**
 732          * Get the base name, i.e. the leftmost parts before the /
 733          * @return string Base name
 734          */
 735         function getBaseText() {
 736                 global $wgNamespacesWithSubpages;
 737                 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace ] ) && $wgNamespacesWithSubpages[ $this->mNamespace ] ) {
 738                         $parts = explode( '/', $this->getText() );
 739                         # Don't discard the real title if there's no subpage involved
 740                         if( count( $parts ) > 1 )
 741                                 unset( $parts[ count( $parts ) - 1 ] );
 742                         return implode( '/', $parts );
 743                 } else {
 744                         return $this->getText();
 745                 }
 746         }
 747
 748         /**
 749          * Get the lowest-level subpage name, i.e. the rightmost part after /
 750          * @return string Subpage name
 751          */
 752         function getSubpageText() {
 753                 global $wgNamespacesWithSubpages;
 754                 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace ] ) && $wgNamespacesWithSubpages[ $this->mNamespace ] ) {
 755                         $parts = explode( '/', $this->mTextform );
 756                         return( $parts[ count( $parts ) - 1 ] );
 757                 } else {
 758                         return( $this->mTextform );
 759                 }
 760         }
 761
 762         /**
 763          * Get a URL-encoded form of the subpage text
 764          * @return string URL-encoded subpage name
 765          */
 766         function getSubpageUrlForm() {
 767                 $text = $this->getSubpageText();
 768                 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
 769                 $text = str_replace( '%28', '(', str_replace( '%29', ')', $text ) ); # Clean up the URL; per below, this might not be safe
 770                 return( $text );
 771         }
 772
 773         /**
 774          * Get a URL-encoded title (not an actual URL) including interwiki
 775          * @return string the URL-encoded form
 776          * @access public
 777          */
 778         function getPrefixedURL() {
 779                 $s = $this->prefix( $this->mDbkeyform );
 780                 $s = str_replace( ' ', '_', $s );
 781
 782                 $s = wfUrlencode ( $s ) ;
 783
 784                 # Cleaning up URL to make it look nice -- is this safe?
 785                 $s = str_replace( '%28', '(', $s );
 786                 $s = str_replace( '%29', ')', $s );
 787
 788                 return $s;
 789         }
 790
 791         /**
 792          * Get a real URL referring to this title, with interwiki link and
 793          * fragment
 794          *
 795          * @param string $query an optional query string, not used
 796          *      for interwiki links
 797          * @param string $variant language variant of url (for sr, zh..)
 798          * @return string the URL
 799          * @access public
 800          */
 801         function getFullURL( $query = '', $variant = false ) {
 802                 global $wgContLang, $wgServer, $wgRequest;
 803
 804                 if ( '' == $this->mInterwiki ) {
 805                         $url = $this->getLocalUrl( $query, $variant );
 806
 807                         // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
 808                         // Correct fix would be to move the prepending elsewhere.
 809                         if ($wgRequest->getVal('action') != 'render') {
 810                                 $url = $wgServer . $url;
 811                         }
 812                 } else {
 813                         $baseUrl = $this->getInterwikiLink( $this->mInterwiki );
 814
 815                         $namespace = $wgContLang->getNsText( $this->mNamespace );
 816                         if ( '' != $namespace ) {
 817                                 # Can this actually happen? Interwikis shouldn't be parsed.
 818                                 $namespace .= ':';
 819                         }
 820                         $url = str_replace( '$1', $namespace . $this->mUrlform, $baseUrl );
 821                         if( $query != '' ) {
 822                                 if( false === strpos( $url, '?' ) ) {
 823                                         $url .= '?';
 824                                 } else {
 825                                         $url .= '&';
 826                                 }
 827                                 $url .= $query;
 828                         }
 829                 }
 830
 831                 # Finally, add the fragment.
 832                 $url .= $this->getFragmentForURL();
 833
 834                 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
 835                 return $url;
 836         }
 837
 838         /**
 839          * Get a URL with no fragment or server name.  If this page is generated
 840          * with action=render, $wgServer is prepended.
 841          * @param string $query an optional query string; if not specified,
 842          *      $wgArticlePath will be used.
 843          * @param string $variant language variant of url (for sr, zh..)
 844          * @return string the URL
 845          * @access public
 846          */
 847         function getLocalURL( $query = '', $variant = false ) {
 848                 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
 849                 global $wgVariantArticlePath, $wgContLang, $wgUser;
 850
 851                 // internal links should point to same variant as current page (only anonymous users)
 852                 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
 853                         $pref = $wgContLang->getPreferredVariant(false);
 854                         if($pref != $wgContLang->getCode())
 855                                 $variant = $pref;
 856                 }
 857
 858                 if ( $this->isExternal() ) {
 859                         $url = $this->getFullURL();
 860                         if ( $query ) {
 861                                 // This is currently only used for edit section links in the
 862                                 // context of interwiki transclusion. In theory we should
 863                                 // append the query to the end of any existing query string,
 864                                 // but interwiki transclusion is already broken in that case.
 865                                 $url .= "?$query";
 866                         }
 867                 } else {
 868                         $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
 869                         if ( $query == '' ) {
 870                                 if($variant!=false && $wgContLang->hasVariants()){
 871                                         if($wgVariantArticlePath==false)
 872                                                 $variantArticlePath =  "$wgScript?title=$1&variant=$2"; // default
 873                                         else
 874                                                 $variantArticlePath = $wgVariantArticlePath;
 875
 876                                         $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
 877                                         $url = str_replace( '$1', $dbkey, $url  );
 878
 879                                 }
 880                                 else
 881                                         $url = str_replace( '$1', $dbkey, $wgArticlePath );
 882                         } else {
 883                                 global $wgActionPaths;
 884                                 $url = false;
 885                                 $matches = array();
 886                                 if( !empty( $wgActionPaths ) &&
 887                                         preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
 888                                 {
 889                                         $action = urldecode( $matches[2] );
 890                                         if( isset( $wgActionPaths[$action] ) ) {
 891                                                 $query = $matches[1];
 892                                                 if( isset( $matches[4] ) ) $query .= $matches[4];
 893                                                 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
 894                                                 if( $query != '' ) $url .= '?' . $query;
 895                                         }
 896                                 }
 897                                 if ( $url === false ) {
 898                                         if ( $query == '-' ) {
 899                                                 $query = '';
 900                                         }
 901                                         $url = "{$wgScript}?title={$dbkey}&{$query}";
 902                                 }
 903                         }
 904
 905                         // FIXME: this causes breakage in various places when we
 906                         // actually expected a local URL and end up with dupe prefixes.
 907                         if ($wgRequest->getVal('action') == 'render') {
 908                                 $url = $wgServer . $url;
 909                         }
 910                 }
 911                 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
 912                 return $url;
 913         }
 914
 915         /**
 916          * Get an HTML-escaped version of the URL form, suitable for
 917          * using in a link, without a server name or fragment
 918          * @param string $query an optional query string
 919          * @return string the URL
 920          * @access public
 921          */
 922         function escapeLocalURL( $query = '' ) {
 923                 return htmlspecialchars( $this->getLocalURL( $query ) );
 924         }
 925
 926         /**
 927          * Get an HTML-escaped version of the URL form, suitable for
 928          * using in a link, including the server name and fragment
 929          *
 930          * @return string the URL
 931          * @param string $query an optional query string
 932          * @access public
 933          */
 934         function escapeFullURL( $query = '' ) {
 935                 return htmlspecialchars( $this->getFullURL( $query ) );
 936         }
 937
 938         /**
 939          * Get the URL form for an internal link.
 940          * - Used in various Squid-related code, in case we have a different
 941          * internal hostname for the server from the exposed one.
 942          *
 943          * @param string $query an optional query string
 944          * @param string $variant language variant of url (for sr, zh..)
 945          * @return string the URL
 946          * @access public
 947          */
 948         function getInternalURL( $query = '', $variant = false ) {
 949                 global $wgInternalServer;
 950                 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
 951                 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
 952                 return $url;
 953         }
 954
 955         /**
 956          * Get the edit URL for this Title
 957          * @return string the URL, or a null string if this is an
 958          *      interwiki link
 959          * @access public
 960          */
 961         function getEditURL() {
 962                 if ( '' != $this->mInterwiki ) { return ''; }
 963                 $s = $this->getLocalURL( 'action=edit' );
 964
 965                 return $s;
 966         }
 967
 968         /**
 969          * Get the HTML-escaped displayable text form.
 970          * Used for the title field in <a> tags.
 971          * @return string the text, including any prefixes
 972          * @access public
 973          */
 974         function getEscapedText() {
 975                 return htmlspecialchars( $this->getPrefixedText() );
 976         }
 977
 978         /**
 979          * Is this Title interwiki?
 980          * @return boolean
 981          * @access public
 982          */
 983         function isExternal() { return ( '' != $this->mInterwiki ); }
 984
 985         /**
 986          * Is this page "semi-protected" - the *only* protection is autoconfirm?
 987          *
 988          * @param string Action to check (default: edit)
 989          * @return bool
 990          */
 991         function isSemiProtected( $action = 'edit' ) {
 992                 if( $this->exists() ) {
 993                         foreach( $this->getRestrictions( $action ) as $restriction ) {
 994                                 if( strtolower( $restriction ) != 'autoconfirmed' )
 995                                         return false;
 996                         }
 997                         return true;
 998                 } else {
 999                         # If it doesn't exist, it can't be protected
1000                         return false;
1001                 }
1002         }
1003
1004         /**
1005          * Does the title correspond to a protected article?
1006          * @param string $what the action the page is protected from,
1007          *      by default checks move and edit
1008          * @return boolean
1009          * @access public
1010          */
1011         function isProtected( $action = '' ) {
1012                 global $wgRestrictionLevels;
1013                 if ( NS_SPECIAL == $this->mNamespace ) { return true; }
1014
1015                 if( $action == 'edit' || $action == '' ) {
1016                         $r = $this->getRestrictions( 'edit' );
1017                         foreach( $wgRestrictionLevels as $level ) {
1018                                 if( in_array( $level, $r ) && $level != '' ) {
1019                                         return( true );
1020                                 }
1021                         }
1022                 }
1023
1024                 if( $action == 'move' || $action == '' ) {
1025                         $r = $this->getRestrictions( 'move' );
1026                         foreach( $wgRestrictionLevels as $level ) {
1027                                 if( in_array( $level, $r ) && $level != '' ) {
1028                                         return( true );
1029                                 }
1030                         }
1031                 }
1032
1033                 return false;
1034         }
1035
1036         /**
1037          * Is $wgUser is watching this page?
1038          * @return boolean
1039          * @access public
1040          */
1041         function userIsWatching() {
1042                 global $wgUser;
1043
1044                 if ( is_null( $this->mWatched ) ) {
1045                         if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn()) {
1046                                 $this->mWatched = false;
1047                         } else {
1048                                 $this->mWatched = $wgUser->isWatched( $this );
1049                         }
1050                 }
1051                 return $this->mWatched;
1052         }
1053
1054         /**
1055          * Can $wgUser perform $action this page?
1056          * @param string $action action that permission needs to be checked for
1057          * @return boolean
1058          * @private
1059          */
1060         function userCan($action) {
1061                 $fname = 'Title::userCan';
1062                 wfProfileIn( $fname );
1063
1064                 global $wgUser;
1065
1066                 $result = null;
1067                 wfRunHooks( 'userCan', array( &$this, &$wgUser, $action, &$result ) );
1068                 if ( $result !== null ) {
1069                         wfProfileOut( $fname );
1070                         return $result;
1071                 }
1072
1073                 if( NS_SPECIAL == $this->mNamespace ) {
1074                         wfProfileOut( $fname );
1075                         return false;
1076                 }
1077                 // XXX: This is the code that prevents unprotecting a page in NS_MEDIAWIKI
1078                 // from taking effect -ævar
1079                 if( NS_MEDIAWIKI == $this->mNamespace &&
1080                     !$wgUser->isAllowed('editinterface') ) {
1081                         wfProfileOut( $fname );
1082                         return false;
1083                 }
1084
1085                 if( $this->mDbkeyform == '_' ) {
1086                         # FIXME: Is this necessary? Shouldn't be allowed anyway...
1087                         wfProfileOut( $fname );
1088                         return false;
1089                 }
1090
1091                 # protect css/js subpages of user pages
1092                 # XXX: this might be better using restrictions
1093                 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1094                 if( $this->isCssJsSubpage()
1095                         && !$wgUser->isAllowed('editinterface')
1096                         && !preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) ) {
1097                         wfProfileOut( $fname );
1098                         return false;
1099                 }
1100
1101                 foreach( $this->getRestrictions($action) as $right ) {
1102                         // Backwards compatibility, rewrite sysop -> protect
1103                         if ( $right == 'sysop' ) {
1104                                 $right = 'protect';
1105                         }
1106                         if( '' != $right && !$wgUser->isAllowed( $right ) ) {
1107                                 wfProfileOut( $fname );
1108                                 return false;
1109                         }
1110                 }
1111
1112                 if( $action == 'move' &&
1113                         !( $this->isMovable() && $wgUser->isAllowed( 'move' ) ) ) {
1114                         wfProfileOut( $fname );
1115                         return false;
1116                 }
1117
1118                 if( $action == 'create' ) {
1119                         if( (  $this->isTalkPage() && !$wgUser->isAllowed( 'createtalk' ) ) ||
1120                                 ( !$this->isTalkPage() && !$wgUser->isAllowed( 'createpage' ) ) ) {
1121                                 wfProfileOut( $fname );
1122                                 return false;
1123                         }
1124                 }
1125
1126                 wfProfileOut( $fname );
1127                 return true;
1128         }
1129
1130         /**
1131          * Can $wgUser edit this page?
1132          * @return boolean
1133          * @access public
1134          */
1135         function userCanEdit() {
1136                 return $this->userCan('edit');
1137         }
1138
1139         /**
1140          * Can $wgUser create this page?
1141          * @return boolean
1142          * @access public
1143          */
1144         function userCanCreate() {
1145                 return $this->userCan('create');
1146         }
1147
1148         /**
1149          * Can $wgUser move this page?
1150          * @return boolean
1151          * @access public
1152          */
1153         function userCanMove() {
1154                 return $this->userCan('move');
1155         }
1156
1157         /**
1158          * Would anybody with sufficient privileges be able to move this page?
1159          * Some pages just aren't movable.
1160          *
1161          * @return boolean
1162          * @access public
1163          */
1164         function isMovable() {
1165                 return Namespace::isMovable( $this->getNamespace() )
1166                         && $this->getInterwiki() == '';
1167         }
1168
1169         /**
1170          * Can $wgUser read this page?
1171          * @return boolean
1172          * @access public
1173          */
1174         function userCanRead() {
1175                 global $wgUser;
1176
1177                 $result = null;
1178                 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1179                 if ( $result !== null ) {
1180                         return $result;
1181                 }
1182
1183                 if( $wgUser->isAllowed('read') ) {
1184                         return true;
1185                 } else {
1186                         global $wgWhitelistRead;
1187
1188                         /**
1189                          * Always grant access to the login page.
1190                          * Even anons need to be able to log in.
1191                         */
1192                         if( $this->isSpecial( 'Userlogin' ) || $this->isSpecial( 'Resetpass' ) ) {
1193                                 return true;
1194                         }
1195
1196                         /** some pages are explicitly allowed */
1197                         $name = $this->getPrefixedText();
1198                         if( $wgWhitelistRead && in_array( $name, $wgWhitelistRead ) ) {
1199                                 return true;
1200                         }
1201
1202                         # Compatibility with old settings
1203                         if( $wgWhitelistRead && $this->getNamespace() == NS_MAIN ) {
1204                                 if( in_array( ':' . $name, $wgWhitelistRead ) ) {
1205                                         return true;
1206                                 }
1207                         }
1208                 }
1209                 return false;
1210         }
1211
1212         /**
1213          * Is this a talk page of some sort?
1214          * @return bool
1215          * @access public
1216          */
1217         function isTalkPage() {
1218                 return Namespace::isTalk( $this->getNamespace() );
1219         }
1220
1221         /**
1222          * Is this a subpage?
1223          * @return bool
1224          * @access public
1225          */
1226         function isSubpage() {
1227                 global $wgNamespacesWithSubpages;
1228
1229                 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace ] ) ) {
1230                         return ( strpos( $this->getText(), '/' ) !== false && $wgNamespacesWithSubpages[ $this->mNamespace ] == true );
1231                 } else {
1232                         return false;
1233                 }
1234         }
1235
1236         /**
1237          * Is this a .css or .js subpage of a user page?
1238          * @return bool
1239          * @access public
1240          */
1241         function isCssJsSubpage() {
1242                 return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.(css|js)$/", $this->mTextform ) );
1243         }
1244         /**
1245          * Is this a *valid* .css or .js subpage of a user page?
1246          * Check that the corresponding skin exists
1247          */
1248         function isValidCssJsSubpage() {
1249                 if ( $this->isCssJsSubpage() ) {
1250                         $skinNames = Skin::getSkinNames();
1251                         return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1252                 } else {
1253                         return false;
1254                 }
1255         }
1256         /**
1257          * Trim down a .css or .js subpage title to get the corresponding skin name
1258          */
1259         function getSkinFromCssJsSubpage() {
1260                 $subpage = explode( '/', $this->mTextform );
1261                 $subpage = $subpage[ count( $subpage ) - 1 ];
1262                 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1263         }
1264         /**
1265          * Is this a .css subpage of a user page?
1266          * @return bool
1267          * @access public
1268          */
1269         function isCssSubpage() {
1270                 return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.css$/", $this->mTextform ) );
1271         }
1272         /**
1273          * Is this a .js subpage of a user page?
1274          * @return bool
1275          * @access public
1276          */
1277         function isJsSubpage() {
1278                 return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.js$/", $this->mTextform ) );
1279         }
1280         /**
1281          * Protect css/js subpages of user pages: can $wgUser edit
1282          * this page?
1283          *
1284          * @return boolean
1285          * @todo XXX: this might be better using restrictions
1286          * @access public
1287          */
1288         function userCanEditCssJsSubpage() {
1289                 global $wgUser;
1290                 return ( $wgUser->isAllowed('editinterface') or preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) );
1291         }
1292
1293         /**
1294          * Loads a string into mRestrictions array
1295          * @param string $res restrictions in string format
1296          * @access public
1297          */
1298         function loadRestrictions( $res ) {
1299                 foreach( explode( ':', trim( $res ) ) as $restrict ) {
1300                         $temp = explode( '=', trim( $restrict ) );
1301                         if(count($temp) == 1) {
1302                                 // old format should be treated as edit/move restriction
1303                                 $this->mRestrictions["edit"] = explode( ',', trim( $temp[0] ) );
1304                                 $this->mRestrictions["move"] = explode( ',', trim( $temp[0] ) );
1305                         } else {
1306                                 $this->mRestrictions[$temp[0]] = explode( ',', trim( $temp[1] ) );
1307                         }
1308                 }
1309                 $this->mRestrictionsLoaded = true;
1310         }
1311
1312         /**
1313          * Accessor/initialisation for mRestrictions
1314          * @param string $action action that permission needs to be checked for
1315          * @return array the array of groups allowed to edit this article
1316          * @access public
1317          */
1318         function getRestrictions($action) {
1319                 $id = $this->getArticleID();
1320                 if ( 0 == $id ) { return array(); }
1321
1322                 if ( ! $this->mRestrictionsLoaded ) {
1323                         $dbr =& wfGetDB( DB_SLAVE );
1324                         $res = $dbr->selectField( 'page', 'page_restrictions', 'page_id='.$id );
1325                         $this->loadRestrictions( $res );
1326                 }
1327                 if( isset( $this->mRestrictions[$action] ) ) {
1328                         return $this->mRestrictions[$action];
1329                 }
1330                 return array();
1331         }
1332
1333         /**
1334          * Is there a version of this page in the deletion archive?
1335          * @return int the number of archived revisions
1336          * @access public
1337          */
1338         function isDeleted() {
1339                 $fname = 'Title::isDeleted';
1340                 if ( $this->getNamespace() < 0 ) {
1341                         $n = 0;
1342                 } else {
1343                         $dbr =& wfGetDB( DB_SLAVE );
1344                         $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1345                                 'ar_title' => $this->getDBkey() ), $fname );
1346                         if( $this->getNamespace() == NS_IMAGE ) {
1347                                 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
1348                                         array( 'fa_name' => $this->getDBkey() ), $fname );
1349                         }
1350                 }
1351                 return (int)$n;
1352         }
1353
1354         /**
1355          * Get the article ID for this Title from the link cache,
1356          * adding it if necessary
1357          * @param int $flags a bit field; may be GAID_FOR_UPDATE to select
1358          *      for update
1359          * @return int the ID
1360          * @access public
1361          */
1362         function getArticleID( $flags = 0 ) {
1363                 $linkCache =& LinkCache::singleton();
1364                 if ( $flags & GAID_FOR_UPDATE ) {
1365                         $oldUpdate = $linkCache->forUpdate( true );
1366                         $this->mArticleID = $linkCache->addLinkObj( $this );
1367                         $linkCache->forUpdate( $oldUpdate );
1368                 } else {
1369                         if ( -1 == $this->mArticleID ) {
1370                                 $this->mArticleID = $linkCache->addLinkObj( $this );
1371                         }
1372                 }
1373                 return $this->mArticleID;
1374         }
1375
1376         function getLatestRevID() {
1377                 if ($this->mLatestID !== false)
1378                         return $this->mLatestID;
1379
1380                 $db =& wfGetDB(DB_SLAVE);
1381                 return $this->mLatestID = $db->selectField( 'revision',
1382                         "max(rev_id)",
1383                         array('rev_page' => $this->getArticleID()),
1384                         'Title::getLatestRevID' );
1385         }
1386
1387         /**
1388          * This clears some fields in this object, and clears any associated
1389          * keys in the "bad links" section of the link cache.
1390          *
1391          * - This is called from Article::insertNewArticle() to allow
1392          * loading of the new page_id. It's also called from
1393          * Article::doDeleteArticle()
1394          *
1395          * @param int $newid the new Article ID
1396          * @access public
1397          */
1398         function resetArticleID( $newid ) {
1399                 $linkCache =& LinkCache::singleton();
1400                 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
1401
1402                 if ( 0 == $newid ) { $this->mArticleID = -1; }
1403                 else { $this->mArticleID = $newid; }
1404                 $this->mRestrictionsLoaded = false;
1405                 $this->mRestrictions = array();
1406         }
1407
1408         /**
1409          * Updates page_touched for this page; called from LinksUpdate.php
1410          * @return bool true if the update succeded
1411          * @access public
1412          */
1413         function invalidateCache() {
1414                 global $wgUseFileCache;
1415
1416                 if ( wfReadOnly() ) {
1417                         return;
1418                 }
1419
1420                 $dbw =& wfGetDB( DB_MASTER );
1421                 $success = $dbw->update( 'page',
1422                         array( /* SET */
1423                                 'page_touched' => $dbw->timestamp()
1424                         ), array( /* WHERE */
1425                                 'page_namespace' => $this->getNamespace() ,
1426                                 'page_title' => $this->getDBkey()
1427                         ), 'Title::invalidateCache'
1428                 );
1429
1430                 if ($wgUseFileCache) {
1431                         $cache = new HTMLFileCache($this);
1432                         @unlink($cache->fileCacheName());
1433                 }
1434
1435                 return $success;
1436         }
1437
1438         /**
1439          * Prefix some arbitrary text with the namespace or interwiki prefix
1440          * of this object
1441          *
1442          * @param string $name the text
1443          * @return string the prefixed text
1444          * @private
1445          */
1446         /* private */ function prefix( $name ) {
1447                 global $wgContLang;
1448
1449                 $p = '';
1450                 if ( '' != $this->mInterwiki ) {
1451                         $p = $this->mInterwiki . ':';
1452                 }
1453                 if ( 0 != $this->mNamespace ) {
1454                         $p .= $wgContLang->getNsText( $this->mNamespace ) . ':';
1455                 }
1456                 return $p . $name;
1457         }
1458
1459         /**
1460          * Secure and split - main initialisation function for this object
1461          *
1462          * Assumes that mDbkeyform has been set, and is urldecoded
1463          * and uses underscores, but not otherwise munged.  This function
1464          * removes illegal characters, splits off the interwiki and
1465          * namespace prefixes, sets the other forms, and canonicalizes
1466          * everything.
1467          * @return bool true on success
1468          * @private
1469          */
1470         /* private */ function secureAndSplit() {
1471                 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
1472
1473                 # Initialisation
1474                 static $rxTc = false;
1475                 if( !$rxTc ) {
1476                         # % is needed as well
1477                         $rxTc = '/[^' . Title::legalChars() . ']|%[0-9A-Fa-f]{2}/S';
1478                 }
1479
1480                 $this->mInterwiki = $this->mFragment = '';
1481                 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
1482
1483                 $dbkey = $this->mDbkeyform;
1484
1485                 # Strip Unicode bidi override characters.
1486                 # Sometimes they slip into cut-n-pasted page titles, where the
1487                 # override chars get included in list displays.
1488                 $dbkey = str_replace( "\xE2\x80\x8E", '', $dbkey ); // 200E LEFT-TO-RIGHT MARK
1489                 $dbkey = str_replace( "\xE2\x80\x8F", '', $dbkey ); // 200F RIGHT-TO-LEFT MARK
1490
1491                 # Clean up whitespace
1492                 #
1493                 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
1494                 $dbkey = trim( $dbkey, '_' );
1495
1496                 if ( '' == $dbkey ) {
1497                         return false;
1498                 }
1499
1500                 if( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
1501                         # Contained illegal UTF-8 sequences or forbidden Unicode chars.
1502                         return false;
1503                 }
1504
1505                 $this->mDbkeyform = $dbkey;
1506
1507                 # Initial colon indicates main namespace rather than specified default
1508                 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
1509                 if ( ':' == $dbkey{0} ) {
1510                         $this->mNamespace = NS_MAIN;
1511                         $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
1512                 }
1513
1514                 # Namespace or interwiki prefix
1515                 $firstPass = true;
1516                 do {
1517                         $m = array();
1518                         if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $dbkey, $m ) ) {
1519                                 $p = $m[1];
1520                                 $lowerNs = $wgContLang->lc( $p );
1521                                 if ( $ns = Namespace::getCanonicalIndex( $lowerNs ) ) {
1522                                         # Canonical namespace
1523                                         $dbkey = $m[2];
1524                                         $this->mNamespace = $ns;
1525                                 } elseif ( $ns = $wgContLang->getNsIndex( $lowerNs )) {
1526                                         # Ordinary namespace
1527                                         $dbkey = $m[2];
1528                                         $this->mNamespace = $ns;
1529                                 } elseif( $this->getInterwikiLink( $p ) ) {
1530                                         if( !$firstPass ) {
1531                                                 # Can't make a local interwiki link to an interwiki link.
1532                                                 # That's just crazy!
1533                                                 return false;
1534                                         }
1535
1536                                         # Interwiki link
1537                                         $dbkey = $m[2];
1538                                         $this->mInterwiki = $wgContLang->lc( $p );
1539
1540                                         # Redundant interwiki prefix to the local wiki
1541                                         if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
1542                                                 if( $dbkey == '' ) {
1543                                                         # Can't have an empty self-link
1544                                                         return false;
1545                                                 }
1546                                                 $this->mInterwiki = '';
1547                                                 $firstPass = false;
1548                                                 # Do another namespace split...
1549                                                 continue;
1550                                         }
1551
1552                                         # If there's an initial colon after the interwiki, that also
1553                                         # resets the default namespace
1554                                         if ( $dbkey !== '' && $dbkey[0] == ':' ) {
1555                                                 $this->mNamespace = NS_MAIN;
1556                                                 $dbkey = substr( $dbkey, 1 );
1557                                         }
1558                                 }
1559                                 # If there's no recognized interwiki or namespace,
1560                                 # then let the colon expression be part of the title.
1561                         }
1562                         break;
1563                 } while( true );
1564
1565                 # We already know that some pages won't be in the database!
1566                 #
1567                 if ( '' != $this->mInterwiki || NS_SPECIAL == $this->mNamespace ) {
1568                         $this->mArticleID = 0;
1569                 }
1570                 $fragment = strstr( $dbkey, '#' );
1571                 if ( false !== $fragment ) {
1572                         $this->setFragment( $fragment );
1573                         $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
1574                         # remove whitespace again: prevents "Foo_bar_#"
1575                         # becoming "Foo_bar_"
1576                         $dbkey = preg_replace( '/_*$/', '', $dbkey );
1577                 }
1578
1579                 # Reject illegal characters.
1580                 #
1581                 if( preg_match( $rxTc, $dbkey ) ) {
1582                         return false;
1583                 }
1584
1585                 /**
1586                  * Pages with "/./" or "/../" appearing in the URLs will
1587                  * often be unreachable due to the way web browsers deal
1588                  * with 'relative' URLs. Forbid them explicitly.
1589                  */
1590                 if ( strpos( $dbkey, '.' ) !== false &&
1591                      ( $dbkey === '.' || $dbkey === '..' ||
1592                        strpos( $dbkey, './' ) === 0  ||
1593                        strpos( $dbkey, '../' ) === 0 ||
1594                        strpos( $dbkey, '/./' ) !== false ||
1595                        strpos( $dbkey, '/../' ) !== false ) )
1596                 {
1597                         return false;
1598                 }
1599
1600                 /**
1601                  * Limit the size of titles to 255 bytes.
1602                  * This is typically the size of the underlying database field.
1603                  * We make an exception for special pages, which don't need to be stored
1604                  * in the database, and may edge over 255 bytes due to subpage syntax
1605                  * for long titles, e.g. [[Special:Block/Long name]]
1606                  */
1607                 if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) ||
1608                   strlen( $dbkey ) > 512 )
1609                 {
1610                         return false;
1611                 }
1612
1613                 /**
1614                  * Normally, all wiki links are forced to have
1615                  * an initial capital letter so [[foo]] and [[Foo]]
1616                  * point to the same place.
1617                  *
1618                  * Don't force it for interwikis, since the other
1619                  * site might be case-sensitive.
1620                  */
1621                 if( $wgCapitalLinks && $this->mInterwiki == '') {
1622                         $dbkey = $wgContLang->ucfirst( $dbkey );
1623                 }
1624
1625                 /**
1626                  * Can't make a link to a namespace alone...
1627                  * "empty" local links can only be self-links
1628                  * with a fragment identifier.
1629                  */
1630                 if( $dbkey == '' &&
1631                         $this->mInterwiki == '' &&
1632                         $this->mNamespace != NS_MAIN ) {
1633                         return false;
1634                 }
1635
1636                 // Any remaining initial :s are illegal.
1637                 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
1638                         return false;
1639                 }
1640
1641                 # Fill fields
1642                 $this->mDbkeyform = $dbkey;
1643                 $this->mUrlform = wfUrlencode( $dbkey );
1644
1645                 $this->mTextform = str_replace( '_', ' ', $dbkey );
1646
1647                 return true;
1648         }
1649
1650         /**
1651          * Set the fragment for this title
1652          * This is kind of bad, since except for this rarely-used function, Title objects
1653          * are immutable. The reason this is here is because it's better than setting the
1654          * members directly, which is what Linker::formatComment was doing previously.
1655          *
1656          * @param string $fragment text
1657          * @access kind of public
1658          */
1659         function setFragment( $fragment ) {
1660                 $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
1661         }
1662
1663         /**
1664          * Get a Title object associated with the talk page of this article
1665          * @return Title the object for the talk page
1666          * @access public
1667          */
1668         function getTalkPage() {
1669                 return Title::makeTitle( Namespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1670         }
1671
1672         /**
1673          * Get a title object associated with the subject page of this
1674          * talk page
1675          *
1676          * @return Title the object for the subject page
1677          * @access public
1678          */
1679         function getSubjectPage() {
1680                 return Title::makeTitle( Namespace::getSubject( $this->getNamespace() ), $this->getDBkey() );
1681         }
1682
1683         /**
1684          * Get an array of Title objects linking to this Title
1685          * Also stores the IDs in the link cache.
1686          *
1687          * WARNING: do not use this function on arbitrary user-supplied titles!
1688          * On heavily-used templates it will max out the memory.
1689          *
1690          * @param string $options may be FOR UPDATE
1691          * @return array the Title objects linking here
1692          * @access public
1693          */
1694         function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
1695                 $linkCache =& LinkCache::singleton();
1696
1697                 if ( $options ) {
1698                         $db =& wfGetDB( DB_MASTER );
1699                 } else {
1700                         $db =& wfGetDB( DB_SLAVE );
1701                 }
1702
1703                 $res = $db->select( array( 'page', $table ),
1704                         array( 'page_namespace', 'page_title', 'page_id' ),
1705                         array(
1706                                 "{$prefix}_from=page_id",
1707                                 "{$prefix}_namespace" => $this->getNamespace(),
1708                                 "{$prefix}_title"     => $this->getDbKey() ),
1709                         'Title::getLinksTo',
1710                         $options );
1711
1712                 $retVal = array();
1713                 if ( $db->numRows( $res ) ) {
1714                         while ( $row = $db->fetchObject( $res ) ) {
1715                                 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
1716                                         $linkCache->addGoodLinkObj( $row->page_id, $titleObj );
1717                                         $retVal[] = $titleObj;
1718                                 }
1719                         }
1720                 }
1721                 $db->freeResult( $res );
1722                 return $retVal;
1723         }
1724
1725         /**
1726          * Get an array of Title objects using this Title as a template
1727          * Also stores the IDs in the link cache.
1728          *
1729          * WARNING: do not use this function on arbitrary user-supplied titles!
1730          * On heavily-used templates it will max out the memory.
1731          *
1732          * @param string $options may be FOR UPDATE
1733          * @return array the Title objects linking here
1734          * @access public
1735          */
1736         function getTemplateLinksTo( $options = '' ) {
1737                 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
1738         }
1739
1740         /**
1741          * Get an array of Title objects referring to non-existent articles linked from this page
1742          *
1743          * @param string $options may be FOR UPDATE
1744          * @return array the Title objects
1745          * @access public
1746          */
1747         function getBrokenLinksFrom( $options = '' ) {
1748                 if ( $options ) {
1749                         $db =& wfGetDB( DB_MASTER );
1750                 } else {
1751                         $db =& wfGetDB( DB_SLAVE );
1752                 }
1753
1754                 $res = $db->safeQuery(
1755                           "SELECT pl_namespace, pl_title
1756                              FROM !
1757                         LEFT JOIN !
1758                                ON pl_namespace=page_namespace
1759                               AND pl_title=page_title
1760                             WHERE pl_from=?
1761                               AND page_namespace IS NULL
1762                                   !",
1763                         $db->tableName( 'pagelinks' ),
1764                         $db->tableName( 'page' ),
1765                         $this->getArticleId(),
1766                         $options );
1767
1768                 $retVal = array();
1769                 if ( $db->numRows( $res ) ) {
1770                         while ( $row = $db->fetchObject( $res ) ) {
1771                                 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
1772                         }
1773                 }
1774                 $db->freeResult( $res );
1775                 return $retVal;
1776         }
1777
1778
1779         /**
1780          * Get a list of URLs to purge from the Squid cache when this
1781          * page changes
1782          *
1783          * @return array the URLs
1784          * @access public
1785          */
1786         function getSquidURLs() {
1787                 global $wgContLang;
1788
1789                 $urls = array(
1790                         $this->getInternalURL(),
1791                         $this->getInternalURL( 'action=history' )
1792                 );
1793
1794                 // purge variant urls as well
1795                 if($wgContLang->hasVariants()){
1796                         $variants = $wgContLang->getVariants();
1797                         foreach($variants as $vCode){
1798                                 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
1799                                 $urls[] = $this->getInternalURL('',$vCode);
1800                         }
1801                 }
1802
1803                 return $urls;
1804         }
1805
1806         function purgeSquid() {
1807                 global $wgUseSquid;
1808                 if ( $wgUseSquid ) {
1809                         $urls = $this->getSquidURLs();
1810                         $u = new SquidUpdate( $urls );
1811                         $u->doUpdate();
1812                 }
1813         }
1814
1815         /**
1816          * Move this page without authentication
1817          * @param Title &$nt the new page Title
1818          * @access public
1819          */
1820         function moveNoAuth( &$nt ) {
1821                 return $this->moveTo( $nt, false );
1822         }
1823
1824         /**
1825          * Check whether a given move operation would be valid.
1826          * Returns true if ok, or a message key string for an error message
1827          * if invalid. (Scarrrrry ugly interface this.)
1828          * @param Title &$nt the new title
1829          * @param bool $auth indicates whether $wgUser's permissions
1830          *      should be checked
1831          * @return mixed true on success, message name on failure
1832          * @access public
1833          */
1834         function isValidMoveOperation( &$nt, $auth = true ) {
1835                 if( !$this or !$nt ) {
1836                         return 'badtitletext';
1837                 }
1838                 if( $this->equals( $nt ) ) {
1839                         return 'selfmove';
1840                 }
1841                 if( !$this->isMovable() || !$nt->isMovable() ) {
1842                         return 'immobile_namespace';
1843                 }
1844
1845                 $oldid = $this->getArticleID();
1846                 $newid = $nt->getArticleID();
1847
1848                 if ( strlen( $nt->getDBkey() ) < 1 ) {
1849                         return 'articleexists';
1850                 }
1851                 if ( ( '' == $this->getDBkey() ) ||
1852                          ( !$oldid ) ||
1853                      ( '' == $nt->getDBkey() ) ) {
1854                         return 'badarticleerror';
1855                 }
1856
1857                 if ( $auth && (
1858                                 !$this->userCanEdit() || !$nt->userCanEdit() ||
1859                                 !$this->userCanMove() || !$nt->userCanMove() ) ) {
1860                         return 'protectedpage';
1861                 }
1862
1863                 # The move is allowed only if (1) the target doesn't exist, or
1864                 # (2) the target is a redirect to the source, and has no history
1865                 # (so we can undo bad moves right after they're done).
1866
1867                 if ( 0 != $newid ) { # Target exists; check for validity
1868                         if ( ! $this->isValidMoveTarget( $nt ) ) {
1869                                 return 'articleexists';
1870                         }
1871                 }
1872                 return true;
1873         }
1874
1875         /**
1876          * Move a title to a new location
1877          * @param Title &$nt the new title
1878          * @param bool $auth indicates whether $wgUser's permissions
1879          *      should be checked
1880          * @return mixed true on success, message name on failure
1881          * @access public
1882          */
1883         function moveTo( &$nt, $auth = true, $reason = '' ) {
1884                 $err = $this->isValidMoveOperation( $nt, $auth );
1885                 if( is_string( $err ) ) {
1886                         return $err;
1887                 }
1888
1889                 $pageid = $this->getArticleID();
1890                 if( $nt->exists() ) {
1891                         $this->moveOverExistingRedirect( $nt, $reason );
1892                         $pageCountChange = 0;
1893                 } else { # Target didn't exist, do normal move.
1894                         $this->moveToNewTitle( $nt, $reason );
1895                         $pageCountChange = 1;
1896                 }
1897                 $redirid = $this->getArticleID();
1898
1899                 # Fixing category links (those without piped 'alternate' names) to be sorted under the new title
1900                 $dbw =& wfGetDB( DB_MASTER );
1901                 $categorylinks = $dbw->tableName( 'categorylinks' );
1902                 $sql = "UPDATE $categorylinks SET cl_sortkey=" . $dbw->addQuotes( $nt->getPrefixedText() ) .
1903                         " WHERE cl_from=" . $dbw->addQuotes( $pageid ) .
1904                         " AND cl_sortkey=" . $dbw->addQuotes( $this->getPrefixedText() );
1905                 $dbw->query( $sql, 'SpecialMovepage::doSubmit' );
1906
1907                 # Update watchlists
1908
1909                 $oldnamespace = $this->getNamespace() & ~1;
1910                 $newnamespace = $nt->getNamespace() & ~1;
1911                 $oldtitle = $this->getDBkey();
1912                 $newtitle = $nt->getDBkey();
1913
1914                 if( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
1915                         WatchedItem::duplicateEntries( $this, $nt );
1916                 }
1917
1918                 # Update search engine
1919                 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
1920                 $u->doUpdate();
1921                 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
1922                 $u->doUpdate();
1923
1924                 # Update site_stats
1925                 if ( $this->getNamespace() == NS_MAIN and $nt->getNamespace() != NS_MAIN ) {
1926                         # Moved out of main namespace
1927                         # not viewed, edited, removing
1928                         $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange);
1929                 } elseif ( $this->getNamespace() != NS_MAIN and $nt->getNamespace() == NS_MAIN ) {
1930                         # Moved into main namespace
1931                         # not viewed, edited, adding
1932                         $u = new SiteStatsUpdate( 0, 1, +1, $pageCountChange );
1933                 } elseif ( $pageCountChange ) {
1934                         # Added redirect
1935                         $u = new SiteStatsUpdate( 0, 0, 0, 1 );
1936                 } else{
1937                         $u = false;
1938                 }
1939                 if ( $u ) {
1940                         $u->doUpdate();
1941                 }
1942
1943                 global $wgUser;
1944                 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
1945                 return true;
1946         }
1947
1948         /**
1949          * Move page to a title which is at present a redirect to the
1950          * source page
1951          *
1952          * @param Title &$nt the page to move to, which should currently
1953          *      be a redirect
1954          * @private
1955          */
1956         function moveOverExistingRedirect( &$nt, $reason = '' ) {
1957                 global $wgUseSquid;
1958                 $fname = 'Title::moveOverExistingRedirect';
1959                 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
1960
1961                 if ( $reason ) {
1962                         $comment .= ": $reason";
1963                 }
1964
1965                 $now = wfTimestampNow();
1966                 $newid = $nt->getArticleID();
1967                 $oldid = $this->getArticleID();
1968                 $dbw =& wfGetDB( DB_MASTER );
1969                 $linkCache =& LinkCache::singleton();
1970
1971                 # Delete the old redirect. We don't save it to history since
1972                 # by definition if we've got here it's rather uninteresting.
1973                 # We have to remove it so that the next step doesn't trigger
1974                 # a conflict on the unique namespace+title index...
1975                 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
1976
1977                 # Save a null revision in the page's history notifying of the move
1978                 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
1979                 $nullRevId = $nullRevision->insertOn( $dbw );
1980
1981                 # Change the name of the target page:
1982                 $dbw->update( 'page',
1983                         /* SET */ array(
1984                                 'page_touched'   => $dbw->timestamp($now),
1985                                 'page_namespace' => $nt->getNamespace(),
1986                                 'page_title'     => $nt->getDBkey(),
1987                                 'page_latest'    => $nullRevId,
1988                         ),
1989                         /* WHERE */ array( 'page_id' => $oldid ),
1990                         $fname
1991                 );
1992                 $linkCache->clearLink( $nt->getPrefixedDBkey() );
1993
1994                 # Recreate the redirect, this time in the other direction.
1995                 $mwRedir = MagicWord::get( 'redirect' );
1996                 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
1997                 $redirectArticle = new Article( $this );
1998                 $newid = $redirectArticle->insertOn( $dbw );
1999                 $redirectRevision = new Revision( array(
2000                         'page'    => $newid,
2001                         'comment' => $comment,
2002                         'text'    => $redirectText ) );
2003                 $redirectRevision->insertOn( $dbw );
2004                 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2005                 $linkCache->clearLink( $this->getPrefixedDBkey() );
2006
2007                 # Log the move
2008                 $log = new LogPage( 'move' );
2009                 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
2010
2011                 # Now, we record the link from the redirect to the new title.
2012                 # It should have no other outgoing links...
2013                 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2014                 $dbw->insert( 'pagelinks',
2015                         array(
2016                                 'pl_from'      => $newid,
2017                                 'pl_namespace' => $nt->getNamespace(),
2018                                 'pl_title'     => $nt->getDbKey() ),
2019                         $fname );
2020
2021                 # Purge squid
2022                 if ( $wgUseSquid ) {
2023                         $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2024                         $u = new SquidUpdate( $urls );
2025                         $u->doUpdate();
2026                 }
2027         }
2028
2029         /**
2030          * Move page to non-existing title.
2031          * @param Title &$nt the new Title
2032          * @private
2033          */
2034         function moveToNewTitle( &$nt, $reason = '' ) {
2035                 global $wgUseSquid;
2036                 $fname = 'MovePageForm::moveToNewTitle';
2037                 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2038                 if ( $reason ) {
2039                         $comment .= ": $reason";
2040                 }
2041
2042                 $newid = $nt->getArticleID();
2043                 $oldid = $this->getArticleID();
2044                 $dbw =& wfGetDB( DB_MASTER );
2045                 $now = $dbw->timestamp();
2046                 $linkCache =& LinkCache::singleton();
2047
2048                 # Save a null revision in the page's history notifying of the move
2049                 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
2050                 $nullRevId = $nullRevision->insertOn( $dbw );
2051
2052                 # Rename cur entry
2053                 $dbw->update( 'page',
2054                         /* SET */ array(
2055                                 'page_touched'   => $now,
2056                                 'page_namespace' => $nt->getNamespace(),
2057                                 'page_title'     => $nt->getDBkey(),
2058                                 'page_latest'    => $nullRevId,
2059                         ),
2060                         /* WHERE */ array( 'page_id' => $oldid ),
2061                         $fname
2062                 );
2063
2064                 $linkCache->clearLink( $nt->getPrefixedDBkey() );
2065
2066                 # Insert redirect
2067                 $mwRedir = MagicWord::get( 'redirect' );
2068                 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2069                 $redirectArticle = new Article( $this );
2070                 $newid = $redirectArticle->insertOn( $dbw );
2071                 $redirectRevision = new Revision( array(
2072                         'page'    => $newid,
2073                         'comment' => $comment,
2074                         'text'    => $redirectText ) );
2075                 $redirectRevision->insertOn( $dbw );
2076                 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2077                 $linkCache->clearLink( $this->getPrefixedDBkey() );
2078
2079                 # Log the move
2080                 $log = new LogPage( 'move' );
2081                 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
2082
2083                 # Purge caches as per article creation
2084                 Article::onArticleCreate( $nt );
2085
2086                 # Record the just-created redirect's linking to the page
2087                 $dbw->insert( 'pagelinks',
2088                         array(
2089                                 'pl_from'      => $newid,
2090                                 'pl_namespace' => $nt->getNamespace(),
2091                                 'pl_title'     => $nt->getDBkey() ),
2092                         $fname );
2093
2094                 # Purge old title from squid
2095                 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2096                 $this->purgeSquid();
2097         }
2098
2099         /**
2100          * Checks if $this can be moved to a given Title
2101          * - Selects for update, so don't call it unless you mean business
2102          *
2103          * @param Title &$nt the new title to check
2104          * @access public
2105          */
2106         function isValidMoveTarget( $nt ) {
2107
2108                 $fname = 'Title::isValidMoveTarget';
2109                 $dbw =& wfGetDB( DB_MASTER );
2110
2111                 # Is it a redirect?
2112                 $id  = $nt->getArticleID();
2113                 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
2114                         array( 'page_is_redirect','old_text','old_flags' ),
2115                         array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
2116                         $fname, 'FOR UPDATE' );
2117
2118                 if ( !$obj || 0 == $obj->page_is_redirect ) {
2119                         # Not a redirect
2120                         wfDebug( __METHOD__ . ": not a redirect\n" );
2121                         return false;
2122                 }
2123                 $text = Revision::getRevisionText( $obj );
2124
2125                 # Does the redirect point to the source?
2126                 # Or is it a broken self-redirect, usually caused by namespace collisions?
2127                 $m = array();
2128                 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2129                         $redirTitle = Title::newFromText( $m[1] );
2130                         if( !is_object( $redirTitle ) ||
2131                                 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2132                                 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2133                                 wfDebug( __METHOD__ . ": redirect points to other page\n" );
2134                                 return false;
2135                         }
2136                 } else {
2137                         # Fail safe
2138                         wfDebug( __METHOD__ . ": failsafe\n" );
2139                         return false;
2140                 }
2141
2142                 # Does the article have a history?
2143                 $row = $dbw->selectRow( array( 'page', 'revision'),
2144                         array( 'rev_id' ),
2145                         array( 'page_namespace' => $nt->getNamespace(),
2146                                 'page_title' => $nt->getDBkey(),
2147                                 'page_id=rev_page AND page_latest != rev_id'
2148                         ), $fname, 'FOR UPDATE'
2149                 );
2150
2151                 # Return true if there was no history
2152                 return $row === false;
2153         }
2154
2155         /**
2156          * Create a redirect; fails if the title already exists; does
2157          * not notify RC
2158          *
2159          * @param Title $dest the destination of the redirect
2160          * @param string $comment the comment string describing the move
2161          * @return bool true on success
2162          * @access public
2163          */
2164         function createRedirect( $dest, $comment ) {
2165                 if ( $this->getArticleID() ) {
2166                         return false;
2167                 }
2168
2169                 $fname = 'Title::createRedirect';
2170                 $dbw =& wfGetDB( DB_MASTER );
2171
2172                 $article = new Article( $this );
2173                 $newid = $article->insertOn( $dbw );
2174                 $revision = new Revision( array(
2175                         'page'      => $newid,
2176                         'comment'   => $comment,
2177                         'text'      => "#REDIRECT [[" . $dest->getPrefixedText() . "]]\n",
2178                         ) );
2179                 $revision->insertOn( $dbw );
2180                 $article->updateRevisionOn( $dbw, $revision, 0 );
2181
2182                 # Link table
2183                 $dbw->insert( 'pagelinks',
2184                         array(
2185                                 'pl_from'      => $newid,
2186                                 'pl_namespace' => $dest->getNamespace(),
2187                                 'pl_title'     => $dest->getDbKey()
2188                         ), $fname
2189                 );
2190
2191                 Article::onArticleCreate( $this );
2192                 return true;
2193         }
2194
2195         /**
2196          * Get categories to which this Title belongs and return an array of
2197          * categories' names.
2198          *
2199          * @return array an array of parents in the form:
2200          *      $parent => $currentarticle
2201          * @access public
2202          */
2203         function getParentCategories() {
2204                 global $wgContLang;
2205
2206                 $titlekey = $this->getArticleId();
2207                 $dbr =& wfGetDB( DB_SLAVE );
2208                 $categorylinks = $dbr->tableName( 'categorylinks' );
2209
2210                 # NEW SQL
2211                 $sql = "SELECT * FROM $categorylinks"
2212                      ." WHERE cl_from='$titlekey'"
2213                          ." AND cl_from <> '0'"
2214                          ." ORDER BY cl_sortkey";
2215
2216                 $res = $dbr->query ( $sql ) ;
2217
2218                 if($dbr->numRows($res) > 0) {
2219                         while ( $x = $dbr->fetchObject ( $res ) )
2220                                 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
2221                                 $data[$wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to] = $this->getFullText();
2222                         $dbr->freeResult ( $res ) ;
2223                 } else {
2224                         $data = '';
2225                 }
2226                 return $data;
2227         }
2228
2229         /**
2230          * Get a tree of parent categories
2231          * @param array $children an array with the children in the keys, to check for circular refs
2232          * @return array
2233          * @access public
2234          */
2235         function getParentCategoryTree( $children = array() ) {
2236                 $parents = $this->getParentCategories();
2237
2238                 if($parents != '') {
2239                         foreach($parents as $parent => $current) {
2240                                 if ( array_key_exists( $parent, $children ) ) {
2241                                         # Circular reference
2242                                         $stack[$parent] = array();
2243                                 } else {
2244                                         $nt = Title::newFromText($parent);
2245                                         if ( $nt ) {
2246                                                 $stack[$parent] = $nt->getParentCategoryTree( $children + array($parent => 1) );
2247                                         }
2248                                 }
2249                         }
2250                         return $stack;
2251                 } else {
2252                         return array();
2253                 }
2254         }
2255
2256
2257         /**
2258          * Get an associative array for selecting this title from
2259          * the "page" table
2260          *
2261          * @return array
2262          * @access public
2263          */
2264         function pageCond() {
2265                 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
2266         }
2267
2268         /**
2269          * Get the revision ID of the previous revision
2270          *
2271          * @param integer $revision  Revision ID. Get the revision that was before this one.
2272          * @return integer $oldrevision|false
2273          */
2274         function getPreviousRevisionID( $revision ) {
2275                 $dbr =& wfGetDB( DB_SLAVE );
2276                 return $dbr->selectField( 'revision', 'rev_id',
2277                         'rev_page=' . intval( $this->getArticleId() ) .
2278                         ' AND rev_id<' . intval( $revision ) . ' ORDER BY rev_id DESC' );
2279         }
2280
2281         /**
2282          * Get the revision ID of the next revision
2283          *
2284          * @param integer $revision  Revision ID. Get the revision that was after this one.
2285          * @return integer $oldrevision|false
2286          */
2287         function getNextRevisionID( $revision ) {
2288                 $dbr =& wfGetDB( DB_SLAVE );
2289                 return $dbr->selectField( 'revision', 'rev_id',
2290                         'rev_page=' . intval( $this->getArticleId() ) .
2291                         ' AND rev_id>' . intval( $revision ) . ' ORDER BY rev_id' );
2292         }
2293
2294         /**
2295          * Get the number of revisions between the given revision IDs.
2296          *
2297          * @param integer $old  Revision ID.
2298          * @param integer $new  Revision ID.
2299          * @return integer  Number of revisions between these IDs.
2300          */
2301         function countRevisionsBetween( $old, $new ) {
2302                 $dbr =& wfGetDB( DB_SLAVE );
2303                 return $dbr->selectField( 'revision', 'count(*)',
2304                         'rev_page = ' . intval( $this->getArticleId() ) .
2305                         ' AND rev_id > ' . intval( $old ) .
2306                         ' AND rev_id < ' . intval( $new ) );
2307         }
2308
2309         /**
2310          * Compare with another title.
2311          *
2312          * @param Title $title
2313          * @return bool
2314          */
2315         function equals( $title ) {
2316                 // Note: === is necessary for proper matching of number-like titles.
2317                 return $this->getInterwiki() === $title->getInterwiki()
2318                         && $this->getNamespace() == $title->getNamespace()
2319                         && $this->getDbkey() === $title->getDbkey();
2320         }
2321
2322         /**
2323          * Check if page exists
2324          * @return bool
2325          */
2326         function exists() {
2327                 return $this->getArticleId() != 0;
2328         }
2329
2330         /**
2331          * Should a link should be displayed as a known link, just based on its title?
2332          *
2333          * Currently, a self-link with a fragment and special pages are in
2334          * this category. Special pages never exist in the database.
2335          */
2336         function isAlwaysKnown() {
2337                 return  $this->isExternal() || ( 0 == $this->mNamespace && "" == $this->mDbkeyform )
2338                   || NS_SPECIAL == $this->mNamespace;
2339         }
2340
2341         /**
2342          * Update page_touched timestamps and send squid purge messages for
2343          * pages linking to this title. May be sent to the job queue depending
2344          * on the number of links. Typically called on create and delete.
2345          */
2346         function touchLinks() {
2347                 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
2348                 $u->doUpdate();
2349
2350                 if ( $this->getNamespace() == NS_CATEGORY ) {
2351                         $u = new HTMLCacheUpdate( $this, 'categorylinks' );
2352                         $u->doUpdate();
2353                 }
2354         }
2355
2356         /**
2357          * Get the last touched timestamp
2358          */
2359         function getTouched() {
2360                 $dbr =& wfGetDB( DB_SLAVE );
2361                 $touched = $dbr->selectField( 'page', 'page_touched',
2362                         array(
2363                                 'page_namespace' => $this->getNamespace(),
2364                                 'page_title' => $this->getDBkey()
2365                         ), __METHOD__
2366                 );
2367                 return $touched;
2368         }
2369
2370         /**
2371          * Get a cached value from a global cache that is invalidated when this page changes
2372          * @param string $key the key
2373          * @param callback $callback A callback function which generates the value on cache miss
2374          *
2375          * @deprecated use DependencyWrapper
2376          */
2377         function getRelatedCache( $memc, $key, $expiry, $callback, $params = array() ) {
2378                 return DependencyWrapper::getValueFromCache( $memc, $key, $expiry, $callback,
2379                         $params, new TitleDependency( $this ) );
2380         }
2381
2382         function trackbackURL() {
2383                 global $wgTitle, $wgScriptPath, $wgServer;
2384
2385                 return "$wgServer$wgScriptPath/trackback.php?article="
2386                         . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey()));
2387         }
2388
2389         function trackbackRDF() {
2390                 $url = htmlspecialchars($this->getFullURL());
2391                 $title = htmlspecialchars($this->getText());
2392                 $tburl = $this->trackbackURL();
2393
2394                 return "
2395 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
2396          xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
2397          xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
2398 <rdf:Description
2399    rdf:about=\"$url\"
2400    dc:identifier=\"$url\"
2401    dc:title=\"$title\"
2402    trackback:ping=\"$tburl\" />
2403 </rdf:RDF>";
2404         }
2405
2406         /**
2407          * Generate strings used for xml 'id' names in monobook tabs
2408          * @return string
2409          */
2410         function getNamespaceKey() {
2411                 global $wgContLang;
2412                 switch ($this->getNamespace()) {
2413                         case NS_MAIN:
2414                         case NS_TALK:
2415                                 return 'nstab-main';
2416                         case NS_USER:
2417                         case NS_USER_TALK:
2418                                 return 'nstab-user';
2419                         case NS_MEDIA:
2420                                 return 'nstab-media';
2421                         case NS_SPECIAL:
2422                                 return 'nstab-special';
2423                         case NS_PROJECT:
2424                         case NS_PROJECT_TALK:
2425                                 return 'nstab-project';
2426                         case NS_IMAGE:
2427                         case NS_IMAGE_TALK:
2428                                 return 'nstab-image';
2429                         case NS_MEDIAWIKI:
2430                         case NS_MEDIAWIKI_TALK:
2431                                 return 'nstab-mediawiki';
2432                         case NS_TEMPLATE:
2433                         case NS_TEMPLATE_TALK:
2434                                 return 'nstab-template';
2435                         case NS_HELP:
2436                         case NS_HELP_TALK:
2437                                 return 'nstab-help';
2438                         case NS_CATEGORY:
2439                         case NS_CATEGORY_TALK:
2440                                 return 'nstab-category';
2441                         default:
2442                                 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
2443                 }
2444         }
2445
2446         /**
2447          * Returns true if this title resolves to the named special page
2448          * @param string $name The special page name
2449          * @access public
2450          */
2451         function isSpecial( $name ) {
2452                 if ( $this->getNamespace() == NS_SPECIAL ) {
2453                         list( $thisName, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $this->getDBkey() );
2454                         if ( $name == $thisName ) {
2455                                 return true;
2456                         }
2457                 }
2458                 return false;
2459         }
2460
2461         /**
2462          * If the Title refers to a special page alias which is not the local default,
2463          * returns a new Title which points to the local default. Otherwise, returns $this.
2464          */
2465         function fixSpecialName() {
2466                 if ( $this->getNamespace() == NS_SPECIAL ) {
2467                         $canonicalName = SpecialPage::resolveAlias( $this->mDbkeyform );
2468                         if ( $canonicalName ) {
2469                                 $localName = SpecialPage::getLocalNameFor( $canonicalName );
2470                                 if ( $localName != $this->mDbkeyform ) {
2471                                         return Title::makeTitle( NS_SPECIAL, $localName );
2472                                 }
2473                         }
2474                 }
2475                 return $this;
2476         }
2477 }
2478 ?>