More reversion of r77297, 1 of 2 commits to keep it readable in CR (hopefully)
[mediawiki.git] / includes / Title.php
blob5b90cfeb93217784a0422ddced533efa088fc4b4
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 /**
17 * @deprecated This used to be a define, but was moved to
18 * Title::GAID_FOR_UPDATE in 1.17. This will probably be removed in 1.18
20 define( 'GAID_FOR_UPDATE', Title::GAID_FOR_UPDATE );
22 /**
23 * Represents a title within MediaWiki.
24 * Optionally may contain an interwiki designation or namespace.
25 * @note This class can fetch various kinds of data from the database;
26 * however, it does so inefficiently.
28 * @internal documentation reviewed 15 Mar 2010
30 class Title {
31 /** @name Static cache variables */
32 // @{
33 static private $titleCache = array();
34 // @}
36 /**
37 * Title::newFromText maintains a cache to avoid expensive re-normalization of
38 * commonly used titles. On a batch operation this can become a memory leak
39 * if not bounded. After hitting this many titles reset the cache.
41 const CACHE_MAX = 1000;
43 /**
44 * Used to be GAID_FOR_UPDATE define. Used with getArticleId() and friends
45 * to use the master DB
47 const GAID_FOR_UPDATE = 1;
50 /**
51 * @name Private member variables
52 * Please use the accessor functions instead.
53 * @private
55 // @{
57 var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
58 var $mUrlform = ''; // /< URL-encoded form of the main part
59 var $mDbkeyform = ''; // /< Main part with underscores
60 var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
61 var $mNamespace = NS_MAIN; // /< Namespace index, i.e. one of the NS_xxxx constants
62 var $mInterwiki = ''; // /< Interwiki prefix (or null string)
63 var $mFragment; // /< Title fragment (i.e. the bit after the #)
64 var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
65 var $mLatestID = false; // /< ID of most recent revision
66 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
67 var $mOldRestrictions = false;
68 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
69 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
70 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
71 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
72 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
73 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
74 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
75 var $mTitleProtection; ///< Cached value of getTitleProtection
76 # Don't change the following default, NS_MAIN is hardcoded in several
77 # places. See bug 696.
78 var $mDefaultNamespace = NS_MAIN; // /< Namespace index when there is no namespace
79 # Zero except in {{transclusion}} tags
80 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
81 var $mLength = -1; // /< The page length, 0 for special pages
82 var $mRedirect = null; // /< Is the article at this title a redirect?
83 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
84 var $mBacklinkCache = null; // /< Cache of links to this title
85 // @}
88 /**
89 * Constructor
90 * @private
92 /* private */ function __construct() { }
94 /**
95 * Create a new Title from a prefixed DB key
97 * @param $key \type{\string} The database key, which has underscores
98 * instead of spaces, possibly including namespace and
99 * interwiki prefixes
100 * @return \type{Title} the new object, or NULL on an error
102 public static function newFromDBkey( $key ) {
103 $t = new Title();
104 $t->mDbkeyform = $key;
105 if ( $t->secureAndSplit() ) {
106 return $t;
107 } else {
108 return null;
113 * Create a new Title from text, such as what one would find in a link. De-
114 * codes any HTML entities in the text.
116 * @param $text string The link text; spaces, prefixes, and an
117 * initial ':' indicating the main namespace are accepted.
118 * @param $defaultNamespace int The namespace to use if none is speci-
119 * fied by a prefix. If you want to force a specific namespace even if
120 * $text might begin with a namespace prefix, use makeTitle() or
121 * makeTitleSafe().
122 * @return Title The new object, or null on an error.
124 public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
125 if ( is_object( $text ) ) {
126 throw new MWException( 'Title::newFromText given an object' );
130 * Wiki pages often contain multiple links to the same page.
131 * Title normalization and parsing can become expensive on
132 * pages with many links, so we can save a little time by
133 * caching them.
135 * In theory these are value objects and won't get changed...
137 if ( $defaultNamespace == NS_MAIN && isset( Title::$titleCache[$text] ) ) {
138 return Title::$titleCache[$text];
142 * Convert things like &eacute; &#257; or &#x3017; into normalized (bug 14952) text
144 $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text );
146 $t = new Title();
147 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
148 $t->mDefaultNamespace = $defaultNamespace;
150 static $cachedcount = 0 ;
151 if ( $t->secureAndSplit() ) {
152 if ( $defaultNamespace == NS_MAIN ) {
153 if ( $cachedcount >= self::CACHE_MAX ) {
154 # Avoid memory leaks on mass operations...
155 Title::$titleCache = array();
156 $cachedcount = 0;
158 $cachedcount++;
159 Title::$titleCache[$text] =& $t;
161 return $t;
162 } else {
163 $ret = null;
164 return $ret;
169 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
171 * Example of wrong and broken code:
172 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
174 * Example of right code:
175 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
177 * Create a new Title from URL-encoded text. Ensures that
178 * the given title's length does not exceed the maximum.
180 * @param $url \type{\string} the title, as might be taken from a URL
181 * @return \type{Title} the new object, or NULL on an error
183 public static function newFromURL( $url ) {
184 global $wgLegalTitleChars;
185 $t = new Title();
187 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
188 # but some URLs used it as a space replacement and they still come
189 # from some external search tools.
190 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
191 $url = str_replace( '+', ' ', $url );
194 $t->mDbkeyform = str_replace( ' ', '_', $url );
195 if ( $t->secureAndSplit() ) {
196 return $t;
197 } else {
198 return null;
203 * Create a new Title from an article ID
205 * @param $id \type{\int} the page_id corresponding to the Title to create
206 * @param $flags \type{\int} use Title::GAID_FOR_UPDATE to use master
207 * @return \type{Title} the new object, or NULL on an error
209 public static function newFromID( $id, $flags = 0 ) {
210 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
211 $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__ );
212 if ( $row !== false ) {
213 $title = Title::newFromRow( $row );
214 } else {
215 $title = null;
217 return $title;
221 * Make an array of titles from an array of IDs
223 * @param $ids \type{\arrayof{\int}} Array of IDs
224 * @return \type{\arrayof{Title}} Array of Titles
226 public static function newFromIDs( $ids ) {
227 if ( !count( $ids ) ) {
228 return array();
230 $dbr = wfGetDB( DB_SLAVE );
232 $res = $dbr->select(
233 'page',
234 array(
235 'page_namespace', 'page_title', 'page_id',
236 'page_len', 'page_is_redirect', 'page_latest',
238 array( 'page_id' => $ids ),
239 __METHOD__
242 $titles = array();
243 foreach ( $res as $row ) {
244 $titles[] = Title::newFromRow( $row );
246 return $titles;
250 * Make a Title object from a DB row
252 * @param $row \type{Row} (needs at least page_title,page_namespace)
253 * @return \type{Title} corresponding Title
255 public static function newFromRow( $row ) {
256 $t = self::makeTitle( $row->page_namespace, $row->page_title );
258 $t->mArticleID = isset( $row->page_id ) ? intval( $row->page_id ) : -1;
259 $t->mLength = isset( $row->page_len ) ? intval( $row->page_len ) : -1;
260 $t->mRedirect = isset( $row->page_is_redirect ) ? (bool)$row->page_is_redirect : null;
261 $t->mLatestID = isset( $row->page_latest ) ? intval( $row->page_latest ) : false;
263 return $t;
267 * Create a new Title from a namespace index and a DB key.
268 * It's assumed that $ns and $title are *valid*, for instance when
269 * they came directly from the database or a special page name.
270 * For convenience, spaces are converted to underscores so that
271 * eg user_text fields can be used directly.
273 * @param $ns \type{\int} the namespace of the article
274 * @param $title \type{\string} the unprefixed database key form
275 * @param $fragment \type{\string} The link fragment (after the "#")
276 * @param $interwiki \type{\string} The interwiki prefix
277 * @return \type{Title} the new object
279 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
280 $t = new Title();
281 $t->mInterwiki = $interwiki;
282 $t->mFragment = $fragment;
283 $t->mNamespace = $ns = intval( $ns );
284 $t->mDbkeyform = str_replace( ' ', '_', $title );
285 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
286 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
287 $t->mTextform = str_replace( '_', ' ', $title );
288 return $t;
292 * Create a new Title from a namespace index and a DB key.
293 * The parameters will be checked for validity, which is a bit slower
294 * than makeTitle() but safer for user-provided data.
296 * @param $ns \type{\int} the namespace of the article
297 * @param $title \type{\string} the database key form
298 * @param $fragment \type{\string} The link fragment (after the "#")
299 * @param $interwiki \type{\string} The interwiki prefix
300 * @return \type{Title} the new object, or NULL on an error
302 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
303 $t = new Title();
304 $t->mDbkeyform = Title::makeName( $ns, $title, $fragment, $interwiki );
305 if ( $t->secureAndSplit() ) {
306 return $t;
307 } else {
308 return null;
313 * Create a new Title for the Main Page
315 * @return \type{Title} the new object
317 public static function newMainPage() {
318 $title = Title::newFromText( wfMsgForContent( 'mainpage' ) );
319 // Don't give fatal errors if the message is broken
320 if ( !$title ) {
321 $title = Title::newFromText( 'Main Page' );
323 return $title;
327 * Extract a redirect destination from a string and return the
328 * Title, or null if the text doesn't contain a valid redirect
329 * This will only return the very next target, useful for
330 * the redirect table and other checks that don't need full recursion
332 * @param $text String: Text with possible redirect
333 * @return Title: The corresponding Title
335 public static function newFromRedirect( $text ) {
336 return self::newFromRedirectInternal( $text );
340 * Extract a redirect destination from a string and return the
341 * Title, or null if the text doesn't contain a valid redirect
342 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
343 * in order to provide (hopefully) the Title of the final destination instead of another redirect
345 * @param $text \type{\string} Text with possible redirect
346 * @return \type{Title} The corresponding Title
348 public static function newFromRedirectRecurse( $text ) {
349 $titles = self::newFromRedirectArray( $text );
350 return $titles ? array_pop( $titles ) : null;
354 * Extract a redirect destination from a string and return an
355 * array of Titles, or null if the text doesn't contain a valid redirect
356 * The last element in the array is the final destination after all redirects
357 * have been resolved (up to $wgMaxRedirects times)
359 * @param $text \type{\string} Text with possible redirect
360 * @return \type{\array} Array of Titles, with the destination last
362 public static function newFromRedirectArray( $text ) {
363 global $wgMaxRedirects;
364 // are redirects disabled?
365 if ( $wgMaxRedirects < 1 ) {
366 return null;
368 $title = self::newFromRedirectInternal( $text );
369 if ( is_null( $title ) ) {
370 return null;
372 // recursive check to follow double redirects
373 $recurse = $wgMaxRedirects;
374 $titles = array( $title );
375 while ( --$recurse > 0 ) {
376 if ( $title->isRedirect() ) {
377 $article = new Article( $title, 0 );
378 $newtitle = $article->getRedirectTarget();
379 } else {
380 break;
382 // Redirects to some special pages are not permitted
383 if ( $newtitle instanceOf Title && $newtitle->isValidRedirectTarget() ) {
384 // the new title passes the checks, so make that our current title so that further recursion can be checked
385 $title = $newtitle;
386 $titles[] = $newtitle;
387 } else {
388 break;
391 return $titles;
395 * Really extract the redirect destination
396 * Do not call this function directly, use one of the newFromRedirect* functions above
398 * @param $text \type{\string} Text with possible redirect
399 * @return \type{Title} The corresponding Title
401 protected static function newFromRedirectInternal( $text ) {
402 $redir = MagicWord::get( 'redirect' );
403 $text = trim( $text );
404 if ( $redir->matchStartAndRemove( $text ) ) {
405 // Extract the first link and see if it's usable
406 // Ensure that it really does come directly after #REDIRECT
407 // Some older redirects included a colon, so don't freak about that!
408 $m = array();
409 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
410 // Strip preceding colon used to "escape" categories, etc.
411 // and URL-decode links
412 if ( strpos( $m[1], '%' ) !== false ) {
413 // Match behavior of inline link parsing here;
414 // don't interpret + as " " most of the time!
415 // It might be safe to just use rawurldecode instead, though.
416 $m[1] = urldecode( ltrim( $m[1], ':' ) );
418 $title = Title::newFromText( $m[1] );
419 // If the title is a redirect to bad special pages or is invalid, return null
420 if ( !$title instanceof Title || !$title->isValidRedirectTarget() ) {
421 return null;
423 return $title;
426 return null;
429 # ----------------------------------------------------------------------------
430 # Static functions
431 # ----------------------------------------------------------------------------
434 * Get the prefixed DB key associated with an ID
436 * @param $id \type{\int} the page_id of the article
437 * @return \type{Title} an object representing the article, or NULL
438 * if no such article was found
440 public static function nameOf( $id ) {
441 $dbr = wfGetDB( DB_SLAVE );
443 $s = $dbr->selectRow(
444 'page',
445 array( 'page_namespace', 'page_title' ),
446 array( 'page_id' => $id ),
447 __METHOD__
449 if ( $s === false ) {
450 return null;
453 $n = self::makeName( $s->page_namespace, $s->page_title );
454 return $n;
458 * Get a regex character class describing the legal characters in a link
460 * @return \type{\string} the list of characters, not delimited
462 public static function legalChars() {
463 global $wgLegalTitleChars;
464 return $wgLegalTitleChars;
468 * Get a string representation of a title suitable for
469 * including in a search index
471 * @param $ns \type{\int} a namespace index
472 * @param $title \type{\string} text-form main part
473 * @return \type{\string} a stripped-down title string ready for the
474 * search index
476 public static function indexTitle( $ns, $title ) {
477 global $wgContLang;
479 $lc = SearchEngine::legalSearchChars() . '&#;';
480 $t = $wgContLang->normalizeForSearch( $title );
481 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
482 $t = $wgContLang->lc( $t );
484 # Handle 's, s'
485 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
486 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
488 $t = preg_replace( "/\\s+/", ' ', $t );
490 if ( $ns == NS_FILE ) {
491 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
493 return trim( $t );
497 * Make a prefixed DB key from a DB key and a namespace index
499 * @param $ns \type{\int} numerical representation of the namespace
500 * @param $title \type{\string} the DB key form the title
501 * @param $fragment \type{\string} The link fragment (after the "#")
502 * @param $interwiki \type{\string} The interwiki prefix
503 * @return \type{\string} the prefixed form of the title
505 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
506 global $wgContLang;
508 $namespace = $wgContLang->getNsText( $ns );
509 $name = $namespace == '' ? $title : "$namespace:$title";
510 if ( strval( $interwiki ) != '' ) {
511 $name = "$interwiki:$name";
513 if ( strval( $fragment ) != '' ) {
514 $name .= '#' . $fragment;
516 return $name;
520 * Determine whether the object refers to a page within
521 * this project.
523 * @return \type{\bool} TRUE if this is an in-project interwiki link
524 * or a wikilink, FALSE otherwise
526 public function isLocal() {
527 if ( $this->mInterwiki != '' ) {
528 return Interwiki::fetch( $this->mInterwiki )->isLocal();
529 } else {
530 return true;
535 * Determine whether the object refers to a page within
536 * this project and is transcludable.
538 * @return \type{\bool} TRUE if this is transcludable
540 public function isTrans() {
541 if ( $this->mInterwiki == '' ) {
542 return false;
545 return Interwiki::fetch( $this->mInterwiki )->isTranscludable();
549 * Returns the DB name of the distant wiki
550 * which owns the object.
552 * @return \type{\string} the DB name
554 public function getTransWikiID() {
555 if ( $this->mInterwiki == '' ) {
556 return false;
559 return Interwiki::fetch( $this->mInterwiki )->getWikiID();
563 * Escape a text fragment, say from a link, for a URL
565 * @param $fragment string containing a URL or link fragment (after the "#")
566 * @return String: escaped string
568 static function escapeFragmentForURL( $fragment ) {
569 # Note that we don't urlencode the fragment. urlencoded Unicode
570 # fragments appear not to work in IE (at least up to 7) or in at least
571 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
572 # to care if they aren't encoded.
573 return Sanitizer::escapeId( $fragment, 'noninitial' );
576 # ----------------------------------------------------------------------------
577 # Other stuff
578 # ----------------------------------------------------------------------------
580 /** Simple accessors */
582 * Get the text form (spaces not underscores) of the main part
584 * @return \type{\string} Main part of the title
586 public function getText() { return $this->mTextform; }
589 * Get the URL-encoded form of the main part
591 * @return \type{\string} Main part of the title, URL-encoded
593 public function getPartialURL() { return $this->mUrlform; }
596 * Get the main part with underscores
598 * @return String: Main part of the title, with underscores
600 public function getDBkey() { return $this->mDbkeyform; }
603 * Get the namespace index, i.e.\ one of the NS_xxxx constants.
605 * @return Integer: Namespace index
607 public function getNamespace() { return $this->mNamespace; }
610 * Get the namespace text
612 * @return String: Namespace text
614 public function getNsText() {
615 global $wgContLang;
617 if ( $this->mInterwiki != '' ) {
618 // This probably shouldn't even happen. ohh man, oh yuck.
619 // But for interwiki transclusion it sometimes does.
620 // Shit. Shit shit shit.
622 // Use the canonical namespaces if possible to try to
623 // resolve a foreign namespace.
624 if ( MWNamespace::exists( $this->mNamespace ) ) {
625 return MWNamespace::getCanonicalName( $this->mNamespace );
628 return $wgContLang->getNsText( $this->mNamespace );
632 * Get the DB key with the initial letter case as specified by the user
634 * @return \type{\string} DB key
636 function getUserCaseDBKey() {
637 return $this->mUserCaseDBKey;
641 * Get the namespace text of the subject (rather than talk) page
643 * @return \type{\string} Namespace text
645 public function getSubjectNsText() {
646 global $wgContLang;
647 return $wgContLang->getNsText( MWNamespace::getSubject( $this->mNamespace ) );
651 * Get the namespace text of the talk page
653 * @return \type{\string} Namespace text
655 public function getTalkNsText() {
656 global $wgContLang;
657 return( $wgContLang->getNsText( MWNamespace::getTalk( $this->mNamespace ) ) );
661 * Could this title have a corresponding talk page?
663 * @return \type{\bool} TRUE or FALSE
665 public function canTalk() {
666 return( MWNamespace::canTalk( $this->mNamespace ) );
670 * Get the interwiki prefix (or null string)
672 * @return \type{\string} Interwiki prefix
674 public function getInterwiki() { return $this->mInterwiki; }
677 * Get the Title fragment (i.e.\ the bit after the #) in text form
679 * @return \type{\string} Title fragment
681 public function getFragment() { return $this->mFragment; }
684 * Get the fragment in URL form, including the "#" character if there is one
685 * @return \type{\string} Fragment in URL form
687 public function getFragmentForURL() {
688 if ( $this->mFragment == '' ) {
689 return '';
690 } else {
691 return '#' . Title::escapeFragmentForURL( $this->mFragment );
696 * Get the default namespace index, for when there is no namespace
698 * @return \type{\int} Default namespace index
700 public function getDefaultNamespace() { return $this->mDefaultNamespace; }
703 * Get title for search index
705 * @return \type{\string} a stripped-down title string ready for the
706 * search index
708 public function getIndexTitle() {
709 return Title::indexTitle( $this->mNamespace, $this->mTextform );
713 * Get the prefixed database key form
715 * @return \type{\string} the prefixed title, with underscores and
716 * any interwiki and namespace prefixes
718 public function getPrefixedDBkey() {
719 $s = $this->prefix( $this->mDbkeyform );
720 $s = str_replace( ' ', '_', $s );
721 return $s;
725 * Get the prefixed title with spaces.
726 * This is the form usually used for display
728 * @return \type{\string} the prefixed title, with spaces
730 public function getPrefixedText() {
731 if ( empty( $this->mPrefixedText ) ) { // FIXME: bad usage of empty() ?
732 $s = $this->prefix( $this->mTextform );
733 $s = str_replace( '_', ' ', $s );
734 $this->mPrefixedText = $s;
736 return $this->mPrefixedText;
740 * Get the prefixed title with spaces, plus any fragment
741 * (part beginning with '#')
743 * @return \type{\string} the prefixed title, with spaces and
744 * the fragment, including '#'
746 public function getFullText() {
747 $text = $this->getPrefixedText();
748 if ( $this->mFragment != '' ) {
749 $text .= '#' . $this->mFragment;
751 return $text;
755 * Get the base name, i.e. the leftmost parts before the /
757 * @return \type{\string} Base name
759 public function getBaseText() {
760 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
761 return $this->getText();
764 $parts = explode( '/', $this->getText() );
765 # Don't discard the real title if there's no subpage involved
766 if ( count( $parts ) > 1 ) {
767 unset( $parts[count( $parts ) - 1] );
769 return implode( '/', $parts );
773 * Get the lowest-level subpage name, i.e. the rightmost part after /
775 * @return \type{\string} Subpage name
777 public function getSubpageText() {
778 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
779 return( $this->mTextform );
781 $parts = explode( '/', $this->mTextform );
782 return( $parts[count( $parts ) - 1] );
786 * Get a URL-encoded form of the subpage text
788 * @return \type{\string} URL-encoded subpage name
790 public function getSubpageUrlForm() {
791 $text = $this->getSubpageText();
792 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
793 return( $text );
797 * Get a URL-encoded title (not an actual URL) including interwiki
799 * @return \type{\string} the URL-encoded form
801 public function getPrefixedURL() {
802 $s = $this->prefix( $this->mDbkeyform );
803 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
804 return $s;
808 * Get a real URL referring to this title, with interwiki link and
809 * fragment
811 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
812 * links. Can be specified as an associative array as well, e.g.,
813 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
814 * @param $variant \type{\string} language variant of url (for sr, zh..)
815 * @return \type{\string} the URL
817 public function getFullURL( $query = '', $variant = false ) {
818 global $wgServer, $wgRequest;
820 if ( is_array( $query ) ) {
821 $query = wfArrayToCGI( $query );
824 $interwiki = Interwiki::fetch( $this->mInterwiki );
825 if ( !$interwiki ) {
826 $url = $this->getLocalURL( $query, $variant );
828 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
829 // Correct fix would be to move the prepending elsewhere.
830 if ( $wgRequest->getVal( 'action' ) != 'render' ) {
831 $url = $wgServer . $url;
833 } else {
834 $baseUrl = $interwiki->getURL();
836 $namespace = wfUrlencode( $this->getNsText() );
837 if ( $namespace != '' ) {
838 # Can this actually happen? Interwikis shouldn't be parsed.
839 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
840 $namespace .= ':';
842 $url = str_replace( '$1', $namespace . $this->mUrlform, $baseUrl );
843 $url = wfAppendQuery( $url, $query );
846 # Finally, add the fragment.
847 $url .= $this->getFragmentForURL();
849 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
850 return $url;
854 * Get a URL with no fragment or server name. If this page is generated
855 * with action=render, $wgServer is prepended.
857 * @param $query Mixed: an optional query string; if not specified,
858 * $wgArticlePath will be used. Can be specified as an associative array
859 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
860 * URL-escaped).
861 * @param $variant \type{\string} language variant of url (for sr, zh..)
862 * @return \type{\string} the URL
864 public function getLocalURL( $query = '', $variant = false ) {
865 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
866 global $wgVariantArticlePath, $wgContLang;
868 if ( is_array( $query ) ) {
869 $query = wfArrayToCGI( $query );
872 if ( $this->isExternal() ) {
873 $url = $this->getFullURL();
874 if ( $query ) {
875 // This is currently only used for edit section links in the
876 // context of interwiki transclusion. In theory we should
877 // append the query to the end of any existing query string,
878 // but interwiki transclusion is already broken in that case.
879 $url .= "?$query";
881 } else {
882 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
883 if ( $query == '' ) {
884 if ( $variant != false && $wgContLang->hasVariants() ) {
885 if ( !$wgVariantArticlePath ) {
886 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
887 } else {
888 $variantArticlePath = $wgVariantArticlePath;
890 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
891 $url = str_replace( '$1', $dbkey, $url );
892 } else {
893 $url = str_replace( '$1', $dbkey, $wgArticlePath );
895 } else {
896 global $wgActionPaths;
897 $url = false;
898 $matches = array();
899 if ( !empty( $wgActionPaths ) &&
900 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
902 $action = urldecode( $matches[2] );
903 if ( isset( $wgActionPaths[$action] ) ) {
904 $query = $matches[1];
905 if ( isset( $matches[4] ) ) {
906 $query .= $matches[4];
908 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
909 if ( $query != '' ) {
910 $url = wfAppendQuery( $url, $query );
914 if ( $url === false ) {
915 if ( $query == '-' ) {
916 $query = '';
918 $url = "{$wgScript}?title={$dbkey}&{$query}";
922 // FIXME: this causes breakage in various places when we
923 // actually expected a local URL and end up with dupe prefixes.
924 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
925 $url = $wgServer . $url;
928 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
929 return $url;
933 * Get a URL that's the simplest URL that will be valid to link, locally,
934 * to the current Title. It includes the fragment, but does not include
935 * the server unless action=render is used (or the link is external). If
936 * there's a fragment but the prefixed text is empty, we just return a link
937 * to the fragment.
939 * The result obviously should not be URL-escaped, but does need to be
940 * HTML-escaped if it's being output in HTML.
942 * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the
943 * query string. Keys and values will be escaped.
944 * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
945 * for external links. Default is "false" (same variant as current page,
946 * for anonymous users).
947 * @return \type{\string} the URL
949 public function getLinkUrl( $query = array(), $variant = false ) {
950 wfProfileIn( __METHOD__ );
951 if ( $this->isExternal() ) {
952 $ret = $this->getFullURL( $query );
953 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
954 $ret = $this->getFragmentForURL();
955 } else {
956 $ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
958 wfProfileOut( __METHOD__ );
959 return $ret;
963 * Get an HTML-escaped version of the URL form, suitable for
964 * using in a link, without a server name or fragment
966 * @param $query \type{\string} an optional query string
967 * @return \type{\string} the URL
969 public function escapeLocalURL( $query = '' ) {
970 return htmlspecialchars( $this->getLocalURL( $query ) );
974 * Get an HTML-escaped version of the URL form, suitable for
975 * using in a link, including the server name and fragment
977 * @param $query \type{\string} an optional query string
978 * @return \type{\string} the URL
980 public function escapeFullURL( $query = '' ) {
981 return htmlspecialchars( $this->getFullURL( $query ) );
985 * Get the URL form for an internal link.
986 * - Used in various Squid-related code, in case we have a different
987 * internal hostname for the server from the exposed one.
989 * @param $query \type{\string} an optional query string
990 * @param $variant \type{\string} language variant of url (for sr, zh..)
991 * @return \type{\string} the URL
993 public function getInternalURL( $query = '', $variant = false ) {
994 global $wgInternalServer;
995 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
996 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
997 return $url;
1001 * Get the edit URL for this Title
1003 * @return \type{\string} the URL, or a null string if this is an
1004 * interwiki link
1006 public function getEditURL() {
1007 if ( $this->mInterwiki != '' ) {
1008 return '';
1010 $s = $this->getLocalURL( 'action=edit' );
1012 return $s;
1016 * Get the HTML-escaped displayable text form.
1017 * Used for the title field in <a> tags.
1019 * @return \type{\string} the text, including any prefixes
1021 public function getEscapedText() {
1022 return htmlspecialchars( $this->getPrefixedText() );
1026 * Is this Title interwiki?
1028 * @return \type{\bool}
1030 public function isExternal() {
1031 return ( $this->mInterwiki != '' );
1035 * Is this page "semi-protected" - the *only* protection is autoconfirm?
1037 * @param $action \type{\string} Action to check (default: edit)
1038 * @return \type{\bool}
1040 public function isSemiProtected( $action = 'edit' ) {
1041 if ( $this->exists() ) {
1042 $restrictions = $this->getRestrictions( $action );
1043 if ( count( $restrictions ) > 0 ) {
1044 foreach ( $restrictions as $restriction ) {
1045 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
1046 return false;
1049 } else {
1050 # Not protected
1051 return false;
1053 return true;
1054 } else {
1055 # If it doesn't exist, it can't be protected
1056 return false;
1061 * Does the title correspond to a protected article?
1063 * @param $action \type{\string} the action the page is protected from,
1064 * by default checks all actions.
1065 * @return \type{\bool}
1067 public function isProtected( $action = '' ) {
1068 global $wgRestrictionLevels;
1070 $restrictionTypes = $this->getRestrictionTypes();
1072 # Special pages have inherent protection
1073 if( $this->getNamespace() == NS_SPECIAL ) {
1074 return true;
1077 # Check regular protection levels
1078 foreach ( $restrictionTypes as $type ) {
1079 if ( $action == $type || $action == '' ) {
1080 $r = $this->getRestrictions( $type );
1081 foreach ( $wgRestrictionLevels as $level ) {
1082 if ( in_array( $level, $r ) && $level != '' ) {
1083 return true;
1089 return false;
1093 * Is this a conversion table for the LanguageConverter?
1095 * @return \type{\bool}
1097 public function isConversionTable() {
1099 $this->getNamespace() == NS_MEDIAWIKI &&
1100 strpos( $this->getText(), 'Conversiontable' ) !== false
1103 return true;
1106 return false;
1110 * Is $wgUser watching this page?
1112 * @return \type{\bool}
1114 public function userIsWatching() {
1115 global $wgUser;
1117 if ( is_null( $this->mWatched ) ) {
1118 if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn() ) {
1119 $this->mWatched = false;
1120 } else {
1121 $this->mWatched = $wgUser->isWatched( $this );
1124 return $this->mWatched;
1128 * Can $wgUser perform $action on this page?
1129 * This skips potentially expensive cascading permission checks
1130 * as well as avoids expensive error formatting
1132 * Suitable for use for nonessential UI controls in common cases, but
1133 * _not_ for functional access control.
1135 * May provide false positives, but should never provide a false negative.
1137 * @param $action \type{\string} action that permission needs to be checked for
1138 * @return \type{\bool}
1140 public function quickUserCan( $action ) {
1141 return $this->userCan( $action, false );
1145 * Determines if $wgUser is unable to edit this page because it has been protected
1146 * by $wgNamespaceProtection.
1148 * @return \type{\bool}
1150 public function isNamespaceProtected() {
1151 global $wgNamespaceProtection, $wgUser;
1152 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
1153 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
1154 if ( $right != '' && !$wgUser->isAllowed( $right ) ) {
1155 return true;
1159 return false;
1163 * Can $wgUser perform $action on this page?
1165 * @param $action \type{\string} action that permission needs to be checked for
1166 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1167 * @return \type{\bool}
1169 public function userCan( $action, $doExpensiveQueries = true ) {
1170 global $wgUser;
1171 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries, true ) === array() );
1175 * Can $user perform $action on this page?
1177 * FIXME: This *does not* check throttles (User::pingLimiter()).
1179 * @param $action \type{\string}action that permission needs to be checked for
1180 * @param $user \type{User} user to check
1181 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1182 * @param $ignoreErrors \type{\arrayof{\string}} Set this to a list of message keys whose corresponding errors may be ignored.
1183 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1185 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1186 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1188 // Remove the errors being ignored.
1189 foreach ( $errors as $index => $error ) {
1190 $error_key = is_array( $error ) ? $error[0] : $error;
1192 if ( in_array( $error_key, $ignoreErrors ) ) {
1193 unset( $errors[$index] );
1197 return $errors;
1201 * Permissions checks that fail most often, and which are easiest to test.
1203 * @param $action String the action to check
1204 * @param $user User user to check
1205 * @param $errors Array list of current errors
1206 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1207 * @param $short Boolean short circuit on first error
1209 * @return Array list of errors
1211 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1212 if ( $action == 'create' ) {
1213 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1214 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1215 $errors[] = $user->isAnon() ? array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1217 } elseif ( $action == 'move' ) {
1218 if ( !$user->isAllowed( 'move-rootuserpages' )
1219 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1220 // Show user page-specific message only if the user can move other pages
1221 $errors[] = array( 'cant-move-user-page' );
1224 // Check if user is allowed to move files if it's a file
1225 if ( $this->mNamespace == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
1226 $errors[] = array( 'movenotallowedfile' );
1229 if ( !$user->isAllowed( 'move' ) ) {
1230 // User can't move anything
1231 global $wgGroupPermissions;
1232 $userCanMove = false;
1233 if ( isset( $wgGroupPermissions['user']['move'] ) ) {
1234 $userCanMove = $wgGroupPermissions['user']['move'];
1236 $autoconfirmedCanMove = false;
1237 if ( isset( $wgGroupPermissions['autoconfirmed']['move'] ) ) {
1238 $autoconfirmedCanMove = $wgGroupPermissions['autoconfirmed']['move'];
1240 if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) {
1241 // custom message if logged-in users without any special rights can move
1242 $errors[] = array( 'movenologintext' );
1243 } else {
1244 $errors[] = array( 'movenotallowed' );
1247 } elseif ( $action == 'move-target' ) {
1248 if ( !$user->isAllowed( 'move' ) ) {
1249 // User can't move anything
1250 $errors[] = array( 'movenotallowed' );
1251 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1252 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1253 // Show user page-specific message only if the user can move other pages
1254 $errors[] = array( 'cant-move-to-user-page' );
1256 } elseif ( !$user->isAllowed( $action ) ) {
1257 // We avoid expensive display logic for quickUserCan's and such
1258 $groups = false;
1259 if ( !$short ) {
1260 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1261 User::getGroupsWithPermission( $action ) );
1264 if ( $groups ) {
1265 global $wgLang;
1266 $return = array(
1267 'badaccess-groups',
1268 $wgLang->commaList( $groups ),
1269 count( $groups )
1271 } else {
1272 $return = array( 'badaccess-group0' );
1274 $errors[] = $return;
1277 return $errors;
1281 * Add the resulting error code to the errors array
1283 * @param $errors Array list of current errors
1284 * @param $result Mixed result of errors
1286 * @return Array list of errors
1288 private function resultToError( $errors, $result ) {
1289 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1290 // A single array representing an error
1291 $errors[] = $result;
1292 } else if ( is_array( $result ) && is_array( $result[0] ) ) {
1293 // A nested array representing multiple errors
1294 $errors = array_merge( $errors, $result );
1295 } else if ( $result !== '' && is_string( $result ) ) {
1296 // A string representing a message-id
1297 $errors[] = array( $result );
1298 } else if ( $result === false ) {
1299 // a generic "We don't want them to do that"
1300 $errors[] = array( 'badaccess-group0' );
1302 return $errors;
1306 * Check various permission hooks
1307 * @see checkQuickPermissions for parameter information
1309 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1310 // Use getUserPermissionsErrors instead
1311 $result = '';
1312 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1313 return $result ? array() : array( array( 'badaccess-group0' ) );
1315 // Check getUserPermissionsErrors hook
1316 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1317 $errors = $this->resultToError( $errors, $result );
1319 // Check getUserPermissionsErrorsExpensive hook
1320 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1321 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1322 $errors = $this->resultToError( $errors, $result );
1325 return $errors;
1329 * Check permissions on special pages & namespaces
1330 * @see checkQuickPermissions for parameter information
1332 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1333 # Only 'createaccount' and 'execute' can be performed on
1334 # special pages, which don't actually exist in the DB.
1335 $specialOKActions = array( 'createaccount', 'execute' );
1336 if ( NS_SPECIAL == $this->mNamespace && !in_array( $action, $specialOKActions ) ) {
1337 $errors[] = array( 'ns-specialprotected' );
1340 # Check $wgNamespaceProtection for restricted namespaces
1341 if ( $this->isNamespaceProtected() ) {
1342 $ns = $this->mNamespace == NS_MAIN ?
1343 wfMsg( 'nstab-main' ) : $this->getNsText();
1344 $errors[] = $this->mNamespace == NS_MEDIAWIKI ?
1345 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1348 return $errors;
1352 * Check CSS/JS sub-page permissions
1353 * @see checkQuickPermissions for parameter information
1355 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1356 # Protect css/js subpages of user pages
1357 # XXX: this might be better using restrictions
1358 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssSubpage()
1359 # and $this->userCanEditJsSubpage() from working
1360 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1361 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1362 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform ) ) {
1363 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1364 $errors[] = array( 'customcssjsprotected' );
1365 } else if ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1366 $errors[] = array( 'customcssjsprotected' );
1370 return $errors;
1374 * Check against page_restrictions table requirements on this
1375 * page. The user must possess all required rights for this
1376 * action.
1377 * @see checkQuickPermissions for parameter information
1379 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1380 foreach ( $this->getRestrictions( $action ) as $right ) {
1381 // Backwards compatibility, rewrite sysop -> protect
1382 if ( $right == 'sysop' ) {
1383 $right = 'protect';
1385 if ( $right != '' && !$user->isAllowed( $right ) ) {
1386 // Users with 'editprotected' permission can edit protected pages
1387 if ( $action == 'edit' && $user->isAllowed( 'editprotected' ) ) {
1388 // Users with 'editprotected' permission cannot edit protected pages
1389 // with cascading option turned on.
1390 if ( $this->mCascadeRestriction ) {
1391 $errors[] = array( 'protectedpagetext', $right );
1393 } else {
1394 $errors[] = array( 'protectedpagetext', $right );
1399 return $errors;
1403 * Check restrictions on cascading pages.
1404 * @see checkQuickPermissions for parameter information
1406 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1407 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1408 # We /could/ use the protection level on the source page, but it's
1409 # fairly ugly as we have to establish a precedence hierarchy for pages
1410 # included by multiple cascade-protected pages. So just restrict
1411 # it to people with 'protect' permission, as they could remove the
1412 # protection anyway.
1413 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1414 # Cascading protection depends on more than this page...
1415 # Several cascading protected pages may include this page...
1416 # Check each cascading level
1417 # This is only for protection restrictions, not for all actions
1418 if ( isset( $restrictions[$action] ) ) {
1419 foreach ( $restrictions[$action] as $right ) {
1420 $right = ( $right == 'sysop' ) ? 'protect' : $right;
1421 if ( $right != '' && !$user->isAllowed( $right ) ) {
1422 $pages = '';
1423 foreach ( $cascadingSources as $page )
1424 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1425 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1431 return $errors;
1435 * Check action permissions not already checked in checkQuickPermissions
1436 * @see checkQuickPermissions for parameter information
1438 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1439 if ( $action == 'protect' ) {
1440 if ( $this->getUserPermissionsErrors( 'edit', $user ) != array() ) {
1441 // If they can't edit, they shouldn't protect.
1442 $errors[] = array( 'protect-cantedit' );
1444 } elseif ( $action == 'create' ) {
1445 $title_protection = $this->getTitleProtection();
1446 if( $title_protection ) {
1447 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1448 $title_protection['pt_create_perm'] = 'protect'; // B/C
1450 if( $title_protection['pt_create_perm'] == '' || !$user->isAllowed( $title_protection['pt_create_perm'] ) ) {
1451 $errors[] = array( 'titleprotected', User::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1454 } elseif ( $action == 'move' ) {
1455 // Check for immobile pages
1456 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
1457 // Specific message for this case
1458 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1459 } elseif ( !$this->isMovable() ) {
1460 // Less specific message for rarer cases
1461 $errors[] = array( 'immobile-page' );
1463 } elseif ( $action == 'move-target' ) {
1464 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
1465 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1466 } elseif ( !$this->isMovable() ) {
1467 $errors[] = array( 'immobile-target-page' );
1470 return $errors;
1474 * Check that the user isn't blocked from editting.
1475 * @see checkQuickPermissions for parameter information
1477 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1478 if( $short && count( $errors ) > 0 ) {
1479 return $errors;
1482 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
1484 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1485 $errors[] = array( 'confirmedittext' );
1488 // Edit blocks should not affect reading. Account creation blocks handled at userlogin.
1489 if ( $action != 'read' && $action != 'createaccount' && $user->isBlockedFrom( $this ) ) {
1490 $block = $user->mBlock;
1492 // This is from OutputPage::blockedPage
1493 // Copied at r23888 by werdna
1495 $id = $user->blockedBy();
1496 $reason = $user->blockedFor();
1497 if ( $reason == '' ) {
1498 $reason = wfMsg( 'blockednoreason' );
1500 $ip = wfGetIP();
1502 if ( is_numeric( $id ) ) {
1503 $name = User::whoIs( $id );
1504 } else {
1505 $name = $id;
1508 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
1509 $blockid = $block->mId;
1510 $blockExpiry = $user->mBlock->mExpiry;
1511 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $user->mBlock->mTimestamp ), true );
1512 if ( $blockExpiry == 'infinity' ) {
1513 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1514 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1516 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1517 if ( !strpos( $option, ':' ) )
1518 continue;
1520 list( $show, $value ) = explode( ':', $option );
1522 if ( $value == 'infinite' || $value == 'indefinite' ) {
1523 $blockExpiry = $show;
1524 break;
1527 } else {
1528 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
1531 $intended = $user->mBlock->mAddress;
1533 $errors[] = array( ( $block->mAuto ? 'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1534 $blockid, $blockExpiry, $intended, $blockTimestamp );
1537 return $errors;
1541 * Can $user perform $action on this page? This is an internal function,
1542 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1543 * checks on wfReadOnly() and blocks)
1545 * @param $action \type{\string} action that permission needs to be checked for
1546 * @param $user \type{User} user to check
1547 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1548 * @param $short \type{\bool} Set this to true to stop after the first permission error.
1549 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1551 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
1552 wfProfileIn( __METHOD__ );
1554 $errors = array();
1555 $checks = array(
1556 'checkQuickPermissions',
1557 'checkPermissionHooks',
1558 'checkSpecialsAndNSPermissions',
1559 'checkCSSandJSPermissions',
1560 'checkPageRestrictions',
1561 'checkCascadingSourcesRestrictions',
1562 'checkActionPermissions',
1563 'checkUserBlock'
1566 while( count( $checks ) > 0 &&
1567 !( $short && count( $errors ) > 0 ) ) {
1568 $method = array_shift( $checks );
1569 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
1572 wfProfileOut( __METHOD__ );
1573 return $errors;
1577 * Is this title subject to title protection?
1579 * @return \type{\mixed} An associative array representing any existent title
1580 * protection, or false if there's none.
1582 private function getTitleProtection() {
1583 // Can't protect pages in special namespaces
1584 if ( $this->getNamespace() < 0 ) {
1585 return false;
1588 // Can't protect pages that exist.
1589 if ( $this->exists() ) {
1590 return false;
1593 if ( !isset( $this->mTitleProtection ) ) {
1594 $dbr = wfGetDB( DB_SLAVE );
1595 $res = $dbr->select( 'protected_titles', '*',
1596 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1597 __METHOD__ );
1599 // fetchRow returns false if there are no rows.
1600 $this->mTitleProtection = $dbr->fetchRow( $res );
1602 return $this->mTitleProtection;
1605 private function invalidateTitleProtectionCache() {
1606 unset( $this->mTitleProtection );
1610 * Update the title protection status
1612 * @param $create_perm \type{\string} Permission required for creation
1613 * @param $reason \type{\string} Reason for protection
1614 * @param $expiry \type{\string} Expiry timestamp
1615 * @return boolean true
1617 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1618 global $wgUser, $wgContLang;
1620 if ( $create_perm == implode( ',', $this->getRestrictions( 'create' ) )
1621 && $expiry == $this->mRestrictionsExpiry['create'] ) {
1622 // No change
1623 return true;
1626 list ( $namespace, $title ) = array( $this->getNamespace(), $this->getDBkey() );
1628 $dbw = wfGetDB( DB_MASTER );
1630 $encodedExpiry = Block::encodeExpiry( $expiry, $dbw );
1632 $expiry_description = '';
1633 if ( $encodedExpiry != 'infinity' ) {
1634 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ),
1635 $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')';
1636 } else {
1637 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ) . ')';
1640 # Update protection table
1641 if ( $create_perm != '' ) {
1642 $dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ),
1643 array(
1644 'pt_namespace' => $namespace,
1645 'pt_title' => $title,
1646 'pt_create_perm' => $create_perm,
1647 'pt_timestamp' => Block::encodeExpiry( wfTimestampNow(), $dbw ),
1648 'pt_expiry' => $encodedExpiry,
1649 'pt_user' => $wgUser->getId(),
1650 'pt_reason' => $reason,
1651 ), __METHOD__
1653 } else {
1654 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1655 'pt_title' => $title ), __METHOD__ );
1657 $this->invalidateTitleProtectionCache();
1659 # Update the protection log
1660 if ( $dbw->affectedRows() ) {
1661 $log = new LogPage( 'protect' );
1663 if ( $create_perm ) {
1664 $params = array( "[create=$create_perm] $expiry_description", '' );
1665 $log->addEntry( ( isset( $this->mRestrictions['create'] ) && $this->mRestrictions['create'] ) ? 'modify' : 'protect', $this, trim( $reason ), $params );
1666 } else {
1667 $log->addEntry( 'unprotect', $this, $reason );
1671 return true;
1675 * Remove any title protection due to page existing
1677 public function deleteTitleProtection() {
1678 $dbw = wfGetDB( DB_MASTER );
1680 $dbw->delete(
1681 'protected_titles',
1682 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1683 __METHOD__
1685 $this->invalidateTitleProtectionCache();
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();
2068 $this->invalidateTitleProtectionCache();
2071 wfProfileOut( __METHOD__ );
2073 if ( $getPages ) {
2074 $this->mCascadeSources = $sources;
2075 $this->mCascadingRestrictions = $pagerestrictions;
2076 } else {
2077 $this->mHasCascadingRestrictions = $sources;
2080 return array( $sources, $pagerestrictions );
2084 * Returns cascading restrictions for the current article
2086 * @return Boolean
2088 function areRestrictionsCascading() {
2089 if ( !$this->mRestrictionsLoaded ) {
2090 $this->loadRestrictions();
2093 return $this->mCascadeRestriction;
2097 * Loads a string into mRestrictions array
2099 * @param $res \type{Resource} restrictions as an SQL result.
2100 * @param $oldFashionedRestrictions string comma-separated list of page
2101 * restrictions from page table (pre 1.10)
2103 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2104 $rows = array();
2106 foreach ( $res as $row ) {
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();
2188 $this->invalidateTitleProtectionCache();
2192 $this->mRestrictionsLoaded = true;
2196 * Load restrictions from the page_restrictions table
2198 * @param $oldFashionedRestrictions string comma-separated list of page
2199 * restrictions from page table (pre 1.10)
2201 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2202 if ( !$this->mRestrictionsLoaded ) {
2203 if ( $this->exists() ) {
2204 $dbr = wfGetDB( DB_SLAVE );
2206 $res = $dbr->select( 'page_restrictions', '*',
2207 array( 'pr_page' => $this->getArticleId() ), __METHOD__ );
2209 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2210 } else {
2211 $title_protection = $this->getTitleProtection();
2213 if ( $title_protection ) {
2214 $now = wfTimestampNow();
2215 $expiry = Block::decodeExpiry( $title_protection['pt_expiry'] );
2217 if ( !$expiry || $expiry > $now ) {
2218 // Apply the restrictions
2219 $this->mRestrictionsExpiry['create'] = $expiry;
2220 $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2221 } else { // Get rid of the old restrictions
2222 Title::purgeExpiredRestrictions();
2223 $this->invalidateTitleProtectionCache();
2225 } else {
2226 $this->mRestrictionsExpiry['create'] = Block::decodeExpiry( '' );
2228 $this->mRestrictionsLoaded = true;
2234 * Purge expired restrictions from the page_restrictions table
2236 static function purgeExpiredRestrictions() {
2237 $dbw = wfGetDB( DB_MASTER );
2238 $dbw->delete(
2239 'page_restrictions',
2240 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2241 __METHOD__
2244 $dbw->delete(
2245 'protected_titles',
2246 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2247 __METHOD__
2252 * Accessor/initialisation for mRestrictions
2254 * @param $action \type{\string} action that permission needs to be checked for
2255 * @return \type{\arrayof{\string}} the array of groups allowed to edit this article
2257 public function getRestrictions( $action ) {
2258 if ( !$this->mRestrictionsLoaded ) {
2259 $this->loadRestrictions();
2261 return isset( $this->mRestrictions[$action] )
2262 ? $this->mRestrictions[$action]
2263 : array();
2267 * Get the expiry time for the restriction against a given action
2269 * @return 14-char timestamp, or 'infinity' if the page is protected forever
2270 * or not protected at all, or false if the action is not recognised.
2272 public function getRestrictionExpiry( $action ) {
2273 if ( !$this->mRestrictionsLoaded ) {
2274 $this->loadRestrictions();
2276 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
2280 * Is there a version of this page in the deletion archive?
2282 * @return \type{\int} the number of archived revisions
2284 public function isDeleted() {
2285 if ( $this->getNamespace() < 0 ) {
2286 $n = 0;
2287 } else {
2288 $dbr = wfGetDB( DB_SLAVE );
2289 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2290 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2291 __METHOD__
2293 if ( $this->getNamespace() == NS_FILE ) {
2294 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
2295 array( 'fa_name' => $this->getDBkey() ),
2296 __METHOD__
2300 return (int)$n;
2304 * Is there a version of this page in the deletion archive?
2306 * @return Boolean
2308 public function isDeletedQuick() {
2309 if ( $this->getNamespace() < 0 ) {
2310 return false;
2312 $dbr = wfGetDB( DB_SLAVE );
2313 $deleted = (bool)$dbr->selectField( 'archive', '1',
2314 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2315 __METHOD__
2317 if ( !$deleted && $this->getNamespace() == NS_FILE ) {
2318 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2319 array( 'fa_name' => $this->getDBkey() ),
2320 __METHOD__
2323 return $deleted;
2327 * Get the article ID for this Title from the link cache,
2328 * adding it if necessary
2330 * @param $flags \type{\int} a bit field; may be Title::GAID_FOR_UPDATE to select
2331 * for update
2332 * @return \type{\int} the ID
2334 public function getArticleID( $flags = 0 ) {
2335 if ( $this->getNamespace() < 0 ) {
2336 return $this->mArticleID = 0;
2338 $linkCache = LinkCache::singleton();
2339 if ( $flags & self::GAID_FOR_UPDATE ) {
2340 $oldUpdate = $linkCache->forUpdate( true );
2341 $linkCache->clearLink( $this );
2342 $this->mArticleID = $linkCache->addLinkObj( $this );
2343 $linkCache->forUpdate( $oldUpdate );
2344 } else {
2345 if ( -1 == $this->mArticleID ) {
2346 $this->mArticleID = $linkCache->addLinkObj( $this );
2349 return $this->mArticleID;
2353 * Is this an article that is a redirect page?
2354 * Uses link cache, adding it if necessary
2356 * @param $flags \type{\int} a bit field; may be Title::GAID_FOR_UPDATE to select for update
2357 * @return \type{\bool}
2359 public function isRedirect( $flags = 0 ) {
2360 if ( !is_null( $this->mRedirect ) ) {
2361 return $this->mRedirect;
2363 # Calling getArticleID() loads the field from cache as needed
2364 if ( !$this->getArticleID( $flags ) ) {
2365 return $this->mRedirect = false;
2367 $linkCache = LinkCache::singleton();
2368 $this->mRedirect = (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2370 return $this->mRedirect;
2374 * What is the length of this page?
2375 * Uses link cache, adding it if necessary
2377 * @param $flags \type{\int} a bit field; may be Title::GAID_FOR_UPDATE to select for update
2378 * @return \type{\bool}
2380 public function getLength( $flags = 0 ) {
2381 if ( $this->mLength != -1 ) {
2382 return $this->mLength;
2384 # Calling getArticleID() loads the field from cache as needed
2385 if ( !$this->getArticleID( $flags ) ) {
2386 return $this->mLength = 0;
2388 $linkCache = LinkCache::singleton();
2389 $this->mLength = intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2391 return $this->mLength;
2395 * What is the page_latest field for this page?
2397 * @param $flags \type{\int} a bit field; may be Title::GAID_FOR_UPDATE to select for update
2398 * @return \type{\int} or 0 if the page doesn't exist
2400 public function getLatestRevID( $flags = 0 ) {
2401 if ( $this->mLatestID !== false ) {
2402 return intval( $this->mLatestID );
2404 # Calling getArticleID() loads the field from cache as needed
2405 if ( !$this->getArticleID( $flags ) ) {
2406 return $this->mLatestID = 0;
2408 $linkCache = LinkCache::singleton();
2409 $this->mLatestID = intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2411 return $this->mLatestID;
2415 * This clears some fields in this object, and clears any associated
2416 * keys in the "bad links" section of the link cache.
2418 * - This is called from Article::insertNewArticle() to allow
2419 * loading of the new page_id. It's also called from
2420 * Article::doDeleteArticle()
2422 * @param $newid \type{\int} the new Article ID
2424 public function resetArticleID( $newid ) {
2425 $linkCache = LinkCache::singleton();
2426 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2428 if ( $newid === false ) {
2429 $this->mArticleID = -1;
2430 } else {
2431 $this->mArticleID = intval( $newid );
2433 $this->mRestrictionsLoaded = false;
2434 $this->mRestrictions = array();
2435 $this->mRedirect = null;
2436 $this->mLength = -1;
2437 $this->mLatestID = false;
2441 * Updates page_touched for this page; called from LinksUpdate.php
2443 * @return \type{\bool} true if the update succeded
2445 public function invalidateCache() {
2446 if ( wfReadOnly() ) {
2447 return;
2449 $dbw = wfGetDB( DB_MASTER );
2450 $success = $dbw->update(
2451 'page',
2452 array( 'page_touched' => $dbw->timestamp() ),
2453 $this->pageCond(),
2454 __METHOD__
2456 HTMLFileCache::clearFileCache( $this );
2457 return $success;
2461 * Prefix some arbitrary text with the namespace or interwiki prefix
2462 * of this object
2464 * @param $name \type{\string} the text
2465 * @return \type{\string} the prefixed text
2466 * @private
2468 /* private */ function prefix( $name ) {
2469 $p = '';
2470 if ( $this->mInterwiki != '' ) {
2471 $p = $this->mInterwiki . ':';
2473 if ( 0 != $this->mNamespace ) {
2474 $p .= $this->getNsText() . ':';
2476 return $p . $name;
2480 * Returns a simple regex that will match on characters and sequences invalid in titles.
2481 * Note that this doesn't pick up many things that could be wrong with titles, but that
2482 * replacing this regex with something valid will make many titles valid.
2484 * @return string regex string
2486 static function getTitleInvalidRegex() {
2487 static $rxTc = false;
2488 if ( !$rxTc ) {
2489 # Matching titles will be held as illegal.
2490 $rxTc = '/' .
2491 # Any character not allowed is forbidden...
2492 '[^' . Title::legalChars() . ']' .
2493 # URL percent encoding sequences interfere with the ability
2494 # to round-trip titles -- you can't link to them consistently.
2495 '|%[0-9A-Fa-f]{2}' .
2496 # XML/HTML character references produce similar issues.
2497 '|&[A-Za-z0-9\x80-\xff]+;' .
2498 '|&#[0-9]+;' .
2499 '|&#x[0-9A-Fa-f]+;' .
2500 '/S';
2503 return $rxTc;
2507 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2509 * @param $text string containing title to capitalize
2510 * @param $ns int namespace index, defaults to NS_MAIN
2511 * @return String containing capitalized title
2513 public static function capitalize( $text, $ns = NS_MAIN ) {
2514 global $wgContLang;
2516 if ( MWNamespace::isCapitalized( $ns ) ) {
2517 return $wgContLang->ucfirst( $text );
2518 } else {
2519 return $text;
2524 * Secure and split - main initialisation function for this object
2526 * Assumes that mDbkeyform has been set, and is urldecoded
2527 * and uses underscores, but not otherwise munged. This function
2528 * removes illegal characters, splits off the interwiki and
2529 * namespace prefixes, sets the other forms, and canonicalizes
2530 * everything.
2532 * @return \type{\bool} true on success
2534 private function secureAndSplit() {
2535 global $wgContLang, $wgLocalInterwiki;
2537 # Initialisation
2538 $rxTc = self::getTitleInvalidRegex();
2540 $this->mInterwiki = $this->mFragment = '';
2541 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
2543 $dbkey = $this->mDbkeyform;
2545 # Strip Unicode bidi override characters.
2546 # Sometimes they slip into cut-n-pasted page titles, where the
2547 # override chars get included in list displays.
2548 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2550 # Clean up whitespace
2551 # Note: use of the /u option on preg_replace here will cause
2552 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2553 # conveniently disabling them.
2555 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2556 $dbkey = trim( $dbkey, '_' );
2558 if ( $dbkey == '' ) {
2559 return false;
2562 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
2563 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2564 return false;
2567 $this->mDbkeyform = $dbkey;
2569 # Initial colon indicates main namespace rather than specified default
2570 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2571 if ( ':' == $dbkey { 0 } ) {
2572 $this->mNamespace = NS_MAIN;
2573 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2574 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2577 # Namespace or interwiki prefix
2578 $firstPass = true;
2579 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2580 do {
2581 $m = array();
2582 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2583 $p = $m[1];
2584 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
2585 # Ordinary namespace
2586 $dbkey = $m[2];
2587 $this->mNamespace = $ns;
2588 # For Talk:X pages, check if X has a "namespace" prefix
2589 if ( $ns == NS_TALK && preg_match( $prefixRegexp, $dbkey, $x ) ) {
2590 if ( $wgContLang->getNsIndex( $x[1] ) ) {
2591 return false; # Disallow Talk:File:x type titles...
2592 } else if ( Interwiki::isValidInterwiki( $x[1] ) ) {
2593 return false; # Disallow Talk:Interwiki:x type titles...
2596 } elseif ( Interwiki::isValidInterwiki( $p ) ) {
2597 if ( !$firstPass ) {
2598 # Can't make a local interwiki link to an interwiki link.
2599 # That's just crazy!
2600 return false;
2603 # Interwiki link
2604 $dbkey = $m[2];
2605 $this->mInterwiki = $wgContLang->lc( $p );
2607 # Redundant interwiki prefix to the local wiki
2608 if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
2609 if ( $dbkey == '' ) {
2610 # Can't have an empty self-link
2611 return false;
2613 $this->mInterwiki = '';
2614 $firstPass = false;
2615 # Do another namespace split...
2616 continue;
2619 # If there's an initial colon after the interwiki, that also
2620 # resets the default namespace
2621 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2622 $this->mNamespace = NS_MAIN;
2623 $dbkey = substr( $dbkey, 1 );
2626 # If there's no recognized interwiki or namespace,
2627 # then let the colon expression be part of the title.
2629 break;
2630 } while ( true );
2632 # We already know that some pages won't be in the database!
2634 if ( $this->mInterwiki != '' || NS_SPECIAL == $this->mNamespace ) {
2635 $this->mArticleID = 0;
2637 $fragment = strstr( $dbkey, '#' );
2638 if ( false !== $fragment ) {
2639 $this->setFragment( preg_replace( '/^#_*/', '#', $fragment ) );
2640 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2641 # remove whitespace again: prevents "Foo_bar_#"
2642 # becoming "Foo_bar_"
2643 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2646 # Reject illegal characters.
2648 if ( preg_match( $rxTc, $dbkey ) ) {
2649 return false;
2653 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2654 * reachable due to the way web browsers deal with 'relative' URLs.
2655 * Also, they conflict with subpage syntax. Forbid them explicitly.
2657 if ( strpos( $dbkey, '.' ) !== false &&
2658 ( $dbkey === '.' || $dbkey === '..' ||
2659 strpos( $dbkey, './' ) === 0 ||
2660 strpos( $dbkey, '../' ) === 0 ||
2661 strpos( $dbkey, '/./' ) !== false ||
2662 strpos( $dbkey, '/../' ) !== false ||
2663 substr( $dbkey, -2 ) == '/.' ||
2664 substr( $dbkey, -3 ) == '/..' ) )
2666 return false;
2670 * Magic tilde sequences? Nu-uh!
2672 if ( strpos( $dbkey, '~~~' ) !== false ) {
2673 return false;
2677 * Limit the size of titles to 255 bytes.
2678 * This is typically the size of the underlying database field.
2679 * We make an exception for special pages, which don't need to be stored
2680 * in the database, and may edge over 255 bytes due to subpage syntax
2681 * for long titles, e.g. [[Special:Block/Long name]]
2683 if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) ||
2684 strlen( $dbkey ) > 512 )
2686 return false;
2690 * Normally, all wiki links are forced to have
2691 * an initial capital letter so [[foo]] and [[Foo]]
2692 * point to the same place.
2694 * Don't force it for interwikis, since the other
2695 * site might be case-sensitive.
2697 $this->mUserCaseDBKey = $dbkey;
2698 if ( $this->mInterwiki == '' ) {
2699 $dbkey = self::capitalize( $dbkey, $this->mNamespace );
2703 * Can't make a link to a namespace alone...
2704 * "empty" local links can only be self-links
2705 * with a fragment identifier.
2707 if ( $dbkey == '' &&
2708 $this->mInterwiki == '' &&
2709 $this->mNamespace != NS_MAIN ) {
2710 return false;
2712 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2713 // IP names are not allowed for accounts, and can only be referring to
2714 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2715 // there are numerous ways to present the same IP. Having sp:contribs scan
2716 // them all is silly and having some show the edits and others not is
2717 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2718 $dbkey = ( $this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK ) ?
2719 IP::sanitizeIP( $dbkey ) : $dbkey;
2720 // Any remaining initial :s are illegal.
2721 if ( $dbkey !== '' && ':' == $dbkey { 0 } ) {
2722 return false;
2725 # Fill fields
2726 $this->mDbkeyform = $dbkey;
2727 $this->mUrlform = wfUrlencode( $dbkey );
2729 $this->mTextform = str_replace( '_', ' ', $dbkey );
2731 return true;
2735 * Set the fragment for this title. Removes the first character from the
2736 * specified fragment before setting, so it assumes you're passing it with
2737 * an initial "#".
2739 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2740 * Still in active use privately.
2742 * @param $fragment \type{\string} text
2744 public function setFragment( $fragment ) {
2745 $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
2749 * Get a Title object associated with the talk page of this article
2751 * @return Title the object for the talk page
2753 public function getTalkPage() {
2754 return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
2758 * Get a title object associated with the subject page of this
2759 * talk page
2761 * @return Title the object for the subject page
2763 public function getSubjectPage() {
2764 // Is this the same title?
2765 $subjectNS = MWNamespace::getSubject( $this->getNamespace() );
2766 if ( $this->getNamespace() == $subjectNS ) {
2767 return $this;
2769 return Title::makeTitle( $subjectNS, $this->getDBkey() );
2773 * Get an array of Title objects linking to this Title
2774 * Also stores the IDs in the link cache.
2776 * WARNING: do not use this function on arbitrary user-supplied titles!
2777 * On heavily-used templates it will max out the memory.
2779 * @param $options Array: may be FOR UPDATE
2780 * @param $table String: table name
2781 * @param $prefix String: fields prefix
2782 * @return \type{\arrayof{Title}} the Title objects linking here
2784 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
2785 $linkCache = LinkCache::singleton();
2787 if ( count( $options ) > 0 ) {
2788 $db = wfGetDB( DB_MASTER );
2789 } else {
2790 $db = wfGetDB( DB_SLAVE );
2793 $res = $db->select(
2794 array( 'page', $table ),
2795 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
2796 array(
2797 "{$prefix}_from=page_id",
2798 "{$prefix}_namespace" => $this->getNamespace(),
2799 "{$prefix}_title" => $this->getDBkey() ),
2800 __METHOD__,
2801 $options
2804 $retVal = array();
2805 if ( $db->numRows( $res ) ) {
2806 foreach ( $res as $row ) {
2807 $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title );
2808 if ( $titleObj ) {
2809 $linkCache->addGoodLinkObj( $row->page_id, $titleObj, $row->page_len, $row->page_is_redirect, $row->page_latest );
2810 $retVal[] = $titleObj;
2814 return $retVal;
2818 * Get an array of Title objects using this Title as a template
2819 * Also stores the IDs in the link cache.
2821 * WARNING: do not use this function on arbitrary user-supplied titles!
2822 * On heavily-used templates it will max out the memory.
2824 * @param $options Array: may be FOR UPDATE
2825 * @return \type{\arrayof{Title}} the Title objects linking here
2827 public function getTemplateLinksTo( $options = array() ) {
2828 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2832 * Get an array of Title objects referring to non-existent articles linked from this page
2834 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2835 * @return \type{\arrayof{Title}} the Title objects
2837 public function getBrokenLinksFrom() {
2838 if ( $this->getArticleId() == 0 ) {
2839 # All links from article ID 0 are false positives
2840 return array();
2843 $dbr = wfGetDB( DB_SLAVE );
2844 $res = $dbr->select(
2845 array( 'page', 'pagelinks' ),
2846 array( 'pl_namespace', 'pl_title' ),
2847 array(
2848 'pl_from' => $this->getArticleId(),
2849 'page_namespace IS NULL'
2851 __METHOD__, array(),
2852 array(
2853 'page' => array(
2854 'LEFT JOIN',
2855 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
2860 $retVal = array();
2861 foreach ( $res as $row ) {
2862 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
2864 return $retVal;
2869 * Get a list of URLs to purge from the Squid cache when this
2870 * page changes
2872 * @return \type{\arrayof{\string}} the URLs
2874 public function getSquidURLs() {
2875 global $wgContLang;
2877 $urls = array(
2878 $this->getInternalURL(),
2879 $this->getInternalURL( 'action=history' )
2882 // purge variant urls as well
2883 if ( $wgContLang->hasVariants() ) {
2884 $variants = $wgContLang->getVariants();
2885 foreach ( $variants as $vCode ) {
2886 $urls[] = $this->getInternalURL( '', $vCode );
2890 return $urls;
2894 * Purge all applicable Squid URLs
2896 public function purgeSquid() {
2897 global $wgUseSquid;
2898 if ( $wgUseSquid ) {
2899 $urls = $this->getSquidURLs();
2900 $u = new SquidUpdate( $urls );
2901 $u->doUpdate();
2906 * Move this page without authentication
2908 * @param $nt \type{Title} the new page Title
2909 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2911 public function moveNoAuth( &$nt ) {
2912 return $this->moveTo( $nt, false );
2916 * Check whether a given move operation would be valid.
2917 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2919 * @param $nt \type{Title} the new title
2920 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2921 * should be checked
2922 * @param $reason \type{\string} is the log summary of the move, used for spam checking
2923 * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure
2925 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2926 global $wgUser;
2928 $errors = array();
2929 if ( !$nt ) {
2930 // Normally we'd add this to $errors, but we'll get
2931 // lots of syntax errors if $nt is not an object
2932 return array( array( 'badtitletext' ) );
2934 if ( $this->equals( $nt ) ) {
2935 $errors[] = array( 'selfmove' );
2937 if ( !$this->isMovable() ) {
2938 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2940 if ( $nt->getInterwiki() != '' ) {
2941 $errors[] = array( 'immobile-target-namespace-iw' );
2943 if ( !$nt->isMovable() ) {
2944 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
2947 $oldid = $this->getArticleID();
2948 $newid = $nt->getArticleID();
2950 if ( strlen( $nt->getDBkey() ) < 1 ) {
2951 $errors[] = array( 'articleexists' );
2953 if ( ( $this->getDBkey() == '' ) ||
2954 ( !$oldid ) ||
2955 ( $nt->getDBkey() == '' ) ) {
2956 $errors[] = array( 'badarticleerror' );
2959 // Image-specific checks
2960 if ( $this->getNamespace() == NS_FILE ) {
2961 if ( $nt->getNamespace() != NS_FILE ) {
2962 $errors[] = array( 'imagenocrossnamespace' );
2964 $file = wfLocalFile( $this );
2965 if ( $file->exists() ) {
2966 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
2967 $errors[] = array( 'imageinvalidfilename' );
2969 if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
2970 $errors[] = array( 'imagetypemismatch' );
2973 $destfile = wfLocalFile( $nt );
2974 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destfile->exists() && wfFindFile( $nt ) ) {
2975 $errors[] = array( 'file-exists-sharedrepo' );
2979 if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) {
2980 $errors[] = array( 'nonfile-cannot-move-to-file' );
2983 if ( $auth ) {
2984 $errors = wfMergeErrorArrays( $errors,
2985 $this->getUserPermissionsErrors( 'move', $wgUser ),
2986 $this->getUserPermissionsErrors( 'edit', $wgUser ),
2987 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
2988 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
2991 $match = EditPage::matchSummarySpamRegex( $reason );
2992 if ( $match !== false ) {
2993 // This is kind of lame, won't display nice
2994 $errors[] = array( 'spamprotectiontext' );
2997 $err = null;
2998 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
2999 $errors[] = array( 'hookaborted', $err );
3002 # The move is allowed only if (1) the target doesn't exist, or
3003 # (2) the target is a redirect to the source, and has no history
3004 # (so we can undo bad moves right after they're done).
3006 if ( 0 != $newid ) { # Target exists; check for validity
3007 if ( !$this->isValidMoveTarget( $nt ) ) {
3008 $errors[] = array( 'articleexists' );
3010 } else {
3011 $tp = $nt->getTitleProtection();
3012 $right = ( $tp['pt_create_perm'] == 'sysop' ) ? 'protect' : $tp['pt_create_perm'];
3013 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3014 $errors[] = array( 'cantmove-titleprotected' );
3017 if ( empty( $errors ) ) {
3018 return true;
3020 return $errors;
3024 * Move a title to a new location
3026 * @param $nt \type{Title} the new title
3027 * @param $auth \type{\bool} indicates whether $wgUser's permissions
3028 * should be checked
3029 * @param $reason \type{\string} The reason for the move
3030 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title.
3031 * Ignored if the user doesn't have the suppressredirect right.
3032 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
3034 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3035 global $wgContLang;
3037 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3038 if ( is_array( $err ) ) {
3039 return $err;
3042 // If it is a file, move it first. It is done before all other moving stuff is done because it's hard to revert
3043 $dbw = wfGetDB( DB_MASTER );
3044 if ( $this->getNamespace() == NS_FILE ) {
3045 $file = wfLocalFile( $this );
3046 if ( $file->exists() ) {
3047 $status = $file->move( $nt );
3048 if ( !$status->isOk() ) {
3049 return $status->getErrorsArray();
3054 $pageid = $this->getArticleID();
3055 $protected = $this->isProtected();
3056 if ( $nt->exists() ) {
3057 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
3058 $pageCountChange = ( $createRedirect ? 0 : -1 );
3059 } else { # Target didn't exist, do normal move.
3060 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
3061 $pageCountChange = ( $createRedirect ? 1 : 0 );
3064 if ( is_array( $err ) ) {
3065 return $err;
3067 $redirid = $this->getArticleID();
3069 // Refresh the sortkey for this row. Be careful to avoid resetting
3070 // cl_timestamp, which may disturb time-based lists on some sites.
3071 $prefix = $dbw->selectField(
3072 'categorylinks',
3073 'cl_sortkey_prefix',
3074 array( 'cl_from' => $pageid ),
3075 __METHOD__
3077 $dbw->update( 'categorylinks',
3078 array(
3079 'cl_sortkey' => $wgContLang->convertToSortkey( $nt->getCategorySortkey( $prefix ) ),
3080 'cl_timestamp=cl_timestamp' ),
3081 array( 'cl_from' => $pageid ),
3082 __METHOD__ );
3084 if ( $protected ) {
3085 # Protect the redirect title as the title used to be...
3086 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3087 array(
3088 'pr_page' => $redirid,
3089 'pr_type' => 'pr_type',
3090 'pr_level' => 'pr_level',
3091 'pr_cascade' => 'pr_cascade',
3092 'pr_user' => 'pr_user',
3093 'pr_expiry' => 'pr_expiry'
3095 array( 'pr_page' => $pageid ),
3096 __METHOD__,
3097 array( 'IGNORE' )
3099 # Update the protection log
3100 $log = new LogPage( 'protect' );
3101 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3102 if ( $reason ) {
3103 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3105 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) ); // FIXME: $params?
3108 # Update watchlists
3109 $oldnamespace = $this->getNamespace() & ~1;
3110 $newnamespace = $nt->getNamespace() & ~1;
3111 $oldtitle = $this->getDBkey();
3112 $newtitle = $nt->getDBkey();
3114 if ( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
3115 WatchedItem::duplicateEntries( $this, $nt );
3118 # Update search engine
3119 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
3120 $u->doUpdate();
3121 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
3122 $u->doUpdate();
3124 # Update site_stats
3125 if ( $this->isContentPage() && !$nt->isContentPage() ) {
3126 # No longer a content page
3127 # Not viewed, edited, removing
3128 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
3129 } elseif ( !$this->isContentPage() && $nt->isContentPage() ) {
3130 # Now a content page
3131 # Not viewed, edited, adding
3132 $u = new SiteStatsUpdate( 0, 1, + 1, $pageCountChange );
3133 } elseif ( $pageCountChange ) {
3134 # Redirect added
3135 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
3136 } else {
3137 # Nothing special
3138 $u = false;
3140 if ( $u ) {
3141 $u->doUpdate();
3143 # Update message cache for interface messages
3144 global $wgMessageCache;
3145 if ( $this->getNamespace() == NS_MEDIAWIKI ) {
3146 # @bug 17860: old article can be deleted, if this the case,
3147 # delete it from message cache
3148 if ( $this->getArticleID() === 0 ) {
3149 $wgMessageCache->replace( $this->getDBkey(), false );
3150 } else {
3151 $oldarticle = new Article( $this );
3152 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
3155 if ( $nt->getNamespace() == NS_MEDIAWIKI ) {
3156 $newarticle = new Article( $nt );
3157 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
3160 global $wgUser;
3161 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3162 return true;
3166 * Move page to a title which is at present a redirect to the
3167 * source page
3169 * @param $nt \type{Title} the page to move to, which should currently
3170 * be a redirect
3171 * @param $reason \type{\string} The reason for the move
3172 * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title.
3173 * Ignored if the user doesn't have the suppressredirect right
3175 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
3176 global $wgUseSquid, $wgUser, $wgContLang;
3178 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
3180 if ( $reason ) {
3181 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3183 # Truncate for whole multibyte characters. +5 bytes for ellipsis
3184 $comment = $wgContLang->truncate( $comment, 250 );
3186 $now = wfTimestampNow();
3187 $newid = $nt->getArticleID();
3188 $oldid = $this->getArticleID();
3189 $latest = $this->getLatestRevID();
3191 $dbw = wfGetDB( DB_MASTER );
3193 $rcts = $dbw->timestamp( $nt->getEarliestRevTime() );
3194 $newns = $nt->getNamespace();
3195 $newdbk = $nt->getDBkey();
3197 # Delete the old redirect. We don't save it to history since
3198 # by definition if we've got here it's rather uninteresting.
3199 # We have to remove it so that the next step doesn't trigger
3200 # a conflict on the unique namespace+title index...
3201 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ );
3202 if ( !$dbw->cascadingDeletes() ) {
3203 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__ );
3204 global $wgUseTrackbacks;
3205 if ( $wgUseTrackbacks ) {
3206 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__ );
3208 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__ );
3209 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__ );
3210 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__ );
3211 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__ );
3212 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__ );
3213 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__ );
3214 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__ );
3216 // If the redirect was recently created, it may have an entry in recentchanges still
3217 $dbw->delete( 'recentchanges',
3218 array( 'rc_timestamp' => $rcts, 'rc_namespace' => $newns, 'rc_title' => $newdbk, 'rc_new' => 1 ),
3219 __METHOD__
3222 # Save a null revision in the page's history notifying of the move
3223 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
3224 $nullRevId = $nullRevision->insertOn( $dbw );
3226 $article = new Article( $this );
3227 wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) );
3229 # Change the name of the target page:
3230 $dbw->update( 'page',
3231 /* SET */ array(
3232 'page_touched' => $dbw->timestamp( $now ),
3233 'page_namespace' => $nt->getNamespace(),
3234 'page_title' => $nt->getDBkey(),
3235 'page_latest' => $nullRevId,
3237 /* WHERE */ array( 'page_id' => $oldid ),
3238 __METHOD__
3240 $nt->resetArticleID( $oldid );
3242 # Recreate the redirect, this time in the other direction.
3243 if ( $createRedirect || !$wgUser->isAllowed( 'suppressredirect' ) ) {
3244 $mwRedir = MagicWord::get( 'redirect' );
3245 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3246 $redirectArticle = new Article( $this );
3247 $newid = $redirectArticle->insertOn( $dbw );
3248 $redirectRevision = new Revision( array(
3249 'page' => $newid,
3250 'comment' => $comment,
3251 'text' => $redirectText ) );
3252 $redirectRevision->insertOn( $dbw );
3253 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3255 wfRunHooks( 'NewRevisionFromEditComplete', array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3257 # Now, we record the link from the redirect to the new title.
3258 # It should have no other outgoing links...
3259 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__ );
3260 $dbw->insert( 'pagelinks',
3261 array(
3262 'pl_from' => $newid,
3263 'pl_namespace' => $nt->getNamespace(),
3264 'pl_title' => $nt->getDBkey() ),
3265 __METHOD__ );
3266 $redirectSuppressed = false;
3267 } else {
3268 $this->resetArticleID( 0 );
3269 $redirectSuppressed = true;
3272 # Log the move
3273 $log = new LogPage( 'move' );
3274 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3276 # Purge squid
3277 if ( $wgUseSquid ) {
3278 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
3279 $u = new SquidUpdate( $urls );
3280 $u->doUpdate();
3286 * Move page to non-existing title.
3288 * @param $nt \type{Title} the new Title
3289 * @param $reason \type{\string} The reason for the move
3290 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title
3291 * Ignored if the user doesn't have the suppressredirect right
3293 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
3294 global $wgUser, $wgContLang;
3296 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3297 if ( $reason ) {
3298 $comment .= wfMsgExt( 'colon-separator',
3299 array( 'escapenoentities', 'content' ) );
3300 $comment .= $reason;
3302 # Truncate for whole multibyte characters. +5 bytes for ellipsis
3303 $comment = $wgContLang->truncate( $comment, 250 );
3305 $newid = $nt->getArticleID();
3306 $oldid = $this->getArticleID();
3307 $latest = $this->getLatestRevId();
3309 $dbw = wfGetDB( DB_MASTER );
3310 $now = $dbw->timestamp();
3312 # Save a null revision in the page's history notifying of the move
3313 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
3314 if ( !is_object( $nullRevision ) ) {
3315 throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
3317 $nullRevId = $nullRevision->insertOn( $dbw );
3319 $article = new Article( $this );
3320 wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) );
3322 # Rename page entry
3323 $dbw->update( 'page',
3324 /* SET */ array(
3325 'page_touched' => $now,
3326 'page_namespace' => $nt->getNamespace(),
3327 'page_title' => $nt->getDBkey(),
3328 'page_latest' => $nullRevId,
3330 /* WHERE */ array( 'page_id' => $oldid ),
3331 __METHOD__
3333 $nt->resetArticleID( $oldid );
3335 if ( $createRedirect || !$wgUser->isAllowed( 'suppressredirect' ) ) {
3336 # Insert redirect
3337 $mwRedir = MagicWord::get( 'redirect' );
3338 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3339 $redirectArticle = new Article( $this );
3340 $newid = $redirectArticle->insertOn( $dbw );
3341 $redirectRevision = new Revision( array(
3342 'page' => $newid,
3343 'comment' => $comment,
3344 'text' => $redirectText ) );
3345 $redirectRevision->insertOn( $dbw );
3346 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3348 wfRunHooks( 'NewRevisionFromEditComplete', array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3350 # Record the just-created redirect's linking to the page
3351 $dbw->insert( 'pagelinks',
3352 array(
3353 'pl_from' => $newid,
3354 'pl_namespace' => $nt->getNamespace(),
3355 'pl_title' => $nt->getDBkey() ),
3356 __METHOD__ );
3357 $redirectSuppressed = false;
3358 } else {
3359 $this->resetArticleID( 0 );
3360 $redirectSuppressed = true;
3363 # Log the move
3364 $log = new LogPage( 'move' );
3365 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3367 # Purge caches as per article creation
3368 Article::onArticleCreate( $nt );
3370 # Purge old title from squid
3371 # The new title, and links to the new title, are purged in Article::onArticleCreate()
3372 $this->purgeSquid();
3376 * Move this page's subpages to be subpages of $nt
3378 * @param $nt Title Move target
3379 * @param $auth bool Whether $wgUser's permissions should be checked
3380 * @param $reason string The reason for the move
3381 * @param $createRedirect bool Whether to create redirects from the old subpages to the new ones
3382 * Ignored if the user doesn't have the 'suppressredirect' right
3383 * @return mixed array with old page titles as keys, and strings (new page titles) or
3384 * arrays (errors) as values, or an error array with numeric indices if no pages were moved
3386 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3387 global $wgMaximumMovedPages;
3388 // Check permissions
3389 if ( !$this->userCan( 'move-subpages' ) ) {
3390 return array( 'cant-move-subpages' );
3392 // Do the source and target namespaces support subpages?
3393 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
3394 return array( 'namespace-nosubpages',
3395 MWNamespace::getCanonicalName( $this->getNamespace() ) );
3397 if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) {
3398 return array( 'namespace-nosubpages',
3399 MWNamespace::getCanonicalName( $nt->getNamespace() ) );
3402 $subpages = $this->getSubpages( $wgMaximumMovedPages + 1 );
3403 $retval = array();
3404 $count = 0;
3405 foreach ( $subpages as $oldSubpage ) {
3406 $count++;
3407 if ( $count > $wgMaximumMovedPages ) {
3408 $retval[$oldSubpage->getPrefixedTitle()] =
3409 array( 'movepage-max-pages',
3410 $wgMaximumMovedPages );
3411 break;
3414 // We don't know whether this function was called before
3415 // or after moving the root page, so check both
3416 // $this and $nt
3417 if ( $oldSubpage->getArticleId() == $this->getArticleId() ||
3418 $oldSubpage->getArticleID() == $nt->getArticleId() )
3420 // When moving a page to a subpage of itself,
3421 // don't move it twice
3422 continue;
3424 $newPageName = preg_replace(
3425 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3426 StringUtils::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3427 $oldSubpage->getDBkey() );
3428 if ( $oldSubpage->isTalkPage() ) {
3429 $newNs = $nt->getTalkPage()->getNamespace();
3430 } else {
3431 $newNs = $nt->getSubjectPage()->getNamespace();
3433 # Bug 14385: we need makeTitleSafe because the new page names may
3434 # be longer than 255 characters.
3435 $newSubpage = Title::makeTitleSafe( $newNs, $newPageName );
3437 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3438 if ( $success === true ) {
3439 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3440 } else {
3441 $retval[$oldSubpage->getPrefixedText()] = $success;
3444 return $retval;
3448 * Checks if this page is just a one-rev redirect.
3449 * Adds lock, so don't use just for light purposes.
3451 * @return \type{\bool}
3453 public function isSingleRevRedirect() {
3454 $dbw = wfGetDB( DB_MASTER );
3455 # Is it a redirect?
3456 $row = $dbw->selectRow( 'page',
3457 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3458 $this->pageCond(),
3459 __METHOD__,
3460 array( 'FOR UPDATE' )
3462 # Cache some fields we may want
3463 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
3464 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
3465 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
3466 if ( !$this->mRedirect ) {
3467 return false;
3469 # Does the article have a history?
3470 $row = $dbw->selectField( array( 'page', 'revision' ),
3471 'rev_id',
3472 array( 'page_namespace' => $this->getNamespace(),
3473 'page_title' => $this->getDBkey(),
3474 'page_id=rev_page',
3475 'page_latest != rev_id'
3477 __METHOD__,
3478 array( 'FOR UPDATE' )
3480 # Return true if there was no history
3481 return ( $row === false );
3485 * Checks if $this can be moved to a given Title
3486 * - Selects for update, so don't call it unless you mean business
3488 * @param $nt \type{Title} the new title to check
3489 * @return \type{\bool} TRUE or FALSE
3491 public function isValidMoveTarget( $nt ) {
3492 # Is it an existing file?
3493 if ( $nt->getNamespace() == NS_FILE ) {
3494 $file = wfLocalFile( $nt );
3495 if ( $file->exists() ) {
3496 wfDebug( __METHOD__ . ": file exists\n" );
3497 return false;
3500 # Is it a redirect with no history?
3501 if ( !$nt->isSingleRevRedirect() ) {
3502 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
3503 return false;
3505 # Get the article text
3506 $rev = Revision::newFromTitle( $nt );
3507 $text = $rev->getText();
3508 # Does the redirect point to the source?
3509 # Or is it a broken self-redirect, usually caused by namespace collisions?
3510 $m = array();
3511 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3512 $redirTitle = Title::newFromText( $m[1] );
3513 if ( !is_object( $redirTitle ) ||
3514 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3515 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3516 wfDebug( __METHOD__ . ": redirect points to other page\n" );
3517 return false;
3519 } else {
3520 # Fail safe
3521 wfDebug( __METHOD__ . ": failsafe\n" );
3522 return false;
3524 return true;
3528 * Can this title be added to a user's watchlist?
3530 * @return \type{\bool} TRUE or FALSE
3532 public function isWatchable() {
3533 return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() );
3537 * Get categories to which this Title belongs and return an array of
3538 * categories' names.
3540 * @return \type{\array} array an array of parents in the form:
3541 * $parent => $currentarticle
3543 public function getParentCategories() {
3544 global $wgContLang;
3546 $titlekey = $this->getArticleId();
3547 $dbr = wfGetDB( DB_SLAVE );
3548 $categorylinks = $dbr->tableName( 'categorylinks' );
3550 # NEW SQL
3551 $sql = "SELECT * FROM $categorylinks"
3552 . " WHERE cl_from='$titlekey'"
3553 . " AND cl_from <> '0'"
3554 . " ORDER BY cl_sortkey";
3556 $res = $dbr->query( $sql );
3557 $data = array();
3559 if ( $dbr->numRows( $res ) > 0 ) {
3560 foreach ( $res as $row ) {
3561 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3562 $data[$wgContLang->getNSText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText();
3565 return $data;
3569 * Get a tree of parent categories
3571 * @param $children \type{\array} an array with the children in the keys, to check for circular refs
3572 * @return \type{\array} Tree of parent categories
3574 public function getParentCategoryTree( $children = array() ) {
3575 $stack = array();
3576 $parents = $this->getParentCategories();
3578 if ( $parents ) {
3579 foreach ( $parents as $parent => $current ) {
3580 if ( array_key_exists( $parent, $children ) ) {
3581 # Circular reference
3582 $stack[$parent] = array();
3583 } else {
3584 $nt = Title::newFromText( $parent );
3585 if ( $nt ) {
3586 $stack[$parent] = $nt->getParentCategoryTree( $children + array( $parent => 1 ) );
3592 return $stack;
3597 * Get an associative array for selecting this title from
3598 * the "page" table
3600 * @return \type{\array} Selection array
3602 public function pageCond() {
3603 if ( $this->mArticleID > 0 ) {
3604 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3605 return array( 'page_id' => $this->mArticleID );
3606 } else {
3607 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
3612 * Get the revision ID of the previous revision
3614 * @param $revId \type{\int} Revision ID. Get the revision that was before this one.
3615 * @param $flags \type{\int} Title::GAID_FOR_UPDATE
3616 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3618 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3619 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3620 return $db->selectField( 'revision', 'rev_id',
3621 array(
3622 'rev_page' => $this->getArticleId( $flags ),
3623 'rev_id < ' . intval( $revId )
3625 __METHOD__,
3626 array( 'ORDER BY' => 'rev_id DESC' )
3631 * Get the revision ID of the next revision
3633 * @param $revId \type{\int} Revision ID. Get the revision that was after this one.
3634 * @param $flags \type{\int} Title::GAID_FOR_UPDATE
3635 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3637 public function getNextRevisionID( $revId, $flags = 0 ) {
3638 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3639 return $db->selectField( 'revision', 'rev_id',
3640 array(
3641 'rev_page' => $this->getArticleId( $flags ),
3642 'rev_id > ' . intval( $revId )
3644 __METHOD__,
3645 array( 'ORDER BY' => 'rev_id' )
3650 * Get the first revision of the page
3652 * @param $flags \type{\int} Title::GAID_FOR_UPDATE
3653 * @return Revision (or NULL if page doesn't exist)
3655 public function getFirstRevision( $flags = 0 ) {
3656 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3657 $pageId = $this->getArticleId( $flags );
3658 if ( !$pageId ) {
3659 return null;
3661 $row = $db->selectRow( 'revision', '*',
3662 array( 'rev_page' => $pageId ),
3663 __METHOD__,
3664 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3666 if ( !$row ) {
3667 return null;
3668 } else {
3669 return new Revision( $row );
3674 * Check if this is a new page
3676 * @return bool
3678 public function isNewPage() {
3679 $dbr = wfGetDB( DB_SLAVE );
3680 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
3684 * Get the oldest revision timestamp of this page
3686 * @return String: MW timestamp
3688 public function getEarliestRevTime() {
3689 $dbr = wfGetDB( DB_SLAVE );
3690 if ( $this->exists() ) {
3691 $min = $dbr->selectField( 'revision',
3692 'MIN(rev_timestamp)',
3693 array( 'rev_page' => $this->getArticleId() ),
3694 __METHOD__ );
3695 return wfTimestampOrNull( TS_MW, $min );
3697 return null;
3701 * Get the number of revisions between the given revision IDs.
3702 * Used for diffs and other things that really need it.
3704 * @param $old \type{\int} Revision ID.
3705 * @param $new \type{\int} Revision ID.
3706 * @return \type{\int} Number of revisions between these IDs.
3708 public function countRevisionsBetween( $old, $new ) {
3709 $dbr = wfGetDB( DB_SLAVE );
3710 return (int)$dbr->selectField( 'revision', 'count(*)',
3711 'rev_page = ' . intval( $this->getArticleId() ) .
3712 ' AND rev_id > ' . intval( $old ) .
3713 ' AND rev_id < ' . intval( $new ),
3714 __METHOD__
3719 * Get the number of authors between the given revision IDs.
3720 * Used for diffs and other things that really need it.
3722 * @param $fromRevId \type{\int} Revision ID (first before range)
3723 * @param $toRevId \type{\int} Revision ID (first after range)
3724 * @param $limit \type{\int} Maximum number of authors
3725 * @param $flags \type{\int} Title::GAID_FOR_UPDATE
3726 * @return \type{\int}
3728 public function countAuthorsBetween( $fromRevId, $toRevId, $limit, $flags = 0 ) {
3729 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3730 $res = $db->select( 'revision', 'DISTINCT rev_user_text',
3731 array(
3732 'rev_page = ' . $this->getArticleID(),
3733 'rev_id > ' . (int)$fromRevId,
3734 'rev_id < ' . (int)$toRevId
3735 ), __METHOD__,
3736 array( 'LIMIT' => $limit )
3738 return (int)$db->numRows( $res );
3742 * Compare with another title.
3744 * @param $title \type{Title}
3745 * @return \type{\bool} TRUE or FALSE
3747 public function equals( Title $title ) {
3748 // Note: === is necessary for proper matching of number-like titles.
3749 return $this->getInterwiki() === $title->getInterwiki()
3750 && $this->getNamespace() == $title->getNamespace()
3751 && $this->getDBkey() === $title->getDBkey();
3755 * Callback for usort() to do title sorts by (namespace, title)
3757 * @return Integer: result of string comparison, or namespace comparison
3759 public static function compare( $a, $b ) {
3760 if ( $a->getNamespace() == $b->getNamespace() ) {
3761 return strcmp( $a->getText(), $b->getText() );
3762 } else {
3763 return $a->getNamespace() - $b->getNamespace();
3768 * Return a string representation of this title
3770 * @return \type{\string} String representation of this title
3772 public function __toString() {
3773 return $this->getPrefixedText();
3777 * Check if page exists. For historical reasons, this function simply
3778 * checks for the existence of the title in the page table, and will
3779 * thus return false for interwiki links, special pages and the like.
3780 * If you want to know if a title can be meaningfully viewed, you should
3781 * probably call the isKnown() method instead.
3783 * @return \type{\bool}
3785 public function exists() {
3786 return $this->getArticleId() != 0;
3790 * Should links to this title be shown as potentially viewable (i.e. as
3791 * "bluelinks"), even if there's no record by this title in the page
3792 * table?
3794 * This function is semi-deprecated for public use, as well as somewhat
3795 * misleadingly named. You probably just want to call isKnown(), which
3796 * calls this function internally.
3798 * (ISSUE: Most of these checks are cheap, but the file existence check
3799 * can potentially be quite expensive. Including it here fixes a lot of
3800 * existing code, but we might want to add an optional parameter to skip
3801 * it and any other expensive checks.)
3803 * @return \type{\bool}
3805 public function isAlwaysKnown() {
3806 if ( $this->mInterwiki != '' ) {
3807 return true; // any interwiki link might be viewable, for all we know
3809 switch( $this->mNamespace ) {
3810 case NS_MEDIA:
3811 case NS_FILE:
3812 return (bool)wfFindFile( $this ); // file exists, possibly in a foreign repo
3813 case NS_SPECIAL:
3814 return SpecialPage::exists( $this->getDBkey() ); // valid special page
3815 case NS_MAIN:
3816 return $this->mDbkeyform == ''; // selflink, possibly with fragment
3817 case NS_MEDIAWIKI:
3818 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3819 // the full l10n of that language to be loaded. That takes much memory and
3820 // isn't needed. So we strip the language part away.
3821 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform, 2 );
3822 return (bool)wfMsgWeirdKey( $basename ); // known system message
3823 default:
3824 return false;
3829 * Does this title refer to a page that can (or might) be meaningfully
3830 * viewed? In particular, this function may be used to determine if
3831 * links to the title should be rendered as "bluelinks" (as opposed to
3832 * "redlinks" to non-existent pages).
3834 * @return \type{\bool}
3836 public function isKnown() {
3837 return $this->isAlwaysKnown() || $this->exists();
3841 * Does this page have source text?
3843 * @return Boolean
3845 public function hasSourceText() {
3846 if ( $this->exists() ) {
3847 return true;
3850 if ( $this->mNamespace == NS_MEDIAWIKI ) {
3851 // If the page doesn't exist but is a known system message, default
3852 // message content will be displayed, same for language subpages
3853 // Also, if the page is form Mediawiki:message/lang, calling wfMsgWeirdKey
3854 // causes the full l10n of that language to be loaded. That takes much
3855 // memory and isn't needed. So we strip the language part away.
3856 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform, 2 );
3857 return (bool)wfMsgWeirdKey( $basename );
3860 return false;
3864 * Is this in a namespace that allows actual pages?
3866 * @return \type{\bool}
3867 * @internal note -- uses hardcoded namespace index instead of constants
3869 public function canExist() {
3870 return $this->mNamespace >= 0 && $this->mNamespace != NS_MEDIA;
3874 * Update page_touched timestamps and send squid purge messages for
3875 * pages linking to this title. May be sent to the job queue depending
3876 * on the number of links. Typically called on create and delete.
3878 public function touchLinks() {
3879 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3880 $u->doUpdate();
3882 if ( $this->getNamespace() == NS_CATEGORY ) {
3883 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3884 $u->doUpdate();
3889 * Get the last touched timestamp
3891 * @param $db DatabaseBase: optional db
3892 * @return \type{\string} Last touched timestamp
3894 public function getTouched( $db = null ) {
3895 $db = isset( $db ) ? $db : wfGetDB( DB_SLAVE );
3896 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
3897 return $touched;
3901 * Get the timestamp when this page was updated since the user last saw it.
3903 * @param $user User
3904 * @return Mixed: string/null
3906 public function getNotificationTimestamp( $user = null ) {
3907 global $wgUser, $wgShowUpdatedMarker;
3908 // Assume current user if none given
3909 if ( !$user ) {
3910 $user = $wgUser;
3912 // Check cache first
3913 $uid = $user->getId();
3914 if ( isset( $this->mNotificationTimestamp[$uid] ) ) {
3915 return $this->mNotificationTimestamp[$uid];
3917 if ( !$uid || !$wgShowUpdatedMarker ) {
3918 return $this->mNotificationTimestamp[$uid] = false;
3920 // Don't cache too much!
3921 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
3922 $this->mNotificationTimestamp = array();
3924 $dbr = wfGetDB( DB_SLAVE );
3925 $this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
3926 'wl_notificationtimestamp',
3927 array( 'wl_namespace' => $this->getNamespace(),
3928 'wl_title' => $this->getDBkey(),
3929 'wl_user' => $user->getId()
3931 __METHOD__
3933 return $this->mNotificationTimestamp[$uid];
3937 * Get the trackback URL for this page
3939 * @return \type{\string} Trackback URL
3941 public function trackbackURL() {
3942 global $wgScriptPath, $wgServer, $wgScriptExtension;
3944 return "$wgServer$wgScriptPath/trackback$wgScriptExtension?article="
3945 . htmlspecialchars( urlencode( $this->getPrefixedDBkey() ) );
3949 * Get the trackback RDF for this page
3951 * @return \type{\string} Trackback RDF
3953 public function trackbackRDF() {
3954 $url = htmlspecialchars( $this->getFullURL() );
3955 $title = htmlspecialchars( $this->getText() );
3956 $tburl = $this->trackbackURL();
3958 // Autodiscovery RDF is placed in comments so HTML validator
3959 // won't barf. This is a rather icky workaround, but seems
3960 // frequently used by this kind of RDF thingy.
3962 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3963 return "<!--
3964 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3965 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3966 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3967 <rdf:Description
3968 rdf:about=\"$url\"
3969 dc:identifier=\"$url\"
3970 dc:title=\"$title\"
3971 trackback:ping=\"$tburl\" />
3972 </rdf:RDF>
3973 -->";
3977 * Generate strings used for xml 'id' names in monobook tabs
3979 * @param $prepend string defaults to 'nstab-'
3980 * @return \type{\string} XML 'id' name
3982 public function getNamespaceKey( $prepend = 'nstab-' ) {
3983 global $wgContLang;
3984 // Gets the subject namespace if this title
3985 $namespace = MWNamespace::getSubject( $this->getNamespace() );
3986 // Checks if cononical namespace name exists for namespace
3987 if ( MWNamespace::exists( $this->getNamespace() ) ) {
3988 // Uses canonical namespace name
3989 $namespaceKey = MWNamespace::getCanonicalName( $namespace );
3990 } else {
3991 // Uses text of namespace
3992 $namespaceKey = $this->getSubjectNsText();
3994 // Makes namespace key lowercase
3995 $namespaceKey = $wgContLang->lc( $namespaceKey );
3996 // Uses main
3997 if ( $namespaceKey == '' ) {
3998 $namespaceKey = 'main';
4000 // Changes file to image for backwards compatibility
4001 if ( $namespaceKey == 'file' ) {
4002 $namespaceKey = 'image';
4004 return $prepend . $namespaceKey;
4008 * Returns true if this is a special page.
4010 * @return boolean
4012 public function isSpecialPage() {
4013 return $this->getNamespace() == NS_SPECIAL;
4017 * Returns true if this title resolves to the named special page
4019 * @param $name \type{\string} The special page name
4020 * @return boolean
4022 public function isSpecial( $name ) {
4023 if ( $this->getNamespace() == NS_SPECIAL ) {
4024 list( $thisName, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $this->getDBkey() );
4025 if ( $name == $thisName ) {
4026 return true;
4029 return false;
4033 * If the Title refers to a special page alias which is not the local default,
4035 * @return \type{Title} A new Title which points to the local default.
4036 * Otherwise, returns $this.
4038 public function fixSpecialName() {
4039 if ( $this->getNamespace() == NS_SPECIAL ) {
4040 $canonicalName = SpecialPage::resolveAlias( $this->mDbkeyform );
4041 if ( $canonicalName ) {
4042 $localName = SpecialPage::getLocalNameFor( $canonicalName );
4043 if ( $localName != $this->mDbkeyform ) {
4044 return Title::makeTitle( NS_SPECIAL, $localName );
4048 return $this;
4052 * Is this Title in a namespace which contains content?
4053 * In other words, is this a content page, for the purposes of calculating
4054 * statistics, etc?
4056 * @return Boolean
4058 public function isContentPage() {
4059 return MWNamespace::isContent( $this->getNamespace() );
4063 * Get all extant redirects to this Title
4065 * @param $ns \twotypes{\int,\null} Single namespace to consider;
4066 * NULL to consider all namespaces
4067 * @return \type{\arrayof{Title}} Redirects to this title
4069 public function getRedirectsHere( $ns = null ) {
4070 $redirs = array();
4072 $dbr = wfGetDB( DB_SLAVE );
4073 $where = array(
4074 'rd_namespace' => $this->getNamespace(),
4075 'rd_title' => $this->getDBkey(),
4076 'rd_from = page_id'
4078 if ( !is_null( $ns ) ) {
4079 $where['page_namespace'] = $ns;
4082 $res = $dbr->select(
4083 array( 'redirect', 'page' ),
4084 array( 'page_namespace', 'page_title' ),
4085 $where,
4086 __METHOD__
4089 foreach ( $res as $row ) {
4090 $redirs[] = self::newFromRow( $row );
4092 return $redirs;
4096 * Check if this Title is a valid redirect target
4098 * @return \type{\bool}
4100 public function isValidRedirectTarget() {
4101 global $wgInvalidRedirectTargets;
4103 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4104 if ( $this->isSpecial( 'Userlogout' ) ) {
4105 return false;
4108 foreach ( $wgInvalidRedirectTargets as $target ) {
4109 if ( $this->isSpecial( $target ) ) {
4110 return false;
4114 return true;
4118 * Get a backlink cache object
4120 * @return object BacklinkCache
4122 function getBacklinkCache() {
4123 if ( is_null( $this->mBacklinkCache ) ) {
4124 $this->mBacklinkCache = new BacklinkCache( $this );
4126 return $this->mBacklinkCache;
4130 * Whether the magic words __INDEX__ and __NOINDEX__ function for
4131 * this page.
4133 * @return Boolean
4135 public function canUseNoindex() {
4136 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4138 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4139 ? $wgContentNamespaces
4140 : $wgExemptFromUserRobotsControl;
4142 return !in_array( $this->mNamespace, $bannedNamespaces );
4147 * Returns restriction types for the current Title
4149 * @return array applicable restriction types
4151 public function getRestrictionTypes() {
4152 global $wgRestrictionTypes;
4153 $types = $this->exists() ? $wgRestrictionTypes : array( 'create' );
4155 if ( $this->getNamespace() == NS_FILE ) {
4156 $types[] = 'upload';
4159 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
4161 return $types;
4165 * Returns the raw sort key to be used for categories, with the specified
4166 * prefix. This will be fed to Language::convertToSortkey() to get a
4167 * binary sortkey that can be used for actual sorting.
4169 * @param $prefix string The prefix to be used, specified using
4170 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4171 * prefix.
4172 * @return string
4174 public function getCategorySortkey( $prefix = '' ) {
4175 $unprefixed = $this->getText();
4176 if ( $prefix !== '' ) {
4177 # Separate with a null byte, so the unprefixed part is only used as
4178 # a tiebreaker when two pages have the exact same prefix -- null
4179 # sorts before everything else (hopefully).
4180 return "$prefix\0$unprefixed";
4182 return $unprefixed;