* (bug 6976) Add namespace and direction classes to classic skins
[mediawiki.git] / includes / Title.php
blob7eae8017232ddd41e166788af0bf3687c894aed2
1 <?php
2 /**
3 * See title.txt
5 * @package MediaWiki
6 */
8 /** */
9 require_once( 'normal/UtfNormal.php' );
11 define ( 'GAID_FOR_UPDATE', 1 );
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 );
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.
25 * @package MediaWiki
27 class Title {
28 /**
29 * Static cache variables
31 static private $titleCache=array();
32 static private $interwikiCache=array();
35 /**
36 * All member variables should be considered private
37 * Please use the accessor functions
40 /**#@+
41 * @private
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 /**#@-*/
62 /**
63 * Constructor
64 * @private
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;
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
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;
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.
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
111 public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
112 $fname = 'Title::newFromText';
114 if( is_object( $text ) ) {
115 throw new MWException( 'Title::newFromText given an object' );
119 * Wiki pages often contain multiple links to the same page.
120 * Title normalization and parsing can become expensive on
121 * pages with many links, so we can save a little time by
122 * caching them.
124 * In theory these are value objects and won't get changed...
126 if( $defaultNamespace == NS_MAIN && isset( Title::$titleCache[$text] ) ) {
127 return Title::$titleCache[$text];
131 * Convert things like &eacute; &#257; or &#x3017; into real text...
133 $filteredText = Sanitizer::decodeCharReferences( $text );
135 $t = new Title();
136 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
137 $t->mDefaultNamespace = $defaultNamespace;
139 static $cachedcount = 0 ;
140 if( $t->secureAndSplit() ) {
141 if( $defaultNamespace == NS_MAIN ) {
142 if( $cachedcount >= MW_TITLECACHE_MAX ) {
143 # Avoid memory leaks on mass operations...
144 Title::$titleCache = array();
145 $cachedcount=0;
147 $cachedcount++;
148 Title::$titleCache[$text] =& $t;
150 return $t;
151 } else {
152 $ret = NULL;
153 return $ret;
158 * Create a new Title from URL-encoded text. Ensures that
159 * the given title's length does not exceed the maximum.
160 * @param string $url the title, as might be taken from a URL
161 * @return Title the new object, or NULL on an error
162 * @static
163 * @access public
165 function newFromURL( $url ) {
166 global $wgLegalTitleChars;
167 $t = new Title();
169 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
170 # but some URLs used it as a space replacement and they still come
171 # from some external search tools.
172 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
173 $url = str_replace( '+', ' ', $url );
176 $t->mDbkeyform = str_replace( ' ', '_', $url );
177 if( $t->secureAndSplit() ) {
178 return $t;
179 } else {
180 return NULL;
185 * Create a new Title from an article ID
187 * @todo This is inefficiently implemented, the page row is requested
188 * but not used for anything else
190 * @param int $id the page_id corresponding to the Title to create
191 * @return Title the new object, or NULL on an error
192 * @access public
193 * @static
195 function newFromID( $id ) {
196 $fname = 'Title::newFromID';
197 $dbr =& wfGetDB( DB_SLAVE );
198 $row = $dbr->selectRow( 'page', array( 'page_namespace', 'page_title' ),
199 array( 'page_id' => $id ), $fname );
200 if ( $row !== false ) {
201 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
202 } else {
203 $title = NULL;
205 return $title;
209 * Make an array of titles from an array of IDs
211 function newFromIDs( $ids ) {
212 $dbr =& wfGetDB( DB_SLAVE );
213 $res = $dbr->select( 'page', array( 'page_namespace', 'page_title' ),
214 'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__ );
216 $titles = array();
217 while ( $row = $dbr->fetchObject( $res ) ) {
218 $titles[] = Title::makeTitle( $row->page_namespace, $row->page_title );
220 return $titles;
224 * Create a new Title from a namespace index and a DB key.
225 * It's assumed that $ns and $title are *valid*, for instance when
226 * they came directly from the database or a special page name.
227 * For convenience, spaces are converted to underscores so that
228 * eg user_text fields can be used directly.
230 * @param int $ns the namespace of the article
231 * @param string $title the unprefixed database key form
232 * @return Title the new object
233 * @static
234 * @access public
236 public static function &makeTitle( $ns, $title ) {
237 $t = new Title();
238 $t->mInterwiki = '';
239 $t->mFragment = '';
240 $t->mNamespace = intval( $ns );
241 $t->mDbkeyform = str_replace( ' ', '_', $title );
242 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
243 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
244 $t->mTextform = str_replace( '_', ' ', $title );
245 return $t;
249 * Create a new Title from a namespace index and a DB key.
250 * The parameters will be checked for validity, which is a bit slower
251 * than makeTitle() but safer for user-provided data.
253 * @param int $ns the namespace of the article
254 * @param string $title the database key form
255 * @return Title the new object, or NULL on an error
256 * @static
257 * @access public
259 public static function makeTitleSafe( $ns, $title ) {
260 $t = new Title();
261 $t->mDbkeyform = Title::makeName( $ns, $title );
262 if( $t->secureAndSplit() ) {
263 return $t;
264 } else {
265 return NULL;
270 * Create a new Title for the Main Page
272 * @static
273 * @return Title the new object
274 * @access public
276 public static function newMainPage() {
277 return Title::newFromText( wfMsgForContent( 'mainpage' ) );
281 * Create a new Title for a redirect
282 * @param string $text the redirect title text
283 * @return Title the new object, or NULL if the text is not a
284 * valid redirect
285 * @static
286 * @access public
288 public static function newFromRedirect( $text ) {
289 $mwRedir = MagicWord::get( 'redirect' );
290 $rt = NULL;
291 if ( $mwRedir->matchStart( $text ) ) {
292 if ( preg_match( '/\[{2}(.*?)(?:\||\]{2})/', $text, $m ) ) {
293 # categories are escaped using : for example one can enter:
294 # #REDIRECT [[:Category:Music]]. Need to remove it.
295 if ( substr($m[1],0,1) == ':') {
296 # We don't want to keep the ':'
297 $m[1] = substr( $m[1], 1 );
300 $rt = Title::newFromText( $m[1] );
301 # Disallow redirects to Special:Userlogout
302 if ( !is_null($rt) && $rt->getNamespace() == NS_SPECIAL && preg_match( '/^Userlogout/i', $rt->getText() ) ) {
303 $rt = NULL;
307 return $rt;
310 #----------------------------------------------------------------------------
311 # Static functions
312 #----------------------------------------------------------------------------
315 * Get the prefixed DB key associated with an ID
316 * @param int $id the page_id of the article
317 * @return Title an object representing the article, or NULL
318 * if no such article was found
319 * @static
320 * @access public
322 function nameOf( $id ) {
323 $fname = 'Title::nameOf';
324 $dbr =& wfGetDB( DB_SLAVE );
326 $s = $dbr->selectRow( 'page', array( 'page_namespace','page_title' ), array( 'page_id' => $id ), $fname );
327 if ( $s === false ) { return NULL; }
329 $n = Title::makeName( $s->page_namespace, $s->page_title );
330 return $n;
334 * Get a regex character class describing the legal characters in a link
335 * @return string the list of characters, not delimited
336 * @static
337 * @access public
339 public static function legalChars() {
340 global $wgLegalTitleChars;
341 return $wgLegalTitleChars;
345 * Get a string representation of a title suitable for
346 * including in a search index
348 * @param int $ns a namespace index
349 * @param string $title text-form main part
350 * @return string a stripped-down title string ready for the
351 * search index
353 /* static */ function indexTitle( $ns, $title ) {
354 global $wgContLang;
356 $lc = SearchEngine::legalSearchChars() . '&#;';
357 $t = $wgContLang->stripForSearch( $title );
358 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
359 $t = strtolower( $t );
361 # Handle 's, s'
362 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
363 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
365 $t = preg_replace( "/\\s+/", ' ', $t );
367 if ( $ns == NS_IMAGE ) {
368 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
370 return trim( $t );
374 * Make a prefixed DB key from a DB key and a namespace index
375 * @param int $ns numerical representation of the namespace
376 * @param string $title the DB key form the title
377 * @return string the prefixed form of the title
379 public static function makeName( $ns, $title ) {
380 global $wgContLang;
382 $n = $wgContLang->getNsText( $ns );
383 return $n == '' ? $title : "$n:$title";
387 * Returns the URL associated with an interwiki prefix
388 * @param string $key the interwiki prefix (e.g. "MeatBall")
389 * @return the associated URL, containing "$1", which should be
390 * replaced by an article title
391 * @static (arguably)
392 * @access public
394 function getInterwikiLink( $key ) {
395 global $wgMemc, $wgDBname, $wgInterwikiExpiry;
396 global $wgInterwikiCache;
397 $fname = 'Title::getInterwikiLink';
399 $key = strtolower( $key );
401 $k = $wgDBname.':interwiki:'.$key;
402 if( array_key_exists( $k, Title::$interwikiCache ) ) {
403 return Title::$interwikiCache[$k]->iw_url;
406 if ($wgInterwikiCache) {
407 return Title::getInterwikiCached( $key );
410 $s = $wgMemc->get( $k );
411 # Ignore old keys with no iw_local
412 if( $s && isset( $s->iw_local ) && isset($s->iw_trans)) {
413 Title::$interwikiCache[$k] = $s;
414 return $s->iw_url;
417 $dbr =& wfGetDB( DB_SLAVE );
418 $res = $dbr->select( 'interwiki',
419 array( 'iw_url', 'iw_local', 'iw_trans' ),
420 array( 'iw_prefix' => $key ), $fname );
421 if( !$res ) {
422 return '';
425 $s = $dbr->fetchObject( $res );
426 if( !$s ) {
427 # Cache non-existence: create a blank object and save it to memcached
428 $s = (object)false;
429 $s->iw_url = '';
430 $s->iw_local = 0;
431 $s->iw_trans = 0;
433 $wgMemc->set( $k, $s, $wgInterwikiExpiry );
434 Title::$interwikiCache[$k] = $s;
436 return $s->iw_url;
440 * Fetch interwiki prefix data from local cache in constant database
442 * More logic is explained in DefaultSettings
444 * @return string URL of interwiki site
445 * @access public
447 function getInterwikiCached( $key ) {
448 global $wgDBname, $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
449 static $db, $site;
451 if (!$db)
452 $db=dba_open($wgInterwikiCache,'r','cdb');
453 /* Resolve site name */
454 if ($wgInterwikiScopes>=3 and !$site) {
455 $site = dba_fetch("__sites:{$wgDBname}", $db);
456 if ($site=="")
457 $site = $wgInterwikiFallbackSite;
459 $value = dba_fetch("{$wgDBname}:{$key}", $db);
460 if ($value=='' and $wgInterwikiScopes>=3) {
461 /* try site-level */
462 $value = dba_fetch("_{$site}:{$key}", $db);
464 if ($value=='' and $wgInterwikiScopes>=2) {
465 /* try globals */
466 $value = dba_fetch("__global:{$key}", $db);
468 if ($value=='undef')
469 $value='';
470 $s = (object)false;
471 $s->iw_url = '';
472 $s->iw_local = 0;
473 $s->iw_trans = 0;
474 if ($value!='') {
475 list($local,$url)=explode(' ',$value,2);
476 $s->iw_url=$url;
477 $s->iw_local=(int)$local;
479 Title::$interwikiCache[$wgDBname.':interwiki:'.$key] = $s;
480 return $s->iw_url;
483 * Determine whether the object refers to a page within
484 * this project.
486 * @return bool TRUE if this is an in-project interwiki link
487 * or a wikilink, FALSE otherwise
488 * @access public
490 function isLocal() {
491 global $wgDBname;
493 if ( $this->mInterwiki != '' ) {
494 # Make sure key is loaded into cache
495 $this->getInterwikiLink( $this->mInterwiki );
496 $k = $wgDBname.':interwiki:' . $this->mInterwiki;
497 return (bool)(Title::$interwikiCache[$k]->iw_local);
498 } else {
499 return true;
504 * Determine whether the object refers to a page within
505 * this project and is transcludable.
507 * @return bool TRUE if this is transcludable
508 * @access public
510 function isTrans() {
511 global $wgDBname;
513 if ($this->mInterwiki == '')
514 return false;
515 # Make sure key is loaded into cache
516 $this->getInterwikiLink( $this->mInterwiki );
517 $k = $wgDBname.':interwiki:' . $this->mInterwiki;
518 return (bool)(Title::$interwikiCache[$k]->iw_trans);
522 * Update the page_touched field for an array of title objects
523 * @todo Inefficient unless the IDs are already loaded into the
524 * link cache
525 * @param array $titles an array of Title objects to be touched
526 * @param string $timestamp the timestamp to use instead of the
527 * default current time
528 * @static
529 * @access public
531 function touchArray( $titles, $timestamp = '' ) {
533 if ( count( $titles ) == 0 ) {
534 return;
536 $dbw =& wfGetDB( DB_MASTER );
537 if ( $timestamp == '' ) {
538 $timestamp = $dbw->timestamp();
541 $page = $dbw->tableName( 'page' );
542 $sql = "UPDATE $page SET page_touched='{$timestamp}' WHERE page_id IN (";
543 $first = true;
545 foreach ( $titles as $title ) {
546 if ( $wgUseFileCache ) {
547 $cm = new CacheManager($title);
548 @unlink($cm->fileCacheName());
551 if ( ! $first ) {
552 $sql .= ',';
554 $first = false;
555 $sql .= $title->getArticleID();
557 $sql .= ')';
558 if ( ! $first ) {
559 $dbw->query( $sql, 'Title::touchArray' );
562 // hack hack hack -- brion 2005-07-11. this was unfriendly to db.
563 // do them in small chunks:
564 $fname = 'Title::touchArray';
565 foreach( $titles as $title ) {
566 $dbw->update( 'page',
567 array( 'page_touched' => $timestamp ),
568 array(
569 'page_namespace' => $title->getNamespace(),
570 'page_title' => $title->getDBkey() ),
571 $fname );
575 #----------------------------------------------------------------------------
576 # Other stuff
577 #----------------------------------------------------------------------------
579 /** Simple accessors */
581 * Get the text form (spaces not underscores) of the main part
582 * @return string
583 * @access public
585 function getText() { return $this->mTextform; }
587 * Get the URL-encoded form of the main part
588 * @return string
589 * @access public
591 function getPartialURL() { return $this->mUrlform; }
593 * Get the main part with underscores
594 * @return string
595 * @access public
597 function getDBkey() { return $this->mDbkeyform; }
599 * Get the namespace index, i.e. one of the NS_xxxx constants
600 * @return int
601 * @access public
603 function getNamespace() { return $this->mNamespace; }
605 * Get the namespace text
606 * @return string
607 * @access public
609 function getNsText() {
610 global $wgContLang;
611 return $wgContLang->getNsText( $this->mNamespace );
614 * Get the namespace text of the subject (rather than talk) page
615 * @return string
616 * @access public
618 function getSubjectNsText() {
619 global $wgContLang;
620 return $wgContLang->getNsText( Namespace::getSubject( $this->mNamespace ) );
624 * Get the namespace text of the talk page
625 * @return string
627 function getTalkNsText() {
628 global $wgContLang;
629 return( $wgContLang->getNsText( Namespace::getTalk( $this->mNamespace ) ) );
633 * Could this title have a corresponding talk page?
634 * @return bool
636 function canTalk() {
637 return( Namespace::canTalk( $this->mNamespace ) );
641 * Get the interwiki prefix (or null string)
642 * @return string
643 * @access public
645 function getInterwiki() { return $this->mInterwiki; }
647 * Get the Title fragment (i.e. the bit after the #)
648 * @return string
649 * @access public
651 function getFragment() { return $this->mFragment; }
653 * Get the default namespace index, for when there is no namespace
654 * @return int
655 * @access public
657 function getDefaultNamespace() { return $this->mDefaultNamespace; }
660 * Get title for search index
661 * @return string a stripped-down title string ready for the
662 * search index
664 function getIndexTitle() {
665 return Title::indexTitle( $this->mNamespace, $this->mTextform );
669 * Get the prefixed database key form
670 * @return string the prefixed title, with underscores and
671 * any interwiki and namespace prefixes
672 * @access public
674 function getPrefixedDBkey() {
675 $s = $this->prefix( $this->mDbkeyform );
676 $s = str_replace( ' ', '_', $s );
677 return $s;
681 * Get the prefixed title with spaces.
682 * This is the form usually used for display
683 * @return string the prefixed title, with spaces
684 * @access public
686 function getPrefixedText() {
687 if ( empty( $this->mPrefixedText ) ) { // FIXME: bad usage of empty() ?
688 $s = $this->prefix( $this->mTextform );
689 $s = str_replace( '_', ' ', $s );
690 $this->mPrefixedText = $s;
692 return $this->mPrefixedText;
696 * Get the prefixed title with spaces, plus any fragment
697 * (part beginning with '#')
698 * @return string the prefixed title, with spaces and
699 * the fragment, including '#'
700 * @access public
702 function getFullText() {
703 $text = $this->getPrefixedText();
704 if( '' != $this->mFragment ) {
705 $text .= '#' . $this->mFragment;
707 return $text;
711 * Get the base name, i.e. the leftmost parts before the /
712 * @return string Base name
714 function getBaseText() {
715 global $wgNamespacesWithSubpages;
716 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace ] ) && $wgNamespacesWithSubpages[ $this->mNamespace ] ) {
717 $parts = explode( '/', $this->getText() );
718 # Don't discard the real title if there's no subpage involved
719 if( count( $parts ) > 1 )
720 unset( $parts[ count( $parts ) - 1 ] );
721 return implode( '/', $parts );
722 } else {
723 return $this->getText();
728 * Get the lowest-level subpage name, i.e. the rightmost part after /
729 * @return string Subpage name
731 function getSubpageText() {
732 global $wgNamespacesWithSubpages;
733 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace ] ) && $wgNamespacesWithSubpages[ $this->mNamespace ] ) {
734 $parts = explode( '/', $this->mTextform );
735 return( $parts[ count( $parts ) - 1 ] );
736 } else {
737 return( $this->mTextform );
742 * Get a URL-encoded form of the subpage text
743 * @return string URL-encoded subpage name
745 function getSubpageUrlForm() {
746 $text = $this->getSubpageText();
747 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
748 $text = str_replace( '%28', '(', str_replace( '%29', ')', $text ) ); # Clean up the URL; per below, this might not be safe
749 return( $text );
753 * Get a URL-encoded title (not an actual URL) including interwiki
754 * @return string the URL-encoded form
755 * @access public
757 function getPrefixedURL() {
758 $s = $this->prefix( $this->mDbkeyform );
759 $s = str_replace( ' ', '_', $s );
761 $s = wfUrlencode ( $s ) ;
763 # Cleaning up URL to make it look nice -- is this safe?
764 $s = str_replace( '%28', '(', $s );
765 $s = str_replace( '%29', ')', $s );
767 return $s;
771 * Get a real URL referring to this title, with interwiki link and
772 * fragment
774 * @param string $query an optional query string, not used
775 * for interwiki links
776 * @return string the URL
777 * @access public
779 function getFullURL( $query = '' ) {
780 global $wgContLang, $wgServer, $wgRequest;
782 if ( '' == $this->mInterwiki ) {
783 $url = $this->getLocalUrl( $query );
785 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
786 // Correct fix would be to move the prepending elsewhere.
787 if ($wgRequest->getVal('action') != 'render') {
788 $url = $wgServer . $url;
790 } else {
791 $baseUrl = $this->getInterwikiLink( $this->mInterwiki );
793 $namespace = $wgContLang->getNsText( $this->mNamespace );
794 if ( '' != $namespace ) {
795 # Can this actually happen? Interwikis shouldn't be parsed.
796 $namespace .= ':';
798 $url = str_replace( '$1', $namespace . $this->mUrlform, $baseUrl );
799 if( $query != '' ) {
800 if( false === strpos( $url, '?' ) ) {
801 $url .= '?';
802 } else {
803 $url .= '&';
805 $url .= $query;
809 # Finally, add the fragment.
810 if ( '' != $this->mFragment ) {
811 $url .= '#' . $this->mFragment;
814 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
815 return $url;
819 * Get a URL with no fragment or server name. If this page is generated
820 * with action=render, $wgServer is prepended.
821 * @param string $query an optional query string; if not specified,
822 * $wgArticlePath will be used.
823 * @return string the URL
824 * @access public
826 function getLocalURL( $query = '' ) {
827 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
829 if ( $this->isExternal() ) {
830 $url = $this->getFullURL();
831 if ( $query ) {
832 // This is currently only used for edit section links in the
833 // context of interwiki transclusion. In theory we should
834 // append the query to the end of any existing query string,
835 // but interwiki transclusion is already broken in that case.
836 $url .= "?$query";
838 } else {
839 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
840 if ( $query == '' ) {
841 $url = str_replace( '$1', $dbkey, $wgArticlePath );
842 } else {
843 global $wgActionPaths;
844 $url = false;
845 if( !empty( $wgActionPaths ) &&
846 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
848 $action = urldecode( $matches[2] );
849 if( isset( $wgActionPaths[$action] ) ) {
850 $query = $matches[1];
851 if( isset( $matches[4] ) ) $query .= $matches[4];
852 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
853 if( $query != '' ) $url .= '?' . $query;
856 if ( $url === false ) {
857 if ( $query == '-' ) {
858 $query = '';
860 $url = "{$wgScript}?title={$dbkey}&{$query}";
864 // FIXME: this causes breakage in various places when we
865 // actually expected a local URL and end up with dupe prefixes.
866 if ($wgRequest->getVal('action') == 'render') {
867 $url = $wgServer . $url;
870 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
871 return $url;
875 * Get an HTML-escaped version of the URL form, suitable for
876 * using in a link, without a server name or fragment
877 * @param string $query an optional query string
878 * @return string the URL
879 * @access public
881 function escapeLocalURL( $query = '' ) {
882 return htmlspecialchars( $this->getLocalURL( $query ) );
886 * Get an HTML-escaped version of the URL form, suitable for
887 * using in a link, including the server name and fragment
889 * @return string the URL
890 * @param string $query an optional query string
891 * @access public
893 function escapeFullURL( $query = '' ) {
894 return htmlspecialchars( $this->getFullURL( $query ) );
898 * Get the URL form for an internal link.
899 * - Used in various Squid-related code, in case we have a different
900 * internal hostname for the server from the exposed one.
902 * @param string $query an optional query string
903 * @return string the URL
904 * @access public
906 function getInternalURL( $query = '' ) {
907 global $wgInternalServer;
908 $url = $wgInternalServer . $this->getLocalURL( $query );
909 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
910 return $url;
914 * Get the edit URL for this Title
915 * @return string the URL, or a null string if this is an
916 * interwiki link
917 * @access public
919 function getEditURL() {
920 if ( '' != $this->mInterwiki ) { return ''; }
921 $s = $this->getLocalURL( 'action=edit' );
923 return $s;
927 * Get the HTML-escaped displayable text form.
928 * Used for the title field in <a> tags.
929 * @return string the text, including any prefixes
930 * @access public
932 function getEscapedText() {
933 return htmlspecialchars( $this->getPrefixedText() );
937 * Is this Title interwiki?
938 * @return boolean
939 * @access public
941 function isExternal() { return ( '' != $this->mInterwiki ); }
944 * Is this page "semi-protected" - the *only* protection is autoconfirm?
946 * @param string Action to check (default: edit)
947 * @return bool
949 function isSemiProtected( $action = 'edit' ) {
950 $restrictions = $this->getRestrictions( $action );
951 # We do a full compare because this could be an array
952 foreach( $restrictions as $restriction ) {
953 if( strtolower( $restriction ) != 'autoconfirmed' ) {
954 return( false );
957 return( true );
961 * Does the title correspond to a protected article?
962 * @param string $what the action the page is protected from,
963 * by default checks move and edit
964 * @return boolean
965 * @access public
967 function isProtected( $action = '' ) {
968 global $wgRestrictionLevels;
969 if ( -1 == $this->mNamespace ) { return true; }
971 if( $action == 'edit' || $action == '' ) {
972 $r = $this->getRestrictions( 'edit' );
973 foreach( $wgRestrictionLevels as $level ) {
974 if( in_array( $level, $r ) && $level != '' ) {
975 return( true );
980 if( $action == 'move' || $action == '' ) {
981 $r = $this->getRestrictions( 'move' );
982 foreach( $wgRestrictionLevels as $level ) {
983 if( in_array( $level, $r ) && $level != '' ) {
984 return( true );
989 return false;
993 * Is $wgUser is watching this page?
994 * @return boolean
995 * @access public
997 function userIsWatching() {
998 global $wgUser;
1000 if ( is_null( $this->mWatched ) ) {
1001 if ( -1 == $this->mNamespace || 0 == $wgUser->getID()) {
1002 $this->mWatched = false;
1003 } else {
1004 $this->mWatched = $wgUser->isWatched( $this );
1007 return $this->mWatched;
1011 * Can $wgUser perform $action this page?
1012 * @param string $action action that permission needs to be checked for
1013 * @return boolean
1014 * @private
1016 function userCan($action) {
1017 $fname = 'Title::userCan';
1018 wfProfileIn( $fname );
1020 global $wgUser;
1022 $result = null;
1023 wfRunHooks( 'userCan', array( &$this, &$wgUser, $action, &$result ) );
1024 if ( $result !== null ) {
1025 wfProfileOut( $fname );
1026 return $result;
1029 if( NS_SPECIAL == $this->mNamespace ) {
1030 wfProfileOut( $fname );
1031 return false;
1033 // XXX: This is the code that prevents unprotecting a page in NS_MEDIAWIKI
1034 // from taking effect -ævar
1035 if( NS_MEDIAWIKI == $this->mNamespace &&
1036 !$wgUser->isAllowed('editinterface') ) {
1037 wfProfileOut( $fname );
1038 return false;
1041 if( $this->mDbkeyform == '_' ) {
1042 # FIXME: Is this necessary? Shouldn't be allowed anyway...
1043 wfProfileOut( $fname );
1044 return false;
1047 # protect css/js subpages of user pages
1048 # XXX: this might be better using restrictions
1049 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1050 if( NS_USER == $this->mNamespace
1051 && preg_match("/\\.(css|js)$/", $this->mTextform )
1052 && !$wgUser->isAllowed('editinterface')
1053 && !preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) ) {
1054 wfProfileOut( $fname );
1055 return false;
1058 foreach( $this->getRestrictions($action) as $right ) {
1059 // Backwards compatibility, rewrite sysop -> protect
1060 if ( $right == 'sysop' ) {
1061 $right = 'protect';
1063 if( '' != $right && !$wgUser->isAllowed( $right ) ) {
1064 wfProfileOut( $fname );
1065 return false;
1069 if( $action == 'move' &&
1070 !( $this->isMovable() && $wgUser->isAllowed( 'move' ) ) ) {
1071 wfProfileOut( $fname );
1072 return false;
1075 if( $action == 'create' ) {
1076 if( ( $this->isTalkPage() && !$wgUser->isAllowed( 'createtalk' ) ) ||
1077 ( !$this->isTalkPage() && !$wgUser->isAllowed( 'createpage' ) ) ) {
1078 wfProfileOut( $fname );
1079 return false;
1083 wfProfileOut( $fname );
1084 return true;
1088 * Can $wgUser edit this page?
1089 * @return boolean
1090 * @access public
1092 function userCanEdit() {
1093 return $this->userCan('edit');
1097 * Can $wgUser create this page?
1098 * @return boolean
1099 * @access public
1101 function userCanCreate() {
1102 return $this->userCan('create');
1106 * Can $wgUser move this page?
1107 * @return boolean
1108 * @access public
1110 function userCanMove() {
1111 return $this->userCan('move');
1115 * Would anybody with sufficient privileges be able to move this page?
1116 * Some pages just aren't movable.
1118 * @return boolean
1119 * @access public
1121 function isMovable() {
1122 return Namespace::isMovable( $this->getNamespace() )
1123 && $this->getInterwiki() == '';
1127 * Can $wgUser read this page?
1128 * @return boolean
1129 * @access public
1131 function userCanRead() {
1132 global $wgUser;
1134 $result = null;
1135 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1136 if ( $result !== null ) {
1137 return $result;
1140 if( $wgUser->isAllowed('read') ) {
1141 return true;
1142 } else {
1143 global $wgWhitelistRead;
1145 /** If anon users can create an account,
1146 they need to reach the login page first! */
1147 if( $wgUser->isAllowed( 'createaccount' )
1148 && $this->getNamespace() == NS_SPECIAL
1149 && $this->getText() == 'Userlogin' ) {
1150 return true;
1153 /** some pages are explicitly allowed */
1154 $name = $this->getPrefixedText();
1155 if( $wgWhitelistRead && in_array( $name, $wgWhitelistRead ) ) {
1156 return true;
1159 # Compatibility with old settings
1160 if( $wgWhitelistRead && $this->getNamespace() == NS_MAIN ) {
1161 if( in_array( ':' . $name, $wgWhitelistRead ) ) {
1162 return true;
1166 return false;
1170 * Is this a talk page of some sort?
1171 * @return bool
1172 * @access public
1174 function isTalkPage() {
1175 return Namespace::isTalk( $this->getNamespace() );
1179 * Is this a .css or .js subpage of a user page?
1180 * @return bool
1181 * @access public
1183 function isCssJsSubpage() {
1184 return ( NS_USER == $this->mNamespace and preg_match("/\\.(css|js)$/", $this->mTextform ) );
1187 * Is this a *valid* .css or .js subpage of a user page?
1188 * Check that the corresponding skin exists
1190 function isValidCssJsSubpage() {
1191 if ( $this->isCssJsSubpage() ) {
1192 $skinNames = Skin::getSkinNames();
1193 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1194 } else {
1195 return false;
1199 * Trim down a .css or .js subpage title to get the corresponding skin name
1201 function getSkinFromCssJsSubpage() {
1202 $subpage = explode( '/', $this->mTextform );
1203 $subpage = $subpage[ count( $subpage ) - 1 ];
1204 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1207 * Is this a .css subpage of a user page?
1208 * @return bool
1209 * @access public
1211 function isCssSubpage() {
1212 return ( NS_USER == $this->mNamespace and preg_match("/\\.css$/", $this->mTextform ) );
1215 * Is this a .js subpage of a user page?
1216 * @return bool
1217 * @access public
1219 function isJsSubpage() {
1220 return ( NS_USER == $this->mNamespace and preg_match("/\\.js$/", $this->mTextform ) );
1223 * Protect css/js subpages of user pages: can $wgUser edit
1224 * this page?
1226 * @return boolean
1227 * @todo XXX: this might be better using restrictions
1228 * @access public
1230 function userCanEditCssJsSubpage() {
1231 global $wgUser;
1232 return ( $wgUser->isAllowed('editinterface') or preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) );
1236 * Loads a string into mRestrictions array
1237 * @param string $res restrictions in string format
1238 * @access public
1240 function loadRestrictions( $res ) {
1241 foreach( explode( ':', trim( $res ) ) as $restrict ) {
1242 $temp = explode( '=', trim( $restrict ) );
1243 if(count($temp) == 1) {
1244 // old format should be treated as edit/move restriction
1245 $this->mRestrictions["edit"] = explode( ',', trim( $temp[0] ) );
1246 $this->mRestrictions["move"] = explode( ',', trim( $temp[0] ) );
1247 } else {
1248 $this->mRestrictions[$temp[0]] = explode( ',', trim( $temp[1] ) );
1251 $this->mRestrictionsLoaded = true;
1255 * Accessor/initialisation for mRestrictions
1256 * @param string $action action that permission needs to be checked for
1257 * @return array the array of groups allowed to edit this article
1258 * @access public
1260 function getRestrictions($action) {
1261 $id = $this->getArticleID();
1262 if ( 0 == $id ) { return array(); }
1264 if ( ! $this->mRestrictionsLoaded ) {
1265 $dbr =& wfGetDB( DB_SLAVE );
1266 $res = $dbr->selectField( 'page', 'page_restrictions', 'page_id='.$id );
1267 $this->loadRestrictions( $res );
1269 if( isset( $this->mRestrictions[$action] ) ) {
1270 return $this->mRestrictions[$action];
1272 return array();
1276 * Is there a version of this page in the deletion archive?
1277 * @return int the number of archived revisions
1278 * @access public
1280 function isDeleted() {
1281 $fname = 'Title::isDeleted';
1282 if ( $this->getNamespace() < 0 ) {
1283 $n = 0;
1284 } else {
1285 $dbr =& wfGetDB( DB_SLAVE );
1286 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1287 'ar_title' => $this->getDBkey() ), $fname );
1288 if( $this->getNamespace() == NS_IMAGE ) {
1289 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
1290 array( 'fa_name' => $this->getDBkey() ), $fname );
1293 return (int)$n;
1297 * Get the article ID for this Title from the link cache,
1298 * adding it if necessary
1299 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select
1300 * for update
1301 * @return int the ID
1302 * @access public
1304 function getArticleID( $flags = 0 ) {
1305 $linkCache =& LinkCache::singleton();
1306 if ( $flags & GAID_FOR_UPDATE ) {
1307 $oldUpdate = $linkCache->forUpdate( true );
1308 $this->mArticleID = $linkCache->addLinkObj( $this );
1309 $linkCache->forUpdate( $oldUpdate );
1310 } else {
1311 if ( -1 == $this->mArticleID ) {
1312 $this->mArticleID = $linkCache->addLinkObj( $this );
1315 return $this->mArticleID;
1318 function getLatestRevID() {
1319 if ($this->mLatestID !== false)
1320 return $this->mLatestID;
1322 $db =& wfGetDB(DB_SLAVE);
1323 return $this->mLatestID = $db->selectField( 'revision',
1324 "max(rev_id)",
1325 array('rev_page' => $this->getArticleID()),
1326 'Title::getLatestRevID' );
1330 * This clears some fields in this object, and clears any associated
1331 * keys in the "bad links" section of the link cache.
1333 * - This is called from Article::insertNewArticle() to allow
1334 * loading of the new page_id. It's also called from
1335 * Article::doDeleteArticle()
1337 * @param int $newid the new Article ID
1338 * @access public
1340 function resetArticleID( $newid ) {
1341 $linkCache =& LinkCache::singleton();
1342 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
1344 if ( 0 == $newid ) { $this->mArticleID = -1; }
1345 else { $this->mArticleID = $newid; }
1346 $this->mRestrictionsLoaded = false;
1347 $this->mRestrictions = array();
1351 * Updates page_touched for this page; called from LinksUpdate.php
1352 * @return bool true if the update succeded
1353 * @access public
1355 function invalidateCache() {
1356 global $wgUseFileCache;
1358 if ( wfReadOnly() ) {
1359 return;
1362 $dbw =& wfGetDB( DB_MASTER );
1363 $success = $dbw->update( 'page',
1364 array( /* SET */
1365 'page_touched' => $dbw->timestamp()
1366 ), array( /* WHERE */
1367 'page_namespace' => $this->getNamespace() ,
1368 'page_title' => $this->getDBkey()
1369 ), 'Title::invalidateCache'
1372 if ($wgUseFileCache) {
1373 $cache = new CacheManager($this);
1374 @unlink($cache->fileCacheName());
1377 return $success;
1381 * Prefix some arbitrary text with the namespace or interwiki prefix
1382 * of this object
1384 * @param string $name the text
1385 * @return string the prefixed text
1386 * @private
1388 /* private */ function prefix( $name ) {
1389 global $wgContLang;
1391 $p = '';
1392 if ( '' != $this->mInterwiki ) {
1393 $p = $this->mInterwiki . ':';
1395 if ( 0 != $this->mNamespace ) {
1396 $p .= $wgContLang->getNsText( $this->mNamespace ) . ':';
1398 return $p . $name;
1402 * Secure and split - main initialisation function for this object
1404 * Assumes that mDbkeyform has been set, and is urldecoded
1405 * and uses underscores, but not otherwise munged. This function
1406 * removes illegal characters, splits off the interwiki and
1407 * namespace prefixes, sets the other forms, and canonicalizes
1408 * everything.
1409 * @return bool true on success
1410 * @private
1412 /* private */ function secureAndSplit() {
1413 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
1414 $fname = 'Title::secureAndSplit';
1416 # Initialisation
1417 static $rxTc = false;
1418 if( !$rxTc ) {
1419 # % is needed as well
1420 $rxTc = '/[^' . Title::legalChars() . ']|%[0-9A-Fa-f]{2}/S';
1423 $this->mInterwiki = $this->mFragment = '';
1424 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
1426 # Clean up whitespace
1428 $t = preg_replace( '/[ _]+/', '_', $this->mDbkeyform );
1429 $t = trim( $t, '_' );
1431 if ( '' == $t ) {
1432 return false;
1435 if( false !== strpos( $t, UTF8_REPLACEMENT ) ) {
1436 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
1437 return false;
1440 $this->mDbkeyform = $t;
1442 # Initial colon indicates main namespace rather than specified default
1443 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
1444 if ( ':' == $t{0} ) {
1445 $this->mNamespace = NS_MAIN;
1446 $t = substr( $t, 1 ); # remove the colon but continue processing
1449 # Namespace or interwiki prefix
1450 $firstPass = true;
1451 do {
1452 if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $t, $m ) ) {
1453 $p = $m[1];
1454 $lowerNs = strtolower( $p );
1455 if ( $ns = Namespace::getCanonicalIndex( $lowerNs ) ) {
1456 # Canonical namespace
1457 $t = $m[2];
1458 $this->mNamespace = $ns;
1459 } elseif ( $ns = $wgContLang->getNsIndex( $lowerNs )) {
1460 # Ordinary namespace
1461 $t = $m[2];
1462 $this->mNamespace = $ns;
1463 } elseif( $this->getInterwikiLink( $p ) ) {
1464 if( !$firstPass ) {
1465 # Can't make a local interwiki link to an interwiki link.
1466 # That's just crazy!
1467 return false;
1470 # Interwiki link
1471 $t = $m[2];
1472 $this->mInterwiki = strtolower( $p );
1474 # Redundant interwiki prefix to the local wiki
1475 if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
1476 if( $t == '' ) {
1477 # Can't have an empty self-link
1478 return false;
1480 $this->mInterwiki = '';
1481 $firstPass = false;
1482 # Do another namespace split...
1483 continue;
1486 # If there's an initial colon after the interwiki, that also
1487 # resets the default namespace
1488 if ( $t !== '' && $t[0] == ':' ) {
1489 $this->mNamespace = NS_MAIN;
1490 $t = substr( $t, 1 );
1493 # If there's no recognized interwiki or namespace,
1494 # then let the colon expression be part of the title.
1496 break;
1497 } while( true );
1498 $r = $t;
1500 # We already know that some pages won't be in the database!
1502 if ( '' != $this->mInterwiki || -1 == $this->mNamespace ) {
1503 $this->mArticleID = 0;
1505 $f = strstr( $r, '#' );
1506 if ( false !== $f ) {
1507 $this->mFragment = substr( $f, 1 );
1508 $r = substr( $r, 0, strlen( $r ) - strlen( $f ) );
1509 # remove whitespace again: prevents "Foo_bar_#"
1510 # becoming "Foo_bar_"
1511 $r = preg_replace( '/_*$/', '', $r );
1514 # Reject illegal characters.
1516 if( preg_match( $rxTc, $r ) ) {
1517 return false;
1521 * Pages with "/./" or "/../" appearing in the URLs will
1522 * often be unreachable due to the way web browsers deal
1523 * with 'relative' URLs. Forbid them explicitly.
1525 if ( strpos( $r, '.' ) !== false &&
1526 ( $r === '.' || $r === '..' ||
1527 strpos( $r, './' ) === 0 ||
1528 strpos( $r, '../' ) === 0 ||
1529 strpos( $r, '/./' ) !== false ||
1530 strpos( $r, '/../' ) !== false ) )
1532 return false;
1535 # We shouldn't need to query the DB for the size.
1536 #$maxSize = $dbr->textFieldSize( 'page', 'page_title' );
1537 if ( strlen( $r ) > 255 ) {
1538 return false;
1542 * Normally, all wiki links are forced to have
1543 * an initial capital letter so [[foo]] and [[Foo]]
1544 * point to the same place.
1546 * Don't force it for interwikis, since the other
1547 * site might be case-sensitive.
1549 if( $wgCapitalLinks && $this->mInterwiki == '') {
1550 $t = $wgContLang->ucfirst( $r );
1551 } else {
1552 $t = $r;
1556 * Can't make a link to a namespace alone...
1557 * "empty" local links can only be self-links
1558 * with a fragment identifier.
1560 if( $t == '' &&
1561 $this->mInterwiki == '' &&
1562 $this->mNamespace != NS_MAIN ) {
1563 return false;
1566 // Any remaining initial :s are illegal.
1567 if ( $t !== '' && ':' == $t{0} ) {
1568 return false;
1571 # Fill fields
1572 $this->mDbkeyform = $t;
1573 $this->mUrlform = wfUrlencode( $t );
1575 $this->mTextform = str_replace( '_', ' ', $t );
1577 return true;
1581 * Get a Title object associated with the talk page of this article
1582 * @return Title the object for the talk page
1583 * @access public
1585 function getTalkPage() {
1586 return Title::makeTitle( Namespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1590 * Get a title object associated with the subject page of this
1591 * talk page
1593 * @return Title the object for the subject page
1594 * @access public
1596 function getSubjectPage() {
1597 return Title::makeTitle( Namespace::getSubject( $this->getNamespace() ), $this->getDBkey() );
1601 * Get an array of Title objects linking to this Title
1602 * Also stores the IDs in the link cache.
1604 * WARNING: do not use this function on arbitrary user-supplied titles!
1605 * On heavily-used templates it will max out the memory.
1607 * @param string $options may be FOR UPDATE
1608 * @return array the Title objects linking here
1609 * @access public
1611 function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
1612 $linkCache =& LinkCache::singleton();
1613 $id = $this->getArticleID();
1615 if ( $options ) {
1616 $db =& wfGetDB( DB_MASTER );
1617 } else {
1618 $db =& wfGetDB( DB_SLAVE );
1621 $res = $db->select( array( 'page', $table ),
1622 array( 'page_namespace', 'page_title', 'page_id' ),
1623 array(
1624 "{$prefix}_from=page_id",
1625 "{$prefix}_namespace" => $this->getNamespace(),
1626 "{$prefix}_title" => $this->getDbKey() ),
1627 'Title::getLinksTo',
1628 $options );
1630 $retVal = array();
1631 if ( $db->numRows( $res ) ) {
1632 while ( $row = $db->fetchObject( $res ) ) {
1633 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
1634 $linkCache->addGoodLinkObj( $row->page_id, $titleObj );
1635 $retVal[] = $titleObj;
1639 $db->freeResult( $res );
1640 return $retVal;
1644 * Get an array of Title objects using this Title as a template
1645 * Also stores the IDs in the link cache.
1647 * WARNING: do not use this function on arbitrary user-supplied titles!
1648 * On heavily-used templates it will max out the memory.
1650 * @param string $options may be FOR UPDATE
1651 * @return array the Title objects linking here
1652 * @access public
1654 function getTemplateLinksTo( $options = '' ) {
1655 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
1659 * Get an array of Title objects referring to non-existent articles linked from this page
1661 * @param string $options may be FOR UPDATE
1662 * @return array the Title objects
1663 * @access public
1665 function getBrokenLinksFrom( $options = '' ) {
1666 if ( $options ) {
1667 $db =& wfGetDB( DB_MASTER );
1668 } else {
1669 $db =& wfGetDB( DB_SLAVE );
1672 $res = $db->safeQuery(
1673 "SELECT pl_namespace, pl_title
1674 FROM !
1675 LEFT JOIN !
1676 ON pl_namespace=page_namespace
1677 AND pl_title=page_title
1678 WHERE pl_from=?
1679 AND page_namespace IS NULL
1681 $db->tableName( 'pagelinks' ),
1682 $db->tableName( 'page' ),
1683 $this->getArticleId(),
1684 $options );
1686 $retVal = array();
1687 if ( $db->numRows( $res ) ) {
1688 while ( $row = $db->fetchObject( $res ) ) {
1689 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
1692 $db->freeResult( $res );
1693 return $retVal;
1698 * Get a list of URLs to purge from the Squid cache when this
1699 * page changes
1701 * @return array the URLs
1702 * @access public
1704 function getSquidURLs() {
1705 return array(
1706 $this->getInternalURL(),
1707 $this->getInternalURL( 'action=history' )
1711 function purgeSquid() {
1712 global $wgUseSquid;
1713 if ( $wgUseSquid ) {
1714 $urls = $this->getSquidURLs();
1715 $u = new SquidUpdate( $urls );
1716 $u->doUpdate();
1721 * Move this page without authentication
1722 * @param Title &$nt the new page Title
1723 * @access public
1725 function moveNoAuth( &$nt ) {
1726 return $this->moveTo( $nt, false );
1730 * Check whether a given move operation would be valid.
1731 * Returns true if ok, or a message key string for an error message
1732 * if invalid. (Scarrrrry ugly interface this.)
1733 * @param Title &$nt the new title
1734 * @param bool $auth indicates whether $wgUser's permissions
1735 * should be checked
1736 * @return mixed true on success, message name on failure
1737 * @access public
1739 function isValidMoveOperation( &$nt, $auth = true ) {
1740 if( !$this or !$nt ) {
1741 return 'badtitletext';
1743 if( $this->equals( $nt ) ) {
1744 return 'selfmove';
1746 if( !$this->isMovable() || !$nt->isMovable() ) {
1747 return 'immobile_namespace';
1750 $oldid = $this->getArticleID();
1751 $newid = $nt->getArticleID();
1753 if ( strlen( $nt->getDBkey() ) < 1 ) {
1754 return 'articleexists';
1756 if ( ( '' == $this->getDBkey() ) ||
1757 ( !$oldid ) ||
1758 ( '' == $nt->getDBkey() ) ) {
1759 return 'badarticleerror';
1762 if ( $auth && (
1763 !$this->userCanEdit() || !$nt->userCanEdit() ||
1764 !$this->userCanMove() || !$nt->userCanMove() ) ) {
1765 return 'protectedpage';
1768 # The move is allowed only if (1) the target doesn't exist, or
1769 # (2) the target is a redirect to the source, and has no history
1770 # (so we can undo bad moves right after they're done).
1772 if ( 0 != $newid ) { # Target exists; check for validity
1773 if ( ! $this->isValidMoveTarget( $nt ) ) {
1774 return 'articleexists';
1777 return true;
1781 * Move a title to a new location
1782 * @param Title &$nt the new title
1783 * @param bool $auth indicates whether $wgUser's permissions
1784 * should be checked
1785 * @return mixed true on success, message name on failure
1786 * @access public
1788 function moveTo( &$nt, $auth = true, $reason = '' ) {
1789 $err = $this->isValidMoveOperation( $nt, $auth );
1790 if( is_string( $err ) ) {
1791 return $err;
1794 $pageid = $this->getArticleID();
1795 if( $nt->exists() ) {
1796 $this->moveOverExistingRedirect( $nt, $reason );
1797 $pageCountChange = 0;
1798 } else { # Target didn't exist, do normal move.
1799 $this->moveToNewTitle( $nt, $reason );
1800 $pageCountChange = 1;
1802 $redirid = $this->getArticleID();
1804 # Fixing category links (those without piped 'alternate' names) to be sorted under the new title
1805 $dbw =& wfGetDB( DB_MASTER );
1806 $categorylinks = $dbw->tableName( 'categorylinks' );
1807 $sql = "UPDATE $categorylinks SET cl_sortkey=" . $dbw->addQuotes( $nt->getPrefixedText() ) .
1808 " WHERE cl_from=" . $dbw->addQuotes( $pageid ) .
1809 " AND cl_sortkey=" . $dbw->addQuotes( $this->getPrefixedText() );
1810 $dbw->query( $sql, 'SpecialMovepage::doSubmit' );
1812 # Update watchlists
1814 $oldnamespace = $this->getNamespace() & ~1;
1815 $newnamespace = $nt->getNamespace() & ~1;
1816 $oldtitle = $this->getDBkey();
1817 $newtitle = $nt->getDBkey();
1819 if( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
1820 WatchedItem::duplicateEntries( $this, $nt );
1823 # Update search engine
1824 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
1825 $u->doUpdate();
1826 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
1827 $u->doUpdate();
1829 # Update site_stats
1830 if ( $this->getNamespace() == NS_MAIN and $nt->getNamespace() != NS_MAIN ) {
1831 # Moved out of main namespace
1832 # not viewed, edited, removing
1833 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange);
1834 } elseif ( $this->getNamespace() != NS_MAIN and $nt->getNamespace() == NS_MAIN ) {
1835 # Moved into main namespace
1836 # not viewed, edited, adding
1837 $u = new SiteStatsUpdate( 0, 1, +1, $pageCountChange );
1838 } elseif ( $pageCountChange ) {
1839 # Added redirect
1840 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
1841 } else{
1842 $u = false;
1844 if ( $u ) {
1845 $u->doUpdate();
1848 global $wgUser;
1849 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
1850 return true;
1854 * Move page to a title which is at present a redirect to the
1855 * source page
1857 * @param Title &$nt the page to move to, which should currently
1858 * be a redirect
1859 * @private
1861 function moveOverExistingRedirect( &$nt, $reason = '' ) {
1862 global $wgUseSquid;
1863 $fname = 'Title::moveOverExistingRedirect';
1864 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
1866 if ( $reason ) {
1867 $comment .= ": $reason";
1870 $now = wfTimestampNow();
1871 $rand = wfRandom();
1872 $newid = $nt->getArticleID();
1873 $oldid = $this->getArticleID();
1874 $dbw =& wfGetDB( DB_MASTER );
1875 $linkCache =& LinkCache::singleton();
1877 # Delete the old redirect. We don't save it to history since
1878 # by definition if we've got here it's rather uninteresting.
1879 # We have to remove it so that the next step doesn't trigger
1880 # a conflict on the unique namespace+title index...
1881 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
1883 # Save a null revision in the page's history notifying of the move
1884 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
1885 $nullRevId = $nullRevision->insertOn( $dbw );
1887 # Change the name of the target page:
1888 $dbw->update( 'page',
1889 /* SET */ array(
1890 'page_touched' => $dbw->timestamp($now),
1891 'page_namespace' => $nt->getNamespace(),
1892 'page_title' => $nt->getDBkey(),
1893 'page_latest' => $nullRevId,
1895 /* WHERE */ array( 'page_id' => $oldid ),
1896 $fname
1898 $linkCache->clearLink( $nt->getPrefixedDBkey() );
1900 # Recreate the redirect, this time in the other direction.
1901 $mwRedir = MagicWord::get( 'redirect' );
1902 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
1903 $redirectArticle = new Article( $this );
1904 $newid = $redirectArticle->insertOn( $dbw );
1905 $redirectRevision = new Revision( array(
1906 'page' => $newid,
1907 'comment' => $comment,
1908 'text' => $redirectText ) );
1909 $revid = $redirectRevision->insertOn( $dbw );
1910 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
1911 $linkCache->clearLink( $this->getPrefixedDBkey() );
1913 # Log the move
1914 $log = new LogPage( 'move' );
1915 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
1917 # Now, we record the link from the redirect to the new title.
1918 # It should have no other outgoing links...
1919 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
1920 $dbw->insert( 'pagelinks',
1921 array(
1922 'pl_from' => $newid,
1923 'pl_namespace' => $nt->getNamespace(),
1924 'pl_title' => $nt->getDbKey() ),
1925 $fname );
1927 # Purge squid
1928 if ( $wgUseSquid ) {
1929 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
1930 $u = new SquidUpdate( $urls );
1931 $u->doUpdate();
1936 * Move page to non-existing title.
1937 * @param Title &$nt the new Title
1938 * @private
1940 function moveToNewTitle( &$nt, $reason = '' ) {
1941 global $wgUseSquid;
1942 $fname = 'MovePageForm::moveToNewTitle';
1943 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
1944 if ( $reason ) {
1945 $comment .= ": $reason";
1948 $newid = $nt->getArticleID();
1949 $oldid = $this->getArticleID();
1950 $dbw =& wfGetDB( DB_MASTER );
1951 $now = $dbw->timestamp();
1952 $rand = wfRandom();
1953 $linkCache =& LinkCache::singleton();
1955 # Save a null revision in the page's history notifying of the move
1956 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
1957 $nullRevId = $nullRevision->insertOn( $dbw );
1959 # Rename cur entry
1960 $dbw->update( 'page',
1961 /* SET */ array(
1962 'page_touched' => $now,
1963 'page_namespace' => $nt->getNamespace(),
1964 'page_title' => $nt->getDBkey(),
1965 'page_latest' => $nullRevId,
1967 /* WHERE */ array( 'page_id' => $oldid ),
1968 $fname
1971 $linkCache->clearLink( $nt->getPrefixedDBkey() );
1973 # Insert redirect
1974 $mwRedir = MagicWord::get( 'redirect' );
1975 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
1976 $redirectArticle = new Article( $this );
1977 $newid = $redirectArticle->insertOn( $dbw );
1978 $redirectRevision = new Revision( array(
1979 'page' => $newid,
1980 'comment' => $comment,
1981 'text' => $redirectText ) );
1982 $revid = $redirectRevision->insertOn( $dbw );
1983 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
1984 $linkCache->clearLink( $this->getPrefixedDBkey() );
1986 # Log the move
1987 $log = new LogPage( 'move' );
1988 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
1990 # Purge caches as per article creation
1991 Article::onArticleCreate( $nt );
1993 # Record the just-created redirect's linking to the page
1994 $dbw->insert( 'pagelinks',
1995 array(
1996 'pl_from' => $newid,
1997 'pl_namespace' => $nt->getNamespace(),
1998 'pl_title' => $nt->getDBkey() ),
1999 $fname );
2001 # Purge old title from squid
2002 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2003 $this->purgeSquid();
2007 * Checks if $this can be moved to a given Title
2008 * - Selects for update, so don't call it unless you mean business
2010 * @param Title &$nt the new title to check
2011 * @access public
2013 function isValidMoveTarget( $nt ) {
2015 $fname = 'Title::isValidMoveTarget';
2016 $dbw =& wfGetDB( DB_MASTER );
2018 # Is it a redirect?
2019 $id = $nt->getArticleID();
2020 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
2021 array( 'page_is_redirect','old_text','old_flags' ),
2022 array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
2023 $fname, 'FOR UPDATE' );
2025 if ( !$obj || 0 == $obj->page_is_redirect ) {
2026 # Not a redirect
2027 wfDebug( __METHOD__ . ": not a redirect\n" );
2028 return false;
2030 $text = Revision::getRevisionText( $obj );
2032 # Does the redirect point to the source?
2033 # Or is it a broken self-redirect, usually caused by namespace collisions?
2034 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2035 $redirTitle = Title::newFromText( $m[1] );
2036 if( !is_object( $redirTitle ) ||
2037 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2038 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2039 wfDebug( __METHOD__ . ": redirect points to other page\n" );
2040 return false;
2042 } else {
2043 # Fail safe
2044 wfDebug( __METHOD__ . ": failsafe\n" );
2045 return false;
2048 # Does the article have a history?
2049 $row = $dbw->selectRow( array( 'page', 'revision'),
2050 array( 'rev_id' ),
2051 array( 'page_namespace' => $nt->getNamespace(),
2052 'page_title' => $nt->getDBkey(),
2053 'page_id=rev_page AND page_latest != rev_id'
2054 ), $fname, 'FOR UPDATE'
2057 # Return true if there was no history
2058 return $row === false;
2062 * Create a redirect; fails if the title already exists; does
2063 * not notify RC
2065 * @param Title $dest the destination of the redirect
2066 * @param string $comment the comment string describing the move
2067 * @return bool true on success
2068 * @access public
2070 function createRedirect( $dest, $comment ) {
2071 if ( $this->getArticleID() ) {
2072 return false;
2075 $fname = 'Title::createRedirect';
2076 $dbw =& wfGetDB( DB_MASTER );
2078 $article = new Article( $this );
2079 $newid = $article->insertOn( $dbw );
2080 $revision = new Revision( array(
2081 'page' => $newid,
2082 'comment' => $comment,
2083 'text' => "#REDIRECT [[" . $dest->getPrefixedText() . "]]\n",
2084 ) );
2085 $revisionId = $revision->insertOn( $dbw );
2086 $article->updateRevisionOn( $dbw, $revision, 0 );
2088 # Link table
2089 $dbw->insert( 'pagelinks',
2090 array(
2091 'pl_from' => $newid,
2092 'pl_namespace' => $dest->getNamespace(),
2093 'pl_title' => $dest->getDbKey()
2094 ), $fname
2097 Article::onArticleCreate( $this );
2098 return true;
2102 * Get categories to which this Title belongs and return an array of
2103 * categories' names.
2105 * @return array an array of parents in the form:
2106 * $parent => $currentarticle
2107 * @access public
2109 function getParentCategories() {
2110 global $wgContLang;
2112 $titlekey = $this->getArticleId();
2113 $dbr =& wfGetDB( DB_SLAVE );
2114 $categorylinks = $dbr->tableName( 'categorylinks' );
2116 # NEW SQL
2117 $sql = "SELECT * FROM $categorylinks"
2118 ." WHERE cl_from='$titlekey'"
2119 ." AND cl_from <> '0'"
2120 ." ORDER BY cl_sortkey";
2122 $res = $dbr->query ( $sql ) ;
2124 if($dbr->numRows($res) > 0) {
2125 while ( $x = $dbr->fetchObject ( $res ) )
2126 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
2127 $data[$wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to] = $this->getFullText();
2128 $dbr->freeResult ( $res ) ;
2129 } else {
2130 $data = '';
2132 return $data;
2136 * Get a tree of parent categories
2137 * @param array $children an array with the children in the keys, to check for circular refs
2138 * @return array
2139 * @access public
2141 function getParentCategoryTree( $children = array() ) {
2142 $parents = $this->getParentCategories();
2144 if($parents != '') {
2145 foreach($parents as $parent => $current) {
2146 if ( array_key_exists( $parent, $children ) ) {
2147 # Circular reference
2148 $stack[$parent] = array();
2149 } else {
2150 $nt = Title::newFromText($parent);
2151 if ( $nt ) {
2152 $stack[$parent] = $nt->getParentCategoryTree( $children + array($parent => 1) );
2156 return $stack;
2157 } else {
2158 return array();
2164 * Get an associative array for selecting this title from
2165 * the "page" table
2167 * @return array
2168 * @access public
2170 function pageCond() {
2171 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
2175 * Get the revision ID of the previous revision
2177 * @param integer $revision Revision ID. Get the revision that was before this one.
2178 * @return interger $oldrevision|false
2180 function getPreviousRevisionID( $revision ) {
2181 $dbr =& wfGetDB( DB_SLAVE );
2182 return $dbr->selectField( 'revision', 'rev_id',
2183 'rev_page=' . intval( $this->getArticleId() ) .
2184 ' AND rev_id<' . intval( $revision ) . ' ORDER BY rev_id DESC' );
2188 * Get the revision ID of the next revision
2190 * @param integer $revision Revision ID. Get the revision that was after this one.
2191 * @return interger $oldrevision|false
2193 function getNextRevisionID( $revision ) {
2194 $dbr =& wfGetDB( DB_SLAVE );
2195 return $dbr->selectField( 'revision', 'rev_id',
2196 'rev_page=' . intval( $this->getArticleId() ) .
2197 ' AND rev_id>' . intval( $revision ) . ' ORDER BY rev_id' );
2201 * Compare with another title.
2203 * @param Title $title
2204 * @return bool
2206 function equals( $title ) {
2207 // Note: === is necessary for proper matching of number-like titles.
2208 return $this->getInterwiki() === $title->getInterwiki()
2209 && $this->getNamespace() == $title->getNamespace()
2210 && $this->getDbkey() === $title->getDbkey();
2214 * Check if page exists
2215 * @return bool
2217 function exists() {
2218 return $this->getArticleId() != 0;
2222 * Should a link should be displayed as a known link, just based on its title?
2224 * Currently, a self-link with a fragment and special pages are in
2225 * this category. Special pages never exist in the database.
2227 function isAlwaysKnown() {
2228 return $this->isExternal() || ( 0 == $this->mNamespace && "" == $this->mDbkeyform )
2229 || NS_SPECIAL == $this->mNamespace;
2233 * Update page_touched timestamps and send squid purge messages for
2234 * pages linking to this title. May be sent to the job queue depending
2235 * on the number of links. Typically called on create and delete.
2237 function touchLinks() {
2238 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
2239 $u->doUpdate();
2241 if ( $this->getNamespace() == NS_CATEGORY ) {
2242 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
2243 $u->doUpdate();
2247 function trackbackURL() {
2248 global $wgTitle, $wgScriptPath, $wgServer;
2250 return "$wgServer$wgScriptPath/trackback.php?article="
2251 . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey()));
2254 function trackbackRDF() {
2255 $url = htmlspecialchars($this->getFullURL());
2256 $title = htmlspecialchars($this->getText());
2257 $tburl = $this->trackbackURL();
2259 return "
2260 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
2261 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
2262 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
2263 <rdf:Description
2264 rdf:about=\"$url\"
2265 dc:identifier=\"$url\"
2266 dc:title=\"$title\"
2267 trackback:ping=\"$tburl\" />
2268 </rdf:RDF>";
2272 * Generate strings used for xml 'id' names in monobook tabs
2273 * @return string
2275 function getNamespaceKey() {
2276 switch ($this->getNamespace()) {
2277 case NS_MAIN:
2278 case NS_TALK:
2279 return 'nstab-main';
2280 case NS_USER:
2281 case NS_USER_TALK:
2282 return 'nstab-user';
2283 case NS_MEDIA:
2284 return 'nstab-media';
2285 case NS_SPECIAL:
2286 return 'nstab-special';
2287 case NS_PROJECT:
2288 case NS_PROJECT_TALK:
2289 return 'nstab-project';
2290 case NS_IMAGE:
2291 case NS_IMAGE_TALK:
2292 return 'nstab-image';
2293 case NS_MEDIAWIKI:
2294 case NS_MEDIAWIKI_TALK:
2295 return 'nstab-mediawiki';
2296 case NS_TEMPLATE:
2297 case NS_TEMPLATE_TALK:
2298 return 'nstab-template';
2299 case NS_HELP:
2300 case NS_HELP_TALK:
2301 return 'nstab-help';
2302 case NS_CATEGORY:
2303 case NS_CATEGORY_TALK:
2304 return 'nstab-category';
2305 default:
2306 return 'nstab-' . strtolower( $this->getSubjectNsText() );