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 = '', $variant = false ) {
764 global $wgContLang, $wgServer, $wgRequest;
766 if ( '' == $this->mInterwiki
) {
767 $url = $this->getLocalUrl( $query, $variant );
769 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
770 // Correct fix would be to move the prepending elsewhere.
771 if ($wgRequest->getVal('action') != 'render') {
772 $url = $wgServer . $url;
775 $baseUrl = $this->getInterwikiLink( $this->mInterwiki
);
777 $namespace = wfUrlencode( $this->getNsText() );
778 if ( '' != $namespace ) {
779 # Can this actually happen? Interwikis shouldn't be parsed.
780 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
783 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
784 $url = wfAppendQuery( $url, $query );
787 # Finally, add the fragment.
788 $url .= $this->getFragmentForURL();
790 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
795 * Get a URL with no fragment or server name. If this page is generated
796 * with action=render, $wgServer is prepended.
797 * @param string $query an optional query string; if not specified,
798 * $wgArticlePath will be used.
799 * @param string $variant language variant of url (for sr, zh..)
800 * @return string the URL
802 public function getLocalURL( $query = '', $variant = false ) {
803 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
804 global $wgVariantArticlePath, $wgContLang, $wgUser;
806 // internal links should point to same variant as current page (only anonymous users)
807 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
808 $pref = $wgContLang->getPreferredVariant(false);
809 if($pref != $wgContLang->getCode())
813 if ( $this->isExternal() ) {
814 $url = $this->getFullURL();
816 // This is currently only used for edit section links in the
817 // context of interwiki transclusion. In theory we should
818 // append the query to the end of any existing query string,
819 // but interwiki transclusion is already broken in that case.
823 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
824 if ( $query == '' ) {
825 if( $variant != false && $wgContLang->hasVariants() ) {
826 if( $wgVariantArticlePath == false ) {
827 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
829 $variantArticlePath = $wgVariantArticlePath;
831 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
832 $url = str_replace( '$1', $dbkey, $url );
834 $url = str_replace( '$1', $dbkey, $wgArticlePath );
837 global $wgActionPaths;
840 if( !empty( $wgActionPaths ) &&
841 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
843 $action = urldecode( $matches[2] );
844 if( isset( $wgActionPaths[$action] ) ) {
845 $query = $matches[1];
846 if( isset( $matches[4] ) ) $query .= $matches[4];
847 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
848 if( $query != '' ) $url .= '?' . $query;
851 if ( $url === false ) {
852 if ( $query == '-' ) {
855 $url = "{$wgScript}?title={$dbkey}&{$query}";
859 // FIXME: this causes breakage in various places when we
860 // actually expected a local URL and end up with dupe prefixes.
861 if ($wgRequest->getVal('action') == 'render') {
862 $url = $wgServer . $url;
865 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
870 * Get an HTML-escaped version of the URL form, suitable for
871 * using in a link, without a server name or fragment
872 * @param string $query an optional query string
873 * @return string the URL
875 public function escapeLocalURL( $query = '' ) {
876 return htmlspecialchars( $this->getLocalURL( $query ) );
880 * Get an HTML-escaped version of the URL form, suitable for
881 * using in a link, including the server name and fragment
883 * @return string the URL
884 * @param string $query an optional query string
886 public function escapeFullURL( $query = '' ) {
887 return htmlspecialchars( $this->getFullURL( $query ) );
891 * Get the URL form for an internal link.
892 * - Used in various Squid-related code, in case we have a different
893 * internal hostname for the server from the exposed one.
895 * @param string $query an optional query string
896 * @param string $variant language variant of url (for sr, zh..)
897 * @return string the URL
899 public function getInternalURL( $query = '', $variant = false ) {
900 global $wgInternalServer;
901 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
902 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
907 * Get the edit URL for this Title
908 * @return string the URL, or a null string if this is an
911 public function getEditURL() {
912 if ( '' != $this->mInterwiki
) { return ''; }
913 $s = $this->getLocalURL( 'action=edit' );
919 * Get the HTML-escaped displayable text form.
920 * Used for the title field in <a> tags.
921 * @return string the text, including any prefixes
923 public function getEscapedText() {
924 return htmlspecialchars( $this->getPrefixedText() );
928 * Is this Title interwiki?
931 public function isExternal() { return ( '' != $this->mInterwiki
); }
934 * Is this page "semi-protected" - the *only* protection is autoconfirm?
936 * @param string Action to check (default: edit)
939 public function isSemiProtected( $action = 'edit' ) {
940 if( $this->exists() ) {
941 $restrictions = $this->getRestrictions( $action );
942 if( count( $restrictions ) > 0 ) {
943 foreach( $restrictions as $restriction ) {
944 if( strtolower( $restriction ) != 'autoconfirmed' )
953 # If it doesn't exist, it can't be protected
959 * Does the title correspond to a protected article?
960 * @param string $what the action the page is protected from,
961 * by default checks move and edit
964 public function isProtected( $action = '' ) {
965 global $wgRestrictionLevels, $wgRestrictionTypes;
967 # Special pages have inherent protection
968 if( $this->getNamespace() == NS_SPECIAL
)
971 # Check regular protection levels
972 foreach( $wgRestrictionTypes as $type ){
973 if( $action == $type ||
$action == '' ) {
974 $r = $this->getRestrictions( $type );
975 foreach( $wgRestrictionLevels as $level ) {
976 if( in_array( $level, $r ) && $level != '' ) {
987 * Is $wgUser watching this page?
990 public function userIsWatching() {
993 if ( is_null( $this->mWatched
) ) {
994 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn()) {
995 $this->mWatched
= false;
997 $this->mWatched
= $wgUser->isWatched( $this );
1000 return $this->mWatched
;
1004 * Can $wgUser perform $action on this page?
1005 * This skips potentially expensive cascading permission checks.
1007 * Suitable for use for nonessential UI controls in common cases, but
1008 * _not_ for functional access control.
1010 * May provide false positives, but should never provide a false negative.
1012 * @param string $action action that permission needs to be checked for
1015 public function quickUserCan( $action ) {
1016 return $this->userCan( $action, false );
1020 * Determines if $wgUser is unable to edit this page because it has been protected
1021 * by $wgNamespaceProtection.
1025 public function isNamespaceProtected() {
1026 global $wgNamespaceProtection, $wgUser;
1027 if( isset( $wgNamespaceProtection[ $this->mNamespace
] ) ) {
1028 foreach( (array)$wgNamespaceProtection[ $this->mNamespace
] as $right ) {
1029 if( $right != '' && !$wgUser->isAllowed( $right ) )
1037 * Can $wgUser perform $action on this page?
1038 * @param string $action action that permission needs to be checked for
1039 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1042 public function userCan( $action, $doExpensiveQueries = true ) {
1044 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries ) === array());
1048 * Can $user perform $action on this page?
1050 * FIXME: This *does not* check throttles (User::pingLimiter()).
1052 * @param string $action action that permission needs to be checked for
1053 * @param User $user user to check
1054 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1055 * @return array Array of arrays of the arguments to wfMsg to explain permissions problems.
1057 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true ) {
1058 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1062 global $wgEmailConfirmToEdit;
1064 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
1065 $errors[] = array( 'confirmedittext' );
1068 if ( $user->isBlockedFrom( $this ) ) {
1069 $block = $user->mBlock
;
1071 // This is from OutputPage::blockedPage
1072 // Copied at r23888 by werdna
1074 $id = $user->blockedBy();
1075 $reason = $user->blockedFor();
1076 if( $reason == '' ) {
1077 $reason = wfMsg( 'blockednoreason' );
1081 if ( is_numeric( $id ) ) {
1082 $name = User
::whoIs( $id );
1087 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1088 $blockid = $block->mId
;
1089 $blockExpiry = $user->mBlock
->mExpiry
;
1090 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1092 if ( $blockExpiry == 'infinity' ) {
1093 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1094 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1096 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1097 if ( strpos( $option, ':' ) == false )
1100 list ($show, $value) = explode( ":", $option );
1102 if ( $value == 'infinite' ||
$value == 'indefinite' ) {
1103 $blockExpiry = $show;
1108 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1111 $intended = $user->mBlock
->mAddress
;
1113 $errors[] = array( ($block->mAuto ?
'autoblockedtext' : 'blockedtext'), $link, $reason, $ip, $name,
1114 $blockid, $blockExpiry, $intended, $blockTimestamp );
1121 * Can $user perform $action on this page? This is an internal function,
1122 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1123 * checks on wfReadOnly() and blocks)
1125 * @param string $action action that permission needs to be checked for
1126 * @param User $user user to check
1127 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1128 * @return array Array of arrays of the arguments to wfMsg to explain permissions problems.
1130 private function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true ) {
1131 wfProfileIn( __METHOD__
);
1135 // Use getUserPermissionsErrors instead
1136 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1137 wfProfileOut( __METHOD__
);
1138 return $result ?
array() : array( array( 'badaccess-group0' ) );
1141 if (!wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1142 if ($result != array() && is_array($result) && !is_array($result[0]))
1143 $errors[] = $result; # A single array representing an error
1144 else if (is_array($result) && is_array($result[0]))
1145 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1146 else if ($result != '' && $result != null && $result !== true && $result !== false)
1147 $errors[] = array($result); # A string representing a message-id
1148 else if ($result === false )
1149 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1151 if ($doExpensiveQueries && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1152 if ($result != array() && is_array($result) && !is_array($result[0]))
1153 $errors[] = $result; # A single array representing an error
1154 else if (is_array($result) && is_array($result[0]))
1155 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1156 else if ($result != '' && $result != null && $result !== true && $result !== false)
1157 $errors[] = array($result); # A string representing a message-id
1158 else if ($result === false )
1159 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1162 if( NS_SPECIAL
== $this->mNamespace
) {
1163 $errors[] = array('ns-specialprotected');
1166 if ( $this->isNamespaceProtected() ) {
1167 $ns = $this->getNamespace() == NS_MAIN
1168 ?
wfMsg( 'nstab-main' )
1169 : $this->getNsText();
1170 $errors[] = (NS_MEDIAWIKI
== $this->mNamespace
1171 ?
array('protectedinterface')
1172 : array( 'namespaceprotected', $ns ) );
1175 if( $this->mDbkeyform
== '_' ) {
1176 # FIXME: Is this necessary? Shouldn't be allowed anyway...
1177 $errors[] = array('badaccess-group0');
1180 # protect css/js subpages of user pages
1181 # XXX: this might be better using restrictions
1182 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1183 if( $this->isCssJsSubpage()
1184 && !$user->isAllowed('editusercssjs')
1185 && !preg_match('/^'.preg_quote($user->getName(), '/').'\//', $this->mTextform
) ) {
1186 $errors[] = array('customcssjsprotected');
1189 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1190 # We /could/ use the protection level on the source page, but it's fairly ugly
1191 # as we have to establish a precedence hierarchy for pages included by multiple
1192 # cascade-protected pages. So just restrict it to people with 'protect' permission,
1193 # as they could remove the protection anyway.
1194 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1195 # Cascading protection depends on more than this page...
1196 # Several cascading protected pages may include this page...
1197 # Check each cascading level
1198 # This is only for protection restrictions, not for all actions
1199 if( $cascadingSources > 0 && isset($restrictions[$action]) ) {
1200 foreach( $restrictions[$action] as $right ) {
1201 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1202 if( '' != $right && !$user->isAllowed( $right ) ) {
1204 foreach( $cascadingSources as $page )
1205 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1206 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1212 foreach( $this->getRestrictions($action) as $right ) {
1213 // Backwards compatibility, rewrite sysop -> protect
1214 if ( $right == 'sysop' ) {
1217 if( '' != $right && !$user->isAllowed( $right ) ) {
1218 //Users with 'editprotected' permission can edit protected pages
1219 if( $action=='edit' && $user->isAllowed( 'editprotected' ) ) {
1220 //Users with 'editprotected' permission cannot edit protected pages
1221 //with cascading option turned on.
1222 if($this->mCascadeRestriction
) {
1223 $errors[] = array( 'protectedpagetext', $right );
1225 //Nothing, user can edit!
1228 $errors[] = array( 'protectedpagetext', $right );
1233 if ($action == 'protect') {
1234 if ($this->getUserPermissionsErrors('edit', $user) != array()) {
1235 $errors[] = array( 'protect-cantedit' ); // If they can't edit, they shouldn't protect.
1239 if ($action == 'create') {
1240 $title_protection = $this->getTitleProtection();
1242 if (is_array($title_protection)) {
1243 extract($title_protection);
1245 if ($pt_create_perm == 'sysop')
1246 $pt_create_perm = 'protect';
1248 if ($pt_create_perm == '' ||
!$user->isAllowed($pt_create_perm)) {
1249 $errors[] = array ( 'titleprotected', User
::whoIs($pt_user), $pt_reason );
1253 if( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1254 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1255 $errors[] = $user->isAnon() ?
array ('nocreatetext') : array ('nocreate-loggedin');
1257 } elseif( $action == 'move' && !( $this->isMovable() && $user->isAllowed( 'move' ) ) ) {
1258 $errors[] = $user->isAnon() ?
array ( 'movenologintext' ) : array ('movenotallowed');
1259 } elseif ( !$user->isAllowed( $action ) ) {
1262 global $wgGroupPermissions;
1263 foreach( $wgGroupPermissions as $key => $value ) {
1264 if( isset( $value[$action] ) && $value[$action] == true ) {
1265 $groupName = User
::getGroupName( $key );
1266 $groupPage = User
::getGroupPage( $key );
1268 $groups[] = '[['.$groupPage->getPrefixedText().'|'.$groupName.']]';
1270 $groups[] = $groupName;
1274 $n = count( $groups );
1275 $groups = implode( ', ', $groups );
1280 $return = array( "badaccess-group$n", $groups );
1283 $return = array( 'badaccess-groups', $groups );
1285 $errors[] = $return;
1288 wfProfileOut( __METHOD__
);
1293 * Is this title subject to title protection?
1294 * @return mixed An associative array representing any existent title
1295 * protection, or false if there's none.
1297 private function getTitleProtection() {
1298 // Can't protect pages in special namespaces
1299 if ( $this->getNamespace() < 0 ) {
1303 $dbr = wfGetDB( DB_SLAVE
);
1304 $res = $dbr->select( 'protected_titles', '*',
1305 array ('pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey()) );
1307 if ($row = $dbr->fetchRow( $res )) {
1314 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1315 global $wgGroupPermissions,$wgUser,$wgContLang;
1317 if ($create_perm == implode(',',$this->getRestrictions('create'))
1318 && $expiry == $this->mRestrictionsExpiry
) {
1323 list ($namespace, $title) = array( $this->getNamespace(), $this->getDBkey() );
1325 $dbw = wfGetDB( DB_MASTER
);
1327 $encodedExpiry = Block
::encodeExpiry($expiry, $dbw );
1329 $expiry_description = '';
1330 if ( $encodedExpiry != 'infinity' ) {
1331 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ) ).')';
1334 # Update protection table
1335 if ($create_perm != '' ) {
1336 $dbw->replace( 'protected_titles', array(array('pt_namespace', 'pt_title')),
1337 array( 'pt_namespace' => $namespace, 'pt_title' => $title
1338 , 'pt_create_perm' => $create_perm
1339 , 'pt_timestamp' => Block
::encodeExpiry(wfTimestampNow(), $dbw)
1340 , 'pt_expiry' => $encodedExpiry
1341 , 'pt_user' => $wgUser->getId(), 'pt_reason' => $reason ), __METHOD__
);
1343 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1344 'pt_title' => $title ), __METHOD__
);
1346 # Update the protection log
1347 $log = new LogPage( 'protect' );
1349 if( $create_perm ) {
1350 $log->addEntry( $this->mRestrictions
['create'] ?
'modify' : 'protect', $this, trim( $reason . " [create=$create_perm] $expiry_description" ) );
1352 $log->addEntry( 'unprotect', $this, $reason );
1359 * Remove any title protection (due to page existing
1361 public function deleteTitleProtection() {
1362 $dbw = wfGetDB( DB_MASTER
);
1364 $dbw->delete( 'protected_titles',
1365 array ('pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey()), __METHOD__
);
1369 * Can $wgUser edit this page?
1371 * @deprecated use userCan('edit')
1373 public function userCanEdit( $doExpensiveQueries = true ) {
1374 return $this->userCan( 'edit', $doExpensiveQueries );
1378 * Can $wgUser create this page?
1380 * @deprecated use userCan('create')
1382 public function userCanCreate( $doExpensiveQueries = true ) {
1383 return $this->userCan( 'create', $doExpensiveQueries );
1387 * Can $wgUser move this page?
1389 * @deprecated use userCan('move')
1391 public function userCanMove( $doExpensiveQueries = true ) {
1392 return $this->userCan( 'move', $doExpensiveQueries );
1396 * Would anybody with sufficient privileges be able to move this page?
1397 * Some pages just aren't movable.
1401 public function isMovable() {
1402 return MWNamespace
::isMovable( $this->getNamespace() )
1403 && $this->getInterwiki() == '';
1407 * Can $wgUser read this page?
1409 * @todo fold these checks into userCan()
1411 public function userCanRead() {
1412 global $wgUser, $wgGroupPermissions;
1415 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1416 if ( $result !== null ) {
1420 # Shortcut for public wikis, allows skipping quite a bit of code
1421 if ($wgGroupPermissions['*']['read'])
1424 if( $wgUser->isAllowed( 'read' ) ) {
1427 global $wgWhitelistRead;
1430 * Always grant access to the login page.
1431 * Even anons need to be able to log in.
1433 if( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'Resetpass' ) ) {
1438 * Bail out if there isn't whitelist
1440 if( !is_array($wgWhitelistRead) ) {
1445 * Check for explicit whitelisting
1447 $name = $this->getPrefixedText();
1448 if( in_array( $name, $wgWhitelistRead, true ) )
1452 * Old settings might have the title prefixed with
1453 * a colon for main-namespace pages
1455 if( $this->getNamespace() == NS_MAIN
) {
1456 if( in_array( ':' . $name, $wgWhitelistRead ) )
1461 * If it's a special page, ditch the subpage bit
1464 if( $this->getNamespace() == NS_SPECIAL
) {
1465 $name = $this->getDBkey();
1466 list( $name, /* $subpage */) = SpecialPage
::resolveAliasWithSubpage( $name );
1467 if ( $name === false ) {
1468 # Invalid special page, but we show standard login required message
1472 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1473 if( in_array( $pure, $wgWhitelistRead, true ) )
1482 * Is this a talk page of some sort?
1485 public function isTalkPage() {
1486 return MWNamespace
::isTalk( $this->getNamespace() );
1490 * Is this a subpage?
1493 public function isSubpage() {
1494 global $wgNamespacesWithSubpages;
1496 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace
] ) ) {
1497 return ( strpos( $this->getText(), '/' ) !== false && $wgNamespacesWithSubpages[ $this->mNamespace
] == true );
1504 * Could this page contain custom CSS or JavaScript, based
1509 public function isCssOrJsPage() {
1510 return $this->mNamespace
== NS_MEDIAWIKI
1511 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1515 * Is this a .css or .js subpage of a user page?
1518 public function isCssJsSubpage() {
1519 return ( NS_USER
== $this->mNamespace
and preg_match("/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
1522 * Is this a *valid* .css or .js subpage of a user page?
1523 * Check that the corresponding skin exists
1525 public function isValidCssJsSubpage() {
1526 if ( $this->isCssJsSubpage() ) {
1527 $skinNames = Skin
::getSkinNames();
1528 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1534 * Trim down a .css or .js subpage title to get the corresponding skin name
1536 public function getSkinFromCssJsSubpage() {
1537 $subpage = explode( '/', $this->mTextform
);
1538 $subpage = $subpage[ count( $subpage ) - 1 ];
1539 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1542 * Is this a .css subpage of a user page?
1545 public function isCssSubpage() {
1546 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.css$/", $this->mTextform
) );
1549 * Is this a .js subpage of a user page?
1552 public function isJsSubpage() {
1553 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.js$/", $this->mTextform
) );
1556 * Protect css/js subpages of user pages: can $wgUser edit
1560 * @todo XXX: this might be better using restrictions
1562 public function userCanEditCssJsSubpage() {
1564 return ( $wgUser->isAllowed('editusercssjs') ||
preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform
) );
1568 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1570 * @return bool If the page is subject to cascading restrictions.
1572 public function isCascadeProtected() {
1573 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1574 return ( $sources > 0 );
1578 * Cascading protection: Get the source of any cascading restrictions on this page.
1580 * @param $get_pages bool Whether or not to retrieve the actual pages that the restrictions have come from.
1581 * @return array( mixed title array, restriction array)
1582 * 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.
1583 * The restriction array is an array of each type, each of which contains an array of unique groups
1585 public function getCascadeProtectionSources( $get_pages = true ) {
1586 global $wgEnableCascadingProtection, $wgRestrictionTypes;
1588 # Define our dimension of restrictions types
1589 $pagerestrictions = array();
1590 foreach( $wgRestrictionTypes as $action )
1591 $pagerestrictions[$action] = array();
1593 if (!$wgEnableCascadingProtection)
1594 return array( false, $pagerestrictions );
1596 if ( isset( $this->mCascadeSources
) && $get_pages ) {
1597 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
1598 } else if ( isset( $this->mHasCascadingRestrictions
) && !$get_pages ) {
1599 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
1602 wfProfileIn( __METHOD__
);
1604 $dbr = wfGetDb( DB_SLAVE
);
1606 if ( $this->getNamespace() == NS_IMAGE
) {
1607 $tables = array ('imagelinks', 'page_restrictions');
1608 $where_clauses = array(
1609 'il_to' => $this->getDBkey(),
1611 'pr_cascade' => 1 );
1613 $tables = array ('templatelinks', 'page_restrictions');
1614 $where_clauses = array(
1615 'tl_namespace' => $this->getNamespace(),
1616 'tl_title' => $this->getDBkey(),
1618 'pr_cascade' => 1 );
1622 $cols = array('pr_page', 'page_namespace', 'page_title', 'pr_expiry', 'pr_type', 'pr_level' );
1623 $where_clauses[] = 'page_id=pr_page';
1626 $cols = array( 'pr_expiry' );
1629 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
1631 $sources = $get_pages ?
array() : false;
1632 $now = wfTimestampNow();
1633 $purgeExpired = false;
1635 while( $row = $dbr->fetchObject( $res ) ) {
1636 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1637 if( $expiry > $now ) {
1639 $page_id = $row->pr_page
;
1640 $page_ns = $row->page_namespace
;
1641 $page_title = $row->page_title
;
1642 $sources[$page_id] = Title
::makeTitle($page_ns, $page_title);
1643 # Add groups needed for each restriction type if its not already there
1644 # Make sure this restriction type still exists
1645 if ( isset($pagerestrictions[$row->pr_type
]) && !in_array($row->pr_level
, $pagerestrictions[$row->pr_type
]) ) {
1646 $pagerestrictions[$row->pr_type
][]=$row->pr_level
;
1652 // Trigger lazy purge of expired restrictions from the db
1653 $purgeExpired = true;
1656 if( $purgeExpired ) {
1657 Title
::purgeExpiredRestrictions();
1660 wfProfileOut( __METHOD__
);
1663 $this->mCascadeSources
= $sources;
1664 $this->mCascadingRestrictions
= $pagerestrictions;
1666 $this->mHasCascadingRestrictions
= $sources;
1669 return array( $sources, $pagerestrictions );
1672 function areRestrictionsCascading() {
1673 if (!$this->mRestrictionsLoaded
) {
1674 $this->loadRestrictions();
1677 return $this->mCascadeRestriction
;
1681 * Loads a string into mRestrictions array
1682 * @param resource $res restrictions as an SQL result.
1684 private function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) {
1685 global $wgRestrictionTypes;
1686 $dbr = wfGetDB( DB_SLAVE
);
1688 foreach( $wgRestrictionTypes as $type ){
1689 $this->mRestrictions
[$type] = array();
1692 $this->mCascadeRestriction
= false;
1693 $this->mRestrictionsExpiry
= Block
::decodeExpiry('');
1695 # Backwards-compatibility: also load the restrictions from the page record (old format).
1697 if ( $oldFashionedRestrictions === NULL ) {
1698 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions', array( 'page_id' => $this->getArticleId() ), __METHOD__
);
1701 if ($oldFashionedRestrictions != '') {
1703 foreach( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
1704 $temp = explode( '=', trim( $restrict ) );
1705 if(count($temp) == 1) {
1706 // old old format should be treated as edit/move restriction
1707 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
1708 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
1710 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
1714 $this->mOldRestrictions
= true;
1718 if( $dbr->numRows( $res ) ) {
1719 # Current system - load second to make them override.
1720 $now = wfTimestampNow();
1721 $purgeExpired = false;
1723 while ($row = $dbr->fetchObject( $res ) ) {
1724 # Cycle through all the restrictions.
1726 // Don't take care of restrictions types that aren't in $wgRestrictionTypes
1727 if( !in_array( $row->pr_type
, $wgRestrictionTypes ) )
1730 // This code should be refactored, now that it's being used more generally,
1731 // But I don't really see any harm in leaving it in Block for now -werdna
1732 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1734 // Only apply the restrictions if they haven't expired!
1735 if ( !$expiry ||
$expiry > $now ) {
1736 $this->mRestrictionsExpiry
= $expiry;
1737 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
1739 $this->mCascadeRestriction |
= $row->pr_cascade
;
1741 // Trigger a lazy purge of expired restrictions
1742 $purgeExpired = true;
1746 if( $purgeExpired ) {
1747 Title
::purgeExpiredRestrictions();
1751 $this->mRestrictionsLoaded
= true;
1754 public function loadRestrictions( $oldFashionedRestrictions = NULL ) {
1755 if( !$this->mRestrictionsLoaded
) {
1756 if ($this->exists()) {
1757 $dbr = wfGetDB( DB_SLAVE
);
1759 $res = $dbr->select( 'page_restrictions', '*',
1760 array ( 'pr_page' => $this->getArticleId() ), __METHOD__
);
1762 $this->loadRestrictionsFromRow( $res, $oldFashionedRestrictions );
1764 $title_protection = $this->getTitleProtection();
1766 if (is_array($title_protection)) {
1767 extract($title_protection);
1769 $now = wfTimestampNow();
1770 $expiry = Block
::decodeExpiry($pt_expiry);
1772 if (!$expiry ||
$expiry > $now) {
1773 // Apply the restrictions
1774 $this->mRestrictionsExpiry
= $expiry;
1775 $this->mRestrictions
['create'] = explode(',', trim($pt_create_perm) );
1776 } else { // Get rid of the old restrictions
1777 Title
::purgeExpiredRestrictions();
1780 $this->mRestrictionsLoaded
= true;
1786 * Purge expired restrictions from the page_restrictions table
1788 static function purgeExpiredRestrictions() {
1789 $dbw = wfGetDB( DB_MASTER
);
1790 $dbw->delete( 'page_restrictions',
1791 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1794 $dbw->delete( 'protected_titles',
1795 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1800 * Accessor/initialisation for mRestrictions
1802 * @param string $action action that permission needs to be checked for
1803 * @return array the array of groups allowed to edit this article
1805 public function getRestrictions( $action ) {
1806 if( !$this->mRestrictionsLoaded
) {
1807 $this->loadRestrictions();
1809 return isset( $this->mRestrictions
[$action] )
1810 ?
$this->mRestrictions
[$action]
1815 * Is there a version of this page in the deletion archive?
1816 * @return int the number of archived revisions
1818 public function isDeleted() {
1819 $fname = 'Title::isDeleted';
1820 if ( $this->getNamespace() < 0 ) {
1823 $dbr = wfGetDB( DB_SLAVE
);
1824 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1825 'ar_title' => $this->getDBkey() ), $fname );
1826 if( $this->getNamespace() == NS_IMAGE
) {
1827 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
1828 array( 'fa_name' => $this->getDBkey() ), $fname );
1835 * Get the article ID for this Title from the link cache,
1836 * adding it if necessary
1837 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select
1839 * @return int the ID
1841 public function getArticleID( $flags = 0 ) {
1842 $linkCache = LinkCache
::singleton();
1843 if ( $flags & GAID_FOR_UPDATE
) {
1844 $oldUpdate = $linkCache->forUpdate( true );
1845 $this->mArticleID
= $linkCache->addLinkObj( $this );
1846 $linkCache->forUpdate( $oldUpdate );
1848 if ( -1 == $this->mArticleID
) {
1849 $this->mArticleID
= $linkCache->addLinkObj( $this );
1852 return $this->mArticleID
;
1856 * Is this an article that is a redirect page?
1857 * Uses link cache, adding it if necessary
1858 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update
1861 public function isRedirect( $flags = 0 ) {
1862 if( !is_null($this->mRedirect
) )
1863 return $this->mRedirect
;
1864 # Zero for special pages.
1865 # Also, calling getArticleID() loads the field from cache!
1866 if( !$this->getArticleID($flags) ||
$this->getNamespace() == NS_SPECIAL
) {
1869 $linkCache = LinkCache
::singleton();
1870 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
1872 return $this->mRedirect
;
1876 * What is the length of this page?
1877 * Uses link cache, adding it if necessary
1878 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update
1881 public function getLength( $flags = 0 ) {
1882 if( $this->mLength
!= -1 )
1883 return $this->mLength
;
1884 # Zero for special pages.
1885 # Also, calling getArticleID() loads the field from cache!
1886 if( !$this->getArticleID($flags) ||
$this->getNamespace() == NS_SPECIAL
) {
1889 $linkCache = LinkCache
::singleton();
1890 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
1892 return $this->mLength
;
1896 * What is the page_latest field for this page?
1897 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select for update
1900 public function getLatestRevID( $flags = 0 ) {
1901 if ($this->mLatestID
!== false)
1902 return $this->mLatestID
;
1904 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB(DB_MASTER
) : wfGetDB(DB_SLAVE
);
1905 return $this->mLatestID
= $db->selectField( 'revision',
1907 array('rev_page' => $this->getArticleID()),
1908 'Title::getLatestRevID' );
1912 * This clears some fields in this object, and clears any associated
1913 * keys in the "bad links" section of the link cache.
1915 * - This is called from Article::insertNewArticle() to allow
1916 * loading of the new page_id. It's also called from
1917 * Article::doDeleteArticle()
1919 * @param int $newid the new Article ID
1921 public function resetArticleID( $newid ) {
1922 $linkCache = LinkCache
::singleton();
1923 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
1925 if ( 0 == $newid ) { $this->mArticleID
= -1; }
1926 else { $this->mArticleID
= $newid; }
1927 $this->mRestrictionsLoaded
= false;
1928 $this->mRestrictions
= array();
1932 * Updates page_touched for this page; called from LinksUpdate.php
1933 * @return bool true if the update succeded
1935 public function invalidateCache() {
1936 global $wgUseFileCache;
1938 if ( wfReadOnly() ) {
1942 $dbw = wfGetDB( DB_MASTER
);
1943 $success = $dbw->update( 'page',
1945 'page_touched' => $dbw->timestamp()
1946 ), array( /* WHERE */
1947 'page_namespace' => $this->getNamespace() ,
1948 'page_title' => $this->getDBkey()
1949 ), 'Title::invalidateCache'
1952 if ($wgUseFileCache) {
1953 $cache = new HTMLFileCache($this);
1954 @unlink
($cache->fileCacheName());
1961 * Prefix some arbitrary text with the namespace or interwiki prefix
1964 * @param string $name the text
1965 * @return string the prefixed text
1968 /* private */ function prefix( $name ) {
1970 if ( '' != $this->mInterwiki
) {
1971 $p = $this->mInterwiki
. ':';
1973 if ( 0 != $this->mNamespace
) {
1974 $p .= $this->getNsText() . ':';
1980 * Secure and split - main initialisation function for this object
1982 * Assumes that mDbkeyform has been set, and is urldecoded
1983 * and uses underscores, but not otherwise munged. This function
1984 * removes illegal characters, splits off the interwiki and
1985 * namespace prefixes, sets the other forms, and canonicalizes
1987 * @return bool true on success
1989 private function secureAndSplit() {
1990 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
1993 static $rxTc = false;
1995 # Matching titles will be held as illegal.
1997 # Any character not allowed is forbidden...
1998 '[^' . Title
::legalChars() . ']' .
1999 # URL percent encoding sequences interfere with the ability
2000 # to round-trip titles -- you can't link to them consistently.
2001 '|%[0-9A-Fa-f]{2}' .
2002 # XML/HTML character references produce similar issues.
2003 '|&[A-Za-z0-9\x80-\xff]+;' .
2005 '|&#x[0-9A-Fa-f]+;' .
2009 $this->mInterwiki
= $this->mFragment
= '';
2010 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2012 $dbkey = $this->mDbkeyform
;
2014 # Strip Unicode bidi override characters.
2015 # Sometimes they slip into cut-n-pasted page titles, where the
2016 # override chars get included in list displays.
2017 $dbkey = str_replace( "\xE2\x80\x8E", '', $dbkey ); // 200E LEFT-TO-RIGHT MARK
2018 $dbkey = str_replace( "\xE2\x80\x8F", '', $dbkey ); // 200F RIGHT-TO-LEFT MARK
2020 # Clean up whitespace
2022 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
2023 $dbkey = trim( $dbkey, '_' );
2025 if ( '' == $dbkey ) {
2029 if( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2030 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2034 $this->mDbkeyform
= $dbkey;
2036 # Initial colon indicates main namespace rather than specified default
2037 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2038 if ( ':' == $dbkey{0} ) {
2039 $this->mNamespace
= NS_MAIN
;
2040 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2041 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2044 # Namespace or interwiki prefix
2048 if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $dbkey, $m ) ) {
2050 if ( $ns = $wgContLang->getNsIndex( $p )) {
2051 # Ordinary namespace
2053 $this->mNamespace
= $ns;
2054 } elseif( $this->getInterwikiLink( $p ) ) {
2056 # Can't make a local interwiki link to an interwiki link.
2057 # That's just crazy!
2063 $this->mInterwiki
= $wgContLang->lc( $p );
2065 # Redundant interwiki prefix to the local wiki
2066 if ( 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) ) {
2067 if( $dbkey == '' ) {
2068 # Can't have an empty self-link
2071 $this->mInterwiki
= '';
2073 # Do another namespace split...
2077 # If there's an initial colon after the interwiki, that also
2078 # resets the default namespace
2079 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2080 $this->mNamespace
= NS_MAIN
;
2081 $dbkey = substr( $dbkey, 1 );
2084 # If there's no recognized interwiki or namespace,
2085 # then let the colon expression be part of the title.
2090 # We already know that some pages won't be in the database!
2092 if ( '' != $this->mInterwiki || NS_SPECIAL
== $this->mNamespace
) {
2093 $this->mArticleID
= 0;
2095 $fragment = strstr( $dbkey, '#' );
2096 if ( false !== $fragment ) {
2097 $this->setFragment( $fragment );
2098 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2099 # remove whitespace again: prevents "Foo_bar_#"
2100 # becoming "Foo_bar_"
2101 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2104 # Reject illegal characters.
2106 if( preg_match( $rxTc, $dbkey ) ) {
2111 * Pages with "/./" or "/../" appearing in the URLs will
2112 * often be unreachable due to the way web browsers deal
2113 * with 'relative' URLs. Forbid them explicitly.
2115 if ( strpos( $dbkey, '.' ) !== false &&
2116 ( $dbkey === '.' ||
$dbkey === '..' ||
2117 strpos( $dbkey, './' ) === 0 ||
2118 strpos( $dbkey, '../' ) === 0 ||
2119 strpos( $dbkey, '/./' ) !== false ||
2120 strpos( $dbkey, '/../' ) !== false ||
2121 substr( $dbkey, -2 ) == '/.' ||
2122 substr( $dbkey, -3 ) == '/..' ) )
2128 * Magic tilde sequences? Nu-uh!
2130 if( strpos( $dbkey, '~~~' ) !== false ) {
2135 * Limit the size of titles to 255 bytes.
2136 * This is typically the size of the underlying database field.
2137 * We make an exception for special pages, which don't need to be stored
2138 * in the database, and may edge over 255 bytes due to subpage syntax
2139 * for long titles, e.g. [[Special:Block/Long name]]
2141 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2142 strlen( $dbkey ) > 512 )
2148 * Normally, all wiki links are forced to have
2149 * an initial capital letter so [[foo]] and [[Foo]]
2150 * point to the same place.
2152 * Don't force it for interwikis, since the other
2153 * site might be case-sensitive.
2155 $this->mUserCaseDBKey
= $dbkey;
2156 if( $wgCapitalLinks && $this->mInterwiki
== '') {
2157 $dbkey = $wgContLang->ucfirst( $dbkey );
2161 * Can't make a link to a namespace alone...
2162 * "empty" local links can only be self-links
2163 * with a fragment identifier.
2166 $this->mInterwiki
== '' &&
2167 $this->mNamespace
!= NS_MAIN
) {
2170 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2171 // IP names are not allowed for accounts, and can only be referring to
2172 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2173 // there are numerous ways to present the same IP. Having sp:contribs scan
2174 // them all is silly and having some show the edits and others not is
2175 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2176 $dbkey = ($this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
) ?
2177 IP
::sanitizeIP( $dbkey ) : $dbkey;
2178 // Any remaining initial :s are illegal.
2179 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
2183 // Normalise special page names
2184 if ( $this->mNamespace
== NS_SPECIAL
) {
2185 list( $name, $subpage ) = SpecialPage
::resolveAliasWithSubpage( $dbkey );
2186 $dbkey = SpecialPage
::getLocalNameFor( $name, $subpage );
2191 $this->mDbkeyform
= $dbkey;
2192 $this->mUrlform
= wfUrlencode( $dbkey );
2194 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2200 * Set the fragment for this title
2201 * This is kind of bad, since except for this rarely-used function, Title objects
2202 * are immutable. The reason this is here is because it's better than setting the
2203 * members directly, which is what Linker::formatComment was doing previously.
2205 * @param string $fragment text
2206 * @todo clarify whether access is supposed to be public (was marked as "kind of public")
2208 public function setFragment( $fragment ) {
2209 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2213 * Get a Title object associated with the talk page of this article
2214 * @return Title the object for the talk page
2216 public function getTalkPage() {
2217 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2221 * Get a title object associated with the subject page of this
2224 * @return Title the object for the subject page
2226 public function getSubjectPage() {
2227 return Title
::makeTitle( MWNamespace
::getSubject( $this->getNamespace() ), $this->getDBkey() );
2231 * Get an array of Title objects linking to this Title
2232 * Also stores the IDs in the link cache.
2234 * WARNING: do not use this function on arbitrary user-supplied titles!
2235 * On heavily-used templates it will max out the memory.
2237 * @param string $options may be FOR UPDATE
2238 * @return array the Title objects linking here
2240 public function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
2241 $linkCache = LinkCache
::singleton();
2244 $db = wfGetDB( DB_MASTER
);
2246 $db = wfGetDB( DB_SLAVE
);
2249 $res = $db->select( array( 'page', $table ),
2250 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect' ),
2252 "{$prefix}_from=page_id",
2253 "{$prefix}_namespace" => $this->getNamespace(),
2254 "{$prefix}_title" => $this->getDBkey() ),
2255 'Title::getLinksTo',
2259 if ( $db->numRows( $res ) ) {
2260 while ( $row = $db->fetchObject( $res ) ) {
2261 if ( $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
) ) {
2262 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
);
2263 $retVal[] = $titleObj;
2267 $db->freeResult( $res );
2272 * Get an array of Title objects using this Title as a template
2273 * Also stores the IDs in the link cache.
2275 * WARNING: do not use this function on arbitrary user-supplied titles!
2276 * On heavily-used templates it will max out the memory.
2278 * @param string $options may be FOR UPDATE
2279 * @return array the Title objects linking here
2281 public function getTemplateLinksTo( $options = '' ) {
2282 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2286 * Get an array of Title objects referring to non-existent articles linked from this page
2288 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2289 * @param string $options may be FOR UPDATE
2290 * @return array the Title objects
2292 public function getBrokenLinksFrom( $options = '' ) {
2293 if ( $this->getArticleId() == 0 ) {
2294 # All links from article ID 0 are false positives
2299 $db = wfGetDB( DB_MASTER
);
2301 $db = wfGetDB( DB_SLAVE
);
2304 $res = $db->safeQuery(
2305 "SELECT pl_namespace, pl_title
2308 ON pl_namespace=page_namespace
2309 AND pl_title=page_title
2311 AND page_namespace IS NULL
2313 $db->tableName( 'pagelinks' ),
2314 $db->tableName( 'page' ),
2315 $this->getArticleId(),
2319 if ( $db->numRows( $res ) ) {
2320 while ( $row = $db->fetchObject( $res ) ) {
2321 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2324 $db->freeResult( $res );
2330 * Get a list of URLs to purge from the Squid cache when this
2333 * @return array the URLs
2335 public function getSquidURLs() {
2339 $this->getInternalURL(),
2340 $this->getInternalURL( 'action=history' )
2343 // purge variant urls as well
2344 if($wgContLang->hasVariants()){
2345 $variants = $wgContLang->getVariants();
2346 foreach($variants as $vCode){
2347 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
2348 $urls[] = $this->getInternalURL('',$vCode);
2355 public function purgeSquid() {
2357 if ( $wgUseSquid ) {
2358 $urls = $this->getSquidURLs();
2359 $u = new SquidUpdate( $urls );
2365 * Move this page without authentication
2366 * @param Title &$nt the new page Title
2368 public function moveNoAuth( &$nt ) {
2369 return $this->moveTo( $nt, false );
2373 * Check whether a given move operation would be valid.
2374 * Returns true if ok, or a message key string for an error message
2375 * if invalid. (Scarrrrry ugly interface this.)
2376 * @param Title &$nt the new title
2377 * @param bool $auth indicates whether $wgUser's permissions
2379 * @return mixed true on success, message name on failure
2381 public function isValidMoveOperation( &$nt, $auth = true ) {
2382 if( !$this or !$nt ) {
2383 return 'badtitletext';
2385 if( $this->equals( $nt ) ) {
2388 if( !$this->isMovable() ||
!$nt->isMovable() ) {
2389 return 'immobile_namespace';
2392 $oldid = $this->getArticleID();
2393 $newid = $nt->getArticleID();
2395 if ( strlen( $nt->getDBkey() ) < 1 ) {
2396 return 'articleexists';
2398 if ( ( '' == $this->getDBkey() ) ||
2400 ( '' == $nt->getDBkey() ) ) {
2401 return 'badarticleerror';
2404 // Image-specific checks
2405 if( $this->getNamespace() == NS_IMAGE
) {
2406 $file = wfLocalFile( $this );
2407 if( $file->exists() ) {
2408 if( $nt->getNamespace() != NS_IMAGE
) {
2409 return 'imagenocrossnamespace';
2411 if( !File
::checkExtensionCompatibility( $file, $nt->getDbKey() ) ) {
2412 return 'imagetypemismatch';
2419 $errors = array_merge($this->getUserPermissionsErrors('move', $wgUser),
2420 $this->getUserPermissionsErrors('edit', $wgUser),
2421 $nt->getUserPermissionsErrors('move', $wgUser),
2422 $nt->getUserPermissionsErrors('edit', $wgUser));
2423 if($errors !== array())
2424 return $errors[0][0];
2429 if( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err ) ) ) {
2430 return 'hookaborted';
2433 # The move is allowed only if (1) the target doesn't exist, or
2434 # (2) the target is a redirect to the source, and has no history
2435 # (so we can undo bad moves right after they're done).
2437 if ( 0 != $newid ) { # Target exists; check for validity
2438 if ( ! $this->isValidMoveTarget( $nt ) ) {
2439 return 'articleexists';
2442 $tp = $nt->getTitleProtection();
2443 if ( $tp and !$wgUser->isAllowed( $tp['pt_create_perm'] ) ) {
2444 return 'cantmove-titleprotected';
2451 * Move a title to a new location
2452 * @param Title &$nt the new title
2453 * @param bool $auth indicates whether $wgUser's permissions
2455 * @param string $reason The reason for the move
2456 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
2457 * Ignored if the user doesn't have the suppressredirect right.
2458 * @return mixed true on success, message name on failure
2460 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
2461 $err = $this->isValidMoveOperation( $nt, $auth );
2462 if( is_string( $err ) ) {
2466 $pageid = $this->getArticleID();
2467 if( $nt->exists() ) {
2468 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
2469 $pageCountChange = ($createRedirect ?
0 : -1);
2470 } else { # Target didn't exist, do normal move.
2471 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
2472 $pageCountChange = ($createRedirect ?
1 : 0);
2474 if( is_string( $err ) ) {
2477 $redirid = $this->getArticleID();
2479 // Category memberships include a sort key which may be customized.
2480 // If it's left as the default (the page title), we need to update
2481 // the sort key to match the new title.
2483 // Be careful to avoid resetting cl_timestamp, which may disturb
2484 // time-based lists on some sites.
2486 // Warning -- if the sort key is *explicitly* set to the old title,
2487 // we can't actually distinguish it from a default here, and it'll
2488 // be set to the new title even though it really shouldn't.
2489 // It'll get corrected on the next edit, but resetting cl_timestamp.
2490 $dbw = wfGetDB( DB_MASTER
);
2491 $dbw->update( 'categorylinks',
2493 'cl_sortkey' => $nt->getPrefixedText(),
2494 'cl_timestamp=cl_timestamp' ),
2496 'cl_from' => $pageid,
2497 'cl_sortkey' => $this->getPrefixedText() ),
2502 $oldnamespace = $this->getNamespace() & ~
1;
2503 $newnamespace = $nt->getNamespace() & ~
1;
2504 $oldtitle = $this->getDBkey();
2505 $newtitle = $nt->getDBkey();
2507 if( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
2508 WatchedItem
::duplicateEntries( $this, $nt );
2511 # Update search engine
2512 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2514 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2518 if( $this->isContentPage() && !$nt->isContentPage() ) {
2519 # No longer a content page
2520 # Not viewed, edited, removing
2521 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2522 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2523 # Now a content page
2524 # Not viewed, edited, adding
2525 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
2526 } elseif( $pageCountChange ) {
2528 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2535 # Update message cache for interface messages
2536 if( $nt->getNamespace() == NS_MEDIAWIKI
) {
2537 global $wgMessageCache;
2538 $oldarticle = new Article( $this );
2539 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
2540 $newarticle = new Article( $nt );
2541 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
2545 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2550 * Move page to a title which is at present a redirect to the
2553 * @param Title &$nt the page to move to, which should currently
2555 * @param string $reason The reason for the move
2556 * @param bool $createRedirect Whether to leave a redirect at the old title.
2557 * Ignored if the user doesn't have the suppressredirect right
2559 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
2560 global $wgUseSquid, $wgUser;
2561 $fname = 'Title::moveOverExistingRedirect';
2562 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
2565 $comment .= ": $reason";
2568 $now = wfTimestampNow();
2569 $newid = $nt->getArticleID();
2570 $oldid = $this->getArticleID();
2571 $dbw = wfGetDB( DB_MASTER
);
2573 # Move an image if it is
2574 if( $this->getNamespace() == NS_IMAGE
) {
2575 $file = wfLocalFile( $this );
2576 if( $file->exists() ) {
2577 $status = $file->move( $nt );
2578 if( !$status->isOk() ) {
2579 return $status->getWikiText();
2584 # Delete the old redirect. We don't save it to history since
2585 # by definition if we've got here it's rather uninteresting.
2586 # We have to remove it so that the next step doesn't trigger
2587 # a conflict on the unique namespace+title index...
2588 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2589 if ( !$dbw->cascadingDeletes() ) {
2590 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
2591 global $wgUseTrackbacks;
2592 if ($wgUseTrackbacks)
2593 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
2594 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
2595 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
2596 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
2597 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
2598 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
2599 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
2600 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
2603 # Save a null revision in the page's history notifying of the move
2604 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2605 $nullRevId = $nullRevision->insertOn( $dbw );
2607 # Change the name of the target page:
2608 $dbw->update( 'page',
2610 'page_touched' => $dbw->timestamp($now),
2611 'page_namespace' => $nt->getNamespace(),
2612 'page_title' => $nt->getDBkey(),
2613 'page_latest' => $nullRevId,
2615 /* WHERE */ array( 'page_id' => $oldid ),
2618 $nt->resetArticleID( $oldid );
2620 # Recreate the redirect, this time in the other direction.
2621 if($createRedirect ||
!$wgUser->isAllowed('suppressredirect'))
2623 $mwRedir = MagicWord
::get( 'redirect' );
2624 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2625 $redirectArticle = new Article( $this );
2626 $newid = $redirectArticle->insertOn( $dbw );
2627 $redirectRevision = new Revision( array(
2629 'comment' => $comment,
2630 'text' => $redirectText ) );
2631 $redirectRevision->insertOn( $dbw );
2632 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2634 # Now, we record the link from the redirect to the new title.
2635 # It should have no other outgoing links...
2636 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2637 $dbw->insert( 'pagelinks',
2639 'pl_from' => $newid,
2640 'pl_namespace' => $nt->getNamespace(),
2641 'pl_title' => $nt->getDBkey() ),
2644 $this->resetArticleID( 0 );
2648 $log = new LogPage( 'move' );
2649 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
2652 if ( $wgUseSquid ) {
2653 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2654 $u = new SquidUpdate( $urls );
2660 * Move page to non-existing title.
2661 * @param Title &$nt the new Title
2662 * @param string $reason The reason for the move
2663 * @param bool $createRedirect Whether to create a redirect from the old title to the new title
2664 * Ignored if the user doesn't have the suppressredirect right
2666 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
2667 global $wgUseSquid, $wgUser;
2668 $fname = 'MovePageForm::moveToNewTitle';
2669 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2671 $comment .= ": $reason";
2674 $newid = $nt->getArticleID();
2675 $oldid = $this->getArticleID();
2676 $dbw = wfGetDB( DB_MASTER
);
2677 $now = $dbw->timestamp();
2679 # Move an image if it is
2680 if( $this->getNamespace() == NS_IMAGE
) {
2681 $file = wfLocalFile( $this );
2682 if( $file->exists() ) {
2683 $status = $file->move( $nt );
2684 if( !$status->isOk() ) {
2685 return $status->getWikiText();
2690 # Save a null revision in the page's history notifying of the move
2691 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2692 $nullRevId = $nullRevision->insertOn( $dbw );
2695 $dbw->update( 'page',
2697 'page_touched' => $now,
2698 'page_namespace' => $nt->getNamespace(),
2699 'page_title' => $nt->getDBkey(),
2700 'page_latest' => $nullRevId,
2702 /* WHERE */ array( 'page_id' => $oldid ),
2705 $nt->resetArticleID( $oldid );
2707 if($createRedirect ||
!$wgUser->isAllowed('suppressredirect'))
2710 $mwRedir = MagicWord
::get( 'redirect' );
2711 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2712 $redirectArticle = new Article( $this );
2713 $newid = $redirectArticle->insertOn( $dbw );
2714 $redirectRevision = new Revision( array(
2716 'comment' => $comment,
2717 'text' => $redirectText ) );
2718 $redirectRevision->insertOn( $dbw );
2719 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2721 # Record the just-created redirect's linking to the page
2722 $dbw->insert( 'pagelinks',
2724 'pl_from' => $newid,
2725 'pl_namespace' => $nt->getNamespace(),
2726 'pl_title' => $nt->getDBkey() ),
2729 $this->resetArticleID( 0 );
2733 $log = new LogPage( 'move' );
2734 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
2736 # Purge caches as per article creation
2737 Article
::onArticleCreate( $nt );
2739 # Purge old title from squid
2740 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2741 $this->purgeSquid();
2745 * Checks if $this can be moved to a given Title
2746 * - Selects for update, so don't call it unless you mean business
2748 * @param Title &$nt the new title to check
2750 public function isValidMoveTarget( $nt ) {
2752 $fname = 'Title::isValidMoveTarget';
2753 $dbw = wfGetDB( DB_MASTER
);
2755 # Is it an existsing file?
2756 if( $nt->getNamespace() == NS_IMAGE
) {
2757 $file = wfLocalFile( $nt );
2758 if( $file->exists() ) {
2759 wfDebug( __METHOD__
. ": file exists\n" );
2765 $id = $nt->getArticleID();
2766 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
2767 array( 'page_is_redirect','old_text','old_flags' ),
2768 array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
2769 $fname, 'FOR UPDATE' );
2771 if ( !$obj ||
0 == $obj->page_is_redirect
) {
2773 wfDebug( __METHOD__
. ": not a redirect\n" );
2776 $text = Revision
::getRevisionText( $obj );
2778 # Does the redirect point to the source?
2779 # Or is it a broken self-redirect, usually caused by namespace collisions?
2781 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2782 $redirTitle = Title
::newFromText( $m[1] );
2783 if( !is_object( $redirTitle ) ||
2784 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2785 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2786 wfDebug( __METHOD__
. ": redirect points to other page\n" );
2791 wfDebug( __METHOD__
. ": failsafe\n" );
2795 # Does the article have a history?
2796 $row = $dbw->selectRow( array( 'page', 'revision'),
2798 array( 'page_namespace' => $nt->getNamespace(),
2799 'page_title' => $nt->getDBkey(),
2800 'page_id=rev_page AND page_latest != rev_id'
2801 ), $fname, 'FOR UPDATE'
2804 # Return true if there was no history
2805 return $row === false;
2809 * Can this title be added to a user's watchlist?
2813 public function isWatchable() {
2814 return !$this->isExternal()
2815 && MWNamespace
::isWatchable( $this->getNamespace() );
2819 * Get categories to which this Title belongs and return an array of
2820 * categories' names.
2822 * @return array an array of parents in the form:
2823 * $parent => $currentarticle
2825 public function getParentCategories() {
2828 $titlekey = $this->getArticleId();
2829 $dbr = wfGetDB( DB_SLAVE
);
2830 $categorylinks = $dbr->tableName( 'categorylinks' );
2833 $sql = "SELECT * FROM $categorylinks"
2834 ." WHERE cl_from='$titlekey'"
2835 ." AND cl_from <> '0'"
2836 ." ORDER BY cl_sortkey";
2838 $res = $dbr->query ( $sql ) ;
2840 if($dbr->numRows($res) > 0) {
2841 while ( $x = $dbr->fetchObject ( $res ) )
2842 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
2843 $data[$wgContLang->getNSText ( NS_CATEGORY
).':'.$x->cl_to
] = $this->getFullText();
2844 $dbr->freeResult ( $res ) ;
2852 * Get a tree of parent categories
2853 * @param array $children an array with the children in the keys, to check for circular refs
2856 public function getParentCategoryTree( $children = array() ) {
2858 $parents = $this->getParentCategories();
2860 if($parents != '') {
2861 foreach($parents as $parent => $current) {
2862 if ( array_key_exists( $parent, $children ) ) {
2863 # Circular reference
2864 $stack[$parent] = array();
2866 $nt = Title
::newFromText($parent);
2868 $stack[$parent] = $nt->getParentCategoryTree( $children +
array($parent => 1) );
2880 * Get an associative array for selecting this title from
2885 public function pageCond() {
2886 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
2890 * Get the revision ID of the previous revision
2892 * @param integer $revision Revision ID. Get the revision that was before this one.
2893 * @return integer $oldrevision|false
2895 public function getPreviousRevisionID( $revision ) {
2896 $dbr = wfGetDB( DB_SLAVE
);
2897 return $dbr->selectField( 'revision', 'rev_id',
2898 'rev_page=' . intval( $this->getArticleId() ) .
2899 ' AND rev_id<' . intval( $revision ) . ' ORDER BY rev_id DESC' );
2903 * Get the revision ID of the next revision
2905 * @param integer $revision Revision ID. Get the revision that was after this one.
2906 * @return integer $oldrevision|false
2908 public function getNextRevisionID( $revision ) {
2909 $dbr = wfGetDB( DB_SLAVE
);
2910 return $dbr->selectField( 'revision', 'rev_id',
2911 'rev_page=' . intval( $this->getArticleId() ) .
2912 ' AND rev_id>' . intval( $revision ) . ' ORDER BY rev_id' );
2916 * Get the number of revisions between the given revision IDs.
2917 * Used for diffs and other things that really need it.
2919 * @param integer $old Revision ID.
2920 * @param integer $new Revision ID.
2921 * @return integer Number of revisions between these IDs.
2923 public function countRevisionsBetween( $old, $new ) {
2924 $dbr = wfGetDB( DB_SLAVE
);
2925 return $dbr->selectField( 'revision', 'count(*)',
2926 'rev_page = ' . intval( $this->getArticleId() ) .
2927 ' AND rev_id > ' . intval( $old ) .
2928 ' AND rev_id < ' . intval( $new ),
2930 array( 'USE INDEX' => 'PRIMARY' ) );
2934 * Compare with another title.
2936 * @param Title $title
2939 public function equals( $title ) {
2940 // Note: === is necessary for proper matching of number-like titles.
2941 return $this->getInterwiki() === $title->getInterwiki()
2942 && $this->getNamespace() == $title->getNamespace()
2943 && $this->getDBkey() === $title->getDBkey();
2947 * Callback for usort() to do title sorts by (namespace, title)
2949 static function compare( $a, $b ) {
2950 if( $a->getNamespace() == $b->getNamespace() ) {
2951 return strcmp( $a->getText(), $b->getText() );
2953 return $a->getNamespace() - $b->getNamespace();
2958 * Return a string representation of this title
2962 public function __toString() {
2963 return $this->getPrefixedText();
2967 * Check if page exists
2970 public function exists() {
2971 return $this->getArticleId() != 0;
2975 * Do we know that this title definitely exists, or should we otherwise
2976 * consider that it exists?
2980 public function isAlwaysKnown() {
2981 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
2982 // the full l10n of that language to be loaded. That takes much memory and
2983 // isn't needed. So we strip the language part away.
2984 // Also, extension messages which are not loaded, are shown as red, because
2985 // we don't call MessageCache::loadAllMessages.
2986 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
2987 return $this->isExternal()
2988 ||
( $this->mNamespace
== NS_MAIN
&& $this->mDbkeyform
== '' )
2989 ||
( $this->mNamespace
== NS_MEDIAWIKI
&& wfMsgWeirdKey( $basename ) );
2993 * Update page_touched timestamps and send squid purge messages for
2994 * pages linking to this title. May be sent to the job queue depending
2995 * on the number of links. Typically called on create and delete.
2997 public function touchLinks() {
2998 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3001 if ( $this->getNamespace() == NS_CATEGORY
) {
3002 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3008 * Get the last touched timestamp
3010 public function getTouched() {
3011 $dbr = wfGetDB( DB_SLAVE
);
3012 $touched = $dbr->selectField( 'page', 'page_touched',
3014 'page_namespace' => $this->getNamespace(),
3015 'page_title' => $this->getDBkey()
3021 public function trackbackURL() {
3022 global $wgTitle, $wgScriptPath, $wgServer;
3024 return "$wgServer$wgScriptPath/trackback.php?article="
3025 . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey()));
3028 public function trackbackRDF() {
3029 $url = htmlspecialchars($this->getFullURL());
3030 $title = htmlspecialchars($this->getText());
3031 $tburl = $this->trackbackURL();
3033 // Autodiscovery RDF is placed in comments so HTML validator
3034 // won't barf. This is a rather icky workaround, but seems
3035 // frequently used by this kind of RDF thingy.
3037 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3039 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3040 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3041 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3044 dc:identifier=\"$url\"
3046 trackback:ping=\"$tburl\" />
3052 * Generate strings used for xml 'id' names in monobook tabs
3055 public function getNamespaceKey() {
3057 switch ($this->getNamespace()) {
3060 return 'nstab-main';
3063 return 'nstab-user';
3065 return 'nstab-media';
3067 return 'nstab-special';
3069 case NS_PROJECT_TALK
:
3070 return 'nstab-project';
3073 return 'nstab-image';
3075 case NS_MEDIAWIKI_TALK
:
3076 return 'nstab-mediawiki';
3078 case NS_TEMPLATE_TALK
:
3079 return 'nstab-template';
3082 return 'nstab-help';
3084 case NS_CATEGORY_TALK
:
3085 return 'nstab-category';
3087 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
3092 * Returns true if this title resolves to the named special page
3093 * @param string $name The special page name
3095 public function isSpecial( $name ) {
3096 if ( $this->getNamespace() == NS_SPECIAL
) {
3097 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
3098 if ( $name == $thisName ) {
3106 * If the Title refers to a special page alias which is not the local default,
3107 * returns a new Title which points to the local default. Otherwise, returns $this.
3109 public function fixSpecialName() {
3110 if ( $this->getNamespace() == NS_SPECIAL
) {
3111 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
3112 if ( $canonicalName ) {
3113 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
3114 if ( $localName != $this->mDbkeyform
) {
3115 return Title
::makeTitle( NS_SPECIAL
, $localName );
3123 * Is this Title in a namespace which contains content?
3124 * In other words, is this a content page, for the purposes of calculating
3129 public function isContentPage() {
3130 return MWNamespace
::isContent( $this->getNamespace() );
3133 public function getRedirectsHere() {
3135 $dbr = wfGetDB( DB_SLAVE
);
3136 list($page,$redirect) = $dbr->tableNamesN( 'page', 'redirect' );
3137 $result = $dbr->query( "SELECT page_title, page_namespace FROM $page JOIN $redirect ON page_id = rd_from WHERE rd_title = "
3138 . $dbr->addQuotes( $this->getDBKey() ) . " AND rd_namespace = " . $this->getNamespace(), __METHOD__
);
3139 while( $row = $dbr->fetchObject( $result ) ) {
3140 $redirs[] = self
::newFromRow( $row );