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,
18 define( 'MW_TITLECACHE_MAX', 1000 );
20 # Constants for pr_cascade bitfield
21 define( 'CASCADE', 1 );
25 * - Represents a title, which may contain an interwiki designation or namespace
26 * - Can fetch various kinds of data from the database, albeit inefficiently.
32 * Static cache variables
34 static private $titleCache=array();
35 static private $interwikiCache=array();
39 * All member variables should be considered private
40 * Please use the accessor functions
47 var $mTextform; # Text form (spaces not underscores) of the main part
48 var $mUrlform; # URL-encoded form of the main part
49 var $mDbkeyform; # Main part with underscores
50 var $mNamespace; # Namespace index, i.e. one of the NS_xxxx constants
51 var $mInterwiki; # Interwiki prefix (or null string)
52 var $mFragment; # Title fragment (i.e. the bit after the #)
53 var $mArticleID; # Article ID, fetched from the link cache on demand
54 var $mLatestID; # ID of most recent revision
55 var $mRestrictions; # Array of groups allowed to edit this article
56 var $mCascadeRestriction;
57 var $mCascadeRestrictionSource;
58 var $mRestrictionsLoaded; # Boolean for initialisation on demand
59 var $mPrefixedText; # Text form including namespace/interwiki, initialised on demand
60 var $mDefaultNamespace; # Namespace index when there is no namespace
61 # Zero except in {{transclusion}} tags
62 var $mWatched; # Is $wgUser watching this page? NULL if unfilled, accessed through userIsWatching()
63 var $mOldRestrictions; # Is the page using old-fashioned page_restrictions column?
71 /* private */ function Title() {
72 $this->mInterwiki
= $this->mUrlform
=
73 $this->mTextform
= $this->mDbkeyform
= '';
74 $this->mArticleID
= -1;
75 $this->mNamespace
= NS_MAIN
;
76 $this->mRestrictionsLoaded
= false;
77 $this->mRestrictions
= array();
78 # Dont change the following, NS_MAIN is hardcoded in several place
80 $this->mDefaultNamespace
= NS_MAIN
;
81 $this->mWatched
= NULL;
82 $this->mLatestID
= false;
83 $this->mOldRestrictions
= false;
87 * Create a new Title from a prefixed DB key
88 * @param string $key The database key, which has underscores
89 * instead of spaces, possibly including namespace and
91 * @return Title the new object, or NULL on an error
95 /* static */ function newFromDBkey( $key ) {
97 $t->mDbkeyform
= $key;
98 if( $t->secureAndSplit() )
105 * Create a new Title from text, such as what one would
106 * find in a link. Decodes any HTML entities in the text.
108 * @param string $text the link text; spaces, prefixes,
109 * and an initial ':' indicating the main namespace
111 * @param int $defaultNamespace the namespace to use if
112 * none is specified by a prefix
113 * @return Title the new object, or NULL on an error
117 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
118 if( is_object( $text ) ) {
119 throw new MWException( 'Title::newFromText given an object' );
123 * Wiki pages often contain multiple links to the same page.
124 * Title normalization and parsing can become expensive on
125 * pages with many links, so we can save a little time by
128 * In theory these are value objects and won't get changed...
130 if( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
131 return Title
::$titleCache[$text];
135 * Convert things like é ā or 〗 into real text...
137 $filteredText = Sanitizer
::decodeCharReferences( $text );
140 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
141 $t->mDefaultNamespace
= $defaultNamespace;
143 static $cachedcount = 0 ;
144 if( $t->secureAndSplit() ) {
145 if( $defaultNamespace == NS_MAIN
) {
146 if( $cachedcount >= MW_TITLECACHE_MAX
) {
147 # Avoid memory leaks on mass operations...
148 Title
::$titleCache = array();
152 Title
::$titleCache[$text] =& $t;
162 * Create a new Title from URL-encoded text. Ensures that
163 * the given title's length does not exceed the maximum.
164 * @param string $url the title, as might be taken from a URL
165 * @return Title the new object, or NULL on an error
169 public static function newFromURL( $url ) {
170 global $wgLegalTitleChars;
173 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
174 # but some URLs used it as a space replacement and they still come
175 # from some external search tools.
176 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
177 $url = str_replace( '+', ' ', $url );
180 $t->mDbkeyform
= str_replace( ' ', '_', $url );
181 if( $t->secureAndSplit() ) {
189 * Create a new Title from an article ID
191 * @todo This is inefficiently implemented, the page row is requested
192 * but not used for anything else
194 * @param int $id the page_id corresponding to the Title to create
195 * @return Title the new object, or NULL on an error
199 public static function newFromID( $id ) {
200 $fname = 'Title::newFromID';
201 $dbr =& wfGetDB( DB_SLAVE
);
202 $row = $dbr->selectRow( 'page', array( 'page_namespace', 'page_title' ),
203 array( 'page_id' => $id ), $fname );
204 if ( $row !== false ) {
205 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
213 * Make an array of titles from an array of IDs
215 function newFromIDs( $ids ) {
216 $dbr =& wfGetDB( DB_SLAVE
);
217 $res = $dbr->select( 'page', array( 'page_namespace', 'page_title' ),
218 'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__
);
221 while ( $row = $dbr->fetchObject( $res ) ) {
222 $titles[] = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
228 * Create a new Title from a namespace index and a DB key.
229 * It's assumed that $ns and $title are *valid*, for instance when
230 * they came directly from the database or a special page name.
231 * For convenience, spaces are converted to underscores so that
232 * eg user_text fields can be used directly.
234 * @param int $ns the namespace of the article
235 * @param string $title the unprefixed database key form
236 * @return Title the new object
240 public static function &makeTitle( $ns, $title ) {
244 $t->mNamespace
= intval( $ns );
245 $t->mDbkeyform
= str_replace( ' ', '_', $title );
246 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
247 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
248 $t->mTextform
= str_replace( '_', ' ', $title );
253 * Create a new Title from a namespace index and a DB key.
254 * The parameters will be checked for validity, which is a bit slower
255 * than makeTitle() but safer for user-provided data.
257 * @param int $ns the namespace of the article
258 * @param string $title the database key form
259 * @return Title the new object, or NULL on an error
263 public static function makeTitleSafe( $ns, $title ) {
265 $t->mDbkeyform
= Title
::makeName( $ns, $title );
266 if( $t->secureAndSplit() ) {
274 * Create a new Title for the Main Page
277 * @return Title the new object
280 public static function newMainPage() {
281 return Title
::newFromText( wfMsgForContent( 'mainpage' ) );
285 * Create a new Title for a redirect
286 * @param string $text the redirect title text
287 * @return Title the new object, or NULL if the text is not a
290 public static function newFromRedirect( $text ) {
291 $mwRedir = MagicWord
::get( 'redirect' );
293 if ( $mwRedir->matchStart( $text ) ) {
295 if ( preg_match( '/\[{2}(.*?)(?:\||\]{2})/', $text, $m ) ) {
296 # categories are escaped using : for example one can enter:
297 # #REDIRECT [[:Category:Music]]. Need to remove it.
298 if ( substr($m[1],0,1) == ':') {
299 # We don't want to keep the ':'
300 $m[1] = substr( $m[1], 1 );
303 $rt = Title
::newFromText( $m[1] );
304 # Disallow redirects to Special:Userlogout
305 if ( !is_null($rt) && $rt->isSpecial( 'Userlogout' ) ) {
313 #----------------------------------------------------------------------------
315 #----------------------------------------------------------------------------
318 * Get the prefixed DB key associated with an ID
319 * @param int $id the page_id of the article
320 * @return Title an object representing the article, or NULL
321 * if no such article was found
325 function nameOf( $id ) {
326 $fname = 'Title::nameOf';
327 $dbr =& wfGetDB( DB_SLAVE
);
329 $s = $dbr->selectRow( 'page', array( 'page_namespace','page_title' ), array( 'page_id' => $id ), $fname );
330 if ( $s === false ) { return NULL; }
332 $n = Title
::makeName( $s->page_namespace
, $s->page_title
);
337 * Get a regex character class describing the legal characters in a link
338 * @return string the list of characters, not delimited
342 public static function legalChars() {
343 global $wgLegalTitleChars;
344 return $wgLegalTitleChars;
348 * Get a string representation of a title suitable for
349 * including in a search index
351 * @param int $ns a namespace index
352 * @param string $title text-form main part
353 * @return string a stripped-down title string ready for the
356 public static function indexTitle( $ns, $title ) {
359 $lc = SearchEngine
::legalSearchChars() . '&#;';
360 $t = $wgContLang->stripForSearch( $title );
361 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
362 $t = $wgContLang->lc( $t );
365 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
366 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
368 $t = preg_replace( "/\\s+/", ' ', $t );
370 if ( $ns == NS_IMAGE
) {
371 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
377 * Make a prefixed DB key from a DB key and a namespace index
378 * @param int $ns numerical representation of the namespace
379 * @param string $title the DB key form the title
380 * @return string the prefixed form of the title
382 public static function makeName( $ns, $title ) {
385 $n = $wgContLang->getNsText( $ns );
386 return $n == '' ?
$title : "$n:$title";
390 * Returns the URL associated with an interwiki prefix
391 * @param string $key the interwiki prefix (e.g. "MeatBall")
392 * @return the associated URL, containing "$1", which should be
393 * replaced by an article title
397 function getInterwikiLink( $key ) {
398 global $wgMemc, $wgInterwikiExpiry;
399 global $wgInterwikiCache, $wgContLang;
400 $fname = 'Title::getInterwikiLink';
402 $key = $wgContLang->lc( $key );
404 $k = wfMemcKey( 'interwiki', $key );
405 if( array_key_exists( $k, Title
::$interwikiCache ) ) {
406 return Title
::$interwikiCache[$k]->iw_url
;
409 if ($wgInterwikiCache) {
410 return Title
::getInterwikiCached( $key );
413 $s = $wgMemc->get( $k );
414 # Ignore old keys with no iw_local
415 if( $s && isset( $s->iw_local
) && isset($s->iw_trans
)) {
416 Title
::$interwikiCache[$k] = $s;
420 $dbr =& wfGetDB( DB_SLAVE
);
421 $res = $dbr->select( 'interwiki',
422 array( 'iw_url', 'iw_local', 'iw_trans' ),
423 array( 'iw_prefix' => $key ), $fname );
428 $s = $dbr->fetchObject( $res );
430 # Cache non-existence: create a blank object and save it to memcached
436 $wgMemc->set( $k, $s, $wgInterwikiExpiry );
437 Title
::$interwikiCache[$k] = $s;
443 * Fetch interwiki prefix data from local cache in constant database
445 * More logic is explained in DefaultSettings
447 * @return string URL of interwiki site
450 function getInterwikiCached( $key ) {
451 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
455 $db=dba_open($wgInterwikiCache,'r','cdb');
456 /* Resolve site name */
457 if ($wgInterwikiScopes>=3 and !$site) {
458 $site = dba_fetch('__sites:' . wfWikiID(), $db);
460 $site = $wgInterwikiFallbackSite;
462 $value = dba_fetch( wfMemcKey( $key ), $db);
463 if ($value=='' and $wgInterwikiScopes>=3) {
465 $value = dba_fetch("_{$site}:{$key}", $db);
467 if ($value=='' and $wgInterwikiScopes>=2) {
469 $value = dba_fetch("__global:{$key}", $db);
478 list($local,$url)=explode(' ',$value,2);
480 $s->iw_local
=(int)$local;
482 Title
::$interwikiCache[wfMemcKey( 'interwiki', $key )] = $s;
486 * Determine whether the object refers to a page within
489 * @return bool TRUE if this is an in-project interwiki link
490 * or a wikilink, FALSE otherwise
494 if ( $this->mInterwiki
!= '' ) {
495 # Make sure key is loaded into cache
496 $this->getInterwikiLink( $this->mInterwiki
);
497 $k = wfMemcKey( 'interwiki', $this->mInterwiki
);
498 return (bool)(Title
::$interwikiCache[$k]->iw_local
);
505 * Determine whether the object refers to a page within
506 * this project and is transcludable.
508 * @return bool TRUE if this is transcludable
512 if ($this->mInterwiki
== '')
514 # Make sure key is loaded into cache
515 $this->getInterwikiLink( $this->mInterwiki
);
516 $k = wfMemcKey( 'interwiki', $this->mInterwiki
);
517 return (bool)(Title
::$interwikiCache[$k]->iw_trans
);
521 * Update the page_touched field for an array of title objects
522 * @todo Inefficient unless the IDs are already loaded into the
524 * @param array $titles an array of Title objects to be touched
525 * @param string $timestamp the timestamp to use instead of the
526 * default current time
530 function touchArray( $titles, $timestamp = '' ) {
532 if ( count( $titles ) == 0 ) {
535 $dbw =& wfGetDB( DB_MASTER
);
536 if ( $timestamp == '' ) {
537 $timestamp = $dbw->timestamp();
540 $page = $dbw->tableName( 'page' );
541 $sql = "UPDATE $page SET page_touched='{$timestamp}' WHERE page_id IN (";
544 foreach ( $titles as $title ) {
545 if ( $wgUseFileCache ) {
546 $cm = new HTMLFileCache($title);
547 @unlink($cm->fileCacheName());
554 $sql .= $title->getArticleID();
558 $dbw->query( $sql, 'Title::touchArray' );
561 // hack hack hack -- brion 2005-07-11. this was unfriendly to db.
562 // do them in small chunks:
563 $fname = 'Title::touchArray';
564 foreach( $titles as $title ) {
565 $dbw->update( 'page',
566 array( 'page_touched' => $timestamp ),
568 'page_namespace' => $title->getNamespace(),
569 'page_title' => $title->getDBkey() ),
575 * Escape a text fragment, say from a link, for a URL
577 static function escapeFragmentForURL( $fragment ) {
578 $fragment = str_replace( ' ', '_', $fragment );
579 $fragment = urlencode( Sanitizer
::decodeCharReferences( $fragment ) );
580 $replaceArray = array(
584 return strtr( $fragment, $replaceArray );
587 #----------------------------------------------------------------------------
589 #----------------------------------------------------------------------------
591 /** Simple accessors */
593 * Get the text form (spaces not underscores) of the main part
597 function getText() { return $this->mTextform
; }
599 * Get the URL-encoded form of the main part
603 function getPartialURL() { return $this->mUrlform
; }
605 * Get the main part with underscores
609 function getDBkey() { return $this->mDbkeyform
; }
611 * Get the namespace index, i.e. one of the NS_xxxx constants
615 function getNamespace() { return $this->mNamespace
; }
617 * Get the namespace text
621 function getNsText() {
622 global $wgContLang, $wgCanonicalNamespaceNames;
624 if ( '' != $this->mInterwiki
) {
625 // This probably shouldn't even happen. ohh man, oh yuck.
626 // But for interwiki transclusion it sometimes does.
627 // Shit. Shit shit shit.
629 // Use the canonical namespaces if possible to try to
630 // resolve a foreign namespace.
631 if( isset( $wgCanonicalNamespaceNames[$this->mNamespace
] ) ) {
632 return $wgCanonicalNamespaceNames[$this->mNamespace
];
635 return $wgContLang->getNsText( $this->mNamespace
);
638 * Get the namespace text of the subject (rather than talk) page
642 function getSubjectNsText() {
644 return $wgContLang->getNsText( Namespace::getSubject( $this->mNamespace
) );
648 * Get the namespace text of the talk page
651 function getTalkNsText() {
653 return( $wgContLang->getNsText( Namespace::getTalk( $this->mNamespace
) ) );
657 * Could this title have a corresponding talk page?
661 return( Namespace::canTalk( $this->mNamespace
) );
665 * Get the interwiki prefix (or null string)
669 function getInterwiki() { return $this->mInterwiki
; }
671 * Get the Title fragment (i.e. the bit after the #) in text form
675 function getFragment() { return $this->mFragment
; }
677 * Get the fragment in URL form, including the "#" character if there is one
682 function getFragmentForURL() {
683 if ( $this->mFragment
== '' ) {
686 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
690 * Get the default namespace index, for when there is no namespace
694 function getDefaultNamespace() { return $this->mDefaultNamespace
; }
697 * Get title for search index
698 * @return string a stripped-down title string ready for the
701 function getIndexTitle() {
702 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
706 * Get the prefixed database key form
707 * @return string the prefixed title, with underscores and
708 * any interwiki and namespace prefixes
711 function getPrefixedDBkey() {
712 $s = $this->prefix( $this->mDbkeyform
);
713 $s = str_replace( ' ', '_', $s );
718 * Get the prefixed title with spaces.
719 * This is the form usually used for display
720 * @return string the prefixed title, with spaces
723 function getPrefixedText() {
724 if ( empty( $this->mPrefixedText
) ) { // FIXME: bad usage of empty() ?
725 $s = $this->prefix( $this->mTextform
);
726 $s = str_replace( '_', ' ', $s );
727 $this->mPrefixedText
= $s;
729 return $this->mPrefixedText
;
733 * Get the prefixed title with spaces, plus any fragment
734 * (part beginning with '#')
735 * @return string the prefixed title, with spaces and
736 * the fragment, including '#'
739 function getFullText() {
740 $text = $this->getPrefixedText();
741 if( '' != $this->mFragment
) {
742 $text .= '#' . $this->mFragment
;
748 * Get the base name, i.e. the leftmost parts before the /
749 * @return string Base name
751 function getBaseText() {
752 global $wgNamespacesWithSubpages;
753 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace
] ) && $wgNamespacesWithSubpages[ $this->mNamespace
] ) {
754 $parts = explode( '/', $this->getText() );
755 # Don't discard the real title if there's no subpage involved
756 if( count( $parts ) > 1 )
757 unset( $parts[ count( $parts ) - 1 ] );
758 return implode( '/', $parts );
760 return $this->getText();
765 * Get the lowest-level subpage name, i.e. the rightmost part after /
766 * @return string Subpage name
768 function getSubpageText() {
769 global $wgNamespacesWithSubpages;
770 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace
] ) && $wgNamespacesWithSubpages[ $this->mNamespace
] ) {
771 $parts = explode( '/', $this->mTextform
);
772 return( $parts[ count( $parts ) - 1 ] );
774 return( $this->mTextform
);
779 * Get a URL-encoded form of the subpage text
780 * @return string URL-encoded subpage name
782 function getSubpageUrlForm() {
783 $text = $this->getSubpageText();
784 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
785 $text = str_replace( '%28', '(', str_replace( '%29', ')', $text ) ); # Clean up the URL; per below, this might not be safe
790 * Get a URL-encoded title (not an actual URL) including interwiki
791 * @return string the URL-encoded form
794 function getPrefixedURL() {
795 $s = $this->prefix( $this->mDbkeyform
);
796 $s = str_replace( ' ', '_', $s );
798 $s = wfUrlencode ( $s ) ;
800 # Cleaning up URL to make it look nice -- is this safe?
801 $s = str_replace( '%28', '(', $s );
802 $s = str_replace( '%29', ')', $s );
808 * Get a real URL referring to this title, with interwiki link and
811 * @param string $query an optional query string, not used
812 * for interwiki links
813 * @param string $variant language variant of url (for sr, zh..)
814 * @return string the URL
817 function getFullURL( $query = '', $variant = false ) {
818 global $wgContLang, $wgServer, $wgRequest;
820 if ( '' == $this->mInterwiki
) {
821 $url = $this->getLocalUrl( $query, $variant );
823 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
824 // Correct fix would be to move the prepending elsewhere.
825 if ($wgRequest->getVal('action') != 'render') {
826 $url = $wgServer . $url;
829 $baseUrl = $this->getInterwikiLink( $this->mInterwiki
);
831 $namespace = wfUrlencode( $this->getNsText() );
832 if ( '' != $namespace ) {
833 # Can this actually happen? Interwikis shouldn't be parsed.
834 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
837 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
839 if( false === strpos( $url, '?' ) ) {
848 # Finally, add the fragment.
849 $url .= $this->getFragmentForURL();
851 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
856 * Get a URL with no fragment or server name. If this page is generated
857 * with action=render, $wgServer is prepended.
858 * @param string $query an optional query string; if not specified,
859 * $wgArticlePath will be used.
860 * @param string $variant language variant of url (for sr, zh..)
861 * @return string the URL
864 function getLocalURL( $query = '', $variant = false ) {
865 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
866 global $wgVariantArticlePath, $wgContLang, $wgUser;
868 // internal links should point to same variant as current page (only anonymous users)
869 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
870 $pref = $wgContLang->getPreferredVariant(false);
871 if($pref != $wgContLang->getCode())
875 if ( $this->isExternal() ) {
876 $url = $this->getFullURL();
878 // This is currently only used for edit section links in the
879 // context of interwiki transclusion. In theory we should
880 // append the query to the end of any existing query string,
881 // but interwiki transclusion is already broken in that case.
885 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
886 if ( $query == '' ) {
887 if($variant!=false && $wgContLang->hasVariants()){
888 if($wgVariantArticlePath==false)
889 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
891 $variantArticlePath = $wgVariantArticlePath;
893 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
894 $url = str_replace( '$1', $dbkey, $url );
898 $url = str_replace( '$1', $dbkey, $wgArticlePath );
900 global $wgActionPaths;
903 if( !empty( $wgActionPaths ) &&
904 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
906 $action = urldecode( $matches[2] );
907 if( isset( $wgActionPaths[$action] ) ) {
908 $query = $matches[1];
909 if( isset( $matches[4] ) ) $query .= $matches[4];
910 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
911 if( $query != '' ) $url .= '?' . $query;
914 if ( $url === false ) {
915 if ( $query == '-' ) {
918 $url = "{$wgScript}?title={$dbkey}&{$query}";
922 // FIXME: this causes breakage in various places when we
923 // actually expected a local URL and end up with dupe prefixes.
924 if ($wgRequest->getVal('action') == 'render') {
925 $url = $wgServer . $url;
928 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
933 * Get an HTML-escaped version of the URL form, suitable for
934 * using in a link, without a server name or fragment
935 * @param string $query an optional query string
936 * @return string the URL
939 function escapeLocalURL( $query = '' ) {
940 return htmlspecialchars( $this->getLocalURL( $query ) );
944 * Get an HTML-escaped version of the URL form, suitable for
945 * using in a link, including the server name and fragment
947 * @return string the URL
948 * @param string $query an optional query string
951 function escapeFullURL( $query = '' ) {
952 return htmlspecialchars( $this->getFullURL( $query ) );
956 * Get the URL form for an internal link.
957 * - Used in various Squid-related code, in case we have a different
958 * internal hostname for the server from the exposed one.
960 * @param string $query an optional query string
961 * @param string $variant language variant of url (for sr, zh..)
962 * @return string the URL
965 function getInternalURL( $query = '', $variant = false ) {
966 global $wgInternalServer;
967 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
968 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
973 * Get the edit URL for this Title
974 * @return string the URL, or a null string if this is an
978 function getEditURL() {
979 if ( '' != $this->mInterwiki
) { return ''; }
980 $s = $this->getLocalURL( 'action=edit' );
986 * Get the HTML-escaped displayable text form.
987 * Used for the title field in <a> tags.
988 * @return string the text, including any prefixes
991 function getEscapedText() {
992 return htmlspecialchars( $this->getPrefixedText() );
996 * Is this Title interwiki?
1000 function isExternal() { return ( '' != $this->mInterwiki
); }
1003 * Is this page "semi-protected" - the *only* protection is autoconfirm?
1005 * @param string Action to check (default: edit)
1008 function isSemiProtected( $action = 'edit' ) {
1009 if( $this->exists() ) {
1010 $restrictions = $this->getRestrictions( $action );
1011 if( count( $restrictions ) > 0 ) {
1012 foreach( $restrictions as $restriction ) {
1013 if( strtolower( $restriction ) != 'autoconfirmed' )
1022 # If it doesn't exist, it can't be protected
1028 * Does the title correspond to a protected article?
1029 * @param string $what the action the page is protected from,
1030 * by default checks move and edit
1034 function isProtected( $action = '' ) {
1035 global $wgRestrictionLevels;
1037 if ( NS_SPECIAL
== $this->mNamespace
) { return true; }
1039 if ( $this->getCascadeProtectionSource() ) { return true; }
1041 if( $action == 'edit' ||
$action == '' ) {
1042 $r = $this->getRestrictions( 'edit' );
1043 foreach( $wgRestrictionLevels as $level ) {
1044 if( in_array( $level, $r ) && $level != '' ) {
1050 if( $action == 'move' ||
$action == '' ) {
1051 $r = $this->getRestrictions( 'move' );
1052 foreach( $wgRestrictionLevels as $level ) {
1053 if( in_array( $level, $r ) && $level != '' ) {
1063 * Is $wgUser is watching this page?
1067 function userIsWatching() {
1070 if ( is_null( $this->mWatched
) ) {
1071 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn()) {
1072 $this->mWatched
= false;
1074 $this->mWatched
= $wgUser->isWatched( $this );
1077 return $this->mWatched
;
1081 * Can $wgUser perform $action this page?
1082 * @param string $action action that permission needs to be checked for
1086 function userCan($action) {
1087 $fname = 'Title::userCan';
1088 wfProfileIn( $fname );
1090 global $wgUser, $wgNamespaceProtection;
1093 wfRunHooks( 'userCan', array( &$this, &$wgUser, $action, &$result ) );
1094 if ( $result !== null ) {
1095 wfProfileOut( $fname );
1099 if( NS_SPECIAL
== $this->mNamespace
) {
1100 wfProfileOut( $fname );
1103 if ( array_key_exists( $this->mNamespace
, $wgNamespaceProtection ) ) {
1104 $nsProt = $wgNamespaceProtection[ $this->mNamespace
];
1105 if ( !is_array($nsProt) ) $nsProt = array($nsProt);
1106 foreach( $nsProt as $right ) {
1107 if( '' != $right && !$wgUser->isAllowed( $right ) ) {
1108 wfProfileOut( $fname );
1114 if( $this->mDbkeyform
== '_' ) {
1115 # FIXME: Is this necessary? Shouldn't be allowed anyway...
1116 wfProfileOut( $fname );
1120 # protect css/js subpages of user pages
1121 # XXX: this might be better using restrictions
1122 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1123 if( $this->isCssJsSubpage()
1124 && !$wgUser->isAllowed('editinterface')
1125 && !preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform
) ) {
1126 wfProfileOut( $fname );
1130 if ( $this->getCascadeProtectionSource() ) {
1131 # We /could/ use the protection level on the source page, but it's fairly ugly
1132 # as we have to establish a precedence hierarchy for pages included by multiple
1133 # cascade-protected pages. So just restrict it to people with 'protect' permission,
1134 # as they could remove the protection anyway.
1135 if ( !$wgUser->isAllowed('protect') ) {
1136 wfProfileOut( $fname );
1141 foreach( $this->getRestrictions($action) as $right ) {
1142 // Backwards compatibility, rewrite sysop -> protect
1143 if ( $right == 'sysop' ) {
1146 if( '' != $right && !$wgUser->isAllowed( $right ) ) {
1147 wfProfileOut( $fname );
1152 if( $action == 'move' &&
1153 !( $this->isMovable() && $wgUser->isAllowed( 'move' ) ) ) {
1154 wfProfileOut( $fname );
1158 if( $action == 'create' ) {
1159 if( ( $this->isTalkPage() && !$wgUser->isAllowed( 'createtalk' ) ) ||
1160 ( !$this->isTalkPage() && !$wgUser->isAllowed( 'createpage' ) ) ) {
1161 wfProfileOut( $fname );
1166 wfProfileOut( $fname );
1171 * Can $wgUser edit this page?
1175 function userCanEdit() {
1176 return $this->userCan('edit');
1180 * Can $wgUser create this page?
1184 function userCanCreate() {
1185 return $this->userCan('create');
1189 * Can $wgUser move this page?
1193 function userCanMove() {
1194 return $this->userCan('move');
1198 * Would anybody with sufficient privileges be able to move this page?
1199 * Some pages just aren't movable.
1204 function isMovable() {
1205 return Namespace::isMovable( $this->getNamespace() )
1206 && $this->getInterwiki() == '';
1210 * Can $wgUser read this page?
1214 function userCanRead() {
1218 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1219 if ( $result !== null ) {
1223 if( $wgUser->isAllowed('read') ) {
1226 global $wgWhitelistRead;
1229 * Always grant access to the login page.
1230 * Even anons need to be able to log in.
1232 if( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'Resetpass' ) ) {
1236 /** some pages are explicitly allowed */
1237 $name = $this->getPrefixedText();
1238 if( $wgWhitelistRead && in_array( $name, $wgWhitelistRead ) ) {
1242 # Compatibility with old settings
1243 if( $wgWhitelistRead && $this->getNamespace() == NS_MAIN
) {
1244 if( in_array( ':' . $name, $wgWhitelistRead ) ) {
1253 * Is this a talk page of some sort?
1257 function isTalkPage() {
1258 return Namespace::isTalk( $this->getNamespace() );
1262 * Is this a subpage?
1266 function isSubpage() {
1267 global $wgNamespacesWithSubpages;
1269 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace
] ) ) {
1270 return ( strpos( $this->getText(), '/' ) !== false && $wgNamespacesWithSubpages[ $this->mNamespace
] == true );
1277 * Is this a .css or .js subpage of a user page?
1281 function isCssJsSubpage() {
1282 return ( NS_USER
== $this->mNamespace
and preg_match("/\\/.*\\.(css|js)$/", $this->mTextform
) );
1285 * Is this a *valid* .css or .js subpage of a user page?
1286 * Check that the corresponding skin exists
1288 function isValidCssJsSubpage() {
1289 if ( $this->isCssJsSubpage() ) {
1290 $skinNames = Skin
::getSkinNames();
1291 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1297 * Trim down a .css or .js subpage title to get the corresponding skin name
1299 function getSkinFromCssJsSubpage() {
1300 $subpage = explode( '/', $this->mTextform
);
1301 $subpage = $subpage[ count( $subpage ) - 1 ];
1302 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1305 * Is this a .css subpage of a user page?
1309 function isCssSubpage() {
1310 return ( NS_USER
== $this->mNamespace
and preg_match("/\\/.*\\.css$/", $this->mTextform
) );
1313 * Is this a .js subpage of a user page?
1317 function isJsSubpage() {
1318 return ( NS_USER
== $this->mNamespace
and preg_match("/\\/.*\\.js$/", $this->mTextform
) );
1321 * Protect css/js subpages of user pages: can $wgUser edit
1325 * @todo XXX: this might be better using restrictions
1328 function userCanEditCssJsSubpage() {
1330 return ( $wgUser->isAllowed('editinterface') or preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform
) );
1334 * Cascading protection: Get the source of any cascading restrictions on this page.
1336 * @return int The page_id of the page from which cascading restrictions have come, or false for none.
1339 function getCascadeProtectionSource() {
1341 if ( isset( $this->mCascadeSource
) ) {
1342 return $this->mCascadeSource
;
1347 if ( $this->getNamespace() == NS_IMAGE
) {
1348 $source = $this->getCascadeProtectedImageSource();
1350 $source = $this->getCascadeProtectedPageSource();
1353 $this->mCascadeSource
= $source;
1359 * Cascading protects: Check if the current image is protected due to a cascading restriction
1361 * @return int The page_id of the page from which cascading restrictions have come, or false for none.
1364 function getCascadeProtectedImageSource() {
1365 global $wgEnableCascadingProtection;
1366 if (!$wgEnableCascadingProtection)
1369 wfProfileIn(__METHOD__
);
1371 $dbr =& wfGetDb( DB_SLAVE
);
1373 $cols = array( 'pr_page' );
1374 $tables = array ('imagelinks', 'page_restrictions');
1375 $where_clauses = array( 'il_to' => $this->getDBkey(), 'il_from=pr_page', 'pr_cascade' => 1 );
1377 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
1379 if ($dbr->numRows($res)) {
1380 $row = $dbr->fetchObject($res);
1381 $culprit = $row->pr_page
;
1382 wfProfileOut(__METHOD__
);
1385 wfProfileOut(__METHOD__
);
1391 * Cascading protects: Check if the current page is protected due to a cascading restriction.
1393 * @return int The page_id of the page from which cascading restrictions have come, or false for none.
1396 function getCascadeProtectedPageSource() {
1397 global $wgEnableCascadingProtection;
1398 if (!$wgEnableCascadingProtection)
1401 wfProfileIn(__METHOD__
);
1403 $dbr =& wfGetDb( DB_SLAVE
);
1405 $cols = array( 'pr_page' );
1406 $tables = array ('templatelinks', 'page_restrictions');
1407 $where_clauses = array( 'tl_namespace' => $this->getNamespace(), 'tl_title' => $this->getDBkey(), 'tl_from=pr_page', 'pr_cascade' => 1 );
1409 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
1411 if ($dbr->numRows($res)) {
1412 $row = $dbr->fetchObject($res);
1413 $culprit = $row->pr_page
;
1414 wfProfileOut(__METHOD__
);
1417 wfProfileOut(__METHOD__
);
1422 function areRestrictionsCascading() {
1423 if (!$this->mRestrictionsLoaded
) {
1424 $this->loadRestrictions();
1427 return $this->mCascadeRestriction
;
1431 * Loads a string into mRestrictions array
1432 * @param resource $res restrictions as an SQL result.
1435 function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) {
1436 $dbr =& wfGetDb( DB_SLAVE
);
1438 $this->mRestrictions
['edit'] = array();
1439 $this->mRestrictions
['move'] = array();
1441 # Backwards-compatibility: also load the restrictions from the page record (old format).
1443 if ( $oldFashionedRestrictions == NULL ) {
1444 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions', array( 'page_id' => $this->getArticleId() ), __METHOD__
);
1447 if ($oldFashionedRestrictions != '') {
1449 foreach( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
1450 $temp = explode( '=', trim( $restrict ) );
1451 if(count($temp) == 1) {
1452 // old old format should be treated as edit/move restriction
1453 $this->mRestrictions
["edit"] = explode( ',', trim( $temp[0] ) );
1454 $this->mRestrictions
["move"] = explode( ',', trim( $temp[0] ) );
1456 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
1460 $this->mOldRestrictions
= true;
1461 $this->mCascadeRestriction
= false;
1465 if ($dbr->numRows( $res) ) {
1466 # Current system - load second to make them override.
1467 while ($row = $dbr->fetchObject( $res ) ) {
1468 # Cycle through all the restrictions.
1470 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
1472 $this->mCascadeRestriction |
= $row->pr_cascade
;
1476 $this->mLoadedRestrictions
= true;
1479 function loadRestrictions( $oldFashionedRestrictions = NULL ) {
1480 if( !$this->mRestrictionsLoaded
) {
1481 $dbr =& wfGetDB( DB_SLAVE
);
1483 $res = $dbr->select( 'page_restrictions', '*',
1484 array ( 'pr_page' => $this->getArticleId() ), __METHOD__
);
1486 $this->loadRestrictionsFromRow( $res, $oldFashionedRestrictions );
1491 * Accessor/initialisation for mRestrictions
1494 * @param string $action action that permission needs to be checked for
1495 * @return array the array of groups allowed to edit this article
1497 function getRestrictions( $action ) {
1498 if( $this->exists() ) {
1499 if( !$this->mRestrictionsLoaded
) {
1500 $this->loadRestrictions();
1502 return isset( $this->mRestrictions
[$action] )
1503 ?
$this->mRestrictions
[$action]
1511 * Is there a version of this page in the deletion archive?
1512 * @return int the number of archived revisions
1515 function isDeleted() {
1516 $fname = 'Title::isDeleted';
1517 if ( $this->getNamespace() < 0 ) {
1520 $dbr =& wfGetDB( DB_SLAVE
);
1521 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1522 'ar_title' => $this->getDBkey() ), $fname );
1523 if( $this->getNamespace() == NS_IMAGE
) {
1524 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
1525 array( 'fa_name' => $this->getDBkey() ), $fname );
1532 * Get the article ID for this Title from the link cache,
1533 * adding it if necessary
1534 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select
1536 * @return int the ID
1538 public function getArticleID( $flags = 0 ) {
1539 $linkCache =& LinkCache
::singleton();
1540 if ( $flags & GAID_FOR_UPDATE
) {
1541 $oldUpdate = $linkCache->forUpdate( true );
1542 $this->mArticleID
= $linkCache->addLinkObj( $this );
1543 $linkCache->forUpdate( $oldUpdate );
1545 if ( -1 == $this->mArticleID
) {
1546 $this->mArticleID
= $linkCache->addLinkObj( $this );
1549 return $this->mArticleID
;
1552 function getLatestRevID() {
1553 if ($this->mLatestID
!== false)
1554 return $this->mLatestID
;
1556 $db =& wfGetDB(DB_SLAVE
);
1557 return $this->mLatestID
= $db->selectField( 'revision',
1559 array('rev_page' => $this->getArticleID()),
1560 'Title::getLatestRevID' );
1564 * This clears some fields in this object, and clears any associated
1565 * keys in the "bad links" section of the link cache.
1567 * - This is called from Article::insertNewArticle() to allow
1568 * loading of the new page_id. It's also called from
1569 * Article::doDeleteArticle()
1571 * @param int $newid the new Article ID
1574 function resetArticleID( $newid ) {
1575 $linkCache =& LinkCache
::singleton();
1576 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
1578 if ( 0 == $newid ) { $this->mArticleID
= -1; }
1579 else { $this->mArticleID
= $newid; }
1580 $this->mRestrictionsLoaded
= false;
1581 $this->mRestrictions
= array();
1585 * Updates page_touched for this page; called from LinksUpdate.php
1586 * @return bool true if the update succeded
1589 function invalidateCache() {
1590 global $wgUseFileCache;
1592 if ( wfReadOnly() ) {
1596 $dbw =& wfGetDB( DB_MASTER
);
1597 $success = $dbw->update( 'page',
1599 'page_touched' => $dbw->timestamp()
1600 ), array( /* WHERE */
1601 'page_namespace' => $this->getNamespace() ,
1602 'page_title' => $this->getDBkey()
1603 ), 'Title::invalidateCache'
1606 if ($wgUseFileCache) {
1607 $cache = new HTMLFileCache($this);
1608 @unlink
($cache->fileCacheName());
1615 * Prefix some arbitrary text with the namespace or interwiki prefix
1618 * @param string $name the text
1619 * @return string the prefixed text
1622 /* private */ function prefix( $name ) {
1624 if ( '' != $this->mInterwiki
) {
1625 $p = $this->mInterwiki
. ':';
1627 if ( 0 != $this->mNamespace
) {
1628 $p .= $this->getNsText() . ':';
1634 * Secure and split - main initialisation function for this object
1636 * Assumes that mDbkeyform has been set, and is urldecoded
1637 * and uses underscores, but not otherwise munged. This function
1638 * removes illegal characters, splits off the interwiki and
1639 * namespace prefixes, sets the other forms, and canonicalizes
1641 * @return bool true on success
1644 /* private */ function secureAndSplit() {
1645 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
1648 static $rxTc = false;
1650 # % is needed as well
1651 $rxTc = '/[^' . Title
::legalChars() . ']|%[0-9A-Fa-f]{2}/S';
1654 $this->mInterwiki
= $this->mFragment
= '';
1655 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
1657 $dbkey = $this->mDbkeyform
;
1659 # Strip Unicode bidi override characters.
1660 # Sometimes they slip into cut-n-pasted page titles, where the
1661 # override chars get included in list displays.
1662 $dbkey = str_replace( "\xE2\x80\x8E", '', $dbkey ); // 200E LEFT-TO-RIGHT MARK
1663 $dbkey = str_replace( "\xE2\x80\x8F", '', $dbkey ); // 200F RIGHT-TO-LEFT MARK
1665 # Clean up whitespace
1667 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
1668 $dbkey = trim( $dbkey, '_' );
1670 if ( '' == $dbkey ) {
1674 if( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
1675 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
1679 $this->mDbkeyform
= $dbkey;
1681 # Initial colon indicates main namespace rather than specified default
1682 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
1683 if ( ':' == $dbkey{0} ) {
1684 $this->mNamespace
= NS_MAIN
;
1685 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
1688 # Namespace or interwiki prefix
1692 if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $dbkey, $m ) ) {
1694 $lowerNs = $wgContLang->lc( $p );
1695 if ( $ns = Namespace::getCanonicalIndex( $lowerNs ) ) {
1696 # Canonical namespace
1698 $this->mNamespace
= $ns;
1699 } elseif ( $ns = $wgContLang->getNsIndex( $lowerNs )) {
1700 # Ordinary namespace
1702 $this->mNamespace
= $ns;
1703 } elseif( $this->getInterwikiLink( $p ) ) {
1705 # Can't make a local interwiki link to an interwiki link.
1706 # That's just crazy!
1712 $this->mInterwiki
= $wgContLang->lc( $p );
1714 # Redundant interwiki prefix to the local wiki
1715 if ( 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) ) {
1716 if( $dbkey == '' ) {
1717 # Can't have an empty self-link
1720 $this->mInterwiki
= '';
1722 # Do another namespace split...
1726 # If there's an initial colon after the interwiki, that also
1727 # resets the default namespace
1728 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
1729 $this->mNamespace
= NS_MAIN
;
1730 $dbkey = substr( $dbkey, 1 );
1733 # If there's no recognized interwiki or namespace,
1734 # then let the colon expression be part of the title.
1739 # We already know that some pages won't be in the database!
1741 if ( '' != $this->mInterwiki || NS_SPECIAL
== $this->mNamespace
) {
1742 $this->mArticleID
= 0;
1744 $fragment = strstr( $dbkey, '#' );
1745 if ( false !== $fragment ) {
1746 $this->setFragment( $fragment );
1747 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
1748 # remove whitespace again: prevents "Foo_bar_#"
1749 # becoming "Foo_bar_"
1750 $dbkey = preg_replace( '/_*$/', '', $dbkey );
1753 # Reject illegal characters.
1755 if( preg_match( $rxTc, $dbkey ) ) {
1760 * Pages with "/./" or "/../" appearing in the URLs will
1761 * often be unreachable due to the way web browsers deal
1762 * with 'relative' URLs. Forbid them explicitly.
1764 if ( strpos( $dbkey, '.' ) !== false &&
1765 ( $dbkey === '.' ||
$dbkey === '..' ||
1766 strpos( $dbkey, './' ) === 0 ||
1767 strpos( $dbkey, '../' ) === 0 ||
1768 strpos( $dbkey, '/./' ) !== false ||
1769 strpos( $dbkey, '/../' ) !== false ) )
1775 * Limit the size of titles to 255 bytes.
1776 * This is typically the size of the underlying database field.
1777 * We make an exception for special pages, which don't need to be stored
1778 * in the database, and may edge over 255 bytes due to subpage syntax
1779 * for long titles, e.g. [[Special:Block/Long name]]
1781 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
1782 strlen( $dbkey ) > 512 )
1788 * Normally, all wiki links are forced to have
1789 * an initial capital letter so [[foo]] and [[Foo]]
1790 * point to the same place.
1792 * Don't force it for interwikis, since the other
1793 * site might be case-sensitive.
1795 if( $wgCapitalLinks && $this->mInterwiki
== '') {
1796 $dbkey = $wgContLang->ucfirst( $dbkey );
1800 * Can't make a link to a namespace alone...
1801 * "empty" local links can only be self-links
1802 * with a fragment identifier.
1805 $this->mInterwiki
== '' &&
1806 $this->mNamespace
!= NS_MAIN
) {
1810 // Any remaining initial :s are illegal.
1811 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
1816 $this->mDbkeyform
= $dbkey;
1817 $this->mUrlform
= wfUrlencode( $dbkey );
1819 $this->mTextform
= str_replace( '_', ' ', $dbkey );
1825 * Set the fragment for this title
1826 * This is kind of bad, since except for this rarely-used function, Title objects
1827 * are immutable. The reason this is here is because it's better than setting the
1828 * members directly, which is what Linker::formatComment was doing previously.
1830 * @param string $fragment text
1831 * @access kind of public
1833 function setFragment( $fragment ) {
1834 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
1838 * Get a Title object associated with the talk page of this article
1839 * @return Title the object for the talk page
1842 function getTalkPage() {
1843 return Title
::makeTitle( Namespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1847 * Get a title object associated with the subject page of this
1850 * @return Title the object for the subject page
1853 function getSubjectPage() {
1854 return Title
::makeTitle( Namespace::getSubject( $this->getNamespace() ), $this->getDBkey() );
1858 * Get an array of Title objects linking to this Title
1859 * Also stores the IDs in the link cache.
1861 * WARNING: do not use this function on arbitrary user-supplied titles!
1862 * On heavily-used templates it will max out the memory.
1864 * @param string $options may be FOR UPDATE
1865 * @return array the Title objects linking here
1868 function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
1869 $linkCache =& LinkCache
::singleton();
1872 $db =& wfGetDB( DB_MASTER
);
1874 $db =& wfGetDB( DB_SLAVE
);
1877 $res = $db->select( array( 'page', $table ),
1878 array( 'page_namespace', 'page_title', 'page_id' ),
1880 "{$prefix}_from=page_id",
1881 "{$prefix}_namespace" => $this->getNamespace(),
1882 "{$prefix}_title" => $this->getDbKey() ),
1883 'Title::getLinksTo',
1887 if ( $db->numRows( $res ) ) {
1888 while ( $row = $db->fetchObject( $res ) ) {
1889 if ( $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
) ) {
1890 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj );
1891 $retVal[] = $titleObj;
1895 $db->freeResult( $res );
1900 * Get an array of Title objects using this Title as a template
1901 * Also stores the IDs in the link cache.
1903 * WARNING: do not use this function on arbitrary user-supplied titles!
1904 * On heavily-used templates it will max out the memory.
1906 * @param string $options may be FOR UPDATE
1907 * @return array the Title objects linking here
1910 function getTemplateLinksTo( $options = '' ) {
1911 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
1915 * Get an array of Title objects referring to non-existent articles linked from this page
1917 * @param string $options may be FOR UPDATE
1918 * @return array the Title objects
1921 function getBrokenLinksFrom( $options = '' ) {
1923 $db =& wfGetDB( DB_MASTER
);
1925 $db =& wfGetDB( DB_SLAVE
);
1928 $res = $db->safeQuery(
1929 "SELECT pl_namespace, pl_title
1932 ON pl_namespace=page_namespace
1933 AND pl_title=page_title
1935 AND page_namespace IS NULL
1937 $db->tableName( 'pagelinks' ),
1938 $db->tableName( 'page' ),
1939 $this->getArticleId(),
1943 if ( $db->numRows( $res ) ) {
1944 while ( $row = $db->fetchObject( $res ) ) {
1945 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
1948 $db->freeResult( $res );
1954 * Get a list of URLs to purge from the Squid cache when this
1957 * @return array the URLs
1960 function getSquidURLs() {
1964 $this->getInternalURL(),
1965 $this->getInternalURL( 'action=history' )
1968 // purge variant urls as well
1969 if($wgContLang->hasVariants()){
1970 $variants = $wgContLang->getVariants();
1971 foreach($variants as $vCode){
1972 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
1973 $urls[] = $this->getInternalURL('',$vCode);
1980 function purgeSquid() {
1982 if ( $wgUseSquid ) {
1983 $urls = $this->getSquidURLs();
1984 $u = new SquidUpdate( $urls );
1990 * Move this page without authentication
1991 * @param Title &$nt the new page Title
1994 function moveNoAuth( &$nt ) {
1995 return $this->moveTo( $nt, false );
1999 * Check whether a given move operation would be valid.
2000 * Returns true if ok, or a message key string for an error message
2001 * if invalid. (Scarrrrry ugly interface this.)
2002 * @param Title &$nt the new title
2003 * @param bool $auth indicates whether $wgUser's permissions
2005 * @return mixed true on success, message name on failure
2008 function isValidMoveOperation( &$nt, $auth = true ) {
2009 if( !$this or !$nt ) {
2010 return 'badtitletext';
2012 if( $this->equals( $nt ) ) {
2015 if( !$this->isMovable() ||
!$nt->isMovable() ) {
2016 return 'immobile_namespace';
2019 $oldid = $this->getArticleID();
2020 $newid = $nt->getArticleID();
2022 if ( strlen( $nt->getDBkey() ) < 1 ) {
2023 return 'articleexists';
2025 if ( ( '' == $this->getDBkey() ) ||
2027 ( '' == $nt->getDBkey() ) ) {
2028 return 'badarticleerror';
2032 !$this->userCanEdit() ||
!$nt->userCanEdit() ||
2033 !$this->userCanMove() ||
!$nt->userCanMove() ) ) {
2034 return 'protectedpage';
2037 # The move is allowed only if (1) the target doesn't exist, or
2038 # (2) the target is a redirect to the source, and has no history
2039 # (so we can undo bad moves right after they're done).
2041 if ( 0 != $newid ) { # Target exists; check for validity
2042 if ( ! $this->isValidMoveTarget( $nt ) ) {
2043 return 'articleexists';
2050 * Move a title to a new location
2051 * @param Title &$nt the new title
2052 * @param bool $auth indicates whether $wgUser's permissions
2054 * @return mixed true on success, message name on failure
2057 function moveTo( &$nt, $auth = true, $reason = '' ) {
2058 $err = $this->isValidMoveOperation( $nt, $auth );
2059 if( is_string( $err ) ) {
2063 $pageid = $this->getArticleID();
2064 if( $nt->exists() ) {
2065 $this->moveOverExistingRedirect( $nt, $reason );
2066 $pageCountChange = 0;
2067 } else { # Target didn't exist, do normal move.
2068 $this->moveToNewTitle( $nt, $reason );
2069 $pageCountChange = 1;
2071 $redirid = $this->getArticleID();
2073 # Fixing category links (those without piped 'alternate' names) to be sorted under the new title
2074 $dbw =& wfGetDB( DB_MASTER
);
2075 $categorylinks = $dbw->tableName( 'categorylinks' );
2076 $sql = "UPDATE $categorylinks SET cl_sortkey=" . $dbw->addQuotes( $nt->getPrefixedText() ) .
2077 " WHERE cl_from=" . $dbw->addQuotes( $pageid ) .
2078 " AND cl_sortkey=" . $dbw->addQuotes( $this->getPrefixedText() );
2079 $dbw->query( $sql, 'SpecialMovepage::doSubmit' );
2083 $oldnamespace = $this->getNamespace() & ~
1;
2084 $newnamespace = $nt->getNamespace() & ~
1;
2085 $oldtitle = $this->getDBkey();
2086 $newtitle = $nt->getDBkey();
2088 if( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
2089 WatchedItem
::duplicateEntries( $this, $nt );
2092 # Update search engine
2093 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2095 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2099 if( $this->isContentPage() && !$nt->isContentPage() ) {
2100 # No longer a content page
2101 # Not viewed, edited, removing
2102 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2103 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2104 # Now a content page
2105 # Not viewed, edited, adding
2106 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
2107 } elseif( $pageCountChange ) {
2109 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2118 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2123 * Move page to a title which is at present a redirect to the
2126 * @param Title &$nt the page to move to, which should currently
2130 function moveOverExistingRedirect( &$nt, $reason = '' ) {
2132 $fname = 'Title::moveOverExistingRedirect';
2133 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2136 $comment .= ": $reason";
2139 $now = wfTimestampNow();
2140 $newid = $nt->getArticleID();
2141 $oldid = $this->getArticleID();
2142 $dbw =& wfGetDB( DB_MASTER
);
2143 $linkCache =& LinkCache
::singleton();
2145 # Delete the old redirect. We don't save it to history since
2146 # by definition if we've got here it's rather uninteresting.
2147 # We have to remove it so that the next step doesn't trigger
2148 # a conflict on the unique namespace+title index...
2149 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2151 # Save a null revision in the page's history notifying of the move
2152 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2153 $nullRevId = $nullRevision->insertOn( $dbw );
2155 # Change the name of the target page:
2156 $dbw->update( 'page',
2158 'page_touched' => $dbw->timestamp($now),
2159 'page_namespace' => $nt->getNamespace(),
2160 'page_title' => $nt->getDBkey(),
2161 'page_latest' => $nullRevId,
2163 /* WHERE */ array( 'page_id' => $oldid ),
2166 $linkCache->clearLink( $nt->getPrefixedDBkey() );
2168 # Recreate the redirect, this time in the other direction.
2169 $mwRedir = MagicWord
::get( 'redirect' );
2170 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2171 $redirectArticle = new Article( $this );
2172 $newid = $redirectArticle->insertOn( $dbw );
2173 $redirectRevision = new Revision( array(
2175 'comment' => $comment,
2176 'text' => $redirectText ) );
2177 $redirectRevision->insertOn( $dbw );
2178 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2179 $linkCache->clearLink( $this->getPrefixedDBkey() );
2182 $log = new LogPage( 'move' );
2183 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
2185 # Now, we record the link from the redirect to the new title.
2186 # It should have no other outgoing links...
2187 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2188 $dbw->insert( 'pagelinks',
2190 'pl_from' => $newid,
2191 'pl_namespace' => $nt->getNamespace(),
2192 'pl_title' => $nt->getDbKey() ),
2196 if ( $wgUseSquid ) {
2197 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2198 $u = new SquidUpdate( $urls );
2204 * Move page to non-existing title.
2205 * @param Title &$nt the new Title
2208 function moveToNewTitle( &$nt, $reason = '' ) {
2210 $fname = 'MovePageForm::moveToNewTitle';
2211 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2213 $comment .= ": $reason";
2216 $newid = $nt->getArticleID();
2217 $oldid = $this->getArticleID();
2218 $dbw =& wfGetDB( DB_MASTER
);
2219 $now = $dbw->timestamp();
2220 $linkCache =& LinkCache
::singleton();
2222 # Save a null revision in the page's history notifying of the move
2223 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2224 $nullRevId = $nullRevision->insertOn( $dbw );
2227 $dbw->update( 'page',
2229 'page_touched' => $now,
2230 'page_namespace' => $nt->getNamespace(),
2231 'page_title' => $nt->getDBkey(),
2232 'page_latest' => $nullRevId,
2234 /* WHERE */ array( 'page_id' => $oldid ),
2238 $linkCache->clearLink( $nt->getPrefixedDBkey() );
2241 $mwRedir = MagicWord
::get( 'redirect' );
2242 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2243 $redirectArticle = new Article( $this );
2244 $newid = $redirectArticle->insertOn( $dbw );
2245 $redirectRevision = new Revision( array(
2247 'comment' => $comment,
2248 'text' => $redirectText ) );
2249 $redirectRevision->insertOn( $dbw );
2250 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2251 $linkCache->clearLink( $this->getPrefixedDBkey() );
2254 $log = new LogPage( 'move' );
2255 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
2257 # Purge caches as per article creation
2258 Article
::onArticleCreate( $nt );
2260 # Record the just-created redirect's linking to the page
2261 $dbw->insert( 'pagelinks',
2263 'pl_from' => $newid,
2264 'pl_namespace' => $nt->getNamespace(),
2265 'pl_title' => $nt->getDBkey() ),
2268 # Purge old title from squid
2269 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2270 $this->purgeSquid();
2274 * Checks if $this can be moved to a given Title
2275 * - Selects for update, so don't call it unless you mean business
2277 * @param Title &$nt the new title to check
2280 function isValidMoveTarget( $nt ) {
2282 $fname = 'Title::isValidMoveTarget';
2283 $dbw =& wfGetDB( DB_MASTER
);
2286 $id = $nt->getArticleID();
2287 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
2288 array( 'page_is_redirect','old_text','old_flags' ),
2289 array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
2290 $fname, 'FOR UPDATE' );
2292 if ( !$obj ||
0 == $obj->page_is_redirect
) {
2294 wfDebug( __METHOD__
. ": not a redirect\n" );
2297 $text = Revision
::getRevisionText( $obj );
2299 # Does the redirect point to the source?
2300 # Or is it a broken self-redirect, usually caused by namespace collisions?
2302 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2303 $redirTitle = Title
::newFromText( $m[1] );
2304 if( !is_object( $redirTitle ) ||
2305 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2306 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2307 wfDebug( __METHOD__
. ": redirect points to other page\n" );
2312 wfDebug( __METHOD__
. ": failsafe\n" );
2316 # Does the article have a history?
2317 $row = $dbw->selectRow( array( 'page', 'revision'),
2319 array( 'page_namespace' => $nt->getNamespace(),
2320 'page_title' => $nt->getDBkey(),
2321 'page_id=rev_page AND page_latest != rev_id'
2322 ), $fname, 'FOR UPDATE'
2325 # Return true if there was no history
2326 return $row === false;
2330 * Create a redirect; fails if the title already exists; does
2333 * @param Title $dest the destination of the redirect
2334 * @param string $comment the comment string describing the move
2335 * @return bool true on success
2338 function createRedirect( $dest, $comment ) {
2339 if ( $this->getArticleID() ) {
2343 $fname = 'Title::createRedirect';
2344 $dbw =& wfGetDB( DB_MASTER
);
2346 $article = new Article( $this );
2347 $newid = $article->insertOn( $dbw );
2348 $revision = new Revision( array(
2350 'comment' => $comment,
2351 'text' => "#REDIRECT [[" . $dest->getPrefixedText() . "]]\n",
2353 $revision->insertOn( $dbw );
2354 $article->updateRevisionOn( $dbw, $revision, 0 );
2357 $dbw->insert( 'pagelinks',
2359 'pl_from' => $newid,
2360 'pl_namespace' => $dest->getNamespace(),
2361 'pl_title' => $dest->getDbKey()
2365 Article
::onArticleCreate( $this );
2370 * Get categories to which this Title belongs and return an array of
2371 * categories' names.
2373 * @return array an array of parents in the form:
2374 * $parent => $currentarticle
2377 function getParentCategories() {
2380 $titlekey = $this->getArticleId();
2381 $dbr =& wfGetDB( DB_SLAVE
);
2382 $categorylinks = $dbr->tableName( 'categorylinks' );
2385 $sql = "SELECT * FROM $categorylinks"
2386 ." WHERE cl_from='$titlekey'"
2387 ." AND cl_from <> '0'"
2388 ." ORDER BY cl_sortkey";
2390 $res = $dbr->query ( $sql ) ;
2392 if($dbr->numRows($res) > 0) {
2393 while ( $x = $dbr->fetchObject ( $res ) )
2394 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
2395 $data[$wgContLang->getNSText ( NS_CATEGORY
).':'.$x->cl_to
] = $this->getFullText();
2396 $dbr->freeResult ( $res ) ;
2404 * Get a tree of parent categories
2405 * @param array $children an array with the children in the keys, to check for circular refs
2409 function getParentCategoryTree( $children = array() ) {
2410 $parents = $this->getParentCategories();
2412 if($parents != '') {
2413 foreach($parents as $parent => $current) {
2414 if ( array_key_exists( $parent, $children ) ) {
2415 # Circular reference
2416 $stack[$parent] = array();
2418 $nt = Title
::newFromText($parent);
2420 $stack[$parent] = $nt->getParentCategoryTree( $children +
array($parent => 1) );
2432 * Get an associative array for selecting this title from
2438 function pageCond() {
2439 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
2443 * Get the revision ID of the previous revision
2445 * @param integer $revision Revision ID. Get the revision that was before this one.
2446 * @return integer $oldrevision|false
2448 function getPreviousRevisionID( $revision ) {
2449 $dbr =& wfGetDB( DB_SLAVE
);
2450 return $dbr->selectField( 'revision', 'rev_id',
2451 'rev_page=' . intval( $this->getArticleId() ) .
2452 ' AND rev_id<' . intval( $revision ) . ' ORDER BY rev_id DESC' );
2456 * Get the revision ID of the next revision
2458 * @param integer $revision Revision ID. Get the revision that was after this one.
2459 * @return integer $oldrevision|false
2461 function getNextRevisionID( $revision ) {
2462 $dbr =& wfGetDB( DB_SLAVE
);
2463 return $dbr->selectField( 'revision', 'rev_id',
2464 'rev_page=' . intval( $this->getArticleId() ) .
2465 ' AND rev_id>' . intval( $revision ) . ' ORDER BY rev_id' );
2469 * Get the number of revisions between the given revision IDs.
2471 * @param integer $old Revision ID.
2472 * @param integer $new Revision ID.
2473 * @return integer Number of revisions between these IDs.
2475 function countRevisionsBetween( $old, $new ) {
2476 $dbr =& wfGetDB( DB_SLAVE
);
2477 return $dbr->selectField( 'revision', 'count(*)',
2478 'rev_page = ' . intval( $this->getArticleId() ) .
2479 ' AND rev_id > ' . intval( $old ) .
2480 ' AND rev_id < ' . intval( $new ) );
2484 * Compare with another title.
2486 * @param Title $title
2489 function equals( $title ) {
2490 // Note: === is necessary for proper matching of number-like titles.
2491 return $this->getInterwiki() === $title->getInterwiki()
2492 && $this->getNamespace() == $title->getNamespace()
2493 && $this->getDbkey() === $title->getDbkey();
2497 * Check if page exists
2501 return $this->getArticleId() != 0;
2505 * Should a link should be displayed as a known link, just based on its title?
2507 * Currently, a self-link with a fragment and special pages are in
2508 * this category. Special pages never exist in the database.
2510 function isAlwaysKnown() {
2511 return $this->isExternal() ||
( 0 == $this->mNamespace
&& "" == $this->mDbkeyform
)
2512 || NS_SPECIAL
== $this->mNamespace
;
2516 * Update page_touched timestamps and send squid purge messages for
2517 * pages linking to this title. May be sent to the job queue depending
2518 * on the number of links. Typically called on create and delete.
2520 function touchLinks() {
2521 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
2524 if ( $this->getNamespace() == NS_CATEGORY
) {
2525 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
2531 * Get the last touched timestamp
2533 function getTouched() {
2534 $dbr =& wfGetDB( DB_SLAVE
);
2535 $touched = $dbr->selectField( 'page', 'page_touched',
2537 'page_namespace' => $this->getNamespace(),
2538 'page_title' => $this->getDBkey()
2545 * Get a cached value from a global cache that is invalidated when this page changes
2546 * @param string $key the key
2547 * @param callback $callback A callback function which generates the value on cache miss
2549 * @deprecated use DependencyWrapper
2551 function getRelatedCache( $memc, $key, $expiry, $callback, $params = array() ) {
2552 return DependencyWrapper
::getValueFromCache( $memc, $key, $expiry, $callback,
2553 $params, new TitleDependency( $this ) );
2556 function trackbackURL() {
2557 global $wgTitle, $wgScriptPath, $wgServer;
2559 return "$wgServer$wgScriptPath/trackback.php?article="
2560 . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey()));
2563 function trackbackRDF() {
2564 $url = htmlspecialchars($this->getFullURL());
2565 $title = htmlspecialchars($this->getText());
2566 $tburl = $this->trackbackURL();
2569 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
2570 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
2571 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
2574 dc:identifier=\"$url\"
2576 trackback:ping=\"$tburl\" />
2581 * Generate strings used for xml 'id' names in monobook tabs
2584 function getNamespaceKey() {
2586 switch ($this->getNamespace()) {
2589 return 'nstab-main';
2592 return 'nstab-user';
2594 return 'nstab-media';
2596 return 'nstab-special';
2598 case NS_PROJECT_TALK
:
2599 return 'nstab-project';
2602 return 'nstab-image';
2604 case NS_MEDIAWIKI_TALK
:
2605 return 'nstab-mediawiki';
2607 case NS_TEMPLATE_TALK
:
2608 return 'nstab-template';
2611 return 'nstab-help';
2613 case NS_CATEGORY_TALK
:
2614 return 'nstab-category';
2616 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
2621 * Returns true if this title resolves to the named special page
2622 * @param string $name The special page name
2625 function isSpecial( $name ) {
2626 if ( $this->getNamespace() == NS_SPECIAL
) {
2627 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
2628 if ( $name == $thisName ) {
2636 * If the Title refers to a special page alias which is not the local default,
2637 * returns a new Title which points to the local default. Otherwise, returns $this.
2639 function fixSpecialName() {
2640 if ( $this->getNamespace() == NS_SPECIAL
) {
2641 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
2642 if ( $canonicalName ) {
2643 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
2644 if ( $localName != $this->mDbkeyform
) {
2645 return Title
::makeTitle( NS_SPECIAL
, $localName );
2653 * Is this Title in a namespace which contains content?
2654 * In other words, is this a content page, for the purposes of calculating
2659 public function isContentPage() {
2660 return Namespace::isContent( $this->getNamespace() );