8 if ( !class_exists( 'UtfNormal' ) ) {
9 require_once( dirname(__FILE__
) . '/normal/UtfNormal.php' );
12 define ( 'GAID_FOR_UPDATE', 1 );
14 # Title::newFromTitle maintains a cache to avoid
15 # expensive re-normalization of commonly used titles.
16 # On a batch operation this can become a memory leak
17 # if not bounded. After hitting this many titles,
19 define( 'MW_TITLECACHE_MAX', 1000 );
21 # Constants for pr_cascade bitfield
22 define( 'CASCADE', 1 );
26 * - Represents a title, which may contain an interwiki designation or namespace
27 * - 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 $mUserCaseDBKey; # DB key with the initial letter in the case specified by the user
51 var $mNamespace; # Namespace index, i.e. one of the NS_xxxx constants
52 var $mInterwiki; # Interwiki prefix (or null string)
53 var $mFragment; # Title fragment (i.e. the bit after the #)
54 var $mArticleID; # Article ID, fetched from the link cache on demand
55 var $mLatestID; # ID of most recent revision
56 var $mRestrictions; # Array of groups allowed to edit this article
57 var $mCascadeRestriction; # Cascade restrictions on this page to included templates and images?
58 var $mRestrictionsExpiry; # When do the restrictions on this page expire?
59 var $mHasCascadingRestrictions; # Are cascading restrictions in effect on this page?
60 var $mCascadeRestrictionSources;# Where are the cascading restrictions coming from on this page?
61 var $mRestrictionsLoaded; # Boolean for initialisation on demand
62 var $mPrefixedText; # Text form including namespace/interwiki, initialised on demand
63 var $mDefaultNamespace; # Namespace index when there is no namespace
64 # Zero except in {{transclusion}} tags
65 var $mWatched; # Is $wgUser watching this page? NULL if unfilled, accessed through userIsWatching()
66 var $mLength; # The page length, 0 for special pages
67 var $mRedirect; # Is the article at this title a redirect?
75 /* private */ function __construct() {
76 $this->mInterwiki
= $this->mUrlform
=
77 $this->mTextform
= $this->mDbkeyform
= '';
78 $this->mArticleID
= -1;
79 $this->mNamespace
= NS_MAIN
;
80 $this->mRestrictionsLoaded
= false;
81 $this->mRestrictions
= array();
82 # Dont change the following, NS_MAIN is hardcoded in several place
84 $this->mDefaultNamespace
= NS_MAIN
;
85 $this->mWatched
= NULL;
86 $this->mLatestID
= false;
87 $this->mOldRestrictions
= false;
89 $this->mRedirect
= NULL;
93 * Create a new Title from a prefixed DB key
94 * @param string $key The database key, which has underscores
95 * instead of spaces, possibly including namespace and
97 * @return Title the new object, or NULL on an error
99 public static function newFromDBkey( $key ) {
101 $t->mDbkeyform
= $key;
102 if( $t->secureAndSplit() )
109 * Create a new Title from text, such as what one would
110 * find in a link. Decodes any HTML entities in the text.
112 * @param string $text the link text; spaces, prefixes,
113 * and an initial ':' indicating the main namespace
115 * @param int $defaultNamespace the namespace to use if
116 * none is specified by a prefix
117 * @return Title the new object, or NULL on an error
119 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
120 if( is_object( $text ) ) {
121 throw new MWException( 'Title::newFromText given an object' );
125 * Wiki pages often contain multiple links to the same page.
126 * Title normalization and parsing can become expensive on
127 * pages with many links, so we can save a little time by
130 * In theory these are value objects and won't get changed...
132 if( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
133 return Title
::$titleCache[$text];
137 * Convert things like é ā or 〗 into real text...
139 $filteredText = Sanitizer
::decodeCharReferences( $text );
142 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
143 $t->mDefaultNamespace
= $defaultNamespace;
145 static $cachedcount = 0 ;
146 if( $t->secureAndSplit() ) {
147 if( $defaultNamespace == NS_MAIN
) {
148 if( $cachedcount >= MW_TITLECACHE_MAX
) {
149 # Avoid memory leaks on mass operations...
150 Title
::$titleCache = array();
154 Title
::$titleCache[$text] =& $t;
164 * Create a new Title from URL-encoded text. Ensures that
165 * the given title's length does not exceed the maximum.
166 * @param string $url the title, as might be taken from a URL
167 * @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 * @param int $flags, use GAID_FOR_UPDATE to use master
196 * @return Title the new object, or NULL on an error
198 public static function newFromID( $id, $flags = 0 ) {
199 $fname = 'Title::newFromID';
200 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
201 $row = $db->selectRow( 'page', array( 'page_namespace', 'page_title' ),
202 array( 'page_id' => $id ), $fname );
203 if ( $row !== false ) {
204 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
212 * Make an array of titles from an array of IDs
214 public static function newFromIDs( $ids ) {
215 if ( !count( $ids ) ) {
218 $dbr = wfGetDB( DB_SLAVE
);
219 $res = $dbr->select( 'page', array( 'page_namespace', 'page_title' ),
220 'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__
);
223 while ( $row = $dbr->fetchObject( $res ) ) {
224 $titles[] = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
230 * Make a Title object from a DB row
231 * @param Row $row (needs at least page_title,page_namespace)
233 public static function newFromRow( $row ) {
234 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
236 $t->mArticleID
= isset($row->page_id
) ?
intval($row->page_id
) : -1;
237 $t->mLength
= isset($row->page_len
) ?
intval($row->page_len
) : -1;
238 $t->mRedirect
= isset($row->page_is_redirect
) ?
(bool)$row->page_is_redirect
: NULL;
239 $t->mLatestID
= isset($row->page_latest
) ?
$row->page_latest
: false;
245 * Create a new Title from a namespace index and a DB key.
246 * It's assumed that $ns and $title are *valid*, for instance when
247 * they came directly from the database or a special page name.
248 * For convenience, spaces are converted to underscores so that
249 * eg user_text fields can be used directly.
251 * @param int $ns the namespace of the article
252 * @param string $title the unprefixed database key form
253 * @return Title the new object
255 public static function &makeTitle( $ns, $title ) {
259 $t->mNamespace
= $ns = intval( $ns );
260 $t->mDbkeyform
= str_replace( ' ', '_', $title );
261 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
262 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
263 $t->mTextform
= str_replace( '_', ' ', $title );
268 * Create a new Title from a namespace index and a DB key.
269 * The parameters will be checked for validity, which is a bit slower
270 * than makeTitle() but safer for user-provided data.
272 * @param int $ns the namespace of the article
273 * @param string $title the database key form
274 * @return Title the new object, or NULL on an error
276 public static function makeTitleSafe( $ns, $title ) {
278 $t->mDbkeyform
= Title
::makeName( $ns, $title );
279 if( $t->secureAndSplit() ) {
287 * Create a new Title for the Main Page
288 * @return Title the new object
290 public static function newMainPage() {
291 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
292 // Don't give fatal errors if the message is broken
294 $title = Title
::newFromText( 'Main Page' );
300 * Extract a redirect destination from a string and return the
301 * Title, or null if the text doesn't contain a valid redirect
303 * @param string $text Text with possible redirect
306 public static function newFromRedirect( $text ) {
307 $redir = MagicWord
::get( 'redirect' );
308 if( $redir->matchStart( trim($text) ) ) {
309 // Extract the first link and see if it's usable
311 if( preg_match( '!\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
312 // Strip preceding colon used to "escape" categories, etc.
313 // and URL-decode links
314 if( strpos( $m[1], '%' ) !== false ) {
315 // Match behavior of inline link parsing here;
316 // don't interpret + as " " most of the time!
317 // It might be safe to just use rawurldecode instead, though.
318 $m[1] = urldecode( ltrim( $m[1], ':' ) );
320 $title = Title
::newFromText( $m[1] );
321 // Redirects to Special:Userlogout are not permitted
322 if( $title instanceof Title
&& !$title->isSpecial( 'Userlogout' ) )
329 #----------------------------------------------------------------------------
331 #----------------------------------------------------------------------------
334 * Get the prefixed DB key associated with an ID
335 * @param int $id the page_id of the article
336 * @return Title an object representing the article, or NULL
337 * if no such article was found
341 function nameOf( $id ) {
342 $fname = 'Title::nameOf';
343 $dbr = wfGetDB( DB_SLAVE
);
345 $s = $dbr->selectRow( 'page', array( 'page_namespace','page_title' ), array( 'page_id' => $id ), $fname );
346 if ( $s === false ) { return NULL; }
348 $n = Title
::makeName( $s->page_namespace
, $s->page_title
);
353 * Get a regex character class describing the legal characters in a link
354 * @return string the list of characters, not delimited
356 public static function legalChars() {
357 global $wgLegalTitleChars;
358 return $wgLegalTitleChars;
362 * Get a string representation of a title suitable for
363 * including in a search index
365 * @param int $ns a namespace index
366 * @param string $title text-form main part
367 * @return string a stripped-down title string ready for the
370 public static function indexTitle( $ns, $title ) {
373 $lc = SearchEngine
::legalSearchChars() . '&#;';
374 $t = $wgContLang->stripForSearch( $title );
375 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
376 $t = $wgContLang->lc( $t );
379 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
380 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
382 $t = preg_replace( "/\\s+/", ' ', $t );
384 if ( $ns == NS_IMAGE
) {
385 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
391 * Make a prefixed DB key from a DB key and a namespace index
392 * @param int $ns numerical representation of the namespace
393 * @param string $title the DB key form the title
394 * @return string the prefixed form of the title
396 public static function makeName( $ns, $title ) {
399 $n = $wgContLang->getNsText( $ns );
400 return $n == '' ?
$title : "$n:$title";
404 * Returns the URL associated with an interwiki prefix
405 * @param string $key the interwiki prefix (e.g. "MeatBall")
406 * @return the associated URL, containing "$1", which should be
407 * replaced by an article title
410 public function getInterwikiLink( $key ) {
411 global $wgMemc, $wgInterwikiExpiry;
412 global $wgInterwikiCache, $wgContLang;
413 $fname = 'Title::getInterwikiLink';
415 $key = $wgContLang->lc( $key );
417 $k = wfMemcKey( 'interwiki', $key );
418 if( array_key_exists( $k, Title
::$interwikiCache ) ) {
419 return Title
::$interwikiCache[$k]->iw_url
;
422 if ($wgInterwikiCache) {
423 return Title
::getInterwikiCached( $key );
426 $s = $wgMemc->get( $k );
427 # Ignore old keys with no iw_local
428 if( $s && isset( $s->iw_local
) && isset($s->iw_trans
)) {
429 Title
::$interwikiCache[$k] = $s;
433 $dbr = wfGetDB( DB_SLAVE
);
434 $res = $dbr->select( 'interwiki',
435 array( 'iw_url', 'iw_local', 'iw_trans' ),
436 array( 'iw_prefix' => $key ), $fname );
441 $s = $dbr->fetchObject( $res );
443 # Cache non-existence: create a blank object and save it to memcached
449 $wgMemc->set( $k, $s, $wgInterwikiExpiry );
450 Title
::$interwikiCache[$k] = $s;
456 * Fetch interwiki prefix data from local cache in constant database
458 * More logic is explained in DefaultSettings
460 * @return string URL of interwiki site
462 public static function getInterwikiCached( $key ) {
463 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
467 $db=dba_open($wgInterwikiCache,'r','cdb');
468 /* Resolve site name */
469 if ($wgInterwikiScopes>=3 and !$site) {
470 $site = dba_fetch('__sites:' . wfWikiID(), $db);
472 $site = $wgInterwikiFallbackSite;
474 $value = dba_fetch( wfMemcKey( $key ), $db);
475 if ($value=='' and $wgInterwikiScopes>=3) {
477 $value = dba_fetch("_{$site}:{$key}", $db);
479 if ($value=='' and $wgInterwikiScopes>=2) {
481 $value = dba_fetch("__global:{$key}", $db);
490 list($local,$url)=explode(' ',$value,2);
492 $s->iw_local
=(int)$local;
494 Title
::$interwikiCache[wfMemcKey( 'interwiki', $key )] = $s;
498 * Determine whether the object refers to a page within
501 * @return bool TRUE if this is an in-project interwiki link
502 * or a wikilink, FALSE otherwise
504 public function isLocal() {
505 if ( $this->mInterwiki
!= '' ) {
506 # Make sure key is loaded into cache
507 $this->getInterwikiLink( $this->mInterwiki
);
508 $k = wfMemcKey( 'interwiki', $this->mInterwiki
);
509 return (bool)(Title
::$interwikiCache[$k]->iw_local
);
516 * Determine whether the object refers to a page within
517 * this project and is transcludable.
519 * @return bool TRUE if this is transcludable
521 public function isTrans() {
522 if ($this->mInterwiki
== '')
524 # Make sure key is loaded into cache
525 $this->getInterwikiLink( $this->mInterwiki
);
526 $k = wfMemcKey( 'interwiki', $this->mInterwiki
);
527 return (bool)(Title
::$interwikiCache[$k]->iw_trans
);
531 * Escape a text fragment, say from a link, for a URL
533 static function escapeFragmentForURL( $fragment ) {
534 $fragment = str_replace( ' ', '_', $fragment );
535 $fragment = urlencode( Sanitizer
::decodeCharReferences( $fragment ) );
536 $replaceArray = array(
540 return strtr( $fragment, $replaceArray );
543 #----------------------------------------------------------------------------
545 #----------------------------------------------------------------------------
547 /** Simple accessors */
549 * Get the text form (spaces not underscores) of the main part
552 public function getText() { return $this->mTextform
; }
554 * Get the URL-encoded form of the main part
557 public function getPartialURL() { return $this->mUrlform
; }
559 * Get the main part with underscores
562 public function getDBkey() { return $this->mDbkeyform
; }
564 * Get the namespace index, i.e. one of the NS_xxxx constants
567 public function getNamespace() { return $this->mNamespace
; }
569 * Get the namespace text
572 public function getNsText() {
573 global $wgContLang, $wgCanonicalNamespaceNames;
575 if ( '' != $this->mInterwiki
) {
576 // This probably shouldn't even happen. ohh man, oh yuck.
577 // But for interwiki transclusion it sometimes does.
578 // Shit. Shit shit shit.
580 // Use the canonical namespaces if possible to try to
581 // resolve a foreign namespace.
582 if( isset( $wgCanonicalNamespaceNames[$this->mNamespace
] ) ) {
583 return $wgCanonicalNamespaceNames[$this->mNamespace
];
586 return $wgContLang->getNsText( $this->mNamespace
);
589 * Get the DB key with the initial letter case as specified by the user
591 function getUserCaseDBKey() {
592 return $this->mUserCaseDBKey
;
595 * Get the namespace text of the subject (rather than talk) page
598 public function getSubjectNsText() {
600 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
604 * Get the namespace text of the talk page
607 public function getTalkNsText() {
609 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
613 * Could this title have a corresponding talk page?
616 public function canTalk() {
617 return( MWNamespace
::canTalk( $this->mNamespace
) );
621 * Get the interwiki prefix (or null string)
624 public function getInterwiki() { return $this->mInterwiki
; }
626 * Get the Title fragment (i.e. the bit after the #) in text form
629 public function getFragment() { return $this->mFragment
; }
631 * Get the fragment in URL form, including the "#" character if there is one
634 public function getFragmentForURL() {
635 if ( $this->mFragment
== '' ) {
638 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
642 * Get the default namespace index, for when there is no namespace
645 public function getDefaultNamespace() { return $this->mDefaultNamespace
; }
648 * Get title for search index
649 * @return string a stripped-down title string ready for the
652 public function getIndexTitle() {
653 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
657 * Get the prefixed database key form
658 * @return string the prefixed title, with underscores and
659 * any interwiki and namespace prefixes
661 public function getPrefixedDBkey() {
662 $s = $this->prefix( $this->mDbkeyform
);
663 $s = str_replace( ' ', '_', $s );
668 * Get the prefixed title with spaces.
669 * This is the form usually used for display
670 * @return string the prefixed title, with spaces
672 public function getPrefixedText() {
673 if ( empty( $this->mPrefixedText
) ) { // FIXME: bad usage of empty() ?
674 $s = $this->prefix( $this->mTextform
);
675 $s = str_replace( '_', ' ', $s );
676 $this->mPrefixedText
= $s;
678 return $this->mPrefixedText
;
682 * Get the prefixed title with spaces, plus any fragment
683 * (part beginning with '#')
684 * @return string the prefixed title, with spaces and
685 * the fragment, including '#'
687 public function getFullText() {
688 $text = $this->getPrefixedText();
689 if( '' != $this->mFragment
) {
690 $text .= '#' . $this->mFragment
;
696 * Get the base name, i.e. the leftmost parts before the /
697 * @return string Base name
699 public function getBaseText() {
700 global $wgNamespacesWithSubpages;
701 if( !empty( $wgNamespacesWithSubpages[$this->mNamespace
] ) ) {
702 $parts = explode( '/', $this->getText() );
703 # Don't discard the real title if there's no subpage involved
704 if( count( $parts ) > 1 )
705 unset( $parts[ count( $parts ) - 1 ] );
706 return implode( '/', $parts );
708 return $this->getText();
713 * Get the lowest-level subpage name, i.e. the rightmost part after /
714 * @return string Subpage name
716 public function getSubpageText() {
717 global $wgNamespacesWithSubpages;
718 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace
] ) && $wgNamespacesWithSubpages[ $this->mNamespace
] ) {
719 $parts = explode( '/', $this->mTextform
);
720 return( $parts[ count( $parts ) - 1 ] );
722 return( $this->mTextform
);
727 * Get a URL-encoded form of the subpage text
728 * @return string URL-encoded subpage name
730 public function getSubpageUrlForm() {
731 $text = $this->getSubpageText();
732 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
733 $text = str_replace( '%28', '(', str_replace( '%29', ')', $text ) ); # Clean up the URL; per below, this might not be safe
738 * Get a URL-encoded title (not an actual URL) including interwiki
739 * @return string the URL-encoded form
741 public function getPrefixedURL() {
742 $s = $this->prefix( $this->mDbkeyform
);
743 $s = str_replace( ' ', '_', $s );
745 $s = wfUrlencode ( $s ) ;
747 # Cleaning up URL to make it look nice -- is this safe?
748 $s = str_replace( '%28', '(', $s );
749 $s = str_replace( '%29', ')', $s );
755 * Get a real URL referring to this title, with interwiki link and
758 * @param string $query an optional query string, not used
759 * for interwiki links
760 * @param string $variant language variant of url (for sr, zh..)
761 * @return string the URL
763 public function getFullURL( $query = null, $variant = false ) {
764 global $wgContLang, $wgServer, $wgRequest;
766 $query = wfBuildQuery( $query );
768 if ( '' == $this->mInterwiki
) {
769 $url = $this->getLocalUrl( $query, $variant );
771 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
772 // Correct fix would be to move the prepending elsewhere.
773 if ($wgRequest->getVal('action') != 'render') {
774 $url = $wgServer . $url;
777 $baseUrl = $this->getInterwikiLink( $this->mInterwiki
);
779 $namespace = wfUrlencode( $this->getNsText() );
780 if ( '' != $namespace ) {
781 # Can this actually happen? Interwikis shouldn't be parsed.
782 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
785 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
786 $url = wfAppendQuery( $url, $query );
789 # Finally, add the fragment.
790 $url .= $this->getFragmentForURL();
792 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
797 * Get a URL with no fragment or server name. If this page is generated
798 * with action=render, $wgServer is prepended.
799 * @param string $query an optional query string; if not specified,
800 * $wgArticlePath will be used.
801 * @param string $variant language variant of url (for sr, zh..)
802 * @return string the URL
804 public function getLocalURL( $query = null, $variant = false ) {
805 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
806 global $wgVariantArticlePath, $wgContLang, $wgUser;
808 $query = wfBuildQuery( $query );
810 // internal links should point to same variant as current page (only anonymous users)
811 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
812 $pref = $wgContLang->getPreferredVariant(false);
813 if($pref != $wgContLang->getCode())
817 if ( $this->isExternal() ) {
818 $url = $this->getFullURL();
820 // This is currently only used for edit section links in the
821 // context of interwiki transclusion. In theory we should
822 // append the query to the end of any existing query string,
823 // but interwiki transclusion is already broken in that case.
827 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
828 if ( $query == '' ) {
829 if( $variant != false && $wgContLang->hasVariants() ) {
830 if( $wgVariantArticlePath == false ) {
831 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
833 $variantArticlePath = $wgVariantArticlePath;
835 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
836 $url = str_replace( '$1', $dbkey, $url );
838 $url = str_replace( '$1', $dbkey, $wgArticlePath );
841 global $wgActionPaths;
844 if( !empty( $wgActionPaths ) &&
845 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
847 $action = urldecode( $matches[2] );
848 if( isset( $wgActionPaths[$action] ) ) {
849 $query = $matches[1];
850 if( isset( $matches[4] ) ) $query .= $matches[4];
851 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
852 if( $query != '' ) $url .= '?' . $query;
855 if ( $url === false ) {
856 if ( $query == '-' ) {
859 $url = "{$wgScript}?title={$dbkey}&{$query}";
863 // FIXME: this causes breakage in various places when we
864 // actually expected a local URL and end up with dupe prefixes.
865 if ($wgRequest->getVal('action') == 'render') {
866 $url = $wgServer . $url;
869 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
874 * Get an HTML-escaped version of the URL form, suitable for
875 * using in a link, without a server name or fragment
876 * @param string $query an optional query string
877 * @return string the URL
879 public function escapeLocalURL( $query = '' ) {
880 return htmlspecialchars( $this->getLocalURL( $query ) );
884 * Get an HTML-escaped version of the URL form, suitable for
885 * using in a link, including the server name and fragment
887 * @return string the URL
888 * @param string $query an optional query string
890 public function escapeFullURL( $query = '' ) {
891 return htmlspecialchars( $this->getFullURL( $query ) );
895 * Get the URL form for an internal link.
896 * - Used in various Squid-related code, in case we have a different
897 * internal hostname for the server from the exposed one.
899 * @param string $query an optional query string
900 * @param string $variant language variant of url (for sr, zh..)
901 * @return string the URL
903 public function getInternalURL( $query = '', $variant = false ) {
904 global $wgInternalServer;
905 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
906 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
911 * Get the edit URL for this Title
912 * @return string the URL, or a null string if this is an
915 public function getEditURL() {
916 if ( '' != $this->mInterwiki
) { return ''; }
917 $s = $this->getLocalURL( 'action=edit' );
923 * Get the HTML-escaped displayable text form.
924 * Used for the title field in <a> tags.
925 * @return string the text, including any prefixes
927 public function getEscapedText() {
928 return htmlspecialchars( $this->getPrefixedText() );
932 * Is this Title interwiki?
935 public function isExternal() { return ( '' != $this->mInterwiki
); }
938 * Is this page "semi-protected" - the *only* protection is autoconfirm?
940 * @param string Action to check (default: edit)
943 public function isSemiProtected( $action = 'edit' ) {
944 if( $this->exists() ) {
945 $restrictions = $this->getRestrictions( $action );
946 if( count( $restrictions ) > 0 ) {
947 foreach( $restrictions as $restriction ) {
948 if( strtolower( $restriction ) != 'autoconfirmed' )
957 # If it doesn't exist, it can't be protected
963 * Does the title correspond to a protected article?
964 * @param string $what the action the page is protected from,
965 * by default checks move and edit
968 public function isProtected( $action = '' ) {
969 global $wgRestrictionLevels, $wgRestrictionTypes;
971 # Special pages have inherent protection
972 if( $this->getNamespace() == NS_SPECIAL
)
975 # Check regular protection levels
976 foreach( $wgRestrictionTypes as $type ){
977 if( $action == $type ||
$action == '' ) {
978 $r = $this->getRestrictions( $type );
979 foreach( $wgRestrictionLevels as $level ) {
980 if( in_array( $level, $r ) && $level != '' ) {
991 * Is $wgUser watching this page?
994 public function userIsWatching() {
997 if ( is_null( $this->mWatched
) ) {
998 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn()) {
999 $this->mWatched
= false;
1001 $this->mWatched
= $wgUser->isWatched( $this );
1004 return $this->mWatched
;
1008 * Can $wgUser perform $action on this page?
1009 * This skips potentially expensive cascading permission checks.
1011 * Suitable for use for nonessential UI controls in common cases, but
1012 * _not_ for functional access control.
1014 * May provide false positives, but should never provide a false negative.
1016 * @param string $action action that permission needs to be checked for
1019 public function quickUserCan( $action ) {
1020 return $this->userCan( $action, false );
1024 * Determines if $wgUser is unable to edit this page because it has been protected
1025 * by $wgNamespaceProtection.
1029 public function isNamespaceProtected() {
1030 global $wgNamespaceProtection, $wgUser;
1031 if( isset( $wgNamespaceProtection[ $this->mNamespace
] ) ) {
1032 foreach( (array)$wgNamespaceProtection[ $this->mNamespace
] as $right ) {
1033 if( $right != '' && !$wgUser->isAllowed( $right ) )
1041 * Can $wgUser perform $action on this page?
1042 * @param string $action action that permission needs to be checked for
1043 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1046 public function userCan( $action, $doExpensiveQueries = true ) {
1048 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries ) === array());
1052 * Can $user perform $action on this page?
1054 * FIXME: This *does not* check throttles (User::pingLimiter()).
1056 * @param string $action action that permission needs to be checked for
1057 * @param User $user user to check
1058 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1059 * @return array Array of arrays of the arguments to wfMsg to explain permissions problems.
1061 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true ) {
1062 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1066 global $wgEmailConfirmToEdit;
1068 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
1069 $errors[] = array( 'confirmedittext' );
1072 if ( $user->isBlockedFrom( $this ) ) {
1073 $block = $user->mBlock
;
1075 // This is from OutputPage::blockedPage
1076 // Copied at r23888 by werdna
1078 $id = $user->blockedBy();
1079 $reason = $user->blockedFor();
1080 if( $reason == '' ) {
1081 $reason = wfMsg( 'blockednoreason' );
1085 if ( is_numeric( $id ) ) {
1086 $name = User
::whoIs( $id );
1091 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1092 $blockid = $block->mId
;
1093 $blockExpiry = $user->mBlock
->mExpiry
;
1094 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1096 if ( $blockExpiry == 'infinity' ) {
1097 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1098 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1100 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1101 if ( strpos( $option, ':' ) == false )
1104 list ($show, $value) = explode( ":", $option );
1106 if ( $value == 'infinite' ||
$value == 'indefinite' ) {
1107 $blockExpiry = $show;
1112 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1115 $intended = $user->mBlock
->mAddress
;
1117 $errors[] = array( ($block->mAuto ?
'autoblockedtext' : 'blockedtext'), $link, $reason, $ip, $name,
1118 $blockid, $blockExpiry, $intended, $blockTimestamp );
1125 * Can $user perform $action on this page? This is an internal function,
1126 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1127 * checks on wfReadOnly() and blocks)
1129 * @param string $action action that permission needs to be checked for
1130 * @param User $user user to check
1131 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1132 * @return array Array of arrays of the arguments to wfMsg to explain permissions problems.
1134 private function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true ) {
1135 wfProfileIn( __METHOD__
);
1139 // Use getUserPermissionsErrors instead
1140 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1141 wfProfileOut( __METHOD__
);
1142 return $result ?
array() : array( array( 'badaccess-group0' ) );
1145 if (!wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1146 if ($result != array() && is_array($result) && !is_array($result[0]))
1147 $errors[] = $result; # A single array representing an error
1148 else if (is_array($result) && is_array($result[0]))
1149 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1150 else if ($result != '' && $result != null && $result !== true && $result !== false)
1151 $errors[] = array($result); # A string representing a message-id
1152 else if ($result === false )
1153 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1155 if ($doExpensiveQueries && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1156 if ($result != array() && is_array($result) && !is_array($result[0]))
1157 $errors[] = $result; # A single array representing an error
1158 else if (is_array($result) && is_array($result[0]))
1159 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1160 else if ($result != '' && $result != null && $result !== true && $result !== false)
1161 $errors[] = array($result); # A string representing a message-id
1162 else if ($result === false )
1163 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1166 if( NS_SPECIAL
== $this->mNamespace
) {
1167 $errors[] = array('ns-specialprotected');
1170 if ( $this->isNamespaceProtected() ) {
1171 $ns = $this->getNamespace() == NS_MAIN
1172 ?
wfMsg( 'nstab-main' )
1173 : $this->getNsText();
1174 $errors[] = (NS_MEDIAWIKI
== $this->mNamespace
1175 ?
array('protectedinterface')
1176 : array( 'namespaceprotected', $ns ) );
1179 if( $this->mDbkeyform
== '_' ) {
1180 # FIXME: Is this necessary? Shouldn't be allowed anyway...
1181 $errors[] = array('badaccess-group0');
1184 # protect css/js subpages of user pages
1185 # XXX: this might be better using restrictions
1186 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1187 if( $this->isCssJsSubpage()
1188 && !$user->isAllowed('editusercssjs')
1189 && !preg_match('/^'.preg_quote($user->getName(), '/').'\//', $this->mTextform
) ) {
1190 $errors[] = array('customcssjsprotected');
1193 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1194 # We /could/ use the protection level on the source page, but it's fairly ugly
1195 # as we have to establish a precedence hierarchy for pages included by multiple
1196 # cascade-protected pages. So just restrict it to people with 'protect' permission,
1197 # as they could remove the protection anyway.
1198 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1199 # Cascading protection depends on more than this page...
1200 # Several cascading protected pages may include this page...
1201 # Check each cascading level
1202 # This is only for protection restrictions, not for all actions
1203 if( $cascadingSources > 0 && isset($restrictions[$action]) ) {
1204 foreach( $restrictions[$action] as $right ) {
1205 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1206 if( '' != $right && !$user->isAllowed( $right ) ) {
1208 foreach( $cascadingSources as $page )
1209 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1210 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1216 foreach( $this->getRestrictions($action) as $right ) {
1217 // Backwards compatibility, rewrite sysop -> protect
1218 if ( $right == 'sysop' ) {
1221 if( '' != $right && !$user->isAllowed( $right ) ) {
1222 //Users with 'editprotected' permission can edit protected pages
1223 if( $action=='edit' && $user->isAllowed( 'editprotected' ) ) {
1224 //Users with 'editprotected' permission cannot edit protected pages
1225 //with cascading option turned on.
1226 if($this->mCascadeRestriction
) {
1227 $errors[] = array( 'protectedpagetext', $right );
1229 //Nothing, user can edit!
1232 $errors[] = array( 'protectedpagetext', $right );
1237 if ($action == 'protect') {
1238 if ($this->getUserPermissionsErrors('edit', $user) != array()) {
1239 $errors[] = array( 'protect-cantedit' ); // If they can't edit, they shouldn't protect.
1243 if ($action == 'create') {
1244 $title_protection = $this->getTitleProtection();
1246 if (is_array($title_protection)) {
1247 extract($title_protection);
1249 if ($pt_create_perm == 'sysop')
1250 $pt_create_perm = 'protect';
1252 if ($pt_create_perm == '' ||
!$user->isAllowed($pt_create_perm)) {
1253 $errors[] = array ( 'titleprotected', User
::whoIs($pt_user), $pt_reason );
1257 if( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1258 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1259 $errors[] = $user->isAnon() ?
array ('nocreatetext') : array ('nocreate-loggedin');
1261 } elseif( $action == 'move' && !( $this->isMovable() && $user->isAllowed( 'move' ) ) ) {
1262 $errors[] = $user->isAnon() ?
array ( 'movenologintext' ) : array ('movenotallowed');
1263 } elseif ( !$user->isAllowed( $action ) ) {
1266 global $wgGroupPermissions;
1267 foreach( $wgGroupPermissions as $key => $value ) {
1268 if( isset( $value[$action] ) && $value[$action] == true ) {
1269 $groupName = User
::getGroupName( $key );
1270 $groupPage = User
::getGroupPage( $key );
1272 $groups[] = '[['.$groupPage->getPrefixedText().'|'.$groupName.']]';
1274 $groups[] = $groupName;
1278 $n = count( $groups );
1279 $groups = implode( ', ', $groups );
1284 $return = array( "badaccess-group$n", $groups );
1287 $return = array( 'badaccess-groups', $groups );
1289 $errors[] = $return;
1292 wfProfileOut( __METHOD__
);
1297 * Is this title subject to title protection?
1298 * @return mixed An associative array representing any existent title
1299 * protection, or false if there's none.
1301 private function getTitleProtection() {
1302 // Can't protect pages in special namespaces
1303 if ( $this->getNamespace() < 0 ) {
1307 $dbr = wfGetDB( DB_SLAVE
);
1308 $res = $dbr->select( 'protected_titles', '*',
1309 array ('pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey()) );
1311 if ($row = $dbr->fetchRow( $res )) {
1318 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1319 global $wgGroupPermissions,$wgUser,$wgContLang;
1321 if ($create_perm == implode(',',$this->getRestrictions('create'))
1322 && $expiry == $this->mRestrictionsExpiry
) {
1327 list ($namespace, $title) = array( $this->getNamespace(), $this->getDBkey() );
1329 $dbw = wfGetDB( DB_MASTER
);
1331 $encodedExpiry = Block
::encodeExpiry($expiry, $dbw );
1333 $expiry_description = '';
1334 if ( $encodedExpiry != 'infinity' ) {
1335 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ) ).')';
1338 # Update protection table
1339 if ($create_perm != '' ) {
1340 $dbw->replace( 'protected_titles', array(array('pt_namespace', 'pt_title')),
1341 array( 'pt_namespace' => $namespace, 'pt_title' => $title
1342 , 'pt_create_perm' => $create_perm
1343 , 'pt_timestamp' => Block
::encodeExpiry(wfTimestampNow(), $dbw)
1344 , 'pt_expiry' => $encodedExpiry
1345 , 'pt_user' => $wgUser->getId(), 'pt_reason' => $reason ), __METHOD__
);
1347 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1348 'pt_title' => $title ), __METHOD__
);
1350 # Update the protection log
1351 $log = new LogPage( 'protect' );
1353 if( $create_perm ) {
1354 $log->addEntry( $this->mRestrictions
['create'] ?
'modify' : 'protect', $this, trim( $reason . " [create=$create_perm] $expiry_description" ) );
1356 $log->addEntry( 'unprotect', $this, $reason );
1363 * Remove any title protection (due to page existing
1365 public function deleteTitleProtection() {
1366 $dbw = wfGetDB( DB_MASTER
);
1368 $dbw->delete( 'protected_titles',
1369 array ('pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey()), __METHOD__
);
1373 * Can $wgUser edit this page?
1375 * @deprecated use userCan('edit')
1377 public function userCanEdit( $doExpensiveQueries = true ) {
1378 return $this->userCan( 'edit', $doExpensiveQueries );
1382 * Can $wgUser create this page?
1384 * @deprecated use userCan('create')
1386 public function userCanCreate( $doExpensiveQueries = true ) {
1387 return $this->userCan( 'create', $doExpensiveQueries );
1391 * Can $wgUser move this page?
1393 * @deprecated use userCan('move')
1395 public function userCanMove( $doExpensiveQueries = true ) {
1396 return $this->userCan( 'move', $doExpensiveQueries );
1400 * Would anybody with sufficient privileges be able to move this page?
1401 * Some pages just aren't movable.
1405 public function isMovable() {
1406 return MWNamespace
::isMovable( $this->getNamespace() )
1407 && $this->getInterwiki() == '';
1411 * Can $wgUser read this page?
1413 * @todo fold these checks into userCan()
1415 public function userCanRead() {
1416 global $wgUser, $wgGroupPermissions;
1419 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1420 if ( $result !== null ) {
1424 # Shortcut for public wikis, allows skipping quite a bit of code
1425 if ($wgGroupPermissions['*']['read'])
1428 if( $wgUser->isAllowed( 'read' ) ) {
1431 global $wgWhitelistRead;
1434 * Always grant access to the login page.
1435 * Even anons need to be able to log in.
1437 if( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'Resetpass' ) ) {
1442 * Bail out if there isn't whitelist
1444 if( !is_array($wgWhitelistRead) ) {
1449 * Check for explicit whitelisting
1451 $name = $this->getPrefixedText();
1452 if( in_array( $name, $wgWhitelistRead, true ) )
1456 * Old settings might have the title prefixed with
1457 * a colon for main-namespace pages
1459 if( $this->getNamespace() == NS_MAIN
) {
1460 if( in_array( ':' . $name, $wgWhitelistRead ) )
1465 * If it's a special page, ditch the subpage bit
1468 if( $this->getNamespace() == NS_SPECIAL
) {
1469 $name = $this->getDBkey();
1470 list( $name, /* $subpage */) = SpecialPage
::resolveAliasWithSubpage( $name );
1471 if ( $name === false ) {
1472 # Invalid special page, but we show standard login required message
1476 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1477 if( in_array( $pure, $wgWhitelistRead, true ) )
1486 * Is this a talk page of some sort?
1489 public function isTalkPage() {
1490 return MWNamespace
::isTalk( $this->getNamespace() );
1494 * Is this a subpage?
1497 public function isSubpage() {
1498 global $wgNamespacesWithSubpages;
1500 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace
] ) ) {
1501 return ( strpos( $this->getText(), '/' ) !== false && $wgNamespacesWithSubpages[ $this->mNamespace
] == true );
1508 * Could this page contain custom CSS or JavaScript, based
1513 public function isCssOrJsPage() {
1514 return $this->mNamespace
== NS_MEDIAWIKI
1515 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1519 * Is this a .css or .js subpage of a user page?
1522 public function isCssJsSubpage() {
1523 return ( NS_USER
== $this->mNamespace
and preg_match("/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
1526 * Is this a *valid* .css or .js subpage of a user page?
1527 * Check that the corresponding skin exists
1529 public function isValidCssJsSubpage() {
1530 if ( $this->isCssJsSubpage() ) {
1531 $skinNames = Skin
::getSkinNames();
1532 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1538 * Trim down a .css or .js subpage title to get the corresponding skin name
1540 public function getSkinFromCssJsSubpage() {
1541 $subpage = explode( '/', $this->mTextform
);
1542 $subpage = $subpage[ count( $subpage ) - 1 ];
1543 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1546 * Is this a .css subpage of a user page?
1549 public function isCssSubpage() {
1550 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.css$/", $this->mTextform
) );
1553 * Is this a .js subpage of a user page?
1556 public function isJsSubpage() {
1557 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.js$/", $this->mTextform
) );
1560 * Protect css/js subpages of user pages: can $wgUser edit
1564 * @todo XXX: this might be better using restrictions
1566 public function userCanEditCssJsSubpage() {
1568 return ( $wgUser->isAllowed('editusercssjs') ||
preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform
) );
1572 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1574 * @return bool If the page is subject to cascading restrictions.
1576 public function isCascadeProtected() {
1577 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1578 return ( $sources > 0 );
1582 * Cascading protection: Get the source of any cascading restrictions on this page.
1584 * @param $get_pages bool Whether or not to retrieve the actual pages that the restrictions have come from.
1585 * @return array( mixed title array, restriction array)
1586 * Array of the Title objects of the pages from which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set.
1587 * The restriction array is an array of each type, each of which contains an array of unique groups
1589 public function getCascadeProtectionSources( $get_pages = true ) {
1590 global $wgEnableCascadingProtection, $wgRestrictionTypes;
1592 # Define our dimension of restrictions types
1593 $pagerestrictions = array();
1594 foreach( $wgRestrictionTypes as $action )
1595 $pagerestrictions[$action] = array();
1597 if (!$wgEnableCascadingProtection)
1598 return array( false, $pagerestrictions );
1600 if ( isset( $this->mCascadeSources
) && $get_pages ) {
1601 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
1602 } else if ( isset( $this->mHasCascadingRestrictions
) && !$get_pages ) {
1603 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
1606 wfProfileIn( __METHOD__
);
1608 $dbr = wfGetDb( DB_SLAVE
);
1610 if ( $this->getNamespace() == NS_IMAGE
) {
1611 $tables = array ('imagelinks', 'page_restrictions');
1612 $where_clauses = array(
1613 'il_to' => $this->getDBkey(),
1615 'pr_cascade' => 1 );
1617 $tables = array ('templatelinks', 'page_restrictions');
1618 $where_clauses = array(
1619 'tl_namespace' => $this->getNamespace(),
1620 'tl_title' => $this->getDBkey(),
1622 'pr_cascade' => 1 );
1626 $cols = array('pr_page', 'page_namespace', 'page_title', 'pr_expiry', 'pr_type', 'pr_level' );
1627 $where_clauses[] = 'page_id=pr_page';
1630 $cols = array( 'pr_expiry' );
1633 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
1635 $sources = $get_pages ?
array() : false;
1636 $now = wfTimestampNow();
1637 $purgeExpired = false;
1639 while( $row = $dbr->fetchObject( $res ) ) {
1640 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1641 if( $expiry > $now ) {
1643 $page_id = $row->pr_page
;
1644 $page_ns = $row->page_namespace
;
1645 $page_title = $row->page_title
;
1646 $sources[$page_id] = Title
::makeTitle($page_ns, $page_title);
1647 # Add groups needed for each restriction type if its not already there
1648 # Make sure this restriction type still exists
1649 if ( isset($pagerestrictions[$row->pr_type
]) && !in_array($row->pr_level
, $pagerestrictions[$row->pr_type
]) ) {
1650 $pagerestrictions[$row->pr_type
][]=$row->pr_level
;
1656 // Trigger lazy purge of expired restrictions from the db
1657 $purgeExpired = true;
1660 if( $purgeExpired ) {
1661 Title
::purgeExpiredRestrictions();
1664 wfProfileOut( __METHOD__
);
1667 $this->mCascadeSources
= $sources;
1668 $this->mCascadingRestrictions
= $pagerestrictions;
1670 $this->mHasCascadingRestrictions
= $sources;
1673 return array( $sources, $pagerestrictions );
1676 function areRestrictionsCascading() {
1677 if (!$this->mRestrictionsLoaded
) {
1678 $this->loadRestrictions();
1681 return $this->mCascadeRestriction
;
1685 * Loads a string into mRestrictions array
1686 * @param resource $res restrictions as an SQL result.
1688 private function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) {
1689 global $wgRestrictionTypes;
1690 $dbr = wfGetDB( DB_SLAVE
);
1692 foreach( $wgRestrictionTypes as $type ){
1693 $this->mRestrictions
[$type] = array();
1696 $this->mCascadeRestriction
= false;
1697 $this->mRestrictionsExpiry
= Block
::decodeExpiry('');
1699 # Backwards-compatibility: also load the restrictions from the page record (old format).
1701 if ( $oldFashionedRestrictions === NULL ) {
1702 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions', array( 'page_id' => $this->getArticleId() ), __METHOD__
);
1705 if ($oldFashionedRestrictions != '') {
1707 foreach( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
1708 $temp = explode( '=', trim( $restrict ) );
1709 if(count($temp) == 1) {
1710 // old old format should be treated as edit/move restriction
1711 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
1712 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
1714 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
1718 $this->mOldRestrictions
= true;
1722 if( $dbr->numRows( $res ) ) {
1723 # Current system - load second to make them override.
1724 $now = wfTimestampNow();
1725 $purgeExpired = false;
1727 while ($row = $dbr->fetchObject( $res ) ) {
1728 # Cycle through all the restrictions.
1730 // Don't take care of restrictions types that aren't in $wgRestrictionTypes
1731 if( !in_array( $row->pr_type
, $wgRestrictionTypes ) )
1734 // This code should be refactored, now that it's being used more generally,
1735 // But I don't really see any harm in leaving it in Block for now -werdna
1736 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1738 // Only apply the restrictions if they haven't expired!
1739 if ( !$expiry ||
$expiry > $now ) {
1740 $this->mRestrictionsExpiry
= $expiry;
1741 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
1743 $this->mCascadeRestriction |
= $row->pr_cascade
;
1745 // Trigger a lazy purge of expired restrictions
1746 $purgeExpired = true;
1750 if( $purgeExpired ) {
1751 Title
::purgeExpiredRestrictions();
1755 $this->mRestrictionsLoaded
= true;
1758 public function loadRestrictions( $oldFashionedRestrictions = NULL ) {
1759 if( !$this->mRestrictionsLoaded
) {
1760 if ($this->exists()) {
1761 $dbr = wfGetDB( DB_SLAVE
);
1763 $res = $dbr->select( 'page_restrictions', '*',
1764 array ( 'pr_page' => $this->getArticleId() ), __METHOD__
);
1766 $this->loadRestrictionsFromRow( $res, $oldFashionedRestrictions );
1768 $title_protection = $this->getTitleProtection();
1770 if (is_array($title_protection)) {
1771 extract($title_protection);
1773 $now = wfTimestampNow();
1774 $expiry = Block
::decodeExpiry($pt_expiry);
1776 if (!$expiry ||
$expiry > $now) {
1777 // Apply the restrictions
1778 $this->mRestrictionsExpiry
= $expiry;
1779 $this->mRestrictions
['create'] = explode(',', trim($pt_create_perm) );
1780 } else { // Get rid of the old restrictions
1781 Title
::purgeExpiredRestrictions();
1784 $this->mRestrictionsLoaded
= true;
1790 * Purge expired restrictions from the page_restrictions table
1792 static function purgeExpiredRestrictions() {
1793 $dbw = wfGetDB( DB_MASTER
);
1794 $dbw->delete( 'page_restrictions',
1795 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1798 $dbw->delete( 'protected_titles',
1799 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1804 * Accessor/initialisation for mRestrictions
1806 * @param string $action action that permission needs to be checked for
1807 * @return array the array of groups allowed to edit this article
1809 public function getRestrictions( $action ) {
1810 if( !$this->mRestrictionsLoaded
) {
1811 $this->loadRestrictions();
1813 return isset( $this->mRestrictions
[$action] )
1814 ?
$this->mRestrictions
[$action]
1819 * Is there a version of this page in the deletion archive?
1820 * @return int the number of archived revisions
1822 public function isDeleted() {
1823 $fname = 'Title::isDeleted';
1824 if ( $this->getNamespace() < 0 ) {
1827 $dbr = wfGetDB( DB_SLAVE
);
1828 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1829 'ar_title' => $this->getDBkey() ), $fname );
1830 if( $this->getNamespace() == NS_IMAGE
) {
1831 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
1832 array( 'fa_name' => $this->getDBkey() ), $fname );
1839 * Get the article ID for this Title from the link cache,
1840 * adding it if necessary
1841 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select
1843 * @return int the ID
1845 public function getArticleID( $flags = 0 ) {
1846 $linkCache = LinkCache
::singleton();
1847 if ( $flags & GAID_FOR_UPDATE
) {
1848 $oldUpdate = $linkCache->forUpdate( true );
1849 $this->mArticleID
= $linkCache->addLinkObj( $this );
1850 $linkCache->forUpdate( $oldUpdate );
1852 if ( -1 == $this->mArticleID
) {
1853 $this->mArticleID
= $linkCache->addLinkObj( $this );
1856 return $this->mArticleID
;
1860 * Is this an article that is a redirect page?
1861 * Uses link cache, adding it if necessary
1862 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update
1865 public function isRedirect( $flags = 0 ) {
1866 if( !is_null($this->mRedirect
) )
1867 return $this->mRedirect
;
1868 # Zero for special pages.
1869 # Also, calling getArticleID() loads the field from cache!
1870 if( !$this->getArticleID($flags) ||
$this->getNamespace() == NS_SPECIAL
) {
1873 $linkCache = LinkCache
::singleton();
1874 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
1876 return $this->mRedirect
;
1880 * What is the length of this page?
1881 * Uses link cache, adding it if necessary
1882 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update
1885 public function getLength( $flags = 0 ) {
1886 if( $this->mLength
!= -1 )
1887 return $this->mLength
;
1888 # Zero for special pages.
1889 # Also, calling getArticleID() loads the field from cache!
1890 if( !$this->getArticleID($flags) ||
$this->getNamespace() == NS_SPECIAL
) {
1893 $linkCache = LinkCache
::singleton();
1894 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
1896 return $this->mLength
;
1900 * What is the page_latest field for this page?
1901 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update
1904 public function getLatestRevID( $flags = 0 ) {
1905 if ($this->mLatestID
!== false)
1906 return $this->mLatestID
;
1908 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB(DB_MASTER
) : wfGetDB(DB_SLAVE
);
1909 return $this->mLatestID
= $db->selectField( 'revision',
1911 array('rev_page' => $this->getArticleID()),
1912 'Title::getLatestRevID' );
1916 * This clears some fields in this object, and clears any associated
1917 * keys in the "bad links" section of the link cache.
1919 * - This is called from Article::insertNewArticle() to allow
1920 * loading of the new page_id. It's also called from
1921 * Article::doDeleteArticle()
1923 * @param int $newid the new Article ID
1925 public function resetArticleID( $newid ) {
1926 $linkCache = LinkCache
::singleton();
1927 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
1929 if ( 0 == $newid ) { $this->mArticleID
= -1; }
1930 else { $this->mArticleID
= $newid; }
1931 $this->mRestrictionsLoaded
= false;
1932 $this->mRestrictions
= array();
1936 * Updates page_touched for this page; called from LinksUpdate.php
1937 * @return bool true if the update succeded
1939 public function invalidateCache() {
1940 global $wgUseFileCache;
1942 if ( wfReadOnly() ) {
1946 $dbw = wfGetDB( DB_MASTER
);
1947 $success = $dbw->update( 'page',
1949 'page_touched' => $dbw->timestamp()
1950 ), array( /* WHERE */
1951 'page_namespace' => $this->getNamespace() ,
1952 'page_title' => $this->getDBkey()
1953 ), 'Title::invalidateCache'
1956 if ($wgUseFileCache) {
1957 $cache = new HTMLFileCache($this);
1958 @unlink
($cache->fileCacheName());
1965 * Prefix some arbitrary text with the namespace or interwiki prefix
1968 * @param string $name the text
1969 * @return string the prefixed text
1972 /* private */ function prefix( $name ) {
1974 if ( '' != $this->mInterwiki
) {
1975 $p = $this->mInterwiki
. ':';
1977 if ( 0 != $this->mNamespace
) {
1978 $p .= $this->getNsText() . ':';
1984 * Secure and split - main initialisation function for this object
1986 * Assumes that mDbkeyform has been set, and is urldecoded
1987 * and uses underscores, but not otherwise munged. This function
1988 * removes illegal characters, splits off the interwiki and
1989 * namespace prefixes, sets the other forms, and canonicalizes
1991 * @return bool true on success
1993 private function secureAndSplit() {
1994 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
1997 static $rxTc = false;
1999 # Matching titles will be held as illegal.
2001 # Any character not allowed is forbidden...
2002 '[^' . Title
::legalChars() . ']' .
2003 # URL percent encoding sequences interfere with the ability
2004 # to round-trip titles -- you can't link to them consistently.
2005 '|%[0-9A-Fa-f]{2}' .
2006 # XML/HTML character references produce similar issues.
2007 '|&[A-Za-z0-9\x80-\xff]+;' .
2009 '|&#x[0-9A-Fa-f]+;' .
2013 $this->mInterwiki
= $this->mFragment
= '';
2014 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2016 $dbkey = $this->mDbkeyform
;
2018 # Strip Unicode bidi override characters.
2019 # Sometimes they slip into cut-n-pasted page titles, where the
2020 # override chars get included in list displays.
2021 $dbkey = str_replace( "\xE2\x80\x8E", '', $dbkey ); // 200E LEFT-TO-RIGHT MARK
2022 $dbkey = str_replace( "\xE2\x80\x8F", '', $dbkey ); // 200F RIGHT-TO-LEFT MARK
2024 # Clean up whitespace
2026 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
2027 $dbkey = trim( $dbkey, '_' );
2029 if ( '' == $dbkey ) {
2033 if( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2034 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2038 $this->mDbkeyform
= $dbkey;
2040 # Initial colon indicates main namespace rather than specified default
2041 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2042 if ( ':' == $dbkey{0} ) {
2043 $this->mNamespace
= NS_MAIN
;
2044 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2045 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2048 # Namespace or interwiki prefix
2052 if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $dbkey, $m ) ) {
2054 if ( $ns = $wgContLang->getNsIndex( $p )) {
2055 # Ordinary namespace
2057 $this->mNamespace
= $ns;
2058 } elseif( $this->getInterwikiLink( $p ) ) {
2060 # Can't make a local interwiki link to an interwiki link.
2061 # That's just crazy!
2067 $this->mInterwiki
= $wgContLang->lc( $p );
2069 # Redundant interwiki prefix to the local wiki
2070 if ( 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) ) {
2071 if( $dbkey == '' ) {
2072 # Can't have an empty self-link
2075 $this->mInterwiki
= '';
2077 # Do another namespace split...
2081 # If there's an initial colon after the interwiki, that also
2082 # resets the default namespace
2083 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2084 $this->mNamespace
= NS_MAIN
;
2085 $dbkey = substr( $dbkey, 1 );
2088 # If there's no recognized interwiki or namespace,
2089 # then let the colon expression be part of the title.
2094 # We already know that some pages won't be in the database!
2096 if ( '' != $this->mInterwiki || NS_SPECIAL
== $this->mNamespace
) {
2097 $this->mArticleID
= 0;
2099 $fragment = strstr( $dbkey, '#' );
2100 if ( false !== $fragment ) {
2101 $this->setFragment( $fragment );
2102 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2103 # remove whitespace again: prevents "Foo_bar_#"
2104 # becoming "Foo_bar_"
2105 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2108 # Reject illegal characters.
2110 if( preg_match( $rxTc, $dbkey ) ) {
2115 * Pages with "/./" or "/../" appearing in the URLs will
2116 * often be unreachable due to the way web browsers deal
2117 * with 'relative' URLs. Forbid them explicitly.
2119 if ( strpos( $dbkey, '.' ) !== false &&
2120 ( $dbkey === '.' ||
$dbkey === '..' ||
2121 strpos( $dbkey, './' ) === 0 ||
2122 strpos( $dbkey, '../' ) === 0 ||
2123 strpos( $dbkey, '/./' ) !== false ||
2124 strpos( $dbkey, '/../' ) !== false ||
2125 substr( $dbkey, -2 ) == '/.' ||
2126 substr( $dbkey, -3 ) == '/..' ) )
2132 * Magic tilde sequences? Nu-uh!
2134 if( strpos( $dbkey, '~~~' ) !== false ) {
2139 * Limit the size of titles to 255 bytes.
2140 * This is typically the size of the underlying database field.
2141 * We make an exception for special pages, which don't need to be stored
2142 * in the database, and may edge over 255 bytes due to subpage syntax
2143 * for long titles, e.g. [[Special:Block/Long name]]
2145 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2146 strlen( $dbkey ) > 512 )
2152 * Normally, all wiki links are forced to have
2153 * an initial capital letter so [[foo]] and [[Foo]]
2154 * point to the same place.
2156 * Don't force it for interwikis, since the other
2157 * site might be case-sensitive.
2159 $this->mUserCaseDBKey
= $dbkey;
2160 if( $wgCapitalLinks && $this->mInterwiki
== '') {
2161 $dbkey = $wgContLang->ucfirst( $dbkey );
2165 * Can't make a link to a namespace alone...
2166 * "empty" local links can only be self-links
2167 * with a fragment identifier.
2170 $this->mInterwiki
== '' &&
2171 $this->mNamespace
!= NS_MAIN
) {
2174 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2175 // IP names are not allowed for accounts, and can only be referring to
2176 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2177 // there are numerous ways to present the same IP. Having sp:contribs scan
2178 // them all is silly and having some show the edits and others not is
2179 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2180 $dbkey = ($this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
) ?
2181 IP
::sanitizeIP( $dbkey ) : $dbkey;
2182 // Any remaining initial :s are illegal.
2183 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
2188 $this->mDbkeyform
= $dbkey;
2189 $this->mUrlform
= wfUrlencode( $dbkey );
2191 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2197 * Set the fragment for this title
2198 * This is kind of bad, since except for this rarely-used function, Title objects
2199 * are immutable. The reason this is here is because it's better than setting the
2200 * members directly, which is what Linker::formatComment was doing previously.
2202 * @param string $fragment text
2203 * @todo clarify whether access is supposed to be public (was marked as "kind of public")
2205 public function setFragment( $fragment ) {
2206 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2210 * Get a Title object associated with the talk page of this article
2211 * @return Title the object for the talk page
2213 public function getTalkPage() {
2214 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2218 * Get a title object associated with the subject page of this
2221 * @return Title the object for the subject page
2223 public function getSubjectPage() {
2224 return Title
::makeTitle( MWNamespace
::getSubject( $this->getNamespace() ), $this->getDBkey() );
2228 * Get an array of Title objects linking to this Title
2229 * Also stores the IDs in the link cache.
2231 * WARNING: do not use this function on arbitrary user-supplied titles!
2232 * On heavily-used templates it will max out the memory.
2234 * @param string $options may be FOR UPDATE
2235 * @return array the Title objects linking here
2237 public function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
2238 $linkCache = LinkCache
::singleton();
2241 $db = wfGetDB( DB_MASTER
);
2243 $db = wfGetDB( DB_SLAVE
);
2246 $res = $db->select( array( 'page', $table ),
2247 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect' ),
2249 "{$prefix}_from=page_id",
2250 "{$prefix}_namespace" => $this->getNamespace(),
2251 "{$prefix}_title" => $this->getDBkey() ),
2252 'Title::getLinksTo',
2256 if ( $db->numRows( $res ) ) {
2257 while ( $row = $db->fetchObject( $res ) ) {
2258 if ( $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
) ) {
2259 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
);
2260 $retVal[] = $titleObj;
2264 $db->freeResult( $res );
2269 * Get an array of Title objects using this Title as a template
2270 * Also stores the IDs in the link cache.
2272 * WARNING: do not use this function on arbitrary user-supplied titles!
2273 * On heavily-used templates it will max out the memory.
2275 * @param string $options may be FOR UPDATE
2276 * @return array the Title objects linking here
2278 public function getTemplateLinksTo( $options = '' ) {
2279 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2283 * Get an array of Title objects referring to non-existent articles linked from this page
2285 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2286 * @param string $options may be FOR UPDATE
2287 * @return array the Title objects
2289 public function getBrokenLinksFrom( $options = '' ) {
2290 if ( $this->getArticleId() == 0 ) {
2291 # All links from article ID 0 are false positives
2296 $db = wfGetDB( DB_MASTER
);
2298 $db = wfGetDB( DB_SLAVE
);
2301 $res = $db->safeQuery(
2302 "SELECT pl_namespace, pl_title
2305 ON pl_namespace=page_namespace
2306 AND pl_title=page_title
2308 AND page_namespace IS NULL
2310 $db->tableName( 'pagelinks' ),
2311 $db->tableName( 'page' ),
2312 $this->getArticleId(),
2316 if ( $db->numRows( $res ) ) {
2317 while ( $row = $db->fetchObject( $res ) ) {
2318 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2321 $db->freeResult( $res );
2327 * Get a list of URLs to purge from the Squid cache when this
2330 * @return array the URLs
2332 public function getSquidURLs() {
2336 $this->getInternalURL(),
2337 $this->getInternalURL( 'action=history' )
2340 // purge variant urls as well
2341 if($wgContLang->hasVariants()){
2342 $variants = $wgContLang->getVariants();
2343 foreach($variants as $vCode){
2344 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
2345 $urls[] = $this->getInternalURL('',$vCode);
2352 public function purgeSquid() {
2354 if ( $wgUseSquid ) {
2355 $urls = $this->getSquidURLs();
2356 $u = new SquidUpdate( $urls );
2362 * Move this page without authentication
2363 * @param Title &$nt the new page Title
2365 public function moveNoAuth( &$nt ) {
2366 return $this->moveTo( $nt, false );
2370 * Check whether a given move operation would be valid.
2371 * Returns true if ok, or a message key string for an error message
2372 * if invalid. (Scarrrrry ugly interface this.)
2373 * @param Title &$nt the new title
2374 * @param bool $auth indicates whether $wgUser's permissions
2376 * @return mixed true on success, message name on failure
2378 public function isValidMoveOperation( &$nt, $auth = true ) {
2379 if( !$this or !$nt ) {
2380 return 'badtitletext';
2382 if( $this->equals( $nt ) ) {
2385 if( !$this->isMovable() ||
!$nt->isMovable() ) {
2386 return 'immobile_namespace';
2389 $oldid = $this->getArticleID();
2390 $newid = $nt->getArticleID();
2392 if ( strlen( $nt->getDBkey() ) < 1 ) {
2393 return 'articleexists';
2395 if ( ( '' == $this->getDBkey() ) ||
2397 ( '' == $nt->getDBkey() ) ) {
2398 return 'badarticleerror';
2401 // Image-specific checks
2402 if( $this->getNamespace() == NS_IMAGE
) {
2403 $file = wfLocalFile( $this );
2404 if( $file->exists() ) {
2405 if( $nt->getNamespace() != NS_IMAGE
) {
2406 return 'imagenocrossnamespace';
2408 if( !File
::checkExtensionCompatibility( $file, $nt->getDbKey() ) ) {
2409 return 'imagetypemismatch';
2416 $errors = array_merge($this->getUserPermissionsErrors('move', $wgUser),
2417 $this->getUserPermissionsErrors('edit', $wgUser),
2418 $nt->getUserPermissionsErrors('move', $wgUser),
2419 $nt->getUserPermissionsErrors('edit', $wgUser));
2420 if($errors !== array())
2421 return $errors[0][0];
2426 if( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err ) ) ) {
2427 return 'hookaborted';
2430 # The move is allowed only if (1) the target doesn't exist, or
2431 # (2) the target is a redirect to the source, and has no history
2432 # (so we can undo bad moves right after they're done).
2434 if ( 0 != $newid ) { # Target exists; check for validity
2435 if ( ! $this->isValidMoveTarget( $nt ) ) {
2436 return 'articleexists';
2439 $tp = $nt->getTitleProtection();
2440 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
2441 if ( $tp and !$wgUser->isAllowed( $right ) ) {
2442 return 'cantmove-titleprotected';
2449 * Move a title to a new location
2450 * @param Title &$nt the new title
2451 * @param bool $auth indicates whether $wgUser's permissions
2453 * @param string $reason The reason for the move
2454 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
2455 * Ignored if the user doesn't have the suppressredirect right.
2456 * @return mixed true on success, message name on failure
2458 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
2459 $err = $this->isValidMoveOperation( $nt, $auth );
2460 if( is_string( $err ) ) {
2464 $pageid = $this->getArticleID();
2465 if( $nt->exists() ) {
2466 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
2467 $pageCountChange = ($createRedirect ?
0 : -1);
2468 } else { # Target didn't exist, do normal move.
2469 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
2470 $pageCountChange = ($createRedirect ?
1 : 0);
2472 if( is_string( $err ) ) {
2475 $redirid = $this->getArticleID();
2477 // Category memberships include a sort key which may be customized.
2478 // If it's left as the default (the page title), we need to update
2479 // the sort key to match the new title.
2481 // Be careful to avoid resetting cl_timestamp, which may disturb
2482 // time-based lists on some sites.
2484 // Warning -- if the sort key is *explicitly* set to the old title,
2485 // we can't actually distinguish it from a default here, and it'll
2486 // be set to the new title even though it really shouldn't.
2487 // It'll get corrected on the next edit, but resetting cl_timestamp.
2488 $dbw = wfGetDB( DB_MASTER
);
2489 $dbw->update( 'categorylinks',
2491 'cl_sortkey' => $nt->getPrefixedText(),
2492 'cl_timestamp=cl_timestamp' ),
2494 'cl_from' => $pageid,
2495 'cl_sortkey' => $this->getPrefixedText() ),
2500 $oldnamespace = $this->getNamespace() & ~
1;
2501 $newnamespace = $nt->getNamespace() & ~
1;
2502 $oldtitle = $this->getDBkey();
2503 $newtitle = $nt->getDBkey();
2505 if( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
2506 WatchedItem
::duplicateEntries( $this, $nt );
2509 # Update search engine
2510 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2512 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2516 if( $this->isContentPage() && !$nt->isContentPage() ) {
2517 # No longer a content page
2518 # Not viewed, edited, removing
2519 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2520 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2521 # Now a content page
2522 # Not viewed, edited, adding
2523 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
2524 } elseif( $pageCountChange ) {
2526 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2533 # Update message cache for interface messages
2534 if( $nt->getNamespace() == NS_MEDIAWIKI
) {
2535 global $wgMessageCache;
2536 $oldarticle = new Article( $this );
2537 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
2538 $newarticle = new Article( $nt );
2539 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
2543 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2548 * Move page to a title which is at present a redirect to the
2551 * @param Title &$nt the page to move to, which should currently
2553 * @param string $reason The reason for the move
2554 * @param bool $createRedirect Whether to leave a redirect at the old title.
2555 * Ignored if the user doesn't have the suppressredirect right
2557 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
2558 global $wgUseSquid, $wgUser;
2559 $fname = 'Title::moveOverExistingRedirect';
2560 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
2563 $comment .= ": $reason";
2566 $now = wfTimestampNow();
2567 $newid = $nt->getArticleID();
2568 $oldid = $this->getArticleID();
2569 $dbw = wfGetDB( DB_MASTER
);
2571 # Move an image if it is
2572 if( $this->getNamespace() == NS_IMAGE
) {
2573 $file = wfLocalFile( $this );
2574 if( $file->exists() ) {
2575 $status = $file->move( $nt );
2576 if( !$status->isOk() ) {
2577 return $status->getWikiText();
2582 # Delete the old redirect. We don't save it to history since
2583 # by definition if we've got here it's rather uninteresting.
2584 # We have to remove it so that the next step doesn't trigger
2585 # a conflict on the unique namespace+title index...
2586 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2587 if ( !$dbw->cascadingDeletes() ) {
2588 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
2589 global $wgUseTrackbacks;
2590 if ($wgUseTrackbacks)
2591 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
2592 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
2593 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
2594 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
2595 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
2596 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
2597 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
2598 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
2601 # Save a null revision in the page's history notifying of the move
2602 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2603 $nullRevId = $nullRevision->insertOn( $dbw );
2605 # Change the name of the target page:
2606 $dbw->update( 'page',
2608 'page_touched' => $dbw->timestamp($now),
2609 'page_namespace' => $nt->getNamespace(),
2610 'page_title' => $nt->getDBkey(),
2611 'page_latest' => $nullRevId,
2613 /* WHERE */ array( 'page_id' => $oldid ),
2616 $nt->resetArticleID( $oldid );
2618 # Recreate the redirect, this time in the other direction.
2619 if($createRedirect ||
!$wgUser->isAllowed('suppressredirect'))
2621 $mwRedir = MagicWord
::get( 'redirect' );
2622 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2623 $redirectArticle = new Article( $this );
2624 $newid = $redirectArticle->insertOn( $dbw );
2625 $redirectRevision = new Revision( array(
2627 'comment' => $comment,
2628 'text' => $redirectText ) );
2629 $redirectRevision->insertOn( $dbw );
2630 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2632 # Now, we record the link from the redirect to the new title.
2633 # It should have no other outgoing links...
2634 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2635 $dbw->insert( 'pagelinks',
2637 'pl_from' => $newid,
2638 'pl_namespace' => $nt->getNamespace(),
2639 'pl_title' => $nt->getDBkey() ),
2642 $this->resetArticleID( 0 );
2646 $log = new LogPage( 'move' );
2647 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
2650 if ( $wgUseSquid ) {
2651 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2652 $u = new SquidUpdate( $urls );
2658 * Move page to non-existing title.
2659 * @param Title &$nt the new Title
2660 * @param string $reason The reason for the move
2661 * @param bool $createRedirect Whether to create a redirect from the old title to the new title
2662 * Ignored if the user doesn't have the suppressredirect right
2664 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
2665 global $wgUseSquid, $wgUser;
2666 $fname = 'MovePageForm::moveToNewTitle';
2667 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2669 $comment .= ": $reason";
2672 $newid = $nt->getArticleID();
2673 $oldid = $this->getArticleID();
2674 $dbw = wfGetDB( DB_MASTER
);
2675 $now = $dbw->timestamp();
2677 # Move an image if it is
2678 if( $this->getNamespace() == NS_IMAGE
) {
2679 $file = wfLocalFile( $this );
2680 if( $file->exists() ) {
2681 $status = $file->move( $nt );
2682 if( !$status->isOk() ) {
2683 return $status->getWikiText();
2688 # Save a null revision in the page's history notifying of the move
2689 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2690 $nullRevId = $nullRevision->insertOn( $dbw );
2693 $dbw->update( 'page',
2695 'page_touched' => $now,
2696 'page_namespace' => $nt->getNamespace(),
2697 'page_title' => $nt->getDBkey(),
2698 'page_latest' => $nullRevId,
2700 /* WHERE */ array( 'page_id' => $oldid ),
2703 $nt->resetArticleID( $oldid );
2705 if($createRedirect ||
!$wgUser->isAllowed('suppressredirect'))
2708 $mwRedir = MagicWord
::get( 'redirect' );
2709 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2710 $redirectArticle = new Article( $this );
2711 $newid = $redirectArticle->insertOn( $dbw );
2712 $redirectRevision = new Revision( array(
2714 'comment' => $comment,
2715 'text' => $redirectText ) );
2716 $redirectRevision->insertOn( $dbw );
2717 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2719 # Record the just-created redirect's linking to the page
2720 $dbw->insert( 'pagelinks',
2722 'pl_from' => $newid,
2723 'pl_namespace' => $nt->getNamespace(),
2724 'pl_title' => $nt->getDBkey() ),
2727 $this->resetArticleID( 0 );
2731 $log = new LogPage( 'move' );
2732 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
2734 # Purge caches as per article creation
2735 Article
::onArticleCreate( $nt );
2737 # Purge old title from squid
2738 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2739 $this->purgeSquid();
2743 * Checks if $this can be moved to a given Title
2744 * - Selects for update, so don't call it unless you mean business
2746 * @param Title &$nt the new title to check
2748 public function isValidMoveTarget( $nt ) {
2750 $fname = 'Title::isValidMoveTarget';
2751 $dbw = wfGetDB( DB_MASTER
);
2753 # Is it an existsing file?
2754 if( $nt->getNamespace() == NS_IMAGE
) {
2755 $file = wfLocalFile( $nt );
2756 if( $file->exists() ) {
2757 wfDebug( __METHOD__
. ": file exists\n" );
2763 $id = $nt->getArticleID();
2764 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
2765 array( 'page_is_redirect','old_text','old_flags' ),
2766 array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
2767 $fname, 'FOR UPDATE' );
2769 if ( !$obj ||
0 == $obj->page_is_redirect
) {
2771 wfDebug( __METHOD__
. ": not a redirect\n" );
2774 $text = Revision
::getRevisionText( $obj );
2776 # Does the redirect point to the source?
2777 # Or is it a broken self-redirect, usually caused by namespace collisions?
2779 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2780 $redirTitle = Title
::newFromText( $m[1] );
2781 if( !is_object( $redirTitle ) ||
2782 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2783 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2784 wfDebug( __METHOD__
. ": redirect points to other page\n" );
2789 wfDebug( __METHOD__
. ": failsafe\n" );
2793 # Does the article have a history?
2794 $row = $dbw->selectRow( array( 'page', 'revision'),
2796 array( 'page_namespace' => $nt->getNamespace(),
2797 'page_title' => $nt->getDBkey(),
2798 'page_id=rev_page AND page_latest != rev_id'
2799 ), $fname, 'FOR UPDATE'
2802 # Return true if there was no history
2803 return $row === false;
2807 * Can this title be added to a user's watchlist?
2811 public function isWatchable() {
2812 return !$this->isExternal()
2813 && MWNamespace
::isWatchable( $this->getNamespace() );
2817 * Get categories to which this Title belongs and return an array of
2818 * categories' names.
2820 * @return array an array of parents in the form:
2821 * $parent => $currentarticle
2823 public function getParentCategories() {
2826 $titlekey = $this->getArticleId();
2827 $dbr = wfGetDB( DB_SLAVE
);
2828 $categorylinks = $dbr->tableName( 'categorylinks' );
2831 $sql = "SELECT * FROM $categorylinks"
2832 ." WHERE cl_from='$titlekey'"
2833 ." AND cl_from <> '0'"
2834 ." ORDER BY cl_sortkey";
2836 $res = $dbr->query ( $sql ) ;
2838 if($dbr->numRows($res) > 0) {
2839 while ( $x = $dbr->fetchObject ( $res ) )
2840 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
2841 $data[$wgContLang->getNSText ( NS_CATEGORY
).':'.$x->cl_to
] = $this->getFullText();
2842 $dbr->freeResult ( $res ) ;
2850 * Get a tree of parent categories
2851 * @param array $children an array with the children in the keys, to check for circular refs
2854 public function getParentCategoryTree( $children = array() ) {
2856 $parents = $this->getParentCategories();
2858 if($parents != '') {
2859 foreach($parents as $parent => $current) {
2860 if ( array_key_exists( $parent, $children ) ) {
2861 # Circular reference
2862 $stack[$parent] = array();
2864 $nt = Title
::newFromText($parent);
2866 $stack[$parent] = $nt->getParentCategoryTree( $children +
array($parent => 1) );
2878 * Get an associative array for selecting this title from
2883 public function pageCond() {
2884 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
2888 * Get the revision ID of the previous revision
2890 * @param integer $revision Revision ID. Get the revision that was before this one.
2891 * @return integer $oldrevision|false
2893 public function getPreviousRevisionID( $revision ) {
2894 $dbr = wfGetDB( DB_SLAVE
);
2895 return $dbr->selectField( 'revision', 'rev_id',
2896 'rev_page=' . intval( $this->getArticleId() ) .
2897 ' AND rev_id<' . intval( $revision ) . ' ORDER BY rev_id DESC' );
2901 * Get the revision ID of the next revision
2903 * @param integer $revision Revision ID. Get the revision that was after this one.
2904 * @return integer $oldrevision|false
2906 public function getNextRevisionID( $revision ) {
2907 $dbr = wfGetDB( DB_SLAVE
);
2908 return $dbr->selectField( 'revision', 'rev_id',
2909 'rev_page=' . intval( $this->getArticleId() ) .
2910 ' AND rev_id>' . intval( $revision ) . ' ORDER BY rev_id' );
2914 * Get the number of revisions between the given revision IDs.
2915 * Used for diffs and other things that really need it.
2917 * @param integer $old Revision ID.
2918 * @param integer $new Revision ID.
2919 * @return integer Number of revisions between these IDs.
2921 public function countRevisionsBetween( $old, $new ) {
2922 $dbr = wfGetDB( DB_SLAVE
);
2923 return $dbr->selectField( 'revision', 'count(*)',
2924 'rev_page = ' . intval( $this->getArticleId() ) .
2925 ' AND rev_id > ' . intval( $old ) .
2926 ' AND rev_id < ' . intval( $new ),
2928 array( 'USE INDEX' => 'PRIMARY' ) );
2932 * Compare with another title.
2934 * @param Title $title
2937 public function equals( $title ) {
2938 // Note: === is necessary for proper matching of number-like titles.
2939 return $this->getInterwiki() === $title->getInterwiki()
2940 && $this->getNamespace() == $title->getNamespace()
2941 && $this->getDBkey() === $title->getDBkey();
2945 * Callback for usort() to do title sorts by (namespace, title)
2947 static function compare( $a, $b ) {
2948 if( $a->getNamespace() == $b->getNamespace() ) {
2949 return strcmp( $a->getText(), $b->getText() );
2951 return $a->getNamespace() - $b->getNamespace();
2956 * Return a string representation of this title
2960 public function __toString() {
2961 return $this->getPrefixedText();
2965 * Check if page exists
2968 public function exists() {
2969 return $this->getArticleId() != 0;
2973 * Do we know that this title definitely exists, or should we otherwise
2974 * consider that it exists?
2978 public function isAlwaysKnown() {
2979 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
2980 // the full l10n of that language to be loaded. That takes much memory and
2981 // isn't needed. So we strip the language part away.
2982 // Also, extension messages which are not loaded, are shown as red, because
2983 // we don't call MessageCache::loadAllMessages.
2984 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
2985 return $this->isExternal()
2986 ||
( $this->mNamespace
== NS_MAIN
&& $this->mDbkeyform
== '' )
2987 ||
( $this->mNamespace
== NS_MEDIAWIKI
&& wfMsgWeirdKey( $basename ) );
2991 * Update page_touched timestamps and send squid purge messages for
2992 * pages linking to this title. May be sent to the job queue depending
2993 * on the number of links. Typically called on create and delete.
2995 public function touchLinks() {
2996 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
2999 if ( $this->getNamespace() == NS_CATEGORY
) {
3000 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3006 * Get the last touched timestamp
3008 public function getTouched() {
3009 $dbr = wfGetDB( DB_SLAVE
);
3010 $touched = $dbr->selectField( 'page', 'page_touched',
3012 'page_namespace' => $this->getNamespace(),
3013 'page_title' => $this->getDBkey()
3019 public function trackbackURL() {
3020 global $wgTitle, $wgScriptPath, $wgServer;
3022 return "$wgServer$wgScriptPath/trackback.php?article="
3023 . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey()));
3026 public function trackbackRDF() {
3027 $url = htmlspecialchars($this->getFullURL());
3028 $title = htmlspecialchars($this->getText());
3029 $tburl = $this->trackbackURL();
3031 // Autodiscovery RDF is placed in comments so HTML validator
3032 // won't barf. This is a rather icky workaround, but seems
3033 // frequently used by this kind of RDF thingy.
3035 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3037 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3038 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3039 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3042 dc:identifier=\"$url\"
3044 trackback:ping=\"$tburl\" />
3050 * Generate strings used for xml 'id' names in monobook tabs
3053 public function getNamespaceKey() {
3055 switch ($this->getNamespace()) {
3058 return 'nstab-main';
3061 return 'nstab-user';
3063 return 'nstab-media';
3065 return 'nstab-special';
3067 case NS_PROJECT_TALK
:
3068 return 'nstab-project';
3071 return 'nstab-image';
3073 case NS_MEDIAWIKI_TALK
:
3074 return 'nstab-mediawiki';
3076 case NS_TEMPLATE_TALK
:
3077 return 'nstab-template';
3080 return 'nstab-help';
3082 case NS_CATEGORY_TALK
:
3083 return 'nstab-category';
3085 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
3090 * Returns true if this title resolves to the named special page
3091 * @param string $name The special page name
3093 public function isSpecial( $name ) {
3094 if ( $this->getNamespace() == NS_SPECIAL
) {
3095 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
3096 if ( $name == $thisName ) {
3104 * If the Title refers to a special page alias which is not the local default,
3105 * returns a new Title which points to the local default. Otherwise, returns $this.
3107 public function fixSpecialName() {
3108 if ( $this->getNamespace() == NS_SPECIAL
) {
3109 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
3110 if ( $canonicalName ) {
3111 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
3112 if ( $localName != $this->mDbkeyform
) {
3113 return Title
::makeTitle( NS_SPECIAL
, $localName );
3121 * Is this Title in a namespace which contains content?
3122 * In other words, is this a content page, for the purposes of calculating
3127 public function isContentPage() {
3128 return MWNamespace
::isContent( $this->getNamespace() );
3131 public function getRedirectsHere() {
3133 $dbr = wfGetDB( DB_SLAVE
);
3134 list($page,$redirect) = $dbr->tableNamesN( 'page', 'redirect' );
3135 $result = $dbr->query( "SELECT page_title, page_namespace FROM $page JOIN $redirect ON page_id = rd_from WHERE rd_title = "
3136 . $dbr->addQuotes( $this->getDBKey() ) . " AND rd_namespace = " . $this->getNamespace(), __METHOD__
);
3137 while( $row = $dbr->fetchObject( $result ) ) {
3138 $redirs[] = self
::newFromRow( $row );