Restored line accidentally removed in r70520
[mediawiki.git] / includes / Title.php
blob9bb6f83eb74cee710bb479017b333fd1ee27f51b
1 <?php
2 /**
3 * See title.txt
4 * @file
5 */
7 /**
8 * @todo: determine if it is really necessary to load this. Appears to be left over from pre-autoloader versions, and
9 * is only really needed to provide access to constant UTF8_REPLACEMENT, which actually resides in UtfNormalDefines.php
10 * and is loaded by UtfNormalUtil.php, which is loaded by UtfNormal.php.
12 if ( !class_exists( 'UtfNormal' ) ) {
13 require_once( dirname( __FILE__ ) . '/normal/UtfNormal.php' );
16 define ( 'GAID_FOR_UPDATE', 1 );
18 /**
19 * Represents a title within MediaWiki.
20 * Optionally may contain an interwiki designation or namespace.
21 * @note This class can fetch various kinds of data from the database;
22 * however, it does so inefficiently.
24 * @internal documentation reviewed 15 Mar 2010
26 class Title {
27 /** @name Static cache variables */
28 // @{
29 static private $titleCache = array();
30 // @}
32 /**
33 * Title::newFromText maintains a cache to avoid expensive re-normalization of
34 * commonly used titles. On a batch operation this can become a memory leak
35 * if not bounded. After hitting this many titles reset the cache.
37 const CACHE_MAX = 1000;
40 /**
41 * @name Private member variables
42 * Please use the accessor functions instead.
43 * @private
45 // @{
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 = NS_MAIN; // /< 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 = -1; // /< Article ID, fetched from the link cache on demand
55 var $mLatestID = false; // /< ID of most recent revision
56 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
57 var $mOldRestrictions = false;
58 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
59 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
60 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
61 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
62 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
63 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
64 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
65 var $mTitleProtection; ///< Cached value of getTitleProtection
66 # Don't change the following default, NS_MAIN is hardcoded in several
67 # places. See bug 696.
68 var $mDefaultNamespace = NS_MAIN; // /< Namespace index when there is no namespace
69 # Zero except in {{transclusion}} tags
70 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
71 var $mLength = -1; // /< The page length, 0 for special pages
72 var $mRedirect = null; // /< Is the article at this title a redirect?
73 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
74 var $mBacklinkCache = null; // /< Cache of links to this title
75 // @}
78 /**
79 * Constructor
80 * @private
82 /* private */ function __construct() { }
84 /**
85 * Create a new Title from a prefixed DB key
87 * @param $key \type{\string} The database key, which has underscores
88 * instead of spaces, possibly including namespace and
89 * interwiki prefixes
90 * @return \type{Title} the new object, or NULL on an error
92 public static function newFromDBkey( $key ) {
93 $t = new Title();
94 $t->mDbkeyform = $key;
95 if ( $t->secureAndSplit() ) {
96 return $t;
97 } else {
98 return null;
103 * Create a new Title from text, such as what one would find in a link. De-
104 * codes any HTML entities in the text.
106 * @param $text string The link text; spaces, prefixes, and an
107 * initial ':' indicating the main namespace are accepted.
108 * @param $defaultNamespace int The namespace to use if none is speci-
109 * fied by a prefix. If you want to force a specific namespace even if
110 * $text might begin with a namespace prefix, use makeTitle() or
111 * makeTitleSafe().
112 * @return Title The new object, or null on an error.
114 public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
115 if ( is_object( $text ) ) {
116 throw new MWException( 'Title::newFromText given an object' );
120 * Wiki pages often contain multiple links to the same page.
121 * Title normalization and parsing can become expensive on
122 * pages with many links, so we can save a little time by
123 * caching them.
125 * In theory these are value objects and won't get changed...
127 if ( $defaultNamespace == NS_MAIN && isset( Title::$titleCache[$text] ) ) {
128 return Title::$titleCache[$text];
132 * Convert things like &eacute; &#257; or &#x3017; into normalized(bug 14952) text
134 $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text );
136 $t = new Title();
137 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
138 $t->mDefaultNamespace = $defaultNamespace;
140 static $cachedcount = 0 ;
141 if ( $t->secureAndSplit() ) {
142 if ( $defaultNamespace == NS_MAIN ) {
143 if ( $cachedcount >= self::CACHE_MAX ) {
144 # Avoid memory leaks on mass operations...
145 Title::$titleCache = array();
146 $cachedcount = 0;
148 $cachedcount++;
149 Title::$titleCache[$text] =& $t;
151 return $t;
152 } else {
153 $ret = null;
154 return $ret;
159 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
161 * Example of wrong and broken code:
162 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
164 * Example of right code:
165 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
167 * Create a new Title from URL-encoded text. Ensures that
168 * the given title's length does not exceed the maximum.
170 * @param $url \type{\string} the title, as might be taken from a URL
171 * @return \type{Title} the new object, or NULL on an error
173 public static function newFromURL( $url ) {
174 global $wgLegalTitleChars;
175 $t = new Title();
177 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
178 # but some URLs used it as a space replacement and they still come
179 # from some external search tools.
180 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
181 $url = str_replace( '+', ' ', $url );
184 $t->mDbkeyform = str_replace( ' ', '_', $url );
185 if ( $t->secureAndSplit() ) {
186 return $t;
187 } else {
188 return null;
193 * Create a new Title from an article ID
195 * @param $id \type{\int} the page_id corresponding to the Title to create
196 * @param $flags \type{\int} use GAID_FOR_UPDATE to use master
197 * @return \type{Title} the new object, or NULL on an error
199 public static function newFromID( $id, $flags = 0 ) {
200 $db = ( $flags & GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
201 $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__ );
202 if ( $row !== false ) {
203 $title = Title::newFromRow( $row );
204 } else {
205 $title = null;
207 return $title;
211 * Make an array of titles from an array of IDs
213 * @param $ids \type{\arrayof{\int}} Array of IDs
214 * @return \type{\arrayof{Title}} Array of Titles
216 public static function newFromIDs( $ids ) {
217 if ( !count( $ids ) ) {
218 return array();
220 $dbr = wfGetDB( DB_SLAVE );
222 $res = $dbr->select(
223 'page',
224 array(
225 'page_namespace', 'page_title', 'page_id',
226 'page_len', 'page_is_redirect', 'page_latest',
228 array( 'page_id' => $ids ),
229 __METHOD__
232 $titles = array();
233 foreach ( $res as $row ) {
234 $titles[] = Title::newFromRow( $row );
236 return $titles;
240 * Make a Title object from a DB row
242 * @param $row \type{Row} (needs at least page_title,page_namespace)
243 * @return \type{Title} corresponding Title
245 public static function newFromRow( $row ) {
246 $t = self::makeTitle( $row->page_namespace, $row->page_title );
248 $t->mArticleID = isset( $row->page_id ) ? intval( $row->page_id ) : -1;
249 $t->mLength = isset( $row->page_len ) ? intval( $row->page_len ) : -1;
250 $t->mRedirect = isset( $row->page_is_redirect ) ? (bool)$row->page_is_redirect : null;
251 $t->mLatestID = isset( $row->page_latest ) ? intval( $row->page_latest ) : false;
253 return $t;
257 * Create a new Title from a namespace index and a DB key.
258 * It's assumed that $ns and $title are *valid*, for instance when
259 * they came directly from the database or a special page name.
260 * For convenience, spaces are converted to underscores so that
261 * eg user_text fields can be used directly.
263 * @param $ns \type{\int} the namespace of the article
264 * @param $title \type{\string} the unprefixed database key form
265 * @param $fragment \type{\string} The link fragment (after the "#")
266 * @param $interwiki \type{\string} The interwiki prefix
267 * @return \type{Title} the new object
269 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
270 $t = new Title();
271 $t->mInterwiki = $interwiki;
272 $t->mFragment = $fragment;
273 $t->mNamespace = $ns = intval( $ns );
274 $t->mDbkeyform = str_replace( ' ', '_', $title );
275 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
276 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
277 $t->mTextform = str_replace( '_', ' ', $title );
278 return $t;
282 * Create a new Title from a namespace index and a DB key.
283 * The parameters will be checked for validity, which is a bit slower
284 * than makeTitle() but safer for user-provided data.
286 * @param $ns \type{\int} the namespace of the article
287 * @param $title \type{\string} the database key form
288 * @param $fragment \type{\string} The link fragment (after the "#")
289 * @param $interwiki \type{\string} The interwiki prefix
290 * @return \type{Title} the new object, or NULL on an error
292 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
293 $t = new Title();
294 $t->mDbkeyform = Title::makeName( $ns, $title, $fragment, $interwiki );
295 if ( $t->secureAndSplit() ) {
296 return $t;
297 } else {
298 return null;
303 * Create a new Title for the Main Page
305 * @return \type{Title} the new object
307 public static function newMainPage() {
308 $title = Title::newFromText( wfMsgForContent( 'mainpage' ) );
309 // Don't give fatal errors if the message is broken
310 if ( !$title ) {
311 $title = Title::newFromText( 'Main Page' );
313 return $title;
317 * Extract a redirect destination from a string and return the
318 * Title, or null if the text doesn't contain a valid redirect
319 * This will only return the very next target, useful for
320 * the redirect table and other checks that don't need full recursion
322 * @param $text \type{\string} Text with possible redirect
323 * @return \type{Title} The corresponding Title
325 public static function newFromRedirect( $text ) {
326 return self::newFromRedirectInternal( $text );
330 * Extract a redirect destination from a string and return the
331 * Title, or null if the text doesn't contain a valid redirect
332 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
333 * in order to provide (hopefully) the Title of the final destination instead of another redirect
335 * @param $text \type{\string} Text with possible redirect
336 * @return \type{Title} The corresponding Title
338 public static function newFromRedirectRecurse( $text ) {
339 $titles = self::newFromRedirectArray( $text );
340 return $titles ? array_pop( $titles ) : null;
344 * Extract a redirect destination from a string and return an
345 * array of Titles, or null if the text doesn't contain a valid redirect
346 * The last element in the array is the final destination after all redirects
347 * have been resolved (up to $wgMaxRedirects times)
349 * @param $text \type{\string} Text with possible redirect
350 * @return \type{\array} Array of Titles, with the destination last
352 public static function newFromRedirectArray( $text ) {
353 global $wgMaxRedirects;
354 // are redirects disabled?
355 if ( $wgMaxRedirects < 1 ) {
356 return null;
358 $title = self::newFromRedirectInternal( $text );
359 if ( is_null( $title ) ) {
360 return null;
362 // recursive check to follow double redirects
363 $recurse = $wgMaxRedirects;
364 $titles = array( $title );
365 while ( --$recurse > 0 ) {
366 if ( $title->isRedirect() ) {
367 $article = new Article( $title, 0 );
368 $newtitle = $article->getRedirectTarget();
369 } else {
370 break;
372 // Redirects to some special pages are not permitted
373 if ( $newtitle instanceOf Title && $newtitle->isValidRedirectTarget() ) {
374 // the new title passes the checks, so make that our current title so that further recursion can be checked
375 $title = $newtitle;
376 $titles[] = $newtitle;
377 } else {
378 break;
381 return $titles;
385 * Really extract the redirect destination
386 * Do not call this function directly, use one of the newFromRedirect* functions above
388 * @param $text \type{\string} Text with possible redirect
389 * @return \type{Title} The corresponding Title
391 protected static function newFromRedirectInternal( $text ) {
392 $redir = MagicWord::get( 'redirect' );
393 $text = trim( $text );
394 if ( $redir->matchStartAndRemove( $text ) ) {
395 // Extract the first link and see if it's usable
396 // Ensure that it really does come directly after #REDIRECT
397 // Some older redirects included a colon, so don't freak about that!
398 $m = array();
399 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
400 // Strip preceding colon used to "escape" categories, etc.
401 // and URL-decode links
402 if ( strpos( $m[1], '%' ) !== false ) {
403 // Match behavior of inline link parsing here;
404 // don't interpret + as " " most of the time!
405 // It might be safe to just use rawurldecode instead, though.
406 $m[1] = urldecode( ltrim( $m[1], ':' ) );
408 $title = Title::newFromText( $m[1] );
409 // If the title is a redirect to bad special pages or is invalid, return null
410 if ( !$title instanceof Title || !$title->isValidRedirectTarget() ) {
411 return null;
413 return $title;
416 return null;
419 # ----------------------------------------------------------------------------
420 # Static functions
421 # ----------------------------------------------------------------------------
424 * Get the prefixed DB key associated with an ID
426 * @param $id \type{\int} the page_id of the article
427 * @return \type{Title} an object representing the article, or NULL
428 * if no such article was found
430 public static function nameOf( $id ) {
431 $dbr = wfGetDB( DB_SLAVE );
433 $s = $dbr->selectRow(
434 'page',
435 array( 'page_namespace', 'page_title' ),
436 array( 'page_id' => $id ),
437 __METHOD__
439 if ( $s === false ) {
440 return null;
443 $n = self::makeName( $s->page_namespace, $s->page_title );
444 return $n;
448 * Get a regex character class describing the legal characters in a link
450 * @return \type{\string} the list of characters, not delimited
452 public static function legalChars() {
453 global $wgLegalTitleChars;
454 return $wgLegalTitleChars;
458 * Get a string representation of a title suitable for
459 * including in a search index
461 * @param $ns \type{\int} a namespace index
462 * @param $title \type{\string} text-form main part
463 * @return \type{\string} a stripped-down title string ready for the
464 * search index
466 public static function indexTitle( $ns, $title ) {
467 global $wgContLang;
469 $lc = SearchEngine::legalSearchChars() . '&#;';
470 $t = $wgContLang->normalizeForSearch( $title );
471 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
472 $t = $wgContLang->lc( $t );
474 # Handle 's, s'
475 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
476 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
478 $t = preg_replace( "/\\s+/", ' ', $t );
480 if ( $ns == NS_FILE ) {
481 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
483 return trim( $t );
487 * Make a prefixed DB key from a DB key and a namespace index
489 * @param $ns \type{\int} numerical representation of the namespace
490 * @param $title \type{\string} the DB key form the title
491 * @param $fragment \type{\string} The link fragment (after the "#")
492 * @param $interwiki \type{\string} The interwiki prefix
493 * @return \type{\string} the prefixed form of the title
495 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
496 global $wgContLang;
498 $namespace = $wgContLang->getNsText( $ns );
499 $name = $namespace == '' ? $title : "$namespace:$title";
500 if ( strval( $interwiki ) != '' ) {
501 $name = "$interwiki:$name";
503 if ( strval( $fragment ) != '' ) {
504 $name .= '#' . $fragment;
506 return $name;
510 * Determine whether the object refers to a page within
511 * this project.
513 * @return \type{\bool} TRUE if this is an in-project interwiki link
514 * or a wikilink, FALSE otherwise
516 public function isLocal() {
517 if ( $this->mInterwiki != '' ) {
518 return Interwiki::fetch( $this->mInterwiki )->isLocal();
519 } else {
520 return true;
525 * Determine whether the object refers to a page within
526 * this project and is transcludable.
528 * @return \type{\bool} TRUE if this is transcludable
530 public function isTrans() {
531 if ( $this->mInterwiki == '' ) {
532 return false;
535 return Interwiki::fetch( $this->mInterwiki )->isTranscludable();
539 * Returns the DB name of the distant wiki
540 * which owns the object.
542 * @return \type{\string} the DB name
544 public function getTransWikiID() {
545 if ( $this->mInterwiki == '' ) {
546 return false;
549 return Interwiki::fetch( $this->mInterwiki )->getWikiID();
553 * Escape a text fragment, say from a link, for a URL
555 * @param $fragment string containing a URL or link fragment (after the "#")
556 * @return String: escaped string
558 static function escapeFragmentForURL( $fragment ) {
559 # Note that we don't urlencode the fragment. urlencoded Unicode
560 # fragments appear not to work in IE (at least up to 7) or in at least
561 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
562 # to care if they aren't encoded.
563 return Sanitizer::escapeId( $fragment, 'noninitial' );
566 # ----------------------------------------------------------------------------
567 # Other stuff
568 # ----------------------------------------------------------------------------
570 /** Simple accessors */
572 * Get the text form (spaces not underscores) of the main part
574 * @return \type{\string} Main part of the title
576 public function getText() { return $this->mTextform; }
579 * Get the URL-encoded form of the main part
581 * @return \type{\string} Main part of the title, URL-encoded
583 public function getPartialURL() { return $this->mUrlform; }
586 * Get the main part with underscores
588 * @return \type{\string} Main part of the title, with underscores
590 public function getDBkey() { return $this->mDbkeyform; }
593 * Get the namespace index, i.e.\ one of the NS_xxxx constants.
595 * @return \type{\int} Namespace index
597 public function getNamespace() { return $this->mNamespace; }
600 * Get the namespace text
602 * @return \type{\string} Namespace text
604 public function getNsText() {
605 global $wgContLang;
607 if ( $this->mInterwiki != '' ) {
608 // This probably shouldn't even happen. ohh man, oh yuck.
609 // But for interwiki transclusion it sometimes does.
610 // Shit. Shit shit shit.
612 // Use the canonical namespaces if possible to try to
613 // resolve a foreign namespace.
614 if ( MWNamespace::exists( $this->mNamespace ) ) {
615 return MWNamespace::getCanonicalName( $this->mNamespace );
618 return $wgContLang->getNsText( $this->mNamespace );
622 * Get the DB key with the initial letter case as specified by the user
624 * @return \type{\string} DB key
626 function getUserCaseDBKey() {
627 return $this->mUserCaseDBKey;
631 * Get the namespace text of the subject (rather than talk) page
633 * @return \type{\string} Namespace text
635 public function getSubjectNsText() {
636 global $wgContLang;
637 return $wgContLang->getNsText( MWNamespace::getSubject( $this->mNamespace ) );
641 * Get the namespace text of the talk page
643 * @return \type{\string} Namespace text
645 public function getTalkNsText() {
646 global $wgContLang;
647 return( $wgContLang->getNsText( MWNamespace::getTalk( $this->mNamespace ) ) );
651 * Could this title have a corresponding talk page?
653 * @return \type{\bool} TRUE or FALSE
655 public function canTalk() {
656 return( MWNamespace::canTalk( $this->mNamespace ) );
660 * Get the interwiki prefix (or null string)
662 * @return \type{\string} Interwiki prefix
664 public function getInterwiki() { return $this->mInterwiki; }
667 * Get the Title fragment (i.e.\ the bit after the #) in text form
669 * @return \type{\string} Title fragment
671 public function getFragment() { return $this->mFragment; }
674 * Get the fragment in URL form, including the "#" character if there is one
675 * @return \type{\string} Fragment in URL form
677 public function getFragmentForURL() {
678 if ( $this->mFragment == '' ) {
679 return '';
680 } else {
681 return '#' . Title::escapeFragmentForURL( $this->mFragment );
686 * Get the default namespace index, for when there is no namespace
688 * @return \type{\int} Default namespace index
690 public function getDefaultNamespace() { return $this->mDefaultNamespace; }
693 * Get title for search index
695 * @return \type{\string} a stripped-down title string ready for the
696 * search index
698 public function getIndexTitle() {
699 return Title::indexTitle( $this->mNamespace, $this->mTextform );
703 * Get the prefixed database key form
705 * @return \type{\string} the prefixed title, with underscores and
706 * any interwiki and namespace prefixes
708 public function getPrefixedDBkey() {
709 $s = $this->prefix( $this->mDbkeyform );
710 $s = str_replace( ' ', '_', $s );
711 return $s;
715 * Get the prefixed title with spaces.
716 * This is the form usually used for display
718 * @return \type{\string} the prefixed title, with spaces
720 public function getPrefixedText() {
721 if ( empty( $this->mPrefixedText ) ) { // FIXME: bad usage of empty() ?
722 $s = $this->prefix( $this->mTextform );
723 $s = str_replace( '_', ' ', $s );
724 $this->mPrefixedText = $s;
726 return $this->mPrefixedText;
730 * Get the prefixed title with spaces, plus any fragment
731 * (part beginning with '#')
733 * @return \type{\string} the prefixed title, with spaces and
734 * the fragment, including '#'
736 public function getFullText() {
737 $text = $this->getPrefixedText();
738 if ( $this->mFragment != '' ) {
739 $text .= '#' . $this->mFragment;
741 return $text;
745 * Get the base name, i.e. the leftmost parts before the /
747 * @return \type{\string} Base name
749 public function getBaseText() {
750 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
751 return $this->getText();
754 $parts = explode( '/', $this->getText() );
755 # Don't discard the real title if there's no subpage involved
756 if ( count( $parts ) > 1 ) {
757 unset( $parts[count( $parts ) - 1] );
759 return implode( '/', $parts );
763 * Get the lowest-level subpage name, i.e. the rightmost part after /
765 * @return \type{\string} Subpage name
767 public function getSubpageText() {
768 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
769 return( $this->mTextform );
771 $parts = explode( '/', $this->mTextform );
772 return( $parts[count( $parts ) - 1] );
776 * Get a URL-encoded form of the subpage text
778 * @return \type{\string} URL-encoded subpage name
780 public function getSubpageUrlForm() {
781 $text = $this->getSubpageText();
782 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
783 return( $text );
787 * Get a URL-encoded title (not an actual URL) including interwiki
789 * @return \type{\string} the URL-encoded form
791 public function getPrefixedURL() {
792 $s = $this->prefix( $this->mDbkeyform );
793 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
794 return $s;
798 * Get a real URL referring to this title, with interwiki link and
799 * fragment
801 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
802 * links. Can be specified as an associative array as well, e.g.,
803 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
804 * @param $variant \type{\string} language variant of url (for sr, zh..)
805 * @return \type{\string} the URL
807 public function getFullURL( $query = '', $variant = false ) {
808 global $wgServer, $wgRequest;
810 if ( is_array( $query ) ) {
811 $query = wfArrayToCGI( $query );
814 $interwiki = Interwiki::fetch( $this->mInterwiki );
815 if ( !$interwiki ) {
816 $url = $this->getLocalURL( $query, $variant );
818 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
819 // Correct fix would be to move the prepending elsewhere.
820 if ( $wgRequest->getVal( 'action' ) != 'render' ) {
821 $url = $wgServer . $url;
823 } else {
824 $baseUrl = $interwiki->getURL();
826 $namespace = wfUrlencode( $this->getNsText() );
827 if ( $namespace != '' ) {
828 # Can this actually happen? Interwikis shouldn't be parsed.
829 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
830 $namespace .= ':';
832 $url = str_replace( '$1', $namespace . $this->mUrlform, $baseUrl );
833 $url = wfAppendQuery( $url, $query );
836 # Finally, add the fragment.
837 $url .= $this->getFragmentForURL();
839 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
840 return $url;
844 * Get a URL with no fragment or server name. If this page is generated
845 * with action=render, $wgServer is prepended.
847 * @param $query Mixed: an optional query string; if not specified,
848 * $wgArticlePath will be used. Can be specified as an associative array
849 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
850 * URL-escaped).
851 * @param $variant \type{\string} language variant of url (for sr, zh..)
852 * @return \type{\string} the URL
854 public function getLocalURL( $query = '', $variant = false ) {
855 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
856 global $wgVariantArticlePath, $wgContLang, $wgUser;
858 if ( is_array( $query ) ) {
859 $query = wfArrayToCGI( $query );
862 // internal links should point to same variant as current page (only anonymous users)
863 if ( !$variant && $wgContLang->hasVariants() && !$wgUser->isLoggedIn() ) {
864 $pref = $wgContLang->getPreferredVariant( false );
865 if ( $pref != $wgContLang->getCode() ) {
866 $variant = $pref;
870 if ( $this->isExternal() ) {
871 $url = $this->getFullURL();
872 if ( $query ) {
873 // This is currently only used for edit section links in the
874 // context of interwiki transclusion. In theory we should
875 // append the query to the end of any existing query string,
876 // but interwiki transclusion is already broken in that case.
877 $url .= "?$query";
879 } else {
880 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
881 if ( $query == '' ) {
882 if ( $variant != false && $wgContLang->hasVariants() ) {
883 if ( !$wgVariantArticlePath ) {
884 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
885 } else {
886 $variantArticlePath = $wgVariantArticlePath;
888 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
889 $url = str_replace( '$1', $dbkey, $url );
890 } else {
891 $url = str_replace( '$1', $dbkey, $wgArticlePath );
893 } else {
894 global $wgActionPaths;
895 $url = false;
896 $matches = array();
897 if ( !empty( $wgActionPaths ) &&
898 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
900 $action = urldecode( $matches[2] );
901 if ( isset( $wgActionPaths[$action] ) ) {
902 $query = $matches[1];
903 if ( isset( $matches[4] ) ) {
904 $query .= $matches[4];
906 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
907 if ( $query != '' ) {
908 $url = wfAppendQuery( $url, $query );
912 if ( $url === false ) {
913 if ( $query == '-' ) {
914 $query = '';
916 $url = "{$wgScript}?title={$dbkey}&{$query}";
920 // FIXME: this causes breakage in various places when we
921 // actually expected a local URL and end up with dupe prefixes.
922 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
923 $url = $wgServer . $url;
926 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
927 return $url;
931 * Get a URL that's the simplest URL that will be valid to link, locally,
932 * to the current Title. It includes the fragment, but does not include
933 * the server unless action=render is used (or the link is external). If
934 * there's a fragment but the prefixed text is empty, we just return a link
935 * to the fragment.
937 * The result obviously should not be URL-escaped, but does need to be
938 * HTML-escaped if it's being output in HTML.
940 * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the
941 * query string. Keys and values will be escaped.
942 * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
943 * for external links. Default is "false" (same variant as current page,
944 * for anonymous users).
945 * @return \type{\string} the URL
947 public function getLinkUrl( $query = array(), $variant = false ) {
948 wfProfileIn( __METHOD__ );
949 if ( $this->isExternal() ) {
950 $ret = $this->getFullURL( $query );
951 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
952 $ret = $this->getFragmentForURL();
953 } else {
954 $ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
956 wfProfileOut( __METHOD__ );
957 return $ret;
961 * Get an HTML-escaped version of the URL form, suitable for
962 * using in a link, without a server name or fragment
964 * @param $query \type{\string} an optional query string
965 * @return \type{\string} the URL
967 public function escapeLocalURL( $query = '' ) {
968 return htmlspecialchars( $this->getLocalURL( $query ) );
972 * Get an HTML-escaped version of the URL form, suitable for
973 * using in a link, including the server name and fragment
975 * @param $query \type{\string} an optional query string
976 * @return \type{\string} the URL
978 public function escapeFullURL( $query = '' ) {
979 return htmlspecialchars( $this->getFullURL( $query ) );
983 * Get the URL form for an internal link.
984 * - Used in various Squid-related code, in case we have a different
985 * internal hostname for the server from the exposed one.
987 * @param $query \type{\string} an optional query string
988 * @param $variant \type{\string} language variant of url (for sr, zh..)
989 * @return \type{\string} the URL
991 public function getInternalURL( $query = '', $variant = false ) {
992 global $wgInternalServer;
993 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
994 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
995 return $url;
999 * Get the edit URL for this Title
1001 * @return \type{\string} the URL, or a null string if this is an
1002 * interwiki link
1004 public function getEditURL() {
1005 if ( $this->mInterwiki != '' ) {
1006 return '';
1008 $s = $this->getLocalURL( 'action=edit' );
1010 return $s;
1014 * Get the HTML-escaped displayable text form.
1015 * Used for the title field in <a> tags.
1017 * @return \type{\string} the text, including any prefixes
1019 public function getEscapedText() {
1020 return htmlspecialchars( $this->getPrefixedText() );
1024 * Is this Title interwiki?
1026 * @return \type{\bool}
1028 public function isExternal() {
1029 return ( $this->mInterwiki != '' );
1033 * Is this page "semi-protected" - the *only* protection is autoconfirm?
1035 * @param $action \type{\string} Action to check (default: edit)
1036 * @return \type{\bool}
1038 public function isSemiProtected( $action = 'edit' ) {
1039 if ( $this->exists() ) {
1040 $restrictions = $this->getRestrictions( $action );
1041 if ( count( $restrictions ) > 0 ) {
1042 foreach ( $restrictions as $restriction ) {
1043 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
1044 return false;
1047 } else {
1048 # Not protected
1049 return false;
1051 return true;
1052 } else {
1053 # If it doesn't exist, it can't be protected
1054 return false;
1059 * Does the title correspond to a protected article?
1061 * @param $action \type{\string} the action the page is protected from,
1062 * by default checks all actions.
1063 * @return \type{\bool}
1065 public function isProtected( $action = '' ) {
1066 global $wgRestrictionLevels;
1068 $restrictionTypes = $this->getRestrictionTypes();
1070 # Special pages have inherent protection
1071 if( $this->getNamespace() == NS_SPECIAL ) {
1072 return true;
1075 # Check regular protection levels
1076 foreach ( $restrictionTypes as $type ) {
1077 if ( $action == $type || $action == '' ) {
1078 $r = $this->getRestrictions( $type );
1079 foreach ( $wgRestrictionLevels as $level ) {
1080 if ( in_array( $level, $r ) && $level != '' ) {
1081 return true;
1087 return false;
1091 * Is this a conversion table for the LanguageConverter?
1093 * @return \type{\bool}
1095 public function isConversionTable() {
1097 $this->getNamespace() == NS_MEDIAWIKI &&
1098 strpos( $this->getText(), 'Conversiontable' ) !== false
1101 return true;
1104 return false;
1108 * Is $wgUser watching this page?
1110 * @return \type{\bool}
1112 public function userIsWatching() {
1113 global $wgUser;
1115 if ( is_null( $this->mWatched ) ) {
1116 if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn() ) {
1117 $this->mWatched = false;
1118 } else {
1119 $this->mWatched = $wgUser->isWatched( $this );
1122 return $this->mWatched;
1126 * Can $wgUser perform $action on this page?
1127 * This skips potentially expensive cascading permission checks
1128 * as well as avoids expensive error formatting
1130 * Suitable for use for nonessential UI controls in common cases, but
1131 * _not_ for functional access control.
1133 * May provide false positives, but should never provide a false negative.
1135 * @param $action \type{\string} action that permission needs to be checked for
1136 * @return \type{\bool}
1138 public function quickUserCan( $action ) {
1139 return $this->userCan( $action, false );
1143 * Determines if $wgUser is unable to edit this page because it has been protected
1144 * by $wgNamespaceProtection.
1146 * @return \type{\bool}
1148 public function isNamespaceProtected() {
1149 global $wgNamespaceProtection, $wgUser;
1150 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
1151 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
1152 if ( $right != '' && !$wgUser->isAllowed( $right ) ) {
1153 return true;
1157 return false;
1161 * Can $wgUser perform $action on this page?
1163 * @param $action \type{\string} action that permission needs to be checked for
1164 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1165 * @return \type{\bool}
1167 public function userCan( $action, $doExpensiveQueries = true ) {
1168 global $wgUser;
1169 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries, true ) === array() );
1173 * Can $user perform $action on this page?
1175 * FIXME: This *does not* check throttles (User::pingLimiter()).
1177 * @param $action \type{\string}action that permission needs to be checked for
1178 * @param $user \type{User} user to check
1179 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1180 * @param $ignoreErrors \type{\arrayof{\string}} Set this to a list of message keys whose corresponding errors may be ignored.
1181 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1183 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1184 if ( !StubObject::isRealObject( $user ) ) {
1185 // Since StubObject is always used on globals, we can
1186 // unstub $wgUser here and set $user = $wgUser
1187 global $wgUser;
1188 $wgUser->_unstub( '', 5 );
1189 $user = $wgUser;
1192 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1194 // Remove the errors being ignored.
1195 foreach ( $errors as $index => $error ) {
1196 $error_key = is_array( $error ) ? $error[0] : $error;
1198 if ( in_array( $error_key, $ignoreErrors ) ) {
1199 unset( $errors[$index] );
1203 return $errors;
1207 * Permissions checks that fail most often, and which are easiest to test.
1209 * @param $action String the action to check
1210 * @param $user User user to check
1211 * @param $errors Array list of current errors
1212 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1213 * @param $short Boolean short circuit on first error
1215 * @return Array list of errors
1217 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1218 if ( $action == 'create' ) {
1219 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1220 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1221 $errors[] = $user->isAnon() ? array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1223 } elseif ( $action == 'move' ) {
1224 if ( !$user->isAllowed( 'move-rootuserpages' )
1225 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1226 // Show user page-specific message only if the user can move other pages
1227 $errors[] = array( 'cant-move-user-page' );
1230 // Check if user is allowed to move files if it's a file
1231 if ( $this->mNamespace == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
1232 $errors[] = array( 'movenotallowedfile' );
1235 if ( !$user->isAllowed( 'move' ) ) {
1236 // User can't move anything
1237 global $wgGroupPermissions;
1238 $userCanMove = false;
1239 if ( isset( $wgGroupPermissions['user']['move'] ) ) {
1240 $userCanMove = $wgGroupPermissions['user']['move'];
1242 $autoconfirmedCanMove = false;
1243 if ( isset( $wgGroupPermissions['autoconfirmed']['move'] ) ) {
1244 $autoconfirmedCanMove = $wgGroupPermissions['autoconfirmed']['move'];
1246 if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) {
1247 // custom message if logged-in users without any special rights can move
1248 $errors[] = array( 'movenologintext' );
1249 } else {
1250 $errors[] = array( 'movenotallowed' );
1253 } elseif ( $action == 'move-target' ) {
1254 if ( !$user->isAllowed( 'move' ) ) {
1255 // User can't move anything
1256 $errors[] = array( 'movenotallowed' );
1257 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1258 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1259 // Show user page-specific message only if the user can move other pages
1260 $errors[] = array( 'cant-move-to-user-page' );
1262 } elseif ( !$user->isAllowed( $action ) ) {
1263 $return = null;
1265 // We avoid expensive display logic for quickUserCan's and such
1266 $groups = false;
1267 if ( !$short ) {
1268 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1269 User::getGroupsWithPermission( $action ) );
1272 if ( $groups ) {
1273 global $wgLang;
1274 $return = array(
1275 'badaccess-groups',
1276 $wgLang->commaList( $groups ),
1277 count( $groups )
1279 } else {
1280 $return = array( 'badaccess-group0' );
1282 $errors[] = $return;
1285 return $errors;
1289 * Add the resulting error code to the errors array
1291 * @param $errors Array list of current errors
1292 * @param $result Mixed result of errors
1294 * @return Array list of errors
1296 private function resultToError( $errors, $result ) {
1297 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1298 // A single array representing an error
1299 $errors[] = $result;
1300 } else if ( is_array( $result ) && is_array( $result[0] ) ) {
1301 // A nested array representing multiple errors
1302 $errors = array_merge( $errors, $result );
1303 } else if ( $result !== '' && is_string( $result ) ) {
1304 // A string representing a message-id
1305 $errors[] = array( $result );
1306 } else if ( $result === false ) {
1307 // a generic "We don't want them to do that"
1308 $errors[] = array( 'badaccess-group0' );
1310 return $errors;
1314 * Check various permission hooks
1315 * @see checkQuickPermissions for parameter information
1317 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1318 // Use getUserPermissionsErrors instead
1319 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1320 return $result ? array() : array( array( 'badaccess-group0' ) );
1322 // Check getUserPermissionsErrors hook
1323 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1324 $errors = $this->resultToError( $errors, $result );
1326 // Check getUserPermissionsErrorsExpensive hook
1327 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1328 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1329 $errors = $this->resultToError( $errors, $result );
1332 return $errors;
1336 * Check permissions on special pages & namespaces
1337 * @see checkQuickPermissions for parameter information
1339 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1340 # Only 'createaccount' and 'execute' can be performed on
1341 # special pages, which don't actually exist in the DB.
1342 $specialOKActions = array( 'createaccount', 'execute' );
1343 if ( NS_SPECIAL == $this->mNamespace && !in_array( $action, $specialOKActions ) ) {
1344 $errors[] = array( 'ns-specialprotected' );
1347 # Check $wgNamespaceProtection for restricted namespaces
1348 if ( $this->isNamespaceProtected() ) {
1349 $ns = $this->mNamespace == NS_MAIN ?
1350 wfMsg( 'nstab-main' ) : $this->getNsText();
1351 $errors[] = $this->mNamespace == NS_MEDIAWIKI ?
1352 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1355 return $errors;
1359 * Check CSS/JS sub-page permissions
1360 * @see checkQuickPermissions for parameter information
1362 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1363 # Protect css/js subpages of user pages
1364 # XXX: this might be better using restrictions
1365 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssSubpage()
1366 # and $this->userCanEditJsSubpage() from working
1367 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1368 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1369 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform ) ) {
1370 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1371 $errors[] = array( 'customcssjsprotected' );
1372 } else if ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1373 $errors[] = array( 'customcssjsprotected' );
1377 return $errors;
1381 * Check against page_restrictions table requirements on this
1382 * page. The user must possess all required rights for this
1383 * action.
1384 * @see checkQuickPermissions for parameter information
1386 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1387 foreach ( $this->getRestrictions( $action ) as $right ) {
1388 // Backwards compatibility, rewrite sysop -> protect
1389 if ( $right == 'sysop' ) {
1390 $right = 'protect';
1392 if ( $right != '' && !$user->isAllowed( $right ) ) {
1393 // Users with 'editprotected' permission can edit protected pages
1394 if ( $action == 'edit' && $user->isAllowed( 'editprotected' ) ) {
1395 // Users with 'editprotected' permission cannot edit protected pages
1396 // with cascading option turned on.
1397 if ( $this->mCascadeRestriction ) {
1398 $errors[] = array( 'protectedpagetext', $right );
1400 } else {
1401 $errors[] = array( 'protectedpagetext', $right );
1406 return $errors;
1410 * Check restrictions on cascading pages.
1411 * @see checkQuickPermissions for parameter information
1413 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1414 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1415 # We /could/ use the protection level on the source page, but it's
1416 # fairly ugly as we have to establish a precedence hierarchy for pages
1417 # included by multiple cascade-protected pages. So just restrict
1418 # it to people with 'protect' permission, as they could remove the
1419 # protection anyway.
1420 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1421 # Cascading protection depends on more than this page...
1422 # Several cascading protected pages may include this page...
1423 # Check each cascading level
1424 # This is only for protection restrictions, not for all actions
1425 if ( isset( $restrictions[$action] ) ) {
1426 foreach ( $restrictions[$action] as $right ) {
1427 $right = ( $right == 'sysop' ) ? 'protect' : $right;
1428 if ( $right != '' && !$user->isAllowed( $right ) ) {
1429 $pages = '';
1430 foreach ( $cascadingSources as $page )
1431 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1432 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1438 return $errors;
1442 * Check action permissions not already checked in checkQuickPermissions
1443 * @see checkQuickPermissions for parameter information
1445 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1446 if ( $action == 'protect' ) {
1447 if ( $this->getUserPermissionsErrors( 'edit', $user ) != array() ) {
1448 // If they can't edit, they shouldn't protect.
1449 $errors[] = array( 'protect-cantedit' );
1451 } elseif ( $action == 'create' ) {
1452 $title_protection = $this->getTitleProtection();
1453 if( $title_protection ) {
1454 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1455 $title_protection['pt_create_perm'] = 'protect'; // B/C
1457 if( $title_protection['pt_create_perm'] == '' || !$user->isAllowed( $title_protection['pt_create_perm'] ) ) {
1458 $errors[] = array( 'titleprotected', User::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1461 } elseif ( $action == 'move' ) {
1462 // Check for immobile pages
1463 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
1464 // Specific message for this case
1465 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1466 } elseif ( !$this->isMovable() ) {
1467 // Less specific message for rarer cases
1468 $errors[] = array( 'immobile-page' );
1470 } elseif ( $action == 'move-target' ) {
1471 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
1472 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1473 } elseif ( !$this->isMovable() ) {
1474 $errors[] = array( 'immobile-target-page' );
1477 return $errors;
1481 * Check that the user isn't blocked from editting.
1482 * @see checkQuickPermissions for parameter information
1484 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1485 if( $short ) {
1486 return $errors;
1489 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
1491 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1492 $errors[] = array( 'confirmedittext' );
1495 // Edit blocks should not affect reading. Account creation blocks handled at userlogin.
1496 if ( $action != 'read' && $action != 'createaccount' && $user->isBlockedFrom( $this ) ) {
1497 $block = $user->mBlock;
1499 // This is from OutputPage::blockedPage
1500 // Copied at r23888 by werdna
1502 $id = $user->blockedBy();
1503 $reason = $user->blockedFor();
1504 if ( $reason == '' ) {
1505 $reason = wfMsg( 'blockednoreason' );
1507 $ip = wfGetIP();
1509 if ( is_numeric( $id ) ) {
1510 $name = User::whoIs( $id );
1511 } else {
1512 $name = $id;
1515 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
1516 $blockid = $block->mId;
1517 $blockExpiry = $user->mBlock->mExpiry;
1518 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $user->mBlock->mTimestamp ), true );
1519 if ( $blockExpiry == 'infinity' ) {
1520 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1521 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1523 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1524 if ( !strpos( $option, ':' ) )
1525 continue;
1527 list( $show, $value ) = explode( ':', $option );
1529 if ( $value == 'infinite' || $value == 'indefinite' ) {
1530 $blockExpiry = $show;
1531 break;
1534 } else {
1535 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
1538 $intended = $user->mBlock->mAddress;
1540 $errors[] = array( ( $block->mAuto ? 'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1541 $blockid, $blockExpiry, $intended, $blockTimestamp );
1544 return $errors;
1548 * Can $user perform $action on this page? This is an internal function,
1549 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1550 * checks on wfReadOnly() and blocks)
1552 * @param $action \type{\string} action that permission needs to be checked for
1553 * @param $user \type{User} user to check
1554 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1555 * @param $short \type{\bool} Set this to true to stop after the first permission error.
1556 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1558 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
1559 wfProfileIn( __METHOD__ );
1561 $errors = array();
1562 $checks = array(
1563 'checkQuickPermissions',
1564 'checkPermissionHooks',
1565 'checkSpecialsAndNSPermissions',
1566 'checkCSSandJSPermissions',
1567 'checkPageRestrictions',
1568 'checkCascadingSourcesRestrictions',
1569 'checkActionPermissions',
1570 'checkUserBlock'
1573 while( count( $checks ) > 0 &&
1574 !( $short && count( $errors ) > 0 ) ) {
1575 $method = array_shift( $checks );
1576 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
1579 wfProfileOut( __METHOD__ );
1580 return $errors;
1584 * Is this title subject to title protection?
1586 * @return \type{\mixed} An associative array representing any existent title
1587 * protection, or false if there's none.
1589 private function getTitleProtection() {
1590 // Can't protect pages in special namespaces
1591 if ( $this->getNamespace() < 0 ) {
1592 return false;
1595 // Can't protect pages that exist.
1596 if ( $this->exists() ) {
1597 return false;
1600 if ( !isset( $this->mTitleProtection ) ) {
1601 $dbr = wfGetDB( DB_SLAVE );
1602 $res = $dbr->select( 'protected_titles', '*',
1603 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1604 __METHOD__ );
1606 // fetchRow returns false if there are no rows.
1607 $this->mTitleProtection = $dbr->fetchRow( $res );
1609 return $this->mTitleProtection;
1613 * Update the title protection status
1615 * @param $create_perm \type{\string} Permission required for creation
1616 * @param $reason \type{\string} Reason for protection
1617 * @param $expiry \type{\string} Expiry timestamp
1618 * @return boolean true
1620 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1621 global $wgUser, $wgContLang;
1623 if ( $create_perm == implode( ',', $this->getRestrictions( 'create' ) )
1624 && $expiry == $this->mRestrictionsExpiry['create'] ) {
1625 // No change
1626 return true;
1629 list ( $namespace, $title ) = array( $this->getNamespace(), $this->getDBkey() );
1631 $dbw = wfGetDB( DB_MASTER );
1633 $encodedExpiry = Block::encodeExpiry( $expiry, $dbw );
1635 $expiry_description = '';
1636 if ( $encodedExpiry != 'infinity' ) {
1637 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ),
1638 $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')';
1639 } else {
1640 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ) . ')';
1643 # Update protection table
1644 if ( $create_perm != '' ) {
1645 $dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ),
1646 array(
1647 'pt_namespace' => $namespace,
1648 'pt_title' => $title,
1649 'pt_create_perm' => $create_perm,
1650 'pt_timestamp' => Block::encodeExpiry( wfTimestampNow(), $dbw ),
1651 'pt_expiry' => $encodedExpiry,
1652 'pt_user' => $wgUser->getId(),
1653 'pt_reason' => $reason,
1654 ), __METHOD__
1656 } else {
1657 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1658 'pt_title' => $title ), __METHOD__ );
1660 # Update the protection log
1661 if ( $dbw->affectedRows() ) {
1662 $log = new LogPage( 'protect' );
1664 if ( $create_perm ) {
1665 $params = array( "[create=$create_perm] $expiry_description", '' );
1666 $log->addEntry( ( isset( $this->mRestrictions['create'] ) && $this->mRestrictions['create'] ) ? 'modify' : 'protect', $this, trim( $reason ), $params );
1667 } else {
1668 $log->addEntry( 'unprotect', $this, $reason );
1672 return true;
1676 * Remove any title protection due to page existing
1678 public function deleteTitleProtection() {
1679 $dbw = wfGetDB( DB_MASTER );
1681 $dbw->delete(
1682 'protected_titles',
1683 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1684 __METHOD__
1689 * Would anybody with sufficient privileges be able to move this page?
1690 * Some pages just aren't movable.
1692 * @return \type{\bool} TRUE or FALSE
1694 public function isMovable() {
1695 return MWNamespace::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
1699 * Can $wgUser read this page?
1701 * @return \type{\bool}
1702 * @todo fold these checks into userCan()
1704 public function userCanRead() {
1705 global $wgUser, $wgGroupPermissions;
1707 static $useShortcut = null;
1709 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
1710 if ( is_null( $useShortcut ) ) {
1711 global $wgRevokePermissions;
1712 $useShortcut = true;
1713 if ( empty( $wgGroupPermissions['*']['read'] ) ) {
1714 # Not a public wiki, so no shortcut
1715 $useShortcut = false;
1716 } elseif ( !empty( $wgRevokePermissions ) ) {
1718 * Iterate through each group with permissions being revoked (key not included since we don't care
1719 * what the group name is), then check if the read permission is being revoked. If it is, then
1720 * we don't use the shortcut below since the user might not be able to read, even though anon
1721 * reading is allowed.
1723 foreach ( $wgRevokePermissions as $perms ) {
1724 if ( !empty( $perms['read'] ) ) {
1725 # We might be removing the read right from the user, so no shortcut
1726 $useShortcut = false;
1727 break;
1733 $result = null;
1734 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1735 if ( $result !== null ) {
1736 return $result;
1739 # Shortcut for public wikis, allows skipping quite a bit of code
1740 if ( $useShortcut ) {
1741 return true;
1744 if ( $wgUser->isAllowed( 'read' ) ) {
1745 return true;
1746 } else {
1747 global $wgWhitelistRead;
1750 * Always grant access to the login page.
1751 * Even anons need to be able to log in.
1753 if ( $this->isSpecial( 'Userlogin' ) || $this->isSpecial( 'Resetpass' ) ) {
1754 return true;
1758 * Bail out if there isn't whitelist
1760 if ( !is_array( $wgWhitelistRead ) ) {
1761 return false;
1765 * Check for explicit whitelisting
1767 $name = $this->getPrefixedText();
1768 $dbName = $this->getPrefixedDBKey();
1769 // Check with and without underscores
1770 if ( in_array( $name, $wgWhitelistRead, true ) || in_array( $dbName, $wgWhitelistRead, true ) )
1771 return true;
1774 * Old settings might have the title prefixed with
1775 * a colon for main-namespace pages
1777 if ( $this->getNamespace() == NS_MAIN ) {
1778 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
1779 return true;
1784 * If it's a special page, ditch the subpage bit
1785 * and check again
1787 if ( $this->getNamespace() == NS_SPECIAL ) {
1788 $name = $this->getDBkey();
1789 list( $name, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $name );
1790 if ( $name === false ) {
1791 # Invalid special page, but we show standard login required message
1792 return false;
1795 $pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
1796 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
1797 return true;
1802 return false;
1806 * Is this a talk page of some sort?
1808 * @return \type{\bool}
1810 public function isTalkPage() {
1811 return MWNamespace::isTalk( $this->getNamespace() );
1815 * Is this a subpage?
1817 * @return \type{\bool}
1819 public function isSubpage() {
1820 return MWNamespace::hasSubpages( $this->mNamespace )
1821 ? strpos( $this->getText(), '/' ) !== false
1822 : false;
1826 * Does this have subpages? (Warning, usually requires an extra DB query.)
1828 * @return \type{\bool}
1830 public function hasSubpages() {
1831 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1832 # Duh
1833 return false;
1836 # We dynamically add a member variable for the purpose of this method
1837 # alone to cache the result. There's no point in having it hanging
1838 # around uninitialized in every Title object; therefore we only add it
1839 # if needed and don't declare it statically.
1840 if ( isset( $this->mHasSubpages ) ) {
1841 return $this->mHasSubpages;
1844 $subpages = $this->getSubpages( 1 );
1845 if ( $subpages instanceof TitleArray ) {
1846 return $this->mHasSubpages = (bool)$subpages->count();
1848 return $this->mHasSubpages = false;
1852 * Get all subpages of this page.
1854 * @param $limit Maximum number of subpages to fetch; -1 for no limit
1855 * @return mixed TitleArray, or empty array if this page's namespace
1856 * doesn't allow subpages
1858 public function getSubpages( $limit = -1 ) {
1859 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
1860 return array();
1863 $dbr = wfGetDB( DB_SLAVE );
1864 $conds['page_namespace'] = $this->getNamespace();
1865 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
1866 $options = array();
1867 if ( $limit > -1 ) {
1868 $options['LIMIT'] = $limit;
1870 return $this->mSubpages = TitleArray::newFromResult(
1871 $dbr->select( 'page',
1872 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
1873 $conds,
1874 __METHOD__,
1875 $options
1881 * Could this page contain custom CSS or JavaScript, based
1882 * on the title?
1884 * @return \type{\bool}
1886 public function isCssOrJsPage() {
1887 return $this->mNamespace == NS_MEDIAWIKI
1888 && preg_match( '!\.(?:css|js)$!u', $this->mTextform ) > 0;
1892 * Is this a .css or .js subpage of a user page?
1893 * @return \type{\bool}
1895 public function isCssJsSubpage() {
1896 return ( NS_USER == $this->mNamespace and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform ) );
1900 * Is this a *valid* .css or .js subpage of a user page?
1901 * Check that the corresponding skin exists
1903 * @return \type{\bool}
1905 public function isValidCssJsSubpage() {
1906 if ( $this->isCssJsSubpage() ) {
1907 $name = $this->getSkinFromCssJsSubpage();
1908 if ( $name == 'common' ) {
1909 return true;
1911 $skinNames = Skin::getSkinNames();
1912 return array_key_exists( $name, $skinNames );
1913 } else {
1914 return false;
1919 * Trim down a .css or .js subpage title to get the corresponding skin name
1921 * @return string containing skin name from .css or .js subpage title
1923 public function getSkinFromCssJsSubpage() {
1924 $subpage = explode( '/', $this->mTextform );
1925 $subpage = $subpage[ count( $subpage ) - 1 ];
1926 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1930 * Is this a .css subpage of a user page?
1932 * @return \type{\bool}
1934 public function isCssSubpage() {
1935 return ( NS_USER == $this->mNamespace && preg_match( "/\\/.*\\.css$/", $this->mTextform ) );
1939 * Is this a .js subpage of a user page?
1941 * @return \type{\bool}
1943 public function isJsSubpage() {
1944 return ( NS_USER == $this->mNamespace && preg_match( "/\\/.*\\.js$/", $this->mTextform ) );
1948 * Protect css subpages of user pages: can $wgUser edit
1949 * this page?
1951 * @return \type{\bool}
1952 * @todo XXX: this might be better using restrictions
1954 public function userCanEditCssSubpage() {
1955 global $wgUser;
1956 return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'editusercss' ) )
1957 || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) );
1961 * Protect js subpages of user pages: can $wgUser edit
1962 * this page?
1964 * @return \type{\bool}
1965 * @todo XXX: this might be better using restrictions
1967 public function userCanEditJsSubpage() {
1968 global $wgUser;
1969 return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'edituserjs' ) )
1970 || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) );
1974 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1976 * @return \type{\bool} If the page is subject to cascading restrictions.
1978 public function isCascadeProtected() {
1979 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1980 return ( $sources > 0 );
1984 * Cascading protection: Get the source of any cascading restrictions on this page.
1986 * @param $getPages \type{\bool} Whether or not to retrieve the actual pages
1987 * that the restrictions have come from.
1988 * @return \type{\arrayof{mixed title array, restriction array}} Array of the Title
1989 * objects of the pages from which cascading restrictions have come,
1990 * false for none, or true if such restrictions exist, but $getPages was not set.
1991 * The restriction array is an array of each type, each of which contains a
1992 * array of unique groups.
1994 public function getCascadeProtectionSources( $getPages = true ) {
1995 $pagerestrictions = array();
1997 if ( isset( $this->mCascadeSources ) && $getPages ) {
1998 return array( $this->mCascadeSources, $this->mCascadingRestrictions );
1999 } else if ( isset( $this->mHasCascadingRestrictions ) && !$getPages ) {
2000 return array( $this->mHasCascadingRestrictions, $pagerestrictions );
2003 wfProfileIn( __METHOD__ );
2005 $dbr = wfGetDB( DB_SLAVE );
2007 if ( $this->getNamespace() == NS_FILE ) {
2008 $tables = array( 'imagelinks', 'page_restrictions' );
2009 $where_clauses = array(
2010 'il_to' => $this->getDBkey(),
2011 'il_from=pr_page',
2012 'pr_cascade' => 1
2014 } else {
2015 $tables = array( 'templatelinks', 'page_restrictions' );
2016 $where_clauses = array(
2017 'tl_namespace' => $this->getNamespace(),
2018 'tl_title' => $this->getDBkey(),
2019 'tl_from=pr_page',
2020 'pr_cascade' => 1
2024 if ( $getPages ) {
2025 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2026 'pr_expiry', 'pr_type', 'pr_level' );
2027 $where_clauses[] = 'page_id=pr_page';
2028 $tables[] = 'page';
2029 } else {
2030 $cols = array( 'pr_expiry' );
2033 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2035 $sources = $getPages ? array() : false;
2036 $now = wfTimestampNow();
2037 $purgeExpired = false;
2039 foreach ( $res as $row ) {
2040 $expiry = Block::decodeExpiry( $row->pr_expiry );
2041 if ( $expiry > $now ) {
2042 if ( $getPages ) {
2043 $page_id = $row->pr_page;
2044 $page_ns = $row->page_namespace;
2045 $page_title = $row->page_title;
2046 $sources[$page_id] = Title::makeTitle( $page_ns, $page_title );
2047 # Add groups needed for each restriction type if its not already there
2048 # Make sure this restriction type still exists
2050 if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2051 $pagerestrictions[$row->pr_type] = array();
2054 if ( isset( $pagerestrictions[$row->pr_type] ) &&
2055 !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] ) ) {
2056 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2058 } else {
2059 $sources = true;
2061 } else {
2062 // Trigger lazy purge of expired restrictions from the db
2063 $purgeExpired = true;
2066 if ( $purgeExpired ) {
2067 Title::purgeExpiredRestrictions();
2070 wfProfileOut( __METHOD__ );
2072 if ( $getPages ) {
2073 $this->mCascadeSources = $sources;
2074 $this->mCascadingRestrictions = $pagerestrictions;
2075 } else {
2076 $this->mHasCascadingRestrictions = $sources;
2079 return array( $sources, $pagerestrictions );
2083 * Returns cascading restrictions for the current article
2085 * @return Boolean
2087 function areRestrictionsCascading() {
2088 if ( !$this->mRestrictionsLoaded ) {
2089 $this->loadRestrictions();
2092 return $this->mCascadeRestriction;
2096 * Loads a string into mRestrictions array
2098 * @param $res \type{Resource} restrictions as an SQL result.
2099 * @param $oldFashionedRestrictions string comma-separated list of page
2100 * restrictions from page table (pre 1.10)
2102 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2103 $rows = array();
2104 $dbr = wfGetDB( DB_SLAVE );
2106 while ( $row = $dbr->fetchObject( $res ) ) {
2107 $rows[] = $row;
2110 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2114 * Compiles list of active page restrictions from both page table (pre 1.10)
2115 * and page_restrictions table
2117 * @param $rows array of db result objects
2118 * @param $oldFashionedRestrictions string comma-separated list of page
2119 * restrictions from page table (pre 1.10)
2121 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2122 $dbr = wfGetDB( DB_SLAVE );
2124 $restrictionTypes = $this->getRestrictionTypes();
2126 foreach ( $restrictionTypes as $type ) {
2127 $this->mRestrictions[$type] = array();
2128 $this->mRestrictionsExpiry[$type] = Block::decodeExpiry( '' );
2131 $this->mCascadeRestriction = false;
2133 # Backwards-compatibility: also load the restrictions from the page record (old format).
2135 if ( $oldFashionedRestrictions === null ) {
2136 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2137 array( 'page_id' => $this->getArticleId() ), __METHOD__ );
2140 if ( $oldFashionedRestrictions != '' ) {
2142 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2143 $temp = explode( '=', trim( $restrict ) );
2144 if ( count( $temp ) == 1 ) {
2145 // old old format should be treated as edit/move restriction
2146 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
2147 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
2148 } else {
2149 $this->mRestrictions[$temp[0]] = explode( ',', trim( $temp[1] ) );
2153 $this->mOldRestrictions = true;
2157 if ( count( $rows ) ) {
2158 # Current system - load second to make them override.
2159 $now = wfTimestampNow();
2160 $purgeExpired = false;
2162 foreach ( $rows as $row ) {
2163 # Cycle through all the restrictions.
2165 // Don't take care of restrictions types that aren't allowed
2167 if ( !in_array( $row->pr_type, $restrictionTypes ) )
2168 continue;
2170 // This code should be refactored, now that it's being used more generally,
2171 // But I don't really see any harm in leaving it in Block for now -werdna
2172 $expiry = Block::decodeExpiry( $row->pr_expiry );
2174 // Only apply the restrictions if they haven't expired!
2175 if ( !$expiry || $expiry > $now ) {
2176 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
2177 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
2179 $this->mCascadeRestriction |= $row->pr_cascade;
2180 } else {
2181 // Trigger a lazy purge of expired restrictions
2182 $purgeExpired = true;
2186 if ( $purgeExpired ) {
2187 Title::purgeExpiredRestrictions();
2191 $this->mRestrictionsLoaded = true;
2195 * Load restrictions from the page_restrictions table
2197 * @param $oldFashionedRestrictions string comma-separated list of page
2198 * restrictions from page table (pre 1.10)
2200 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2201 if ( !$this->mRestrictionsLoaded ) {
2202 if ( $this->exists() ) {
2203 $dbr = wfGetDB( DB_SLAVE );
2205 $res = $dbr->select( 'page_restrictions', '*',
2206 array( 'pr_page' => $this->getArticleId() ), __METHOD__ );
2208 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2209 } else {
2210 $title_protection = $this->getTitleProtection();
2212 if ( $title_protection ) {
2213 $now = wfTimestampNow();
2214 $expiry = Block::decodeExpiry( $title_protection['pt_expiry'] );
2216 if ( !$expiry || $expiry > $now ) {
2217 // Apply the restrictions
2218 $this->mRestrictionsExpiry['create'] = $expiry;
2219 $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2220 } else { // Get rid of the old restrictions
2221 Title::purgeExpiredRestrictions();
2223 } else {
2224 $this->mRestrictionsExpiry['create'] = Block::decodeExpiry( '' );
2226 $this->mRestrictionsLoaded = true;
2232 * Purge expired restrictions from the page_restrictions table
2234 static function purgeExpiredRestrictions() {
2235 $dbw = wfGetDB( DB_MASTER );
2236 $dbw->delete(
2237 'page_restrictions',
2238 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2239 __METHOD__
2242 $dbw->delete(
2243 'protected_titles',
2244 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2245 __METHOD__
2250 * Accessor/initialisation for mRestrictions
2252 * @param $action \type{\string} action that permission needs to be checked for
2253 * @return \type{\arrayof{\string}} the array of groups allowed to edit this article
2255 public function getRestrictions( $action ) {
2256 if ( !$this->mRestrictionsLoaded ) {
2257 $this->loadRestrictions();
2259 return isset( $this->mRestrictions[$action] )
2260 ? $this->mRestrictions[$action]
2261 : array();
2265 * Get the expiry time for the restriction against a given action
2267 * @return 14-char timestamp, or 'infinity' if the page is protected forever
2268 * or not protected at all, or false if the action is not recognised.
2270 public function getRestrictionExpiry( $action ) {
2271 if ( !$this->mRestrictionsLoaded ) {
2272 $this->loadRestrictions();
2274 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
2278 * Is there a version of this page in the deletion archive?
2280 * @return \type{\int} the number of archived revisions
2282 public function isDeleted() {
2283 if ( $this->getNamespace() < 0 ) {
2284 $n = 0;
2285 } else {
2286 $dbr = wfGetDB( DB_SLAVE );
2287 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2288 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2289 __METHOD__
2291 if ( $this->getNamespace() == NS_FILE ) {
2292 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
2293 array( 'fa_name' => $this->getDBkey() ),
2294 __METHOD__
2298 return (int)$n;
2302 * Is there a version of this page in the deletion archive?
2304 * @return Boolean
2306 public function isDeletedQuick() {
2307 if ( $this->getNamespace() < 0 ) {
2308 return false;
2310 $dbr = wfGetDB( DB_SLAVE );
2311 $deleted = (bool)$dbr->selectField( 'archive', '1',
2312 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2313 __METHOD__
2315 if ( !$deleted && $this->getNamespace() == NS_FILE ) {
2316 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2317 array( 'fa_name' => $this->getDBkey() ),
2318 __METHOD__
2321 return $deleted;
2325 * Get the article ID for this Title from the link cache,
2326 * adding it if necessary
2328 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select
2329 * for update
2330 * @return \type{\int} the ID
2332 public function getArticleID( $flags = 0 ) {
2333 if ( $this->getNamespace() < 0 ) {
2334 return $this->mArticleID = 0;
2336 $linkCache = LinkCache::singleton();
2337 if ( $flags & GAID_FOR_UPDATE ) {
2338 $oldUpdate = $linkCache->forUpdate( true );
2339 $linkCache->clearLink( $this );
2340 $this->mArticleID = $linkCache->addLinkObj( $this );
2341 $linkCache->forUpdate( $oldUpdate );
2342 } else {
2343 if ( -1 == $this->mArticleID ) {
2344 $this->mArticleID = $linkCache->addLinkObj( $this );
2347 return $this->mArticleID;
2351 * Is this an article that is a redirect page?
2352 * Uses link cache, adding it if necessary
2354 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2355 * @return \type{\bool}
2357 public function isRedirect( $flags = 0 ) {
2358 if ( !is_null( $this->mRedirect ) ) {
2359 return $this->mRedirect;
2361 # Calling getArticleID() loads the field from cache as needed
2362 if ( !$this->getArticleID( $flags ) ) {
2363 return $this->mRedirect = false;
2365 $linkCache = LinkCache::singleton();
2366 $this->mRedirect = (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2368 return $this->mRedirect;
2372 * What is the length of this page?
2373 * Uses link cache, adding it if necessary
2375 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2376 * @return \type{\bool}
2378 public function getLength( $flags = 0 ) {
2379 if ( $this->mLength != -1 ) {
2380 return $this->mLength;
2382 # Calling getArticleID() loads the field from cache as needed
2383 if ( !$this->getArticleID( $flags ) ) {
2384 return $this->mLength = 0;
2386 $linkCache = LinkCache::singleton();
2387 $this->mLength = intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2389 return $this->mLength;
2393 * What is the page_latest field for this page?
2395 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2396 * @return \type{\int} or 0 if the page doesn't exist
2398 public function getLatestRevID( $flags = 0 ) {
2399 if ( $this->mLatestID !== false ) {
2400 return intval( $this->mLatestID );
2402 # Calling getArticleID() loads the field from cache as needed
2403 if ( !$this->getArticleID( $flags ) ) {
2404 return $this->mLatestID = 0;
2406 $linkCache = LinkCache::singleton();
2407 $this->mLatestID = intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2409 return $this->mLatestID;
2413 * This clears some fields in this object, and clears any associated
2414 * keys in the "bad links" section of the link cache.
2416 * @param $newid \type{\int} the new Article ID
2418 public function resetArticleID( $newid ) {
2419 $linkCache = LinkCache::singleton();
2420 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2422 if ( $newid === false ) {
2423 $this->mArticleID = -1;
2424 } else {
2425 $this->mArticleID = intval( $newid );
2427 $this->mRestrictionsLoaded = false;
2428 $this->mRestrictions = array();
2429 $this->mRedirect = null;
2430 $this->mLength = -1;
2431 $this->mLatestID = false;
2435 * Updates page_touched for this page; called from LinksUpdate.php
2437 * @return \type{\bool} true if the update succeded
2439 public function invalidateCache() {
2440 if ( wfReadOnly() ) {
2441 return;
2443 $dbw = wfGetDB( DB_MASTER );
2444 $success = $dbw->update(
2445 'page',
2446 array( 'page_touched' => $dbw->timestamp() ),
2447 $this->pageCond(),
2448 __METHOD__
2450 HTMLFileCache::clearFileCache( $this );
2451 return $success;
2455 * Prefix some arbitrary text with the namespace or interwiki prefix
2456 * of this object
2458 * @param $name \type{\string} the text
2459 * @return \type{\string} the prefixed text
2460 * @private
2462 /* private */ function prefix( $name ) {
2463 $p = '';
2464 if ( $this->mInterwiki != '' ) {
2465 $p = $this->mInterwiki . ':';
2467 if ( 0 != $this->mNamespace ) {
2468 $p .= $this->getNsText() . ':';
2470 return $p . $name;
2474 * Returns a simple regex that will match on characters and sequences invalid in titles.
2475 * Note that this doesn't pick up many things that could be wrong with titles, but that
2476 * replacing this regex with something valid will make many titles valid.
2478 * @return string regex string
2480 static function getTitleInvalidRegex() {
2481 static $rxTc = false;
2482 if ( !$rxTc ) {
2483 # Matching titles will be held as illegal.
2484 $rxTc = '/' .
2485 # Any character not allowed is forbidden...
2486 '[^' . Title::legalChars() . ']' .
2487 # URL percent encoding sequences interfere with the ability
2488 # to round-trip titles -- you can't link to them consistently.
2489 '|%[0-9A-Fa-f]{2}' .
2490 # XML/HTML character references produce similar issues.
2491 '|&[A-Za-z0-9\x80-\xff]+;' .
2492 '|&#[0-9]+;' .
2493 '|&#x[0-9A-Fa-f]+;' .
2494 '/S';
2497 return $rxTc;
2501 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2503 * @param $text string containing title to capitalize
2504 * @param $ns int namespace index, defaults to NS_MAIN
2505 * @return String containing capitalized title
2507 public static function capitalize( $text, $ns = NS_MAIN ) {
2508 global $wgContLang;
2510 if ( MWNamespace::isCapitalized( $ns ) ) {
2511 return $wgContLang->ucfirst( $text );
2512 } else {
2513 return $text;
2518 * Secure and split - main initialisation function for this object
2520 * Assumes that mDbkeyform has been set, and is urldecoded
2521 * and uses underscores, but not otherwise munged. This function
2522 * removes illegal characters, splits off the interwiki and
2523 * namespace prefixes, sets the other forms, and canonicalizes
2524 * everything.
2526 * @return \type{\bool} true on success
2528 private function secureAndSplit() {
2529 global $wgContLang, $wgLocalInterwiki;
2531 # Initialisation
2532 $rxTc = self::getTitleInvalidRegex();
2534 $this->mInterwiki = $this->mFragment = '';
2535 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
2537 $dbkey = $this->mDbkeyform;
2539 # Strip Unicode bidi override characters.
2540 # Sometimes they slip into cut-n-pasted page titles, where the
2541 # override chars get included in list displays.
2542 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2544 # Clean up whitespace
2545 # Note: use of the /u option on preg_replace here will cause
2546 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2547 # conveniently disabling them.
2549 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2550 $dbkey = trim( $dbkey, '_' );
2552 if ( $dbkey == '' ) {
2553 return false;
2556 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
2557 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2558 return false;
2561 $this->mDbkeyform = $dbkey;
2563 # Initial colon indicates main namespace rather than specified default
2564 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2565 if ( ':' == $dbkey { 0 } ) {
2566 $this->mNamespace = NS_MAIN;
2567 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2568 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2571 # Namespace or interwiki prefix
2572 $firstPass = true;
2573 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2574 do {
2575 $m = array();
2576 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2577 $p = $m[1];
2578 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
2579 # Ordinary namespace
2580 $dbkey = $m[2];
2581 $this->mNamespace = $ns;
2582 # For Talk:X pages, check if X has a "namespace" prefix
2583 if ( $ns == NS_TALK && preg_match( $prefixRegexp, $dbkey, $x ) ) {
2584 if ( $wgContLang->getNsIndex( $x[1] ) ) {
2585 return false; # Disallow Talk:File:x type titles...
2586 } else if ( Interwiki::isValidInterwiki( $x[1] ) ) {
2587 return false; # Disallow Talk:Interwiki:x type titles...
2590 } elseif ( Interwiki::isValidInterwiki( $p ) ) {
2591 if ( !$firstPass ) {
2592 # Can't make a local interwiki link to an interwiki link.
2593 # That's just crazy!
2594 return false;
2597 # Interwiki link
2598 $dbkey = $m[2];
2599 $this->mInterwiki = $wgContLang->lc( $p );
2601 # Redundant interwiki prefix to the local wiki
2602 if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
2603 if ( $dbkey == '' ) {
2604 # Can't have an empty self-link
2605 return false;
2607 $this->mInterwiki = '';
2608 $firstPass = false;
2609 # Do another namespace split...
2610 continue;
2613 # If there's an initial colon after the interwiki, that also
2614 # resets the default namespace
2615 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2616 $this->mNamespace = NS_MAIN;
2617 $dbkey = substr( $dbkey, 1 );
2620 # If there's no recognized interwiki or namespace,
2621 # then let the colon expression be part of the title.
2623 break;
2624 } while ( true );
2626 # We already know that some pages won't be in the database!
2628 if ( $this->mInterwiki != '' || NS_SPECIAL == $this->mNamespace ) {
2629 $this->mArticleID = 0;
2631 $fragment = strstr( $dbkey, '#' );
2632 if ( false !== $fragment ) {
2633 $this->setFragment( preg_replace( '/^#_*/', '#', $fragment ) );
2634 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2635 # remove whitespace again: prevents "Foo_bar_#"
2636 # becoming "Foo_bar_"
2637 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2640 # Reject illegal characters.
2642 if ( preg_match( $rxTc, $dbkey ) ) {
2643 return false;
2647 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2648 * reachable due to the way web browsers deal with 'relative' URLs.
2649 * Also, they conflict with subpage syntax. Forbid them explicitly.
2651 if ( strpos( $dbkey, '.' ) !== false &&
2652 ( $dbkey === '.' || $dbkey === '..' ||
2653 strpos( $dbkey, './' ) === 0 ||
2654 strpos( $dbkey, '../' ) === 0 ||
2655 strpos( $dbkey, '/./' ) !== false ||
2656 strpos( $dbkey, '/../' ) !== false ||
2657 substr( $dbkey, -2 ) == '/.' ||
2658 substr( $dbkey, -3 ) == '/..' ) )
2660 return false;
2664 * Magic tilde sequences? Nu-uh!
2666 if ( strpos( $dbkey, '~~~' ) !== false ) {
2667 return false;
2671 * Limit the size of titles to 255 bytes.
2672 * This is typically the size of the underlying database field.
2673 * We make an exception for special pages, which don't need to be stored
2674 * in the database, and may edge over 255 bytes due to subpage syntax
2675 * for long titles, e.g. [[Special:Block/Long name]]
2677 if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) ||
2678 strlen( $dbkey ) > 512 )
2680 return false;
2684 * Normally, all wiki links are forced to have
2685 * an initial capital letter so [[foo]] and [[Foo]]
2686 * point to the same place.
2688 * Don't force it for interwikis, since the other
2689 * site might be case-sensitive.
2691 $this->mUserCaseDBKey = $dbkey;
2692 if ( $this->mInterwiki == '' ) {
2693 $dbkey = self::capitalize( $dbkey, $this->mNamespace );
2697 * Can't make a link to a namespace alone...
2698 * "empty" local links can only be self-links
2699 * with a fragment identifier.
2701 if ( $dbkey == '' &&
2702 $this->mInterwiki == '' &&
2703 $this->mNamespace != NS_MAIN ) {
2704 return false;
2706 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2707 // IP names are not allowed for accounts, and can only be referring to
2708 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2709 // there are numerous ways to present the same IP. Having sp:contribs scan
2710 // them all is silly and having some show the edits and others not is
2711 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2712 $dbkey = ( $this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK ) ?
2713 IP::sanitizeIP( $dbkey ) : $dbkey;
2714 // Any remaining initial :s are illegal.
2715 if ( $dbkey !== '' && ':' == $dbkey { 0 } ) {
2716 return false;
2719 # Fill fields
2720 $this->mDbkeyform = $dbkey;
2721 $this->mUrlform = wfUrlencode( $dbkey );
2723 $this->mTextform = str_replace( '_', ' ', $dbkey );
2725 return true;
2729 * Set the fragment for this title. Removes the first character from the
2730 * specified fragment before setting, so it assumes you're passing it with
2731 * an initial "#".
2733 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2734 * Still in active use privately.
2736 * @param $fragment \type{\string} text
2738 public function setFragment( $fragment ) {
2739 $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
2743 * Get a Title object associated with the talk page of this article
2745 * @return \type{Title} the object for the talk page
2747 public function getTalkPage() {
2748 return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
2752 * Get a title object associated with the subject page of this
2753 * talk page
2755 * @return \type{Title} the object for the subject page
2757 public function getSubjectPage() {
2758 // Is this the same title?
2759 $subjectNS = MWNamespace::getSubject( $this->getNamespace() );
2760 if ( $this->getNamespace() == $subjectNS ) {
2761 return $this;
2763 return Title::makeTitle( $subjectNS, $this->getDBkey() );
2767 * Get an array of Title objects linking to this Title
2768 * Also stores the IDs in the link cache.
2770 * WARNING: do not use this function on arbitrary user-supplied titles!
2771 * On heavily-used templates it will max out the memory.
2773 * @param $options Array: may be FOR UPDATE
2774 * @param $table String: table name
2775 * @param $prefix String: fields prefix
2776 * @return \type{\arrayof{Title}} the Title objects linking here
2778 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
2779 $linkCache = LinkCache::singleton();
2781 if ( count( $options ) > 0 ) {
2782 $db = wfGetDB( DB_MASTER );
2783 } else {
2784 $db = wfGetDB( DB_SLAVE );
2787 $res = $db->select(
2788 array( 'page', $table ),
2789 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
2790 array(
2791 "{$prefix}_from=page_id",
2792 "{$prefix}_namespace" => $this->getNamespace(),
2793 "{$prefix}_title" => $this->getDBkey() ),
2794 __METHOD__,
2795 $options
2798 $retVal = array();
2799 if ( $db->numRows( $res ) ) {
2800 foreach ( $res as $row ) {
2801 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
2802 $linkCache->addGoodLinkObj( $row->page_id, $titleObj, $row->page_len, $row->page_is_redirect, $row->page_latest );
2803 $retVal[] = $titleObj;
2807 $db->freeResult( $res );
2808 return $retVal;
2812 * Get an array of Title objects using this Title as a template
2813 * Also stores the IDs in the link cache.
2815 * WARNING: do not use this function on arbitrary user-supplied titles!
2816 * On heavily-used templates it will max out the memory.
2818 * @param $options Array: may be FOR UPDATE
2819 * @return \type{\arrayof{Title}} the Title objects linking here
2821 public function getTemplateLinksTo( $options = array() ) {
2822 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2826 * Get an array of Title objects referring to non-existent articles linked from this page
2828 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2829 * @return \type{\arrayof{Title}} the Title objects
2831 public function getBrokenLinksFrom() {
2832 if ( $this->getArticleId() == 0 ) {
2833 # All links from article ID 0 are false positives
2834 return array();
2837 $dbr = wfGetDB( DB_SLAVE );
2838 $res = $dbr->select(
2839 array( 'page', 'pagelinks' ),
2840 array( 'pl_namespace', 'pl_title' ),
2841 array(
2842 'pl_from' => $this->getArticleId(),
2843 'page_namespace IS NULL'
2845 __METHOD__, array(),
2846 array(
2847 'page' => array(
2848 'LEFT JOIN',
2849 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
2854 $retVal = array();
2855 foreach ( $res as $row ) {
2856 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
2858 return $retVal;
2863 * Get a list of URLs to purge from the Squid cache when this
2864 * page changes
2866 * @return \type{\arrayof{\string}} the URLs
2868 public function getSquidURLs() {
2869 global $wgContLang;
2871 $urls = array(
2872 $this->getInternalURL(),
2873 $this->getInternalURL( 'action=history' )
2876 // purge variant urls as well
2877 if ( $wgContLang->hasVariants() ) {
2878 $variants = $wgContLang->getVariants();
2879 foreach ( $variants as $vCode ) {
2880 $urls[] = $this->getInternalURL( '', $vCode );
2884 return $urls;
2888 * Purge all applicable Squid URLs
2890 public function purgeSquid() {
2891 global $wgUseSquid;
2892 if ( $wgUseSquid ) {
2893 $urls = $this->getSquidURLs();
2894 $u = new SquidUpdate( $urls );
2895 $u->doUpdate();
2900 * Move this page without authentication
2902 * @param $nt \type{Title} the new page Title
2903 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2905 public function moveNoAuth( &$nt ) {
2906 return $this->moveTo( $nt, false );
2910 * Check whether a given move operation would be valid.
2911 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2913 * @param $nt \type{Title} the new title
2914 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2915 * should be checked
2916 * @param $reason \type{\string} is the log summary of the move, used for spam checking
2917 * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure
2919 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2920 global $wgUser;
2922 $errors = array();
2923 if ( !$nt ) {
2924 // Normally we'd add this to $errors, but we'll get
2925 // lots of syntax errors if $nt is not an object
2926 return array( array( 'badtitletext' ) );
2928 if ( $this->equals( $nt ) ) {
2929 $errors[] = array( 'selfmove' );
2931 if ( !$this->isMovable() ) {
2932 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2934 if ( $nt->getInterwiki() != '' ) {
2935 $errors[] = array( 'immobile-target-namespace-iw' );
2937 if ( !$nt->isMovable() ) {
2938 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
2941 $oldid = $this->getArticleID();
2942 $newid = $nt->getArticleID();
2944 if ( strlen( $nt->getDBkey() ) < 1 ) {
2945 $errors[] = array( 'articleexists' );
2947 if ( ( $this->getDBkey() == '' ) ||
2948 ( !$oldid ) ||
2949 ( $nt->getDBkey() == '' ) ) {
2950 $errors[] = array( 'badarticleerror' );
2953 // Image-specific checks
2954 if ( $this->getNamespace() == NS_FILE ) {
2955 if ( $nt->getNamespace() != NS_FILE ) {
2956 $errors[] = array( 'imagenocrossnamespace' );
2958 $file = wfLocalFile( $this );
2959 if ( $file->exists() ) {
2960 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
2961 $errors[] = array( 'imageinvalidfilename' );
2963 if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
2964 $errors[] = array( 'imagetypemismatch' );
2967 $destfile = wfLocalFile( $nt );
2968 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destfile->exists() && wfFindFile( $nt ) ) {
2969 $errors[] = array( 'file-exists-sharedrepo' );
2973 if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) {
2974 $errors[] = array( 'nonfile-cannot-move-to-file' );
2977 if ( $auth ) {
2978 $errors = wfMergeErrorArrays( $errors,
2979 $this->getUserPermissionsErrors( 'move', $wgUser ),
2980 $this->getUserPermissionsErrors( 'edit', $wgUser ),
2981 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
2982 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
2985 $match = EditPage::matchSummarySpamRegex( $reason );
2986 if ( $match !== false ) {
2987 // This is kind of lame, won't display nice
2988 $errors[] = array( 'spamprotectiontext' );
2991 $err = null;
2992 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
2993 $errors[] = array( 'hookaborted', $err );
2996 # The move is allowed only if (1) the target doesn't exist, or
2997 # (2) the target is a redirect to the source, and has no history
2998 # (so we can undo bad moves right after they're done).
3000 if ( 0 != $newid ) { # Target exists; check for validity
3001 if ( !$this->isValidMoveTarget( $nt ) ) {
3002 $errors[] = array( 'articleexists' );
3004 } else {
3005 $tp = $nt->getTitleProtection();
3006 $right = ( $tp['pt_create_perm'] == 'sysop' ) ? 'protect' : $tp['pt_create_perm'];
3007 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3008 $errors[] = array( 'cantmove-titleprotected' );
3011 if ( empty( $errors ) ) {
3012 return true;
3014 return $errors;
3018 * Move a title to a new location
3020 * @param $nt \type{Title} the new title
3021 * @param $auth \type{\bool} indicates whether $wgUser's permissions
3022 * should be checked
3023 * @param $reason \type{\string} The reason for the move
3024 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title.
3025 * Ignored if the user doesn't have the suppressredirect right.
3026 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
3028 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3029 global $wgContLang;
3031 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3032 if ( is_array( $err ) ) {
3033 return $err;
3036 // If it is a file, move it first. It is done before all other moving stuff is done because it's hard to revert
3037 $dbw = wfGetDB( DB_MASTER );
3038 if ( $this->getNamespace() == NS_FILE ) {
3039 $file = wfLocalFile( $this );
3040 if ( $file->exists() ) {
3041 $status = $file->move( $nt );
3042 if ( !$status->isOk() ) {
3043 return $status->getErrorsArray();
3048 $pageid = $this->getArticleID();
3049 $protected = $this->isProtected();
3050 if ( $nt->exists() ) {
3051 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
3052 $pageCountChange = ( $createRedirect ? 0 : -1 );
3053 } else { # Target didn't exist, do normal move.
3054 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
3055 $pageCountChange = ( $createRedirect ? 1 : 0 );
3058 if ( is_array( $err ) ) {
3059 return $err;
3061 $redirid = $this->getArticleID();
3063 // Refresh the sortkey for this row. Be careful to avoid resetting
3064 // cl_timestamp, which may disturb time-based lists on some sites.
3065 $prefix = $dbw->selectField(
3066 'categorylinks',
3067 'cl_sortkey_prefix',
3068 array( 'cl_from' => $pageid ),
3069 __METHOD__
3071 $dbw->update( 'categorylinks',
3072 array(
3073 'cl_sortkey' => $wgContLang->convertToSortkey( $nt->getCategorySortkey( $prefix ) ),
3074 'cl_timestamp=cl_timestamp' ),
3075 array( 'cl_from' => $pageid ),
3076 __METHOD__ );
3078 if ( $protected ) {
3079 # Protect the redirect title as the title used to be...
3080 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3081 array(
3082 'pr_page' => $redirid,
3083 'pr_type' => 'pr_type',
3084 'pr_level' => 'pr_level',
3085 'pr_cascade' => 'pr_cascade',
3086 'pr_user' => 'pr_user',
3087 'pr_expiry' => 'pr_expiry'
3089 array( 'pr_page' => $pageid ),
3090 __METHOD__,
3091 array( 'IGNORE' )
3093 # Update the protection log
3094 $log = new LogPage( 'protect' );
3095 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3096 if ( $reason ) {
3097 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3099 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) ); // FIXME: $params?
3102 # Update watchlists
3103 $oldnamespace = $this->getNamespace() & ~1;
3104 $newnamespace = $nt->getNamespace() & ~1;
3105 $oldtitle = $this->getDBkey();
3106 $newtitle = $nt->getDBkey();
3108 if ( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
3109 WatchedItem::duplicateEntries( $this, $nt );
3112 # Update search engine
3113 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
3114 $u->doUpdate();
3115 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
3116 $u->doUpdate();
3118 # Update site_stats
3119 if ( $this->isContentPage() && !$nt->isContentPage() ) {
3120 # No longer a content page
3121 # Not viewed, edited, removing
3122 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
3123 } elseif ( !$this->isContentPage() && $nt->isContentPage() ) {
3124 # Now a content page
3125 # Not viewed, edited, adding
3126 $u = new SiteStatsUpdate( 0, 1, + 1, $pageCountChange );
3127 } elseif ( $pageCountChange ) {
3128 # Redirect added
3129 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
3130 } else {
3131 # Nothing special
3132 $u = false;
3134 if ( $u ) {
3135 $u->doUpdate();
3137 # Update message cache for interface messages
3138 global $wgMessageCache;
3139 if ( $this->getNamespace() == NS_MEDIAWIKI ) {
3140 # @bug 17860: old article can be deleted, if this the case,
3141 # delete it from message cache
3142 if ( $this->getArticleID() === 0 ) {
3143 $wgMessageCache->replace( $this->getDBkey(), false );
3144 } else {
3145 $oldarticle = new Article( $this );
3146 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
3149 if ( $nt->getNamespace() == NS_MEDIAWIKI ) {
3150 $newarticle = new Article( $nt );
3151 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
3154 global $wgUser;
3155 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3156 return true;
3160 * Move page to a title which is at present a redirect to the
3161 * source page
3163 * @param $nt \type{Title} the page to move to, which should currently
3164 * be a redirect
3165 * @param $reason \type{\string} The reason for the move
3166 * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title.
3167 * Ignored if the user doesn't have the suppressredirect right
3169 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
3170 global $wgUseSquid, $wgUser, $wgContLang;
3172 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
3174 if ( $reason ) {
3175 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3177 # Truncate for whole multibyte characters. +5 bytes for ellipsis
3178 $comment = $wgContLang->truncate( $comment, 250 );
3180 $now = wfTimestampNow();
3181 $newid = $nt->getArticleID();
3182 $oldid = $this->getArticleID();
3183 $latest = $this->getLatestRevID();
3185 $dbw = wfGetDB( DB_MASTER );
3187 $rcts = $dbw->timestamp( $nt->getEarliestRevTime() );
3188 $newns = $nt->getNamespace();
3189 $newdbk = $nt->getDBkey();
3191 # Delete the old redirect. We don't save it to history since
3192 # by definition if we've got here it's rather uninteresting.
3193 # We have to remove it so that the next step doesn't trigger
3194 # a conflict on the unique namespace+title index...
3195 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ );
3196 if ( !$dbw->cascadingDeletes() ) {
3197 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__ );
3198 global $wgUseTrackbacks;
3199 if ( $wgUseTrackbacks ) {
3200 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__ );
3202 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__ );
3203 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__ );
3204 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__ );
3205 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__ );
3206 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__ );
3207 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__ );
3208 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__ );
3210 // If the redirect was recently created, it may have an entry in recentchanges still
3211 $dbw->delete( 'recentchanges',
3212 array( 'rc_timestamp' => $rcts, 'rc_namespace' => $newns, 'rc_title' => $newdbk, 'rc_new' => 1 ),
3213 __METHOD__
3216 # Save a null revision in the page's history notifying of the move
3217 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
3218 $nullRevId = $nullRevision->insertOn( $dbw );
3220 $article = new Article( $this );
3221 wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) );
3223 # Change the name of the target page:
3224 $dbw->update( 'page',
3225 /* SET */ array(
3226 'page_touched' => $dbw->timestamp( $now ),
3227 'page_namespace' => $nt->getNamespace(),
3228 'page_title' => $nt->getDBkey(),
3229 'page_latest' => $nullRevId,
3231 /* WHERE */ array( 'page_id' => $oldid ),
3232 __METHOD__
3234 $nt->resetArticleID( $oldid );
3236 # Recreate the redirect, this time in the other direction.
3237 if ( $createRedirect || !$wgUser->isAllowed( 'suppressredirect' ) ) {
3238 $mwRedir = MagicWord::get( 'redirect' );
3239 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3240 $redirectArticle = new Article( $this );
3241 $newid = $redirectArticle->insertOn( $dbw );
3242 $redirectRevision = new Revision( array(
3243 'page' => $newid,
3244 'comment' => $comment,
3245 'text' => $redirectText ) );
3246 $redirectRevision->insertOn( $dbw );
3247 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3249 wfRunHooks( 'NewRevisionFromEditComplete', array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3251 # Now, we record the link from the redirect to the new title.
3252 # It should have no other outgoing links...
3253 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__ );
3254 $dbw->insert( 'pagelinks',
3255 array(
3256 'pl_from' => $newid,
3257 'pl_namespace' => $nt->getNamespace(),
3258 'pl_title' => $nt->getDBkey() ),
3259 __METHOD__ );
3260 $redirectSuppressed = false;
3261 } else {
3262 $this->resetArticleID( 0 );
3263 $redirectSuppressed = true;
3266 # Log the move
3267 $log = new LogPage( 'move' );
3268 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3270 # Purge squid
3271 if ( $wgUseSquid ) {
3272 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
3273 $u = new SquidUpdate( $urls );
3274 $u->doUpdate();
3280 * Move page to non-existing title.
3282 * @param $nt \type{Title} the new Title
3283 * @param $reason \type{\string} The reason for the move
3284 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title
3285 * Ignored if the user doesn't have the suppressredirect right
3287 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
3288 global $wgUser, $wgContLang;
3290 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3291 if ( $reason ) {
3292 $comment .= wfMsgExt( 'colon-separator',
3293 array( 'escapenoentities', 'content' ) );
3294 $comment .= $reason;
3296 # Truncate for whole multibyte characters. +5 bytes for ellipsis
3297 $comment = $wgContLang->truncate( $comment, 250 );
3299 $newid = $nt->getArticleID();
3300 $oldid = $this->getArticleID();
3301 $latest = $this->getLatestRevId();
3303 $dbw = wfGetDB( DB_MASTER );
3304 $now = $dbw->timestamp();
3306 # Save a null revision in the page's history notifying of the move
3307 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
3308 if ( !is_object( $nullRevision ) ) {
3309 throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
3311 $nullRevId = $nullRevision->insertOn( $dbw );
3313 $article = new Article( $this );
3314 wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) );
3316 # Rename page entry
3317 $dbw->update( 'page',
3318 /* SET */ array(
3319 'page_touched' => $now,
3320 'page_namespace' => $nt->getNamespace(),
3321 'page_title' => $nt->getDBkey(),
3322 'page_latest' => $nullRevId,
3324 /* WHERE */ array( 'page_id' => $oldid ),
3325 __METHOD__
3327 $nt->resetArticleID( $oldid );
3329 if ( $createRedirect || !$wgUser->isAllowed( 'suppressredirect' ) ) {
3330 # Insert redirect
3331 $mwRedir = MagicWord::get( 'redirect' );
3332 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3333 $redirectArticle = new Article( $this );
3334 $newid = $redirectArticle->insertOn( $dbw );
3335 $redirectRevision = new Revision( array(
3336 'page' => $newid,
3337 'comment' => $comment,
3338 'text' => $redirectText ) );
3339 $redirectRevision->insertOn( $dbw );
3340 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3342 wfRunHooks( 'NewRevisionFromEditComplete', array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3344 # Record the just-created redirect's linking to the page
3345 $dbw->insert( 'pagelinks',
3346 array(
3347 'pl_from' => $newid,
3348 'pl_namespace' => $nt->getNamespace(),
3349 'pl_title' => $nt->getDBkey() ),
3350 __METHOD__ );
3351 $redirectSuppressed = false;
3352 } else {
3353 $this->resetArticleID( 0 );
3354 $redirectSuppressed = true;
3357 # Log the move
3358 $log = new LogPage( 'move' );
3359 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3361 # Purge caches as per article creation
3362 Article::onArticleCreate( $nt );
3364 # Purge old title from squid
3365 # The new title, and links to the new title, are purged in Article::onArticleCreate()
3366 $this->purgeSquid();
3370 * Move this page's subpages to be subpages of $nt
3372 * @param $nt Title Move target
3373 * @param $auth bool Whether $wgUser's permissions should be checked
3374 * @param $reason string The reason for the move
3375 * @param $createRedirect bool Whether to create redirects from the old subpages to the new ones
3376 * Ignored if the user doesn't have the 'suppressredirect' right
3377 * @return mixed array with old page titles as keys, and strings (new page titles) or
3378 * arrays (errors) as values, or an error array with numeric indices if no pages were moved
3380 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3381 global $wgMaximumMovedPages;
3382 // Check permissions
3383 if ( !$this->userCan( 'move-subpages' ) ) {
3384 return array( 'cant-move-subpages' );
3386 // Do the source and target namespaces support subpages?
3387 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
3388 return array( 'namespace-nosubpages',
3389 MWNamespace::getCanonicalName( $this->getNamespace() ) );
3391 if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) {
3392 return array( 'namespace-nosubpages',
3393 MWNamespace::getCanonicalName( $nt->getNamespace() ) );
3396 $subpages = $this->getSubpages( $wgMaximumMovedPages + 1 );
3397 $retval = array();
3398 $count = 0;
3399 foreach ( $subpages as $oldSubpage ) {
3400 $count++;
3401 if ( $count > $wgMaximumMovedPages ) {
3402 $retval[$oldSubpage->getPrefixedTitle()] =
3403 array( 'movepage-max-pages',
3404 $wgMaximumMovedPages );
3405 break;
3408 // We don't know whether this function was called before
3409 // or after moving the root page, so check both
3410 // $this and $nt
3411 if ( $oldSubpage->getArticleId() == $this->getArticleId() ||
3412 $oldSubpage->getArticleID() == $nt->getArticleId() )
3414 // When moving a page to a subpage of itself,
3415 // don't move it twice
3416 continue;
3418 $newPageName = preg_replace(
3419 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3420 StringUtils::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3421 $oldSubpage->getDBkey() );
3422 if ( $oldSubpage->isTalkPage() ) {
3423 $newNs = $nt->getTalkPage()->getNamespace();
3424 } else {
3425 $newNs = $nt->getSubjectPage()->getNamespace();
3427 # Bug 14385: we need makeTitleSafe because the new page names may
3428 # be longer than 255 characters.
3429 $newSubpage = Title::makeTitleSafe( $newNs, $newPageName );
3431 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3432 if ( $success === true ) {
3433 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3434 } else {
3435 $retval[$oldSubpage->getPrefixedText()] = $success;
3438 return $retval;
3442 * Checks if this page is just a one-rev redirect.
3443 * Adds lock, so don't use just for light purposes.
3445 * @return \type{\bool}
3447 public function isSingleRevRedirect() {
3448 $dbw = wfGetDB( DB_MASTER );
3449 # Is it a redirect?
3450 $row = $dbw->selectRow( 'page',
3451 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3452 $this->pageCond(),
3453 __METHOD__,
3454 array( 'FOR UPDATE' )
3456 # Cache some fields we may want
3457 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
3458 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
3459 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
3460 if ( !$this->mRedirect ) {
3461 return false;
3463 # Does the article have a history?
3464 $row = $dbw->selectField( array( 'page', 'revision' ),
3465 'rev_id',
3466 array( 'page_namespace' => $this->getNamespace(),
3467 'page_title' => $this->getDBkey(),
3468 'page_id=rev_page',
3469 'page_latest != rev_id'
3471 __METHOD__,
3472 array( 'FOR UPDATE' )
3474 # Return true if there was no history
3475 return ( $row === false );
3479 * Checks if $this can be moved to a given Title
3480 * - Selects for update, so don't call it unless you mean business
3482 * @param $nt \type{Title} the new title to check
3483 * @return \type{\bool} TRUE or FALSE
3485 public function isValidMoveTarget( $nt ) {
3486 # Is it an existing file?
3487 if ( $nt->getNamespace() == NS_FILE ) {
3488 $file = wfLocalFile( $nt );
3489 if ( $file->exists() ) {
3490 wfDebug( __METHOD__ . ": file exists\n" );
3491 return false;
3494 # Is it a redirect with no history?
3495 if ( !$nt->isSingleRevRedirect() ) {
3496 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
3497 return false;
3499 # Get the article text
3500 $rev = Revision::newFromTitle( $nt );
3501 $text = $rev->getText();
3502 # Does the redirect point to the source?
3503 # Or is it a broken self-redirect, usually caused by namespace collisions?
3504 $m = array();
3505 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3506 $redirTitle = Title::newFromText( $m[1] );
3507 if ( !is_object( $redirTitle ) ||
3508 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3509 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3510 wfDebug( __METHOD__ . ": redirect points to other page\n" );
3511 return false;
3513 } else {
3514 # Fail safe
3515 wfDebug( __METHOD__ . ": failsafe\n" );
3516 return false;
3518 return true;
3522 * Can this title be added to a user's watchlist?
3524 * @return \type{\bool} TRUE or FALSE
3526 public function isWatchable() {
3527 return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() );
3531 * Get categories to which this Title belongs and return an array of
3532 * categories' names.
3534 * @return \type{\array} array an array of parents in the form:
3535 * $parent => $currentarticle
3537 public function getParentCategories() {
3538 global $wgContLang;
3540 $titlekey = $this->getArticleId();
3541 $dbr = wfGetDB( DB_SLAVE );
3542 $categorylinks = $dbr->tableName( 'categorylinks' );
3544 # NEW SQL
3545 $sql = "SELECT * FROM $categorylinks"
3546 . " WHERE cl_from='$titlekey'"
3547 . " AND cl_from <> '0'"
3548 . " ORDER BY cl_sortkey";
3550 $res = $dbr->query( $sql );
3552 if ( $dbr->numRows( $res ) > 0 ) {
3553 foreach ( $res as $row )
3554 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3555 $data[$wgContLang->getNSText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText();
3556 $dbr->freeResult( $res );
3557 } else {
3558 $data = array();
3560 return $data;
3564 * Get a tree of parent categories
3566 * @param $children \type{\array} an array with the children in the keys, to check for circular refs
3567 * @return \type{\array} Tree of parent categories
3569 public function getParentCategoryTree( $children = array() ) {
3570 $stack = array();
3571 $parents = $this->getParentCategories();
3573 if ( $parents ) {
3574 foreach ( $parents as $parent => $current ) {
3575 if ( array_key_exists( $parent, $children ) ) {
3576 # Circular reference
3577 $stack[$parent] = array();
3578 } else {
3579 $nt = Title::newFromText( $parent );
3580 if ( $nt ) {
3581 $stack[$parent] = $nt->getParentCategoryTree( $children + array( $parent => 1 ) );
3585 return $stack;
3586 } else {
3587 return array();
3593 * Get an associative array for selecting this title from
3594 * the "page" table
3596 * @return \type{\array} Selection array
3598 public function pageCond() {
3599 if ( $this->mArticleID > 0 ) {
3600 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3601 return array( 'page_id' => $this->mArticleID );
3602 } else {
3603 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
3608 * Get the revision ID of the previous revision
3610 * @param $revId \type{\int} Revision ID. Get the revision that was before this one.
3611 * @param $flags \type{\int} GAID_FOR_UPDATE
3612 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3614 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3615 $db = ( $flags & GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3616 return $db->selectField( 'revision', 'rev_id',
3617 array(
3618 'rev_page' => $this->getArticleId( $flags ),
3619 'rev_id < ' . intval( $revId )
3621 __METHOD__,
3622 array( 'ORDER BY' => 'rev_id DESC' )
3627 * Get the revision ID of the next revision
3629 * @param $revId \type{\int} Revision ID. Get the revision that was after this one.
3630 * @param $flags \type{\int} GAID_FOR_UPDATE
3631 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3633 public function getNextRevisionID( $revId, $flags = 0 ) {
3634 $db = ( $flags & GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3635 return $db->selectField( 'revision', 'rev_id',
3636 array(
3637 'rev_page' => $this->getArticleId( $flags ),
3638 'rev_id > ' . intval( $revId )
3640 __METHOD__,
3641 array( 'ORDER BY' => 'rev_id' )
3646 * Get the first revision of the page
3648 * @param $flags \type{\int} GAID_FOR_UPDATE
3649 * @return Revision (or NULL if page doesn't exist)
3651 public function getFirstRevision( $flags = 0 ) {
3652 $db = ( $flags & GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3653 $pageId = $this->getArticleId( $flags );
3654 if ( !$pageId ) {
3655 return null;
3657 $row = $db->selectRow( 'revision', '*',
3658 array( 'rev_page' => $pageId ),
3659 __METHOD__,
3660 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3662 if ( !$row ) {
3663 return null;
3664 } else {
3665 return new Revision( $row );
3670 * Check if this is a new page
3672 * @return bool
3674 public function isNewPage() {
3675 $dbr = wfGetDB( DB_SLAVE );
3676 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
3680 * Get the oldest revision timestamp of this page
3682 * @return String: MW timestamp
3684 public function getEarliestRevTime() {
3685 $dbr = wfGetDB( DB_SLAVE );
3686 if ( $this->exists() ) {
3687 $min = $dbr->selectField( 'revision',
3688 'MIN(rev_timestamp)',
3689 array( 'rev_page' => $this->getArticleId() ),
3690 __METHOD__ );
3691 return wfTimestampOrNull( TS_MW, $min );
3693 return null;
3697 * Get the number of revisions between the given revision IDs.
3698 * Used for diffs and other things that really need it.
3700 * @param $old \type{\int} Revision ID.
3701 * @param $new \type{\int} Revision ID.
3702 * @return \type{\int} Number of revisions between these IDs.
3704 public function countRevisionsBetween( $old, $new ) {
3705 $dbr = wfGetDB( DB_SLAVE );
3706 return (int)$dbr->selectField( 'revision', 'count(*)',
3707 'rev_page = ' . intval( $this->getArticleId() ) .
3708 ' AND rev_id > ' . intval( $old ) .
3709 ' AND rev_id < ' . intval( $new ),
3710 __METHOD__
3715 * Compare with another title.
3717 * @param $title \type{Title}
3718 * @return \type{\bool} TRUE or FALSE
3720 public function equals( Title $title ) {
3721 // Note: === is necessary for proper matching of number-like titles.
3722 return $this->getInterwiki() === $title->getInterwiki()
3723 && $this->getNamespace() == $title->getNamespace()
3724 && $this->getDBkey() === $title->getDBkey();
3728 * Callback for usort() to do title sorts by (namespace, title)
3730 * @return Integer: result of string comparison, or namespace comparison
3732 public static function compare( $a, $b ) {
3733 if ( $a->getNamespace() == $b->getNamespace() ) {
3734 return strcmp( $a->getText(), $b->getText() );
3735 } else {
3736 return $a->getNamespace() - $b->getNamespace();
3741 * Return a string representation of this title
3743 * @return \type{\string} String representation of this title
3745 public function __toString() {
3746 return $this->getPrefixedText();
3750 * Check if page exists. For historical reasons, this function simply
3751 * checks for the existence of the title in the page table, and will
3752 * thus return false for interwiki links, special pages and the like.
3753 * If you want to know if a title can be meaningfully viewed, you should
3754 * probably call the isKnown() method instead.
3756 * @return \type{\bool}
3758 public function exists() {
3759 return $this->getArticleId() != 0;
3763 * Should links to this title be shown as potentially viewable (i.e. as
3764 * "bluelinks"), even if there's no record by this title in the page
3765 * table?
3767 * This function is semi-deprecated for public use, as well as somewhat
3768 * misleadingly named. You probably just want to call isKnown(), which
3769 * calls this function internally.
3771 * (ISSUE: Most of these checks are cheap, but the file existence check
3772 * can potentially be quite expensive. Including it here fixes a lot of
3773 * existing code, but we might want to add an optional parameter to skip
3774 * it and any other expensive checks.)
3776 * @return \type{\bool}
3778 public function isAlwaysKnown() {
3779 if ( $this->mInterwiki != '' ) {
3780 return true; // any interwiki link might be viewable, for all we know
3782 switch( $this->mNamespace ) {
3783 case NS_MEDIA:
3784 case NS_FILE:
3785 return (bool)wfFindFile( $this ); // file exists, possibly in a foreign repo
3786 case NS_SPECIAL:
3787 return SpecialPage::exists( $this->getDBkey() ); // valid special page
3788 case NS_MAIN:
3789 return $this->mDbkeyform == ''; // selflink, possibly with fragment
3790 case NS_MEDIAWIKI:
3791 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3792 // the full l10n of that language to be loaded. That takes much memory and
3793 // isn't needed. So we strip the language part away.
3794 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform, 2 );
3795 return (bool)wfMsgWeirdKey( $basename ); // known system message
3796 default:
3797 return false;
3802 * Does this title refer to a page that can (or might) be meaningfully
3803 * viewed? In particular, this function may be used to determine if
3804 * links to the title should be rendered as "bluelinks" (as opposed to
3805 * "redlinks" to non-existent pages).
3807 * @return \type{\bool}
3809 public function isKnown() {
3810 return $this->exists() || $this->isAlwaysKnown();
3814 * Does this page have source text?
3816 * @return Boolean
3818 public function hasSourceText() {
3819 if ( $this->exists() ) {
3820 return true;
3823 if ( $this->mNamespace == NS_MEDIAWIKI ) {
3824 // If the page doesn't exist but is a known system message, default
3825 // message content will be displayed, same for language subpages
3826 // Also, if the page is form Mediawiki:message/lang, calling wfMsgWeirdKey
3827 // causes the full l10n of that language to be loaded. That takes much
3828 // memory and isn't needed. So we strip the language part away.
3829 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform, 2 );
3830 return (bool)wfMsgWeirdKey( $basename );
3833 return false;
3837 * Is this in a namespace that allows actual pages?
3839 * @return \type{\bool}
3840 * @internal note -- uses hardcoded namespace index instead of constants
3842 public function canExist() {
3843 return $this->mNamespace >= 0 && $this->mNamespace != NS_MEDIA;
3847 * Update page_touched timestamps and send squid purge messages for
3848 * pages linking to this title. May be sent to the job queue depending
3849 * on the number of links. Typically called on create and delete.
3851 public function touchLinks() {
3852 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3853 $u->doUpdate();
3855 if ( $this->getNamespace() == NS_CATEGORY ) {
3856 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3857 $u->doUpdate();
3862 * Get the last touched timestamp
3864 * @param $db DatabaseBase: optional db
3865 * @return \type{\string} Last touched timestamp
3867 public function getTouched( $db = null ) {
3868 $db = isset( $db ) ? $db : wfGetDB( DB_SLAVE );
3869 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
3870 return $touched;
3874 * Get the timestamp when this page was updated since the user last saw it.
3876 * @param $user User
3877 * @return Mixed: string/null
3879 public function getNotificationTimestamp( $user = null ) {
3880 global $wgUser, $wgShowUpdatedMarker;
3881 // Assume current user if none given
3882 if ( !$user ) {
3883 $user = $wgUser;
3885 // Check cache first
3886 $uid = $user->getId();
3887 if ( isset( $this->mNotificationTimestamp[$uid] ) ) {
3888 return $this->mNotificationTimestamp[$uid];
3890 if ( !$uid || !$wgShowUpdatedMarker ) {
3891 return $this->mNotificationTimestamp[$uid] = false;
3893 // Don't cache too much!
3894 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
3895 $this->mNotificationTimestamp = array();
3897 $dbr = wfGetDB( DB_SLAVE );
3898 $this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
3899 'wl_notificationtimestamp',
3900 array( 'wl_namespace' => $this->getNamespace(),
3901 'wl_title' => $this->getDBkey(),
3902 'wl_user' => $user->getId()
3904 __METHOD__
3906 return $this->mNotificationTimestamp[$uid];
3910 * Get the trackback URL for this page
3912 * @return \type{\string} Trackback URL
3914 public function trackbackURL() {
3915 global $wgScriptPath, $wgServer, $wgScriptExtension;
3917 return "$wgServer$wgScriptPath/trackback$wgScriptExtension?article="
3918 . htmlspecialchars( urlencode( $this->getPrefixedDBkey() ) );
3922 * Get the trackback RDF for this page
3924 * @return \type{\string} Trackback RDF
3926 public function trackbackRDF() {
3927 $url = htmlspecialchars( $this->getFullURL() );
3928 $title = htmlspecialchars( $this->getText() );
3929 $tburl = $this->trackbackURL();
3931 // Autodiscovery RDF is placed in comments so HTML validator
3932 // won't barf. This is a rather icky workaround, but seems
3933 // frequently used by this kind of RDF thingy.
3935 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3936 return "<!--
3937 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3938 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3939 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3940 <rdf:Description
3941 rdf:about=\"$url\"
3942 dc:identifier=\"$url\"
3943 dc:title=\"$title\"
3944 trackback:ping=\"$tburl\" />
3945 </rdf:RDF>
3946 -->";
3950 * Generate strings used for xml 'id' names in monobook tabs
3952 * @param $prepend string defaults to 'nstab-'
3953 * @return \type{\string} XML 'id' name
3955 public function getNamespaceKey( $prepend = 'nstab-' ) {
3956 global $wgContLang;
3957 // Gets the subject namespace if this title
3958 $namespace = MWNamespace::getSubject( $this->getNamespace() );
3959 // Checks if cononical namespace name exists for namespace
3960 if ( MWNamespace::exists( $this->getNamespace() ) ) {
3961 // Uses canonical namespace name
3962 $namespaceKey = MWNamespace::getCanonicalName( $namespace );
3963 } else {
3964 // Uses text of namespace
3965 $namespaceKey = $this->getSubjectNsText();
3967 // Makes namespace key lowercase
3968 $namespaceKey = $wgContLang->lc( $namespaceKey );
3969 // Uses main
3970 if ( $namespaceKey == '' ) {
3971 $namespaceKey = 'main';
3973 // Changes file to image for backwards compatibility
3974 if ( $namespaceKey == 'file' ) {
3975 $namespaceKey = 'image';
3977 return $prepend . $namespaceKey;
3981 * Returns true if this is a special page.
3983 * @return boolean
3985 public function isSpecialPage() {
3986 return $this->getNamespace() == NS_SPECIAL;
3990 * Returns true if this title resolves to the named special page
3992 * @param $name \type{\string} The special page name
3993 * @return boolean
3995 public function isSpecial( $name ) {
3996 if ( $this->getNamespace() == NS_SPECIAL ) {
3997 list( $thisName, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $this->getDBkey() );
3998 if ( $name == $thisName ) {
3999 return true;
4002 return false;
4006 * If the Title refers to a special page alias which is not the local default,
4008 * @return \type{Title} A new Title which points to the local default.
4009 * Otherwise, returns $this.
4011 public function fixSpecialName() {
4012 if ( $this->getNamespace() == NS_SPECIAL ) {
4013 $canonicalName = SpecialPage::resolveAlias( $this->mDbkeyform );
4014 if ( $canonicalName ) {
4015 $localName = SpecialPage::getLocalNameFor( $canonicalName );
4016 if ( $localName != $this->mDbkeyform ) {
4017 return Title::makeTitle( NS_SPECIAL, $localName );
4021 return $this;
4025 * Is this Title in a namespace which contains content?
4026 * In other words, is this a content page, for the purposes of calculating
4027 * statistics, etc?
4029 * @return \type{\bool}
4031 public function isContentPage() {
4032 return MWNamespace::isContent( $this->getNamespace() );
4036 * Get all extant redirects to this Title
4038 * @param $ns \twotypes{\int,\null} Single namespace to consider;
4039 * NULL to consider all namespaces
4040 * @return \type{\arrayof{Title}} Redirects to this title
4042 public function getRedirectsHere( $ns = null ) {
4043 $redirs = array();
4045 $dbr = wfGetDB( DB_SLAVE );
4046 $where = array(
4047 'rd_namespace' => $this->getNamespace(),
4048 'rd_title' => $this->getDBkey(),
4049 'rd_from = page_id'
4051 if ( !is_null( $ns ) ) {
4052 $where['page_namespace'] = $ns;
4055 $res = $dbr->select(
4056 array( 'redirect', 'page' ),
4057 array( 'page_namespace', 'page_title' ),
4058 $where,
4059 __METHOD__
4063 foreach ( $res as $row ) {
4064 $redirs[] = self::newFromRow( $row );
4066 return $redirs;
4070 * Check if this Title is a valid redirect target
4072 * @return \type{\bool}
4074 public function isValidRedirectTarget() {
4075 global $wgInvalidRedirectTargets;
4077 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4078 if ( $this->isSpecial( 'Userlogout' ) ) {
4079 return false;
4082 foreach ( $wgInvalidRedirectTargets as $target ) {
4083 if ( $this->isSpecial( $target ) ) {
4084 return false;
4088 return true;
4092 * Get a backlink cache object
4094 * @return object BacklinkCache
4096 function getBacklinkCache() {
4097 if ( is_null( $this->mBacklinkCache ) ) {
4098 $this->mBacklinkCache = new BacklinkCache( $this );
4100 return $this->mBacklinkCache;
4104 * Whether the magic words __INDEX__ and __NOINDEX__ function for
4105 * this page.
4107 * @return Boolean
4109 public function canUseNoindex() {
4110 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4112 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4113 ? $wgContentNamespaces
4114 : $wgExemptFromUserRobotsControl;
4116 return !in_array( $this->mNamespace, $bannedNamespaces );
4121 * Returns restriction types for the current Title
4123 * @return array applicable restriction types
4125 public function getRestrictionTypes() {
4126 global $wgRestrictionTypes;
4127 $types = $this->exists() ? $wgRestrictionTypes : array( 'create' );
4129 if ( $this->getNamespace() == NS_FILE ) {
4130 $types[] = 'upload';
4133 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
4135 return $types;
4139 * Returns the raw sort key to be used for categories, with the specified
4140 * prefix. This will be fed to Language::convertToSortkey() to get a
4141 * binary sortkey that can be used for actual sorting.
4143 * @param $prefix string The prefix to be used, specified using
4144 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4145 * prefix.
4146 * @return string
4148 public function getCategorySortkey( $prefix = '' ) {
4149 $unprefixed = $this->getText();
4150 if ( $prefix !== '' ) {
4151 # Separate with a null byte, so the unprefixed part is only used as
4152 # a tiebreaker when two pages have the exact same prefix -- null
4153 # sorts before everything else (hopefully).
4154 return "$prefix\0$unprefixed";
4156 return $unprefixed;