Fix documentation in Linker::formatTemplates.
[mediawiki.git] / includes / Title.php
blobe02396b9100110480097773b48c6f9c41ee15b3e
1 <?php
2 /**
3 * Representation a title within %MediaWiki.
5 * See title.txt
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
22 * @file
25 /**
26 * Represents a title within MediaWiki.
27 * Optionally may contain an interwiki designation or namespace.
28 * @note This class can fetch various kinds of data from the database;
29 * however, it does so inefficiently.
31 * @internal documentation reviewed 15 Mar 2010
33 class Title {
34 /** @name Static cache variables */
35 // @{
36 static private $titleCache = array();
37 // @}
39 /**
40 * Title::newFromText maintains a cache to avoid expensive re-normalization of
41 * commonly used titles. On a batch operation this can become a memory leak
42 * if not bounded. After hitting this many titles reset the cache.
44 const CACHE_MAX = 1000;
46 /**
47 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
48 * to use the master DB
50 const GAID_FOR_UPDATE = 1;
52 /**
53 * @name Private member variables
54 * Please use the accessor functions instead.
55 * @private
57 // @{
59 var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
60 var $mUrlform = ''; // /< URL-encoded form of the main part
61 var $mDbkeyform = ''; // /< Main part with underscores
62 var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
63 var $mNamespace = NS_MAIN; // /< Namespace index, i.e. one of the NS_xxxx constants
64 var $mInterwiki = ''; // /< Interwiki prefix (or null string)
65 var $mFragment; // /< Title fragment (i.e. the bit after the #)
66 var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
67 var $mLatestID = false; // /< ID of most recent revision
68 var $mContentModel = false; // /< ID of the page's content model, i.e. one of the CONTENT_MODEL_XXX constants
69 private $mEstimateRevisions; // /< Estimated number of revisions; null of not loaded
70 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
71 var $mOldRestrictions = false;
72 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
73 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
74 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
75 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
76 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
77 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
78 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
79 var $mTitleProtection; ///< Cached value for getTitleProtection (create protection)
80 # Don't change the following default, NS_MAIN is hardcoded in several
81 # places. See bug 696.
82 var $mDefaultNamespace = NS_MAIN; // /< Namespace index when there is no namespace
83 # Zero except in {{transclusion}} tags
84 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
85 var $mLength = -1; // /< The page length, 0 for special pages
86 var $mRedirect = null; // /< Is the article at this title a redirect?
87 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
88 var $mHasSubpage; // /< Whether a page has any subpages
89 // @}
92 /**
93 * Constructor
95 /*protected*/ function __construct() { }
97 /**
98 * Create a new Title from a prefixed DB key
100 * @param $key String the database key, which has underscores
101 * instead of spaces, possibly including namespace and
102 * interwiki prefixes
103 * @return Title, or NULL on an error
105 public static function newFromDBkey( $key ) {
106 $t = new Title();
107 $t->mDbkeyform = $key;
108 if ( $t->secureAndSplit() ) {
109 return $t;
110 } else {
111 return null;
116 * Create a new Title from text, such as what one would find in a link. De-
117 * codes any HTML entities in the text.
119 * @param $text String the link text; spaces, prefixes, and an
120 * initial ':' indicating the main namespace are accepted.
121 * @param $defaultNamespace Int the namespace to use if none is speci-
122 * fied by a prefix. If you want to force a specific namespace even if
123 * $text might begin with a namespace prefix, use makeTitle() or
124 * makeTitleSafe().
125 * @throws MWException
126 * @return Title|null - Title or null on an error.
128 public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
129 if ( is_object( $text ) ) {
130 throw new MWException( 'Title::newFromText given an object' );
134 * Wiki pages often contain multiple links to the same page.
135 * Title normalization and parsing can become expensive on
136 * pages with many links, so we can save a little time by
137 * caching them.
139 * In theory these are value objects and won't get changed...
141 if ( $defaultNamespace == NS_MAIN && isset( Title::$titleCache[$text] ) ) {
142 return Title::$titleCache[$text];
145 # Convert things like &eacute; &#257; or &#x3017; into normalized (bug 14952) text
146 $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text );
148 $t = new Title();
149 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
150 $t->mDefaultNamespace = $defaultNamespace;
152 static $cachedcount = 0 ;
153 if ( $t->secureAndSplit() ) {
154 if ( $defaultNamespace == NS_MAIN ) {
155 if ( $cachedcount >= self::CACHE_MAX ) {
156 # Avoid memory leaks on mass operations...
157 Title::$titleCache = array();
158 $cachedcount = 0;
160 $cachedcount++;
161 Title::$titleCache[$text] =& $t;
163 return $t;
164 } else {
165 $ret = null;
166 return $ret;
171 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
173 * Example of wrong and broken code:
174 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
176 * Example of right code:
177 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
179 * Create a new Title from URL-encoded text. Ensures that
180 * the given title's length does not exceed the maximum.
182 * @param $url String the title, as might be taken from a URL
183 * @return Title the new object, or NULL on an error
185 public static function newFromURL( $url ) {
186 $t = new Title();
188 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
189 # but some URLs used it as a space replacement and they still come
190 # from some external search tools.
191 if ( strpos( self::legalChars(), '+' ) === false ) {
192 $url = str_replace( '+', ' ', $url );
195 $t->mDbkeyform = str_replace( ' ', '_', $url );
196 if ( $t->secureAndSplit() ) {
197 return $t;
198 } else {
199 return null;
204 * Returns a list of fields that are to be selected for initializing Title objects or LinkCache entries.
205 * Uses $wgContentHandlerUseDB to determine whether to include page_content_model.
207 * @return array
209 protected static function getSelectFields() {
210 global $wgContentHandlerUseDB;
212 $fields = array(
213 'page_namespace', 'page_title', 'page_id',
214 'page_len', 'page_is_redirect', 'page_latest',
217 if ( $wgContentHandlerUseDB ) {
218 $fields[] = 'page_content_model';
221 return $fields;
225 * Create a new Title from an article ID
227 * @param $id Int the page_id corresponding to the Title to create
228 * @param $flags Int use Title::GAID_FOR_UPDATE to use master
229 * @return Title the new object, or NULL on an error
231 public static function newFromID( $id, $flags = 0 ) {
232 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
233 $row = $db->selectRow(
234 'page',
235 self::getSelectFields(),
236 array( 'page_id' => $id ),
237 __METHOD__
239 if ( $row !== false ) {
240 $title = Title::newFromRow( $row );
241 } else {
242 $title = null;
244 return $title;
248 * Make an array of titles from an array of IDs
250 * @param $ids Array of Int Array of IDs
251 * @return Array of Titles
253 public static function newFromIDs( $ids ) {
254 if ( !count( $ids ) ) {
255 return array();
257 $dbr = wfGetDB( DB_SLAVE );
259 $res = $dbr->select(
260 'page',
261 self::getSelectFields(),
262 array( 'page_id' => $ids ),
263 __METHOD__
266 $titles = array();
267 foreach ( $res as $row ) {
268 $titles[] = Title::newFromRow( $row );
270 return $titles;
274 * Make a Title object from a DB row
276 * @param $row Object database row (needs at least page_title,page_namespace)
277 * @return Title corresponding Title
279 public static function newFromRow( $row ) {
280 $t = self::makeTitle( $row->page_namespace, $row->page_title );
281 $t->loadFromRow( $row );
282 return $t;
286 * Load Title object fields from a DB row.
287 * If false is given, the title will be treated as non-existing.
289 * @param $row Object|bool database row
291 public function loadFromRow( $row ) {
292 if ( $row ) { // page found
293 if ( isset( $row->page_id ) )
294 $this->mArticleID = (int)$row->page_id;
295 if ( isset( $row->page_len ) )
296 $this->mLength = (int)$row->page_len;
297 if ( isset( $row->page_is_redirect ) )
298 $this->mRedirect = (bool)$row->page_is_redirect;
299 if ( isset( $row->page_latest ) )
300 $this->mLatestID = (int)$row->page_latest;
301 if ( isset( $row->page_content_model ) )
302 $this->mContentModel = strval( $row->page_content_model );
303 else
304 $this->mContentModel = false; # initialized lazily in getContentModel()
305 } else { // page not found
306 $this->mArticleID = 0;
307 $this->mLength = 0;
308 $this->mRedirect = false;
309 $this->mLatestID = 0;
310 $this->mContentModel = false; # initialized lazily in getContentModel()
315 * Create a new Title from a namespace index and a DB key.
316 * It's assumed that $ns and $title are *valid*, for instance when
317 * they came directly from the database or a special page name.
318 * For convenience, spaces are converted to underscores so that
319 * eg user_text fields can be used directly.
321 * @param $ns Int the namespace of the article
322 * @param $title String the unprefixed database key form
323 * @param $fragment String the link fragment (after the "#")
324 * @param $interwiki String the interwiki prefix
325 * @return Title the new object
327 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
328 $t = new Title();
329 $t->mInterwiki = $interwiki;
330 $t->mFragment = $fragment;
331 $t->mNamespace = $ns = intval( $ns );
332 $t->mDbkeyform = str_replace( ' ', '_', $title );
333 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
334 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
335 $t->mTextform = str_replace( '_', ' ', $title );
336 $t->mContentModel = false; # initialized lazily in getContentModel()
337 return $t;
341 * Create a new Title from a namespace index and a DB key.
342 * The parameters will be checked for validity, which is a bit slower
343 * than makeTitle() but safer for user-provided data.
345 * @param $ns Int the namespace of the article
346 * @param $title String database key form
347 * @param $fragment String the link fragment (after the "#")
348 * @param $interwiki String interwiki prefix
349 * @return Title the new object, or NULL on an error
351 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
352 if ( !MWNamespace::exists( $ns ) ) {
353 return null;
356 $t = new Title();
357 $t->mDbkeyform = Title::makeName( $ns, $title, $fragment, $interwiki );
358 if ( $t->secureAndSplit() ) {
359 return $t;
360 } else {
361 return null;
366 * Create a new Title for the Main Page
368 * @return Title the new object
370 public static function newMainPage() {
371 $title = Title::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
372 // Don't give fatal errors if the message is broken
373 if ( !$title ) {
374 $title = Title::newFromText( 'Main Page' );
376 return $title;
380 * Extract a redirect destination from a string and return the
381 * Title, or null if the text doesn't contain a valid redirect
382 * This will only return the very next target, useful for
383 * the redirect table and other checks that don't need full recursion
385 * @param $text String: Text with possible redirect
386 * @return Title: The corresponding Title
387 * @deprecated since 1.21, use Content::getRedirectTarget instead.
389 public static function newFromRedirect( $text ) {
390 ContentHandler::deprecated( __METHOD__, '1.21' );
392 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
393 return $content->getRedirectTarget();
397 * Extract a redirect destination from a string and return the
398 * Title, or null if the text doesn't contain a valid redirect
399 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
400 * in order to provide (hopefully) the Title of the final destination instead of another redirect
402 * @param $text String Text with possible redirect
403 * @return Title
404 * @deprecated since 1.21, use Content::getUltimateRedirectTarget instead.
406 public static function newFromRedirectRecurse( $text ) {
407 ContentHandler::deprecated( __METHOD__, '1.21' );
409 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
410 return $content->getUltimateRedirectTarget();
414 * Extract a redirect destination from a string and return an
415 * array of Titles, or null if the text doesn't contain a valid redirect
416 * The last element in the array is the final destination after all redirects
417 * have been resolved (up to $wgMaxRedirects times)
419 * @param $text String Text with possible redirect
420 * @return Array of Titles, with the destination last
421 * @deprecated since 1.21, use Content::getRedirectChain instead.
423 public static function newFromRedirectArray( $text ) {
424 ContentHandler::deprecated( __METHOD__, '1.21' );
426 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
427 return $content->getRedirectChain();
431 * Get the prefixed DB key associated with an ID
433 * @param $id Int the page_id of the article
434 * @return Title an object representing the article, or NULL if no such article was found
436 public static function nameOf( $id ) {
437 $dbr = wfGetDB( DB_SLAVE );
439 $s = $dbr->selectRow(
440 'page',
441 array( 'page_namespace', 'page_title' ),
442 array( 'page_id' => $id ),
443 __METHOD__
445 if ( $s === false ) {
446 return null;
449 $n = self::makeName( $s->page_namespace, $s->page_title );
450 return $n;
454 * Get a regex character class describing the legal characters in a link
456 * @return String the list of characters, not delimited
458 public static function legalChars() {
459 global $wgLegalTitleChars;
460 return $wgLegalTitleChars;
464 * Returns a simple regex that will match on characters and sequences invalid in titles.
465 * Note that this doesn't pick up many things that could be wrong with titles, but that
466 * replacing this regex with something valid will make many titles valid.
468 * @return String regex string
470 static function getTitleInvalidRegex() {
471 static $rxTc = false;
472 if ( !$rxTc ) {
473 # Matching titles will be held as illegal.
474 $rxTc = '/' .
475 # Any character not allowed is forbidden...
476 '[^' . self::legalChars() . ']' .
477 # URL percent encoding sequences interfere with the ability
478 # to round-trip titles -- you can't link to them consistently.
479 '|%[0-9A-Fa-f]{2}' .
480 # XML/HTML character references produce similar issues.
481 '|&[A-Za-z0-9\x80-\xff]+;' .
482 '|&#[0-9]+;' .
483 '|&#x[0-9A-Fa-f]+;' .
484 '/S';
487 return $rxTc;
491 * Get a string representation of a title suitable for
492 * including in a search index
494 * @param $ns Int a namespace index
495 * @param $title String text-form main part
496 * @return String a stripped-down title string ready for the search index
498 public static function indexTitle( $ns, $title ) {
499 global $wgContLang;
501 $lc = SearchEngine::legalSearchChars() . '&#;';
502 $t = $wgContLang->normalizeForSearch( $title );
503 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
504 $t = $wgContLang->lc( $t );
506 # Handle 's, s'
507 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
508 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
510 $t = preg_replace( "/\\s+/", ' ', $t );
512 if ( $ns == NS_FILE ) {
513 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
515 return trim( $t );
519 * Make a prefixed DB key from a DB key and a namespace index
521 * @param $ns Int numerical representation of the namespace
522 * @param $title String the DB key form the title
523 * @param $fragment String The link fragment (after the "#")
524 * @param $interwiki String The interwiki prefix
525 * @return String the prefixed form of the title
527 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
528 global $wgContLang;
530 $namespace = $wgContLang->getNsText( $ns );
531 $name = $namespace == '' ? $title : "$namespace:$title";
532 if ( strval( $interwiki ) != '' ) {
533 $name = "$interwiki:$name";
535 if ( strval( $fragment ) != '' ) {
536 $name .= '#' . $fragment;
538 return $name;
542 * Escape a text fragment, say from a link, for a URL
544 * @param $fragment string containing a URL or link fragment (after the "#")
545 * @return String: escaped string
547 static function escapeFragmentForURL( $fragment ) {
548 # Note that we don't urlencode the fragment. urlencoded Unicode
549 # fragments appear not to work in IE (at least up to 7) or in at least
550 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
551 # to care if they aren't encoded.
552 return Sanitizer::escapeId( $fragment, 'noninitial' );
556 * Callback for usort() to do title sorts by (namespace, title)
558 * @param $a Title
559 * @param $b Title
561 * @return Integer: result of string comparison, or namespace comparison
563 public static function compare( $a, $b ) {
564 if ( $a->getNamespace() == $b->getNamespace() ) {
565 return strcmp( $a->getText(), $b->getText() );
566 } else {
567 return $a->getNamespace() - $b->getNamespace();
572 * Determine whether the object refers to a page within
573 * this project.
575 * @return Bool TRUE if this is an in-project interwiki link or a wikilink, FALSE otherwise
577 public function isLocal() {
578 if ( $this->mInterwiki != '' ) {
579 return Interwiki::fetch( $this->mInterwiki )->isLocal();
580 } else {
581 return true;
586 * Is this Title interwiki?
588 * @return Bool
590 public function isExternal() {
591 return ( $this->mInterwiki != '' );
595 * Get the interwiki prefix (or null string)
597 * @return String Interwiki prefix
599 public function getInterwiki() {
600 return $this->mInterwiki;
604 * Determine whether the object refers to a page within
605 * this project and is transcludable.
607 * @return Bool TRUE if this is transcludable
609 public function isTrans() {
610 if ( $this->mInterwiki == '' ) {
611 return false;
614 return Interwiki::fetch( $this->mInterwiki )->isTranscludable();
618 * Returns the DB name of the distant wiki which owns the object.
620 * @return String the DB name
622 public function getTransWikiID() {
623 if ( $this->mInterwiki == '' ) {
624 return false;
627 return Interwiki::fetch( $this->mInterwiki )->getWikiID();
631 * Get the text form (spaces not underscores) of the main part
633 * @return String Main part of the title
635 public function getText() {
636 return $this->mTextform;
640 * Get the URL-encoded form of the main part
642 * @return String Main part of the title, URL-encoded
644 public function getPartialURL() {
645 return $this->mUrlform;
649 * Get the main part with underscores
651 * @return String: Main part of the title, with underscores
653 public function getDBkey() {
654 return $this->mDbkeyform;
658 * Get the DB key with the initial letter case as specified by the user
660 * @return String DB key
662 function getUserCaseDBKey() {
663 return $this->mUserCaseDBKey;
667 * Get the namespace index, i.e. one of the NS_xxxx constants.
669 * @return Integer: Namespace index
671 public function getNamespace() {
672 return $this->mNamespace;
676 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
678 * @throws MWException
679 * @return String: Content model id
681 public function getContentModel() {
682 if ( !$this->mContentModel ) {
683 $linkCache = LinkCache::singleton();
684 $this->mContentModel = $linkCache->getGoodLinkFieldObj( $this, 'model' );
687 if ( !$this->mContentModel ) {
688 $this->mContentModel = ContentHandler::getDefaultModelFor( $this );
691 if( !$this->mContentModel ) {
692 throw new MWException( "failed to determin content model!" );
695 return $this->mContentModel;
699 * Convenience method for checking a title's content model name
701 * @param String $id The content model ID (use the CONTENT_MODEL_XXX constants).
702 * @return Boolean true if $this->getContentModel() == $id
704 public function hasContentModel( $id ) {
705 return $this->getContentModel() == $id;
709 * Get the namespace text
711 * @return String: Namespace text
713 public function getNsText() {
714 global $wgContLang;
716 if ( $this->mInterwiki != '' ) {
717 // This probably shouldn't even happen. ohh man, oh yuck.
718 // But for interwiki transclusion it sometimes does.
719 // Shit. Shit shit shit.
721 // Use the canonical namespaces if possible to try to
722 // resolve a foreign namespace.
723 if ( MWNamespace::exists( $this->mNamespace ) ) {
724 return MWNamespace::getCanonicalName( $this->mNamespace );
728 if ( $wgContLang->needsGenderDistinction() &&
729 MWNamespace::hasGenderDistinction( $this->mNamespace ) ) {
730 $gender = GenderCache::singleton()->getGenderOf( $this->getText(), __METHOD__ );
731 return $wgContLang->getGenderNsText( $this->mNamespace, $gender );
734 return $wgContLang->getNsText( $this->mNamespace );
738 * Get the namespace text of the subject (rather than talk) page
740 * @return String Namespace text
742 public function getSubjectNsText() {
743 global $wgContLang;
744 return $wgContLang->getNsText( MWNamespace::getSubject( $this->mNamespace ) );
748 * Get the namespace text of the talk page
750 * @return String Namespace text
752 public function getTalkNsText() {
753 global $wgContLang;
754 return( $wgContLang->getNsText( MWNamespace::getTalk( $this->mNamespace ) ) );
758 * Could this title have a corresponding talk page?
760 * @return Bool TRUE or FALSE
762 public function canTalk() {
763 return( MWNamespace::canTalk( $this->mNamespace ) );
767 * Is this in a namespace that allows actual pages?
769 * @return Bool
770 * @internal note -- uses hardcoded namespace index instead of constants
772 public function canExist() {
773 return $this->mNamespace >= NS_MAIN;
777 * Can this title be added to a user's watchlist?
779 * @return Bool TRUE or FALSE
781 public function isWatchable() {
782 return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() );
786 * Returns true if this is a special page.
788 * @return boolean
790 public function isSpecialPage() {
791 return $this->getNamespace() == NS_SPECIAL;
795 * Returns true if this title resolves to the named special page
797 * @param $name String The special page name
798 * @return boolean
800 public function isSpecial( $name ) {
801 if ( $this->isSpecialPage() ) {
802 list( $thisName, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $this->getDBkey() );
803 if ( $name == $thisName ) {
804 return true;
807 return false;
811 * If the Title refers to a special page alias which is not the local default, resolve
812 * the alias, and localise the name as necessary. Otherwise, return $this
814 * @return Title
816 public function fixSpecialName() {
817 if ( $this->isSpecialPage() ) {
818 list( $canonicalName, $par ) = SpecialPageFactory::resolveAlias( $this->mDbkeyform );
819 if ( $canonicalName ) {
820 $localName = SpecialPageFactory::getLocalNameFor( $canonicalName, $par );
821 if ( $localName != $this->mDbkeyform ) {
822 return Title::makeTitle( NS_SPECIAL, $localName );
826 return $this;
830 * Returns true if the title is inside the specified namespace.
832 * Please make use of this instead of comparing to getNamespace()
833 * This function is much more resistant to changes we may make
834 * to namespaces than code that makes direct comparisons.
835 * @param $ns int The namespace
836 * @return bool
837 * @since 1.19
839 public function inNamespace( $ns ) {
840 return MWNamespace::equals( $this->getNamespace(), $ns );
844 * Returns true if the title is inside one of the specified namespaces.
846 * @param ...$namespaces The namespaces to check for
847 * @return bool
848 * @since 1.19
850 public function inNamespaces( /* ... */ ) {
851 $namespaces = func_get_args();
852 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
853 $namespaces = $namespaces[0];
856 foreach ( $namespaces as $ns ) {
857 if ( $this->inNamespace( $ns ) ) {
858 return true;
862 return false;
866 * Returns true if the title has the same subject namespace as the
867 * namespace specified.
868 * For example this method will take NS_USER and return true if namespace
869 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
870 * as their subject namespace.
872 * This is MUCH simpler than individually testing for equivilance
873 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
874 * @since 1.19
875 * @param $ns int
876 * @return bool
878 public function hasSubjectNamespace( $ns ) {
879 return MWNamespace::subjectEquals( $this->getNamespace(), $ns );
883 * Is this Title in a namespace which contains content?
884 * In other words, is this a content page, for the purposes of calculating
885 * statistics, etc?
887 * @return Boolean
889 public function isContentPage() {
890 return MWNamespace::isContent( $this->getNamespace() );
894 * Would anybody with sufficient privileges be able to move this page?
895 * Some pages just aren't movable.
897 * @return Bool TRUE or FALSE
899 public function isMovable() {
900 if ( !MWNamespace::isMovable( $this->getNamespace() ) || $this->getInterwiki() != '' ) {
901 // Interwiki title or immovable namespace. Hooks don't get to override here
902 return false;
905 $result = true;
906 wfRunHooks( 'TitleIsMovable', array( $this, &$result ) );
907 return $result;
911 * Is this the mainpage?
912 * @note Title::newFromText seems to be sufficiently optimized by the title
913 * cache that we don't need to over-optimize by doing direct comparisons and
914 * acidentally creating new bugs where $title->equals( Title::newFromText() )
915 * ends up reporting something differently than $title->isMainPage();
917 * @since 1.18
918 * @return Bool
920 public function isMainPage() {
921 return $this->equals( Title::newMainPage() );
925 * Is this a subpage?
927 * @return Bool
929 public function isSubpage() {
930 return MWNamespace::hasSubpages( $this->mNamespace )
931 ? strpos( $this->getText(), '/' ) !== false
932 : false;
936 * Is this a conversion table for the LanguageConverter?
938 * @return Bool
940 public function isConversionTable() {
941 //@todo: ConversionTable should become a separate content model.
943 return $this->getNamespace() == NS_MEDIAWIKI &&
944 strpos( $this->getText(), 'Conversiontable/' ) === 0;
948 * Does that page contain wikitext, or it is JS, CSS or whatever?
950 * @return Bool
952 public function isWikitextPage() {
953 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT );
957 * Could this page contain custom CSS or JavaScript for the global UI.
958 * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
959 * or CONTENT_MODEL_JAVASCRIPT.
961 * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage() for that!
963 * Note that this method should not return true for pages that contain and show "inactive" CSS or JS.
965 * @return Bool
967 public function isCssOrJsPage() {
968 $isCssOrJsPage = NS_MEDIAWIKI == $this->mNamespace
969 && ( $this->hasContentModel( CONTENT_MODEL_CSS )
970 || $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) );
972 #NOTE: this hook is also called in ContentHandler::getDefaultModel. It's called here again to make sure
973 # hook funktions can force this method to return true even outside the mediawiki namespace.
975 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$isCssOrJsPage ) );
977 return $isCssOrJsPage;
981 * Is this a .css or .js subpage of a user page?
982 * @return Bool
984 public function isCssJsSubpage() {
985 return ( NS_USER == $this->mNamespace && $this->isSubpage()
986 && ( $this->hasContentModel( CONTENT_MODEL_CSS )
987 || $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) ) );
991 * Trim down a .css or .js subpage title to get the corresponding skin name
993 * @return string containing skin name from .css or .js subpage title
995 public function getSkinFromCssJsSubpage() {
996 $subpage = explode( '/', $this->mTextform );
997 $subpage = $subpage[ count( $subpage ) - 1 ];
998 $lastdot = strrpos( $subpage, '.' );
999 if ( $lastdot === false )
1000 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
1001 return substr( $subpage, 0, $lastdot );
1005 * Is this a .css subpage of a user page?
1007 * @return Bool
1009 public function isCssSubpage() {
1010 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1011 && $this->hasContentModel( CONTENT_MODEL_CSS ) );
1015 * Is this a .js subpage of a user page?
1017 * @return Bool
1019 public function isJsSubpage() {
1020 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1021 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) );
1025 * Is this a talk page of some sort?
1027 * @return Bool
1029 public function isTalkPage() {
1030 return MWNamespace::isTalk( $this->getNamespace() );
1034 * Get a Title object associated with the talk page of this article
1036 * @return Title the object for the talk page
1038 public function getTalkPage() {
1039 return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1043 * Get a title object associated with the subject page of this
1044 * talk page
1046 * @return Title the object for the subject page
1048 public function getSubjectPage() {
1049 // Is this the same title?
1050 $subjectNS = MWNamespace::getSubject( $this->getNamespace() );
1051 if ( $this->getNamespace() == $subjectNS ) {
1052 return $this;
1054 return Title::makeTitle( $subjectNS, $this->getDBkey() );
1058 * Get the default namespace index, for when there is no namespace
1060 * @return Int Default namespace index
1062 public function getDefaultNamespace() {
1063 return $this->mDefaultNamespace;
1067 * Get title for search index
1069 * @return String a stripped-down title string ready for the
1070 * search index
1072 public function getIndexTitle() {
1073 return Title::indexTitle( $this->mNamespace, $this->mTextform );
1077 * Get the Title fragment (i.e.\ the bit after the #) in text form
1079 * @return String Title fragment
1081 public function getFragment() {
1082 return $this->mFragment;
1086 * Get the fragment in URL form, including the "#" character if there is one
1087 * @return String Fragment in URL form
1089 public function getFragmentForURL() {
1090 if ( $this->mFragment == '' ) {
1091 return '';
1092 } else {
1093 return '#' . Title::escapeFragmentForURL( $this->mFragment );
1098 * Set the fragment for this title. Removes the first character from the
1099 * specified fragment before setting, so it assumes you're passing it with
1100 * an initial "#".
1102 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1103 * Still in active use privately.
1105 * @param $fragment String text
1107 public function setFragment( $fragment ) {
1108 $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
1112 * Prefix some arbitrary text with the namespace or interwiki prefix
1113 * of this object
1115 * @param $name String the text
1116 * @return String the prefixed text
1117 * @private
1119 private function prefix( $name ) {
1120 $p = '';
1121 if ( $this->mInterwiki != '' ) {
1122 $p = $this->mInterwiki . ':';
1125 if ( 0 != $this->mNamespace ) {
1126 $p .= $this->getNsText() . ':';
1128 return $p . $name;
1132 * Get the prefixed database key form
1134 * @return String the prefixed title, with underscores and
1135 * any interwiki and namespace prefixes
1137 public function getPrefixedDBkey() {
1138 $s = $this->prefix( $this->mDbkeyform );
1139 $s = str_replace( ' ', '_', $s );
1140 return $s;
1144 * Get the prefixed title with spaces.
1145 * This is the form usually used for display
1147 * @return String the prefixed title, with spaces
1149 public function getPrefixedText() {
1150 // @todo FIXME: Bad usage of empty() ?
1151 if ( empty( $this->mPrefixedText ) ) {
1152 $s = $this->prefix( $this->mTextform );
1153 $s = str_replace( '_', ' ', $s );
1154 $this->mPrefixedText = $s;
1156 return $this->mPrefixedText;
1160 * Return a string representation of this title
1162 * @return String representation of this title
1164 public function __toString() {
1165 return $this->getPrefixedText();
1169 * Get the prefixed title with spaces, plus any fragment
1170 * (part beginning with '#')
1172 * @return String the prefixed title, with spaces and the fragment, including '#'
1174 public function getFullText() {
1175 $text = $this->getPrefixedText();
1176 if ( $this->mFragment != '' ) {
1177 $text .= '#' . $this->mFragment;
1179 return $text;
1183 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1185 * @par Example:
1186 * @code
1187 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1188 * # returns: 'Foo'
1189 * @endcode
1191 * @return String Root name
1192 * @since 1.20
1194 public function getRootText() {
1195 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1196 return $this->getText();
1199 return strtok( $this->getText(), '/' );
1203 * Get the root page name title, i.e. the leftmost part before any slashes
1205 * @par Example:
1206 * @code
1207 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1208 * # returns: Title{User:Foo}
1209 * @endcode
1211 * @return Title Root title
1212 * @since 1.20
1214 public function getRootTitle() {
1215 return Title::makeTitle( $this->getNamespace(), $this->getRootText() );
1219 * Get the base page name without a namespace, i.e. the part before the subpage name
1221 * @par Example:
1222 * @code
1223 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1224 * # returns: 'Foo/Bar'
1225 * @endcode
1227 * @return String Base name
1229 public function getBaseText() {
1230 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1231 return $this->getText();
1234 $parts = explode( '/', $this->getText() );
1235 # Don't discard the real title if there's no subpage involved
1236 if ( count( $parts ) > 1 ) {
1237 unset( $parts[count( $parts ) - 1] );
1239 return implode( '/', $parts );
1243 * Get the base page name title, i.e. the part before the subpage name
1245 * @par Example:
1246 * @code
1247 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1248 * # returns: Title{User:Foo/Bar}
1249 * @endcode
1251 * @return Title Base title
1252 * @since 1.20
1254 public function getBaseTitle() {
1255 return Title::makeTitle( $this->getNamespace(), $this->getBaseText() );
1259 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1261 * @par Example:
1262 * @code
1263 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1264 * # returns: "Baz"
1265 * @endcode
1267 * @return String Subpage name
1269 public function getSubpageText() {
1270 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1271 return( $this->mTextform );
1273 $parts = explode( '/', $this->mTextform );
1274 return( $parts[count( $parts ) - 1] );
1278 * Get the title for a subpage of the current page
1280 * @par Example:
1281 * @code
1282 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1283 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1284 * @endcode
1286 * @param $text String The subpage name to add to the title
1287 * @return Title Subpage title
1288 * @since 1.20
1290 public function getSubpage( $text ) {
1291 return Title::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1295 * Get the HTML-escaped displayable text form.
1296 * Used for the title field in <a> tags.
1298 * @return String the text, including any prefixes
1300 public function getEscapedText() {
1301 wfDeprecated( __METHOD__, '1.19' );
1302 return htmlspecialchars( $this->getPrefixedText() );
1306 * Get a URL-encoded form of the subpage text
1308 * @return String URL-encoded subpage name
1310 public function getSubpageUrlForm() {
1311 $text = $this->getSubpageText();
1312 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1313 return( $text );
1317 * Get a URL-encoded title (not an actual URL) including interwiki
1319 * @return String the URL-encoded form
1321 public function getPrefixedURL() {
1322 $s = $this->prefix( $this->mDbkeyform );
1323 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1324 return $s;
1328 * Helper to fix up the get{Local,Full,Link,Canonical}URL args
1329 * get{Canonical,Full,Link,Local}URL methods accepted an optional
1330 * second argument named variant. This was deprecated in favor
1331 * of passing an array of option with a "variant" key
1332 * Once $query2 is removed for good, this helper can be dropped
1333 * andthe wfArrayToCGI moved to getLocalURL();
1335 * @since 1.19 (r105919)
1336 * @param $query
1337 * @param $query2 bool
1338 * @return String
1340 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1341 if( $query2 !== false ) {
1342 wfDeprecated( "Title::get{Canonical,Full,Link,Local} method called with a second parameter is deprecated. Add your parameter to an array passed as the first parameter.", "1.19" );
1344 if ( is_array( $query ) ) {
1345 $query = wfArrayToCGI( $query );
1347 if ( $query2 ) {
1348 if ( is_string( $query2 ) ) {
1349 // $query2 is a string, we will consider this to be
1350 // a deprecated $variant argument and add it to the query
1351 $query2 = wfArrayToCGI( array( 'variant' => $query2 ) );
1352 } else {
1353 $query2 = wfArrayToCGI( $query2 );
1355 // If we have $query content add a & to it first
1356 if ( $query ) {
1357 $query .= '&';
1359 // Now append the queries together
1360 $query .= $query2;
1362 return $query;
1366 * Get a real URL referring to this title, with interwiki link and
1367 * fragment
1369 * See getLocalURL for the arguments.
1371 * @see self::getLocalURL
1372 * @see wfExpandUrl
1373 * @param $query
1374 * @param $query2 bool
1375 * @param $proto Protocol type to use in URL
1376 * @return String the URL
1378 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1379 $query = self::fixUrlQueryArgs( $query, $query2 );
1381 # Hand off all the decisions on urls to getLocalURL
1382 $url = $this->getLocalURL( $query );
1384 # Expand the url to make it a full url. Note that getLocalURL has the
1385 # potential to output full urls for a variety of reasons, so we use
1386 # wfExpandUrl instead of simply prepending $wgServer
1387 $url = wfExpandUrl( $url, $proto );
1389 # Finally, add the fragment.
1390 $url .= $this->getFragmentForURL();
1392 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
1393 return $url;
1397 * Get a URL with no fragment or server name. If this page is generated
1398 * with action=render, $wgServer is prepended.
1401 * @param $query string|array an optional query string,
1402 * not used for interwiki links. Can be specified as an associative array as well,
1403 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1404 * Some query patterns will trigger various shorturl path replacements.
1405 * @param $query2 Mixed: An optional secondary query array. This one MUST
1406 * be an array. If a string is passed it will be interpreted as a deprecated
1407 * variant argument and urlencoded into a variant= argument.
1408 * This second query argument will be added to the $query
1409 * The second parameter is deprecated since 1.19. Pass it as a key,value
1410 * pair in the first parameter array instead.
1412 * @return String the URL
1414 public function getLocalURL( $query = '', $query2 = false ) {
1415 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1417 $query = self::fixUrlQueryArgs( $query, $query2 );
1419 $interwiki = Interwiki::fetch( $this->mInterwiki );
1420 if ( $interwiki ) {
1421 $namespace = $this->getNsText();
1422 if ( $namespace != '' ) {
1423 # Can this actually happen? Interwikis shouldn't be parsed.
1424 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1425 $namespace .= ':';
1427 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1428 $url = wfAppendQuery( $url, $query );
1429 } else {
1430 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1431 if ( $query == '' ) {
1432 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1433 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1434 } else {
1435 global $wgVariantArticlePath, $wgActionPaths;
1436 $url = false;
1437 $matches = array();
1439 if ( !empty( $wgActionPaths ) &&
1440 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
1442 $action = urldecode( $matches[2] );
1443 if ( isset( $wgActionPaths[$action] ) ) {
1444 $query = $matches[1];
1445 if ( isset( $matches[4] ) ) {
1446 $query .= $matches[4];
1448 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1449 if ( $query != '' ) {
1450 $url = wfAppendQuery( $url, $query );
1455 if ( $url === false &&
1456 $wgVariantArticlePath &&
1457 $this->getPageLanguage()->hasVariants() &&
1458 preg_match( '/^variant=([^&]*)$/', $query, $matches ) )
1460 $variant = urldecode( $matches[1] );
1461 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1462 // Only do the variant replacement if the given variant is a valid
1463 // variant for the page's language.
1464 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1465 $url = str_replace( '$1', $dbkey, $url );
1469 if ( $url === false ) {
1470 if ( $query == '-' ) {
1471 $query = '';
1473 $url = "{$wgScript}?title={$dbkey}&{$query}";
1477 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1479 // @todo FIXME: This causes breakage in various places when we
1480 // actually expected a local URL and end up with dupe prefixes.
1481 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1482 $url = $wgServer . $url;
1485 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1486 return $url;
1490 * Get a URL that's the simplest URL that will be valid to link, locally,
1491 * to the current Title. It includes the fragment, but does not include
1492 * the server unless action=render is used (or the link is external). If
1493 * there's a fragment but the prefixed text is empty, we just return a link
1494 * to the fragment.
1496 * The result obviously should not be URL-escaped, but does need to be
1497 * HTML-escaped if it's being output in HTML.
1499 * See getLocalURL for the arguments.
1501 * @param $query
1502 * @param $query2 bool
1503 * @param $proto Protocol to use; setting this will cause a full URL to be used
1504 * @see self::getLocalURL
1505 * @return String the URL
1507 public function getLinkURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1508 wfProfileIn( __METHOD__ );
1509 if ( $this->isExternal() || $proto !== PROTO_RELATIVE ) {
1510 $ret = $this->getFullURL( $query, $query2, $proto );
1511 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
1512 $ret = $this->getFragmentForURL();
1513 } else {
1514 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1516 wfProfileOut( __METHOD__ );
1517 return $ret;
1521 * Get an HTML-escaped version of the URL form, suitable for
1522 * using in a link, without a server name or fragment
1524 * See getLocalURL for the arguments.
1526 * @see self::getLocalURL
1527 * @param $query string
1528 * @param $query2 bool|string
1529 * @return String the URL
1531 public function escapeLocalURL( $query = '', $query2 = false ) {
1532 wfDeprecated( __METHOD__, '1.19' );
1533 return htmlspecialchars( $this->getLocalURL( $query, $query2 ) );
1537 * Get an HTML-escaped version of the URL form, suitable for
1538 * using in a link, including the server name and fragment
1540 * See getLocalURL for the arguments.
1542 * @see self::getLocalURL
1543 * @return String the URL
1545 public function escapeFullURL( $query = '', $query2 = false ) {
1546 wfDeprecated( __METHOD__, '1.19' );
1547 return htmlspecialchars( $this->getFullURL( $query, $query2 ) );
1551 * Get the URL form for an internal link.
1552 * - Used in various Squid-related code, in case we have a different
1553 * internal hostname for the server from the exposed one.
1555 * This uses $wgInternalServer to qualify the path, or $wgServer
1556 * if $wgInternalServer is not set. If the server variable used is
1557 * protocol-relative, the URL will be expanded to http://
1559 * See getLocalURL for the arguments.
1561 * @see self::getLocalURL
1562 * @return String the URL
1564 public function getInternalURL( $query = '', $query2 = false ) {
1565 global $wgInternalServer, $wgServer;
1566 $query = self::fixUrlQueryArgs( $query, $query2 );
1567 $server = $wgInternalServer !== false ? $wgInternalServer : $wgServer;
1568 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP );
1569 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1570 return $url;
1574 * Get the URL for a canonical link, for use in things like IRC and
1575 * e-mail notifications. Uses $wgCanonicalServer and the
1576 * GetCanonicalURL hook.
1578 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1580 * See getLocalURL for the arguments.
1582 * @see self::getLocalURL
1583 * @return string The URL
1584 * @since 1.18
1586 public function getCanonicalURL( $query = '', $query2 = false ) {
1587 $query = self::fixUrlQueryArgs( $query, $query2 );
1588 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL );
1589 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1590 return $url;
1594 * HTML-escaped version of getCanonicalURL()
1596 * See getLocalURL for the arguments.
1598 * @see self::getLocalURL
1599 * @since 1.18
1600 * @return string
1602 public function escapeCanonicalURL( $query = '', $query2 = false ) {
1603 wfDeprecated( __METHOD__, '1.19' );
1604 return htmlspecialchars( $this->getCanonicalURL( $query, $query2 ) );
1608 * Get the edit URL for this Title
1610 * @return String the URL, or a null string if this is an
1611 * interwiki link
1613 public function getEditURL() {
1614 if ( $this->mInterwiki != '' ) {
1615 return '';
1617 $s = $this->getLocalURL( 'action=edit' );
1619 return $s;
1623 * Is $wgUser watching this page?
1625 * @deprecated in 1.20; use User::isWatched() instead.
1626 * @return Bool
1628 public function userIsWatching() {
1629 global $wgUser;
1631 if ( is_null( $this->mWatched ) ) {
1632 if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn() ) {
1633 $this->mWatched = false;
1634 } else {
1635 $this->mWatched = $wgUser->isWatched( $this );
1638 return $this->mWatched;
1642 * Can $wgUser read this page?
1644 * @deprecated in 1.19; use userCan(), quickUserCan() or getUserPermissionsErrors() instead
1645 * @return Bool
1646 * @todo fold these checks into userCan()
1648 public function userCanRead() {
1649 wfDeprecated( __METHOD__, '1.19' );
1650 return $this->userCan( 'read' );
1654 * Can $user perform $action on this page?
1655 * This skips potentially expensive cascading permission checks
1656 * as well as avoids expensive error formatting
1658 * Suitable for use for nonessential UI controls in common cases, but
1659 * _not_ for functional access control.
1661 * May provide false positives, but should never provide a false negative.
1663 * @param $action String action that permission needs to be checked for
1664 * @param $user User to check (since 1.19); $wgUser will be used if not
1665 * provided.
1666 * @return Bool
1668 public function quickUserCan( $action, $user = null ) {
1669 return $this->userCan( $action, $user, false );
1673 * Can $user perform $action on this page?
1675 * @param $action String action that permission needs to be checked for
1676 * @param $user User to check (since 1.19); $wgUser will be used if not
1677 * provided.
1678 * @param $doExpensiveQueries Bool Set this to false to avoid doing
1679 * unnecessary queries.
1680 * @return Bool
1682 public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1683 if ( !$user instanceof User ) {
1684 global $wgUser;
1685 $user = $wgUser;
1687 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries, true ) );
1691 * Can $user perform $action on this page?
1693 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1695 * @param $action String action that permission needs to be checked for
1696 * @param $user User to check
1697 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary
1698 * queries by skipping checks for cascading protections and user blocks.
1699 * @param $ignoreErrors Array of Strings Set this to a list of message keys
1700 * whose corresponding errors may be ignored.
1701 * @return Array of arguments to wfMessage to explain permissions problems.
1703 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1704 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1706 // Remove the errors being ignored.
1707 foreach ( $errors as $index => $error ) {
1708 $error_key = is_array( $error ) ? $error[0] : $error;
1710 if ( in_array( $error_key, $ignoreErrors ) ) {
1711 unset( $errors[$index] );
1715 return $errors;
1719 * Permissions checks that fail most often, and which are easiest to test.
1721 * @param $action String the action to check
1722 * @param $user User user to check
1723 * @param $errors Array list of current errors
1724 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1725 * @param $short Boolean short circuit on first error
1727 * @return Array list of errors
1729 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1730 if ( $action == 'create' ) {
1731 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1732 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1733 $errors[] = $user->isAnon() ? array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1735 } elseif ( $action == 'move' ) {
1736 if ( !$user->isAllowed( 'move-rootuserpages' )
1737 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1738 // Show user page-specific message only if the user can move other pages
1739 $errors[] = array( 'cant-move-user-page' );
1742 // Check if user is allowed to move files if it's a file
1743 if ( $this->mNamespace == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
1744 $errors[] = array( 'movenotallowedfile' );
1747 if ( !$user->isAllowed( 'move' ) ) {
1748 // User can't move anything
1749 $userCanMove = User::groupHasPermission( 'user', 'move' );
1750 $autoconfirmedCanMove = User::groupHasPermission( 'autoconfirmed', 'move' );
1751 if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) {
1752 // custom message if logged-in users without any special rights can move
1753 $errors[] = array( 'movenologintext' );
1754 } else {
1755 $errors[] = array( 'movenotallowed' );
1758 } elseif ( $action == 'move-target' ) {
1759 if ( !$user->isAllowed( 'move' ) ) {
1760 // User can't move anything
1761 $errors[] = array( 'movenotallowed' );
1762 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1763 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1764 // Show user page-specific message only if the user can move other pages
1765 $errors[] = array( 'cant-move-to-user-page' );
1767 } elseif ( !$user->isAllowed( $action ) ) {
1768 $errors[] = $this->missingPermissionError( $action, $short );
1771 return $errors;
1775 * Add the resulting error code to the errors array
1777 * @param $errors Array list of current errors
1778 * @param $result Mixed result of errors
1780 * @return Array list of errors
1782 private function resultToError( $errors, $result ) {
1783 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1784 // A single array representing an error
1785 $errors[] = $result;
1786 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
1787 // A nested array representing multiple errors
1788 $errors = array_merge( $errors, $result );
1789 } elseif ( $result !== '' && is_string( $result ) ) {
1790 // A string representing a message-id
1791 $errors[] = array( $result );
1792 } elseif ( $result === false ) {
1793 // a generic "We don't want them to do that"
1794 $errors[] = array( 'badaccess-group0' );
1796 return $errors;
1800 * Check various permission hooks
1802 * @param $action String the action to check
1803 * @param $user User user to check
1804 * @param $errors Array list of current errors
1805 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1806 * @param $short Boolean short circuit on first error
1808 * @return Array list of errors
1810 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1811 // Use getUserPermissionsErrors instead
1812 $result = '';
1813 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1814 return $result ? array() : array( array( 'badaccess-group0' ) );
1816 // Check getUserPermissionsErrors hook
1817 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1818 $errors = $this->resultToError( $errors, $result );
1820 // Check getUserPermissionsErrorsExpensive hook
1821 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1822 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1823 $errors = $this->resultToError( $errors, $result );
1826 return $errors;
1830 * Check permissions on special pages & namespaces
1832 * @param $action String the action to check
1833 * @param $user User user to check
1834 * @param $errors Array list of current errors
1835 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1836 * @param $short Boolean short circuit on first error
1838 * @return Array list of errors
1840 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1841 # Only 'createaccount' and 'execute' can be performed on
1842 # special pages, which don't actually exist in the DB.
1843 $specialOKActions = array( 'createaccount', 'execute' );
1844 if ( NS_SPECIAL == $this->mNamespace && !in_array( $action, $specialOKActions ) ) {
1845 $errors[] = array( 'ns-specialprotected' );
1848 # Check $wgNamespaceProtection for restricted namespaces
1849 if ( $this->isNamespaceProtected( $user ) ) {
1850 $ns = $this->mNamespace == NS_MAIN ?
1851 wfMessage( 'nstab-main' )->text() : $this->getNsText();
1852 $errors[] = $this->mNamespace == NS_MEDIAWIKI ?
1853 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1856 return $errors;
1860 * Check CSS/JS sub-page permissions
1862 * @param $action String the action to check
1863 * @param $user User user to check
1864 * @param $errors Array list of current errors
1865 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1866 * @param $short Boolean short circuit on first error
1868 * @return Array list of errors
1870 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1871 # Protect css/js subpages of user pages
1872 # XXX: this might be better using restrictions
1873 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1874 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1875 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform ) ) {
1876 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1877 $errors[] = array( 'customcssprotected' );
1878 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1879 $errors[] = array( 'customjsprotected' );
1883 return $errors;
1887 * Check against page_restrictions table requirements on this
1888 * page. The user must possess all required rights for this
1889 * action.
1891 * @param $action String the action to check
1892 * @param $user User user to check
1893 * @param $errors Array list of current errors
1894 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1895 * @param $short Boolean short circuit on first error
1897 * @return Array list of errors
1899 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1900 foreach ( $this->getRestrictions( $action ) as $right ) {
1901 // Backwards compatibility, rewrite sysop -> protect
1902 if ( $right == 'sysop' ) {
1903 $right = 'protect';
1905 if ( $right != '' && !$user->isAllowed( $right ) ) {
1906 // Users with 'editprotected' permission can edit protected pages
1907 // without cascading option turned on.
1908 if ( $action != 'edit' || !$user->isAllowed( 'editprotected' )
1909 || $this->mCascadeRestriction )
1911 $errors[] = array( 'protectedpagetext', $right );
1916 return $errors;
1920 * Check restrictions on cascading pages.
1922 * @param $action String the action to check
1923 * @param $user User to check
1924 * @param $errors Array list of current errors
1925 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1926 * @param $short Boolean short circuit on first error
1928 * @return Array list of errors
1930 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1931 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1932 # We /could/ use the protection level on the source page, but it's
1933 # fairly ugly as we have to establish a precedence hierarchy for pages
1934 # included by multiple cascade-protected pages. So just restrict
1935 # it to people with 'protect' permission, as they could remove the
1936 # protection anyway.
1937 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1938 # Cascading protection depends on more than this page...
1939 # Several cascading protected pages may include this page...
1940 # Check each cascading level
1941 # This is only for protection restrictions, not for all actions
1942 if ( isset( $restrictions[$action] ) ) {
1943 foreach ( $restrictions[$action] as $right ) {
1944 $right = ( $right == 'sysop' ) ? 'protect' : $right;
1945 if ( $right != '' && !$user->isAllowed( $right ) ) {
1946 $pages = '';
1947 foreach ( $cascadingSources as $page )
1948 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1949 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1955 return $errors;
1959 * Check action permissions not already checked in checkQuickPermissions
1961 * @param $action String the action to check
1962 * @param $user User to check
1963 * @param $errors Array list of current errors
1964 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1965 * @param $short Boolean short circuit on first error
1967 * @return Array list of errors
1969 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1970 global $wgDeleteRevisionsLimit, $wgLang;
1972 if ( $action == 'protect' ) {
1973 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $doExpensiveQueries, true ) ) ) {
1974 // If they can't edit, they shouldn't protect.
1975 $errors[] = array( 'protect-cantedit' );
1977 } elseif ( $action == 'create' ) {
1978 $title_protection = $this->getTitleProtection();
1979 if( $title_protection ) {
1980 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1981 $title_protection['pt_create_perm'] = 'protect'; // B/C
1983 if( $title_protection['pt_create_perm'] == '' ||
1984 !$user->isAllowed( $title_protection['pt_create_perm'] ) )
1986 $errors[] = array( 'titleprotected', User::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1989 } elseif ( $action == 'move' ) {
1990 // Check for immobile pages
1991 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
1992 // Specific message for this case
1993 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1994 } elseif ( !$this->isMovable() ) {
1995 // Less specific message for rarer cases
1996 $errors[] = array( 'immobile-source-page' );
1998 } elseif ( $action == 'move-target' ) {
1999 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2000 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
2001 } elseif ( !$this->isMovable() ) {
2002 $errors[] = array( 'immobile-target-page' );
2004 } elseif ( $action == 'delete' ) {
2005 if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
2006 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion() )
2008 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
2011 return $errors;
2015 * Check that the user isn't blocked from editting.
2017 * @param $action String the action to check
2018 * @param $user User to check
2019 * @param $errors Array list of current errors
2020 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
2021 * @param $short Boolean short circuit on first error
2023 * @return Array list of errors
2025 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
2026 // Account creation blocks handled at userlogin.
2027 // Unblocking handled in SpecialUnblock
2028 if( !$doExpensiveQueries || in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
2029 return $errors;
2032 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
2034 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2035 $errors[] = array( 'confirmedittext' );
2038 if ( ( $action == 'edit' || $action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
2039 // Don't block the user from editing their own talk page unless they've been
2040 // explicitly blocked from that too.
2041 } elseif( $user->isBlocked() && $user->mBlock->prevents( $action ) !== false ) {
2042 $block = $user->getBlock();
2044 // This is from OutputPage::blockedPage
2045 // Copied at r23888 by werdna
2047 $id = $user->blockedBy();
2048 $reason = $user->blockedFor();
2049 if ( $reason == '' ) {
2050 $reason = wfMessage( 'blockednoreason' )->text();
2052 $ip = $user->getRequest()->getIP();
2054 if ( is_numeric( $id ) ) {
2055 $name = User::whoIs( $id );
2056 } else {
2057 $name = $id;
2060 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
2061 $blockid = $block->getId();
2062 $blockExpiry = $block->getExpiry();
2063 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $block->mTimestamp ), true );
2064 if ( $blockExpiry == 'infinity' ) {
2065 $blockExpiry = wfMessage( 'infiniteblock' )->text();
2066 } else {
2067 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
2070 $intended = strval( $block->getTarget() );
2072 $errors[] = array( ( $block->mAuto ? 'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
2073 $blockid, $blockExpiry, $intended, $blockTimestamp );
2076 return $errors;
2080 * Check that the user is allowed to read this page.
2082 * @param $action String the action to check
2083 * @param $user User to check
2084 * @param $errors Array list of current errors
2085 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
2086 * @param $short Boolean short circuit on first error
2088 * @return Array list of errors
2090 private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2091 global $wgWhitelistRead, $wgRevokePermissions;
2092 static $useShortcut = null;
2094 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
2095 if ( is_null( $useShortcut ) ) {
2096 $useShortcut = true;
2097 if ( !User::groupHasPermission( '*', 'read' ) ) {
2098 # Not a public wiki, so no shortcut
2099 $useShortcut = false;
2100 } elseif ( !empty( $wgRevokePermissions ) ) {
2102 * Iterate through each group with permissions being revoked (key not included since we don't care
2103 * what the group name is), then check if the read permission is being revoked. If it is, then
2104 * we don't use the shortcut below since the user might not be able to read, even though anon
2105 * reading is allowed.
2107 foreach ( $wgRevokePermissions as $perms ) {
2108 if ( !empty( $perms['read'] ) ) {
2109 # We might be removing the read right from the user, so no shortcut
2110 $useShortcut = false;
2111 break;
2117 $whitelisted = false;
2118 if ( $useShortcut ) {
2119 # Shortcut for public wikis, allows skipping quite a bit of code
2120 $whitelisted = true;
2121 } elseif ( $user->isAllowed( 'read' ) ) {
2122 # If the user is allowed to read pages, he is allowed to read all pages
2123 $whitelisted = true;
2124 } elseif ( $this->isSpecial( 'Userlogin' )
2125 || $this->isSpecial( 'ChangePassword' )
2126 || $this->isSpecial( 'PasswordReset' )
2128 # Always grant access to the login page.
2129 # Even anons need to be able to log in.
2130 $whitelisted = true;
2131 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2132 # Time to check the whitelist
2133 # Only do these checks is there's something to check against
2134 $name = $this->getPrefixedText();
2135 $dbName = $this->getPrefixedDBKey();
2137 // Check for explicit whitelisting with and without underscores
2138 if ( in_array( $name, $wgWhitelistRead, true ) || in_array( $dbName, $wgWhitelistRead, true ) ) {
2139 $whitelisted = true;
2140 } elseif ( $this->getNamespace() == NS_MAIN ) {
2141 # Old settings might have the title prefixed with
2142 # a colon for main-namespace pages
2143 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2144 $whitelisted = true;
2146 } elseif ( $this->isSpecialPage() ) {
2147 # If it's a special page, ditch the subpage bit and check again
2148 $name = $this->getDBkey();
2149 list( $name, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $name );
2150 if ( $name !== false ) {
2151 $pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
2152 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2153 $whitelisted = true;
2159 if ( !$whitelisted ) {
2160 # If the title is not whitelisted, give extensions a chance to do so...
2161 wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2162 if ( !$whitelisted ) {
2163 $errors[] = $this->missingPermissionError( $action, $short );
2167 return $errors;
2171 * Get a description array when the user doesn't have the right to perform
2172 * $action (i.e. when User::isAllowed() returns false)
2174 * @param $action String the action to check
2175 * @param $short Boolean short circuit on first error
2176 * @return Array list of errors
2178 private function missingPermissionError( $action, $short ) {
2179 // We avoid expensive display logic for quickUserCan's and such
2180 if ( $short ) {
2181 return array( 'badaccess-group0' );
2184 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2185 User::getGroupsWithPermission( $action ) );
2187 if ( count( $groups ) ) {
2188 global $wgLang;
2189 return array(
2190 'badaccess-groups',
2191 $wgLang->commaList( $groups ),
2192 count( $groups )
2194 } else {
2195 return array( 'badaccess-group0' );
2200 * Can $user perform $action on this page? This is an internal function,
2201 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2202 * checks on wfReadOnly() and blocks)
2204 * @param $action String action that permission needs to be checked for
2205 * @param $user User to check
2206 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
2207 * @param $short Bool Set this to true to stop after the first permission error.
2208 * @return Array of arrays of the arguments to wfMessage to explain permissions problems.
2210 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
2211 wfProfileIn( __METHOD__ );
2213 # Read has special handling
2214 if ( $action == 'read' ) {
2215 $checks = array(
2216 'checkPermissionHooks',
2217 'checkReadPermissions',
2219 } else {
2220 $checks = array(
2221 'checkQuickPermissions',
2222 'checkPermissionHooks',
2223 'checkSpecialsAndNSPermissions',
2224 'checkCSSandJSPermissions',
2225 'checkPageRestrictions',
2226 'checkCascadingSourcesRestrictions',
2227 'checkActionPermissions',
2228 'checkUserBlock'
2232 $errors = array();
2233 while( count( $checks ) > 0 &&
2234 !( $short && count( $errors ) > 0 ) ) {
2235 $method = array_shift( $checks );
2236 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2239 wfProfileOut( __METHOD__ );
2240 return $errors;
2244 * Protect css subpages of user pages: can $wgUser edit
2245 * this page?
2247 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2248 * @return Bool
2250 public function userCanEditCssSubpage() {
2251 global $wgUser;
2252 wfDeprecated( __METHOD__, '1.19' );
2253 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'editusercss' ) )
2254 || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) );
2258 * Protect js subpages of user pages: can $wgUser edit
2259 * this page?
2261 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2262 * @return Bool
2264 public function userCanEditJsSubpage() {
2265 global $wgUser;
2266 wfDeprecated( __METHOD__, '1.19' );
2267 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'edituserjs' ) )
2268 || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) );
2272 * Get a filtered list of all restriction types supported by this wiki.
2273 * @param bool $exists True to get all restriction types that apply to
2274 * titles that do exist, False for all restriction types that apply to
2275 * titles that do not exist
2276 * @return array
2278 public static function getFilteredRestrictionTypes( $exists = true ) {
2279 global $wgRestrictionTypes;
2280 $types = $wgRestrictionTypes;
2281 if ( $exists ) {
2282 # Remove the create restriction for existing titles
2283 $types = array_diff( $types, array( 'create' ) );
2284 } else {
2285 # Only the create and upload restrictions apply to non-existing titles
2286 $types = array_intersect( $types, array( 'create', 'upload' ) );
2288 return $types;
2292 * Returns restriction types for the current Title
2294 * @return array applicable restriction types
2296 public function getRestrictionTypes() {
2297 if ( $this->isSpecialPage() ) {
2298 return array();
2301 $types = self::getFilteredRestrictionTypes( $this->exists() );
2303 if ( $this->getNamespace() != NS_FILE ) {
2304 # Remove the upload restriction for non-file titles
2305 $types = array_diff( $types, array( 'upload' ) );
2308 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2310 wfDebug( __METHOD__ . ': applicable restrictions to [[' .
2311 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2313 return $types;
2317 * Is this title subject to title protection?
2318 * Title protection is the one applied against creation of such title.
2320 * @return Mixed An associative array representing any existent title
2321 * protection, or false if there's none.
2323 private function getTitleProtection() {
2324 // Can't protect pages in special namespaces
2325 if ( $this->getNamespace() < 0 ) {
2326 return false;
2329 // Can't protect pages that exist.
2330 if ( $this->exists() ) {
2331 return false;
2334 if ( !isset( $this->mTitleProtection ) ) {
2335 $dbr = wfGetDB( DB_SLAVE );
2336 $res = $dbr->select( 'protected_titles', '*',
2337 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2338 __METHOD__ );
2340 // fetchRow returns false if there are no rows.
2341 $this->mTitleProtection = $dbr->fetchRow( $res );
2343 return $this->mTitleProtection;
2347 * Update the title protection status
2349 * @deprecated in 1.19; will be removed in 1.20. Use WikiPage::doUpdateRestrictions() instead.
2350 * @param $create_perm String Permission required for creation
2351 * @param $reason String Reason for protection
2352 * @param $expiry String Expiry timestamp
2353 * @return boolean true
2355 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
2356 wfDeprecated( __METHOD__, '1.19' );
2358 global $wgUser;
2360 $limit = array( 'create' => $create_perm );
2361 $expiry = array( 'create' => $expiry );
2363 $page = WikiPage::factory( $this );
2364 $cascade = false;
2365 $status = $page->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $wgUser );
2367 return $status->isOK();
2371 * Remove any title protection due to page existing
2373 public function deleteTitleProtection() {
2374 $dbw = wfGetDB( DB_MASTER );
2376 $dbw->delete(
2377 'protected_titles',
2378 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2379 __METHOD__
2381 $this->mTitleProtection = false;
2385 * Is this page "semi-protected" - the *only* protection is autoconfirm?
2387 * @param $action String Action to check (default: edit)
2388 * @return Bool
2390 public function isSemiProtected( $action = 'edit' ) {
2391 if ( $this->exists() ) {
2392 $restrictions = $this->getRestrictions( $action );
2393 if ( count( $restrictions ) > 0 ) {
2394 foreach ( $restrictions as $restriction ) {
2395 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
2396 return false;
2399 } else {
2400 # Not protected
2401 return false;
2403 return true;
2404 } else {
2405 # If it doesn't exist, it can't be protected
2406 return false;
2411 * Does the title correspond to a protected article?
2413 * @param $action String the action the page is protected from,
2414 * by default checks all actions.
2415 * @return Bool
2417 public function isProtected( $action = '' ) {
2418 global $wgRestrictionLevels;
2420 $restrictionTypes = $this->getRestrictionTypes();
2422 # Special pages have inherent protection
2423 if( $this->isSpecialPage() ) {
2424 return true;
2427 # Check regular protection levels
2428 foreach ( $restrictionTypes as $type ) {
2429 if ( $action == $type || $action == '' ) {
2430 $r = $this->getRestrictions( $type );
2431 foreach ( $wgRestrictionLevels as $level ) {
2432 if ( in_array( $level, $r ) && $level != '' ) {
2433 return true;
2439 return false;
2443 * Determines if $user is unable to edit this page because it has been protected
2444 * by $wgNamespaceProtection.
2446 * @param $user User object to check permissions
2447 * @return Bool
2449 public function isNamespaceProtected( User $user ) {
2450 global $wgNamespaceProtection;
2452 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
2453 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
2454 if ( $right != '' && !$user->isAllowed( $right ) ) {
2455 return true;
2459 return false;
2463 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2465 * @return Bool If the page is subject to cascading restrictions.
2467 public function isCascadeProtected() {
2468 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2469 return ( $sources > 0 );
2473 * Cascading protection: Get the source of any cascading restrictions on this page.
2475 * @param $getPages Bool Whether or not to retrieve the actual pages
2476 * that the restrictions have come from.
2477 * @return Mixed Array of Title objects of the pages from which cascading restrictions
2478 * have come, false for none, or true if such restrictions exist, but $getPages
2479 * was not set. The restriction array is an array of each type, each of which
2480 * contains a array of unique groups.
2482 public function getCascadeProtectionSources( $getPages = true ) {
2483 global $wgContLang;
2484 $pagerestrictions = array();
2486 if ( isset( $this->mCascadeSources ) && $getPages ) {
2487 return array( $this->mCascadeSources, $this->mCascadingRestrictions );
2488 } elseif ( isset( $this->mHasCascadingRestrictions ) && !$getPages ) {
2489 return array( $this->mHasCascadingRestrictions, $pagerestrictions );
2492 wfProfileIn( __METHOD__ );
2494 $dbr = wfGetDB( DB_SLAVE );
2496 if ( $this->getNamespace() == NS_FILE ) {
2497 $tables = array( 'imagelinks', 'page_restrictions' );
2498 $where_clauses = array(
2499 'il_to' => $this->getDBkey(),
2500 'il_from=pr_page',
2501 'pr_cascade' => 1
2503 } else {
2504 $tables = array( 'templatelinks', 'page_restrictions' );
2505 $where_clauses = array(
2506 'tl_namespace' => $this->getNamespace(),
2507 'tl_title' => $this->getDBkey(),
2508 'tl_from=pr_page',
2509 'pr_cascade' => 1
2513 if ( $getPages ) {
2514 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2515 'pr_expiry', 'pr_type', 'pr_level' );
2516 $where_clauses[] = 'page_id=pr_page';
2517 $tables[] = 'page';
2518 } else {
2519 $cols = array( 'pr_expiry' );
2522 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2524 $sources = $getPages ? array() : false;
2525 $now = wfTimestampNow();
2526 $purgeExpired = false;
2528 foreach ( $res as $row ) {
2529 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2530 if ( $expiry > $now ) {
2531 if ( $getPages ) {
2532 $page_id = $row->pr_page;
2533 $page_ns = $row->page_namespace;
2534 $page_title = $row->page_title;
2535 $sources[$page_id] = Title::makeTitle( $page_ns, $page_title );
2536 # Add groups needed for each restriction type if its not already there
2537 # Make sure this restriction type still exists
2539 if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2540 $pagerestrictions[$row->pr_type] = array();
2543 if ( isset( $pagerestrictions[$row->pr_type] ) &&
2544 !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] ) ) {
2545 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2547 } else {
2548 $sources = true;
2550 } else {
2551 // Trigger lazy purge of expired restrictions from the db
2552 $purgeExpired = true;
2555 if ( $purgeExpired ) {
2556 Title::purgeExpiredRestrictions();
2559 if ( $getPages ) {
2560 $this->mCascadeSources = $sources;
2561 $this->mCascadingRestrictions = $pagerestrictions;
2562 } else {
2563 $this->mHasCascadingRestrictions = $sources;
2566 wfProfileOut( __METHOD__ );
2567 return array( $sources, $pagerestrictions );
2571 * Accessor/initialisation for mRestrictions
2573 * @param $action String action that permission needs to be checked for
2574 * @return Array of Strings the array of groups allowed to edit this article
2576 public function getRestrictions( $action ) {
2577 if ( !$this->mRestrictionsLoaded ) {
2578 $this->loadRestrictions();
2580 return isset( $this->mRestrictions[$action] )
2581 ? $this->mRestrictions[$action]
2582 : array();
2586 * Get the expiry time for the restriction against a given action
2588 * @param $action
2589 * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever
2590 * or not protected at all, or false if the action is not recognised.
2592 public function getRestrictionExpiry( $action ) {
2593 if ( !$this->mRestrictionsLoaded ) {
2594 $this->loadRestrictions();
2596 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
2600 * Returns cascading restrictions for the current article
2602 * @return Boolean
2604 function areRestrictionsCascading() {
2605 if ( !$this->mRestrictionsLoaded ) {
2606 $this->loadRestrictions();
2609 return $this->mCascadeRestriction;
2613 * Loads a string into mRestrictions array
2615 * @param $res Resource restrictions as an SQL result.
2616 * @param $oldFashionedRestrictions String comma-separated list of page
2617 * restrictions from page table (pre 1.10)
2619 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2620 $rows = array();
2622 foreach ( $res as $row ) {
2623 $rows[] = $row;
2626 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2630 * Compiles list of active page restrictions from both page table (pre 1.10)
2631 * and page_restrictions table for this existing page.
2632 * Public for usage by LiquidThreads.
2634 * @param $rows array of db result objects
2635 * @param $oldFashionedRestrictions string comma-separated list of page
2636 * restrictions from page table (pre 1.10)
2638 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2639 global $wgContLang;
2640 $dbr = wfGetDB( DB_SLAVE );
2642 $restrictionTypes = $this->getRestrictionTypes();
2644 foreach ( $restrictionTypes as $type ) {
2645 $this->mRestrictions[$type] = array();
2646 $this->mRestrictionsExpiry[$type] = $wgContLang->formatExpiry( '', TS_MW );
2649 $this->mCascadeRestriction = false;
2651 # Backwards-compatibility: also load the restrictions from the page record (old format).
2653 if ( $oldFashionedRestrictions === null ) {
2654 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2655 array( 'page_id' => $this->getArticleID() ), __METHOD__ );
2658 if ( $oldFashionedRestrictions != '' ) {
2660 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2661 $temp = explode( '=', trim( $restrict ) );
2662 if ( count( $temp ) == 1 ) {
2663 // old old format should be treated as edit/move restriction
2664 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
2665 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
2666 } else {
2667 $restriction = trim( $temp[1] );
2668 if( $restriction != '' ) { //some old entries are empty
2669 $this->mRestrictions[$temp[0]] = explode( ',', $restriction );
2674 $this->mOldRestrictions = true;
2678 if ( count( $rows ) ) {
2679 # Current system - load second to make them override.
2680 $now = wfTimestampNow();
2681 $purgeExpired = false;
2683 # Cycle through all the restrictions.
2684 foreach ( $rows as $row ) {
2686 // Don't take care of restrictions types that aren't allowed
2687 if ( !in_array( $row->pr_type, $restrictionTypes ) )
2688 continue;
2690 // This code should be refactored, now that it's being used more generally,
2691 // But I don't really see any harm in leaving it in Block for now -werdna
2692 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2694 // Only apply the restrictions if they haven't expired!
2695 if ( !$expiry || $expiry > $now ) {
2696 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
2697 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
2699 $this->mCascadeRestriction |= $row->pr_cascade;
2700 } else {
2701 // Trigger a lazy purge of expired restrictions
2702 $purgeExpired = true;
2706 if ( $purgeExpired ) {
2707 Title::purgeExpiredRestrictions();
2711 $this->mRestrictionsLoaded = true;
2715 * Load restrictions from the page_restrictions table
2717 * @param $oldFashionedRestrictions String comma-separated list of page
2718 * restrictions from page table (pre 1.10)
2720 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2721 global $wgContLang;
2722 if ( !$this->mRestrictionsLoaded ) {
2723 if ( $this->exists() ) {
2724 $dbr = wfGetDB( DB_SLAVE );
2726 $res = $dbr->select(
2727 'page_restrictions',
2728 '*',
2729 array( 'pr_page' => $this->getArticleID() ),
2730 __METHOD__
2733 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2734 } else {
2735 $title_protection = $this->getTitleProtection();
2737 if ( $title_protection ) {
2738 $now = wfTimestampNow();
2739 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW );
2741 if ( !$expiry || $expiry > $now ) {
2742 // Apply the restrictions
2743 $this->mRestrictionsExpiry['create'] = $expiry;
2744 $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2745 } else { // Get rid of the old restrictions
2746 Title::purgeExpiredRestrictions();
2747 $this->mTitleProtection = false;
2749 } else {
2750 $this->mRestrictionsExpiry['create'] = $wgContLang->formatExpiry( '', TS_MW );
2752 $this->mRestrictionsLoaded = true;
2758 * Flush the protection cache in this object and force reload from the database.
2759 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2761 public function flushRestrictions() {
2762 $this->mRestrictionsLoaded = false;
2763 $this->mTitleProtection = null;
2767 * Purge expired restrictions from the page_restrictions table
2769 static function purgeExpiredRestrictions() {
2770 $dbw = wfGetDB( DB_MASTER );
2771 $dbw->delete(
2772 'page_restrictions',
2773 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2774 __METHOD__
2777 $dbw->delete(
2778 'protected_titles',
2779 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2780 __METHOD__
2785 * Does this have subpages? (Warning, usually requires an extra DB query.)
2787 * @return Bool
2789 public function hasSubpages() {
2790 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
2791 # Duh
2792 return false;
2795 # We dynamically add a member variable for the purpose of this method
2796 # alone to cache the result. There's no point in having it hanging
2797 # around uninitialized in every Title object; therefore we only add it
2798 # if needed and don't declare it statically.
2799 if ( isset( $this->mHasSubpages ) ) {
2800 return $this->mHasSubpages;
2803 $subpages = $this->getSubpages( 1 );
2804 if ( $subpages instanceof TitleArray ) {
2805 return $this->mHasSubpages = (bool)$subpages->count();
2807 return $this->mHasSubpages = false;
2811 * Get all subpages of this page.
2813 * @param $limit Int maximum number of subpages to fetch; -1 for no limit
2814 * @return mixed TitleArray, or empty array if this page's namespace
2815 * doesn't allow subpages
2817 public function getSubpages( $limit = -1 ) {
2818 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
2819 return array();
2822 $dbr = wfGetDB( DB_SLAVE );
2823 $conds['page_namespace'] = $this->getNamespace();
2824 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
2825 $options = array();
2826 if ( $limit > -1 ) {
2827 $options['LIMIT'] = $limit;
2829 return $this->mSubpages = TitleArray::newFromResult(
2830 $dbr->select( 'page',
2831 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
2832 $conds,
2833 __METHOD__,
2834 $options
2840 * Is there a version of this page in the deletion archive?
2842 * @return Int the number of archived revisions
2844 public function isDeleted() {
2845 if ( $this->getNamespace() < 0 ) {
2846 $n = 0;
2847 } else {
2848 $dbr = wfGetDB( DB_SLAVE );
2850 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2851 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2852 __METHOD__
2854 if ( $this->getNamespace() == NS_FILE ) {
2855 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
2856 array( 'fa_name' => $this->getDBkey() ),
2857 __METHOD__
2861 return (int)$n;
2865 * Is there a version of this page in the deletion archive?
2867 * @return Boolean
2869 public function isDeletedQuick() {
2870 if ( $this->getNamespace() < 0 ) {
2871 return false;
2873 $dbr = wfGetDB( DB_SLAVE );
2874 $deleted = (bool)$dbr->selectField( 'archive', '1',
2875 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2876 __METHOD__
2878 if ( !$deleted && $this->getNamespace() == NS_FILE ) {
2879 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2880 array( 'fa_name' => $this->getDBkey() ),
2881 __METHOD__
2884 return $deleted;
2888 * Get the article ID for this Title from the link cache,
2889 * adding it if necessary
2891 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select
2892 * for update
2893 * @return Int the ID
2895 public function getArticleID( $flags = 0 ) {
2896 if ( $this->getNamespace() < 0 ) {
2897 return $this->mArticleID = 0;
2899 $linkCache = LinkCache::singleton();
2900 if ( $flags & self::GAID_FOR_UPDATE ) {
2901 $oldUpdate = $linkCache->forUpdate( true );
2902 $linkCache->clearLink( $this );
2903 $this->mArticleID = $linkCache->addLinkObj( $this );
2904 $linkCache->forUpdate( $oldUpdate );
2905 } else {
2906 if ( -1 == $this->mArticleID ) {
2907 $this->mArticleID = $linkCache->addLinkObj( $this );
2910 return $this->mArticleID;
2914 * Is this an article that is a redirect page?
2915 * Uses link cache, adding it if necessary
2917 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2918 * @return Bool
2920 public function isRedirect( $flags = 0 ) {
2921 if ( !is_null( $this->mRedirect ) ) {
2922 return $this->mRedirect;
2924 # Calling getArticleID() loads the field from cache as needed
2925 if ( !$this->getArticleID( $flags ) ) {
2926 return $this->mRedirect = false;
2929 $linkCache = LinkCache::singleton();
2930 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2931 if ( $cached === null ) {
2932 // TODO: check the assumption that the cache actually knows about this title
2933 // and handle this, such as get the title from the database.
2934 // See https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2935 wfDebug( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2936 wfDebug( wfBacktrace() );
2939 $this->mRedirect = (bool)$cached;
2941 return $this->mRedirect;
2945 * What is the length of this page?
2946 * Uses link cache, adding it if necessary
2948 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2949 * @return Int
2951 public function getLength( $flags = 0 ) {
2952 if ( $this->mLength != -1 ) {
2953 return $this->mLength;
2955 # Calling getArticleID() loads the field from cache as needed
2956 if ( !$this->getArticleID( $flags ) ) {
2957 return $this->mLength = 0;
2959 $linkCache = LinkCache::singleton();
2960 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
2961 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
2962 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2963 # as a stop gap, perhaps log this, but don't throw an exception?
2964 wfDebug( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2965 wfDebug( wfBacktrace() );
2968 $this->mLength = intval( $cached );
2970 return $this->mLength;
2974 * What is the page_latest field for this page?
2976 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2977 * @throws MWException
2978 * @return Int or 0 if the page doesn't exist
2980 public function getLatestRevID( $flags = 0 ) {
2981 if ( !( $flags & Title::GAID_FOR_UPDATE ) && $this->mLatestID !== false ) {
2982 return intval( $this->mLatestID );
2984 # Calling getArticleID() loads the field from cache as needed
2985 if ( !$this->getArticleID( $flags ) ) {
2986 return $this->mLatestID = 0;
2988 $linkCache = LinkCache::singleton();
2989 $linkCache->addLinkObj( $this );
2990 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
2991 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
2992 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2993 # as a stop gap, perhaps log this, but don't throw an exception?
2994 throw new MWException( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2997 $this->mLatestID = intval( $cached );
2999 return $this->mLatestID;
3003 * This clears some fields in this object, and clears any associated
3004 * keys in the "bad links" section of the link cache.
3006 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
3007 * loading of the new page_id. It's also called from
3008 * WikiPage::doDeleteArticleReal()
3010 * @param $newid Int the new Article ID
3012 public function resetArticleID( $newid ) {
3013 $linkCache = LinkCache::singleton();
3014 $linkCache->clearLink( $this );
3016 if ( $newid === false ) {
3017 $this->mArticleID = -1;
3018 } else {
3019 $this->mArticleID = intval( $newid );
3021 $this->mRestrictionsLoaded = false;
3022 $this->mRestrictions = array();
3023 $this->mRedirect = null;
3024 $this->mLength = -1;
3025 $this->mLatestID = false;
3026 $this->mContentModel = false;
3027 $this->mEstimateRevisions = null;
3031 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3033 * @param $text String containing title to capitalize
3034 * @param $ns int namespace index, defaults to NS_MAIN
3035 * @return String containing capitalized title
3037 public static function capitalize( $text, $ns = NS_MAIN ) {
3038 global $wgContLang;
3040 if ( MWNamespace::isCapitalized( $ns ) ) {
3041 return $wgContLang->ucfirst( $text );
3042 } else {
3043 return $text;
3048 * Secure and split - main initialisation function for this object
3050 * Assumes that mDbkeyform has been set, and is urldecoded
3051 * and uses underscores, but not otherwise munged. This function
3052 * removes illegal characters, splits off the interwiki and
3053 * namespace prefixes, sets the other forms, and canonicalizes
3054 * everything.
3056 * @return Bool true on success
3058 private function secureAndSplit() {
3059 global $wgContLang, $wgLocalInterwiki;
3061 # Initialisation
3062 $this->mInterwiki = $this->mFragment = '';
3063 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
3065 $dbkey = $this->mDbkeyform;
3067 # Strip Unicode bidi override characters.
3068 # Sometimes they slip into cut-n-pasted page titles, where the
3069 # override chars get included in list displays.
3070 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
3072 # Clean up whitespace
3073 # Note: use of the /u option on preg_replace here will cause
3074 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
3075 # conveniently disabling them.
3076 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
3077 $dbkey = trim( $dbkey, '_' );
3079 if ( $dbkey == '' ) {
3080 return false;
3083 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
3084 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
3085 return false;
3088 $this->mDbkeyform = $dbkey;
3090 # Initial colon indicates main namespace rather than specified default
3091 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
3092 if ( ':' == $dbkey[0] ) {
3093 $this->mNamespace = NS_MAIN;
3094 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
3095 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
3098 # Namespace or interwiki prefix
3099 $firstPass = true;
3100 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
3101 do {
3102 $m = array();
3103 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
3104 $p = $m[1];
3105 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
3106 # Ordinary namespace
3107 $dbkey = $m[2];
3108 $this->mNamespace = $ns;
3109 # For Talk:X pages, check if X has a "namespace" prefix
3110 if ( $ns == NS_TALK && preg_match( $prefixRegexp, $dbkey, $x ) ) {
3111 if ( $wgContLang->getNsIndex( $x[1] ) ) {
3112 # Disallow Talk:File:x type titles...
3113 return false;
3114 } elseif ( Interwiki::isValidInterwiki( $x[1] ) ) {
3115 # Disallow Talk:Interwiki:x type titles...
3116 return false;
3119 } elseif ( Interwiki::isValidInterwiki( $p ) ) {
3120 if ( !$firstPass ) {
3121 # Can't make a local interwiki link to an interwiki link.
3122 # That's just crazy!
3123 return false;
3126 # Interwiki link
3127 $dbkey = $m[2];
3128 $this->mInterwiki = $wgContLang->lc( $p );
3130 # Redundant interwiki prefix to the local wiki
3131 if ( $wgLocalInterwiki !== false
3132 && 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) )
3134 if ( $dbkey == '' ) {
3135 # Can't have an empty self-link
3136 return false;
3138 $this->mInterwiki = '';
3139 $firstPass = false;
3140 # Do another namespace split...
3141 continue;
3144 # If there's an initial colon after the interwiki, that also
3145 # resets the default namespace
3146 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
3147 $this->mNamespace = NS_MAIN;
3148 $dbkey = substr( $dbkey, 1 );
3151 # If there's no recognized interwiki or namespace,
3152 # then let the colon expression be part of the title.
3154 break;
3155 } while ( true );
3157 # We already know that some pages won't be in the database!
3158 if ( $this->mInterwiki != '' || NS_SPECIAL == $this->mNamespace ) {
3159 $this->mArticleID = 0;
3161 $fragment = strstr( $dbkey, '#' );
3162 if ( false !== $fragment ) {
3163 $this->setFragment( $fragment );
3164 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
3165 # remove whitespace again: prevents "Foo_bar_#"
3166 # becoming "Foo_bar_"
3167 $dbkey = preg_replace( '/_*$/', '', $dbkey );
3170 # Reject illegal characters.
3171 $rxTc = self::getTitleInvalidRegex();
3172 if ( preg_match( $rxTc, $dbkey ) ) {
3173 return false;
3176 # Pages with "/./" or "/../" appearing in the URLs will often be un-
3177 # reachable due to the way web browsers deal with 'relative' URLs.
3178 # Also, they conflict with subpage syntax. Forbid them explicitly.
3179 if ( strpos( $dbkey, '.' ) !== false &&
3180 ( $dbkey === '.' || $dbkey === '..' ||
3181 strpos( $dbkey, './' ) === 0 ||
3182 strpos( $dbkey, '../' ) === 0 ||
3183 strpos( $dbkey, '/./' ) !== false ||
3184 strpos( $dbkey, '/../' ) !== false ||
3185 substr( $dbkey, -2 ) == '/.' ||
3186 substr( $dbkey, -3 ) == '/..' ) )
3188 return false;
3191 # Magic tilde sequences? Nu-uh!
3192 if ( strpos( $dbkey, '~~~' ) !== false ) {
3193 return false;
3196 # Limit the size of titles to 255 bytes. This is typically the size of the
3197 # underlying database field. We make an exception for special pages, which
3198 # don't need to be stored in the database, and may edge over 255 bytes due
3199 # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
3200 if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) ||
3201 strlen( $dbkey ) > 512 )
3203 return false;
3206 # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
3207 # and [[Foo]] point to the same place. Don't force it for interwikis, since the
3208 # other site might be case-sensitive.
3209 $this->mUserCaseDBKey = $dbkey;
3210 if ( $this->mInterwiki == '' ) {
3211 $dbkey = self::capitalize( $dbkey, $this->mNamespace );
3214 # Can't make a link to a namespace alone... "empty" local links can only be
3215 # self-links with a fragment identifier.
3216 if ( $dbkey == '' && $this->mInterwiki == '' && $this->mNamespace != NS_MAIN ) {
3217 return false;
3220 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
3221 // IP names are not allowed for accounts, and can only be referring to
3222 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
3223 // there are numerous ways to present the same IP. Having sp:contribs scan
3224 // them all is silly and having some show the edits and others not is
3225 // inconsistent. Same for talk/userpages. Keep them normalized instead.
3226 $dbkey = ( $this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK )
3227 ? IP::sanitizeIP( $dbkey )
3228 : $dbkey;
3230 // Any remaining initial :s are illegal.
3231 if ( $dbkey !== '' && ':' == $dbkey[0] ) {
3232 return false;
3235 # Fill fields
3236 $this->mDbkeyform = $dbkey;
3237 $this->mUrlform = wfUrlencode( $dbkey );
3239 $this->mTextform = str_replace( '_', ' ', $dbkey );
3241 return true;
3245 * Get an array of Title objects linking to this Title
3246 * Also stores the IDs in the link cache.
3248 * WARNING: do not use this function on arbitrary user-supplied titles!
3249 * On heavily-used templates it will max out the memory.
3251 * @param $options Array: may be FOR UPDATE
3252 * @param $table String: table name
3253 * @param $prefix String: fields prefix
3254 * @return Array of Title objects linking here
3256 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3257 if ( count( $options ) > 0 ) {
3258 $db = wfGetDB( DB_MASTER );
3259 } else {
3260 $db = wfGetDB( DB_SLAVE );
3263 $res = $db->select(
3264 array( 'page', $table ),
3265 self::getSelectFields(),
3266 array(
3267 "{$prefix}_from=page_id",
3268 "{$prefix}_namespace" => $this->getNamespace(),
3269 "{$prefix}_title" => $this->getDBkey() ),
3270 __METHOD__,
3271 $options
3274 $retVal = array();
3275 if ( $res->numRows() ) {
3276 $linkCache = LinkCache::singleton();
3277 foreach ( $res as $row ) {
3278 $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title );
3279 if ( $titleObj ) {
3280 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3281 $retVal[] = $titleObj;
3285 return $retVal;
3289 * Get an array of Title objects using this Title as a template
3290 * Also stores the IDs in the link cache.
3292 * WARNING: do not use this function on arbitrary user-supplied titles!
3293 * On heavily-used templates it will max out the memory.
3295 * @param $options Array: may be FOR UPDATE
3296 * @return Array of Title the Title objects linking here
3298 public function getTemplateLinksTo( $options = array() ) {
3299 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3303 * Get an array of Title objects linked from this Title
3304 * Also stores the IDs in the link cache.
3306 * WARNING: do not use this function on arbitrary user-supplied titles!
3307 * On heavily-used templates it will max out the memory.
3309 * @param $options Array: may be FOR UPDATE
3310 * @param $table String: table name
3311 * @param $prefix String: fields prefix
3312 * @return Array of Title objects linking here
3314 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3315 global $wgContentHandlerUseDB;
3317 $id = $this->getArticleID();
3319 # If the page doesn't exist; there can't be any link from this page
3320 if ( !$id ) {
3321 return array();
3324 if ( count( $options ) > 0 ) {
3325 $db = wfGetDB( DB_MASTER );
3326 } else {
3327 $db = wfGetDB( DB_SLAVE );
3330 $namespaceFiled = "{$prefix}_namespace";
3331 $titleField = "{$prefix}_title";
3333 $fields = array( $namespaceFiled, $titleField, 'page_id', 'page_len', 'page_is_redirect', 'page_latest' );
3334 if ( $wgContentHandlerUseDB ) $fields[] = 'page_content_model';
3336 $res = $db->select(
3337 array( $table, 'page' ),
3338 $fields,
3339 array( "{$prefix}_from" => $id ),
3340 __METHOD__,
3341 $options,
3342 array( 'page' => array( 'LEFT JOIN', array( "page_namespace=$namespaceFiled", "page_title=$titleField" ) ) )
3345 $retVal = array();
3346 if ( $res->numRows() ) {
3347 $linkCache = LinkCache::singleton();
3348 foreach ( $res as $row ) {
3349 $titleObj = Title::makeTitle( $row->$namespaceFiled, $row->$titleField );
3350 if ( $titleObj ) {
3351 if ( $row->page_id ) {
3352 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3353 } else {
3354 $linkCache->addBadLinkObj( $titleObj );
3356 $retVal[] = $titleObj;
3360 return $retVal;
3364 * Get an array of Title objects used on this Title as a template
3365 * Also stores the IDs in the link cache.
3367 * WARNING: do not use this function on arbitrary user-supplied titles!
3368 * On heavily-used templates it will max out the memory.
3370 * @param $options Array: may be FOR UPDATE
3371 * @return Array of Title the Title objects used here
3373 public function getTemplateLinksFrom( $options = array() ) {
3374 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3378 * Get an array of Title objects referring to non-existent articles linked from this page
3380 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
3381 * @return Array of Title the Title objects
3383 public function getBrokenLinksFrom() {
3384 if ( $this->getArticleID() == 0 ) {
3385 # All links from article ID 0 are false positives
3386 return array();
3389 $dbr = wfGetDB( DB_SLAVE );
3390 $res = $dbr->select(
3391 array( 'page', 'pagelinks' ),
3392 array( 'pl_namespace', 'pl_title' ),
3393 array(
3394 'pl_from' => $this->getArticleID(),
3395 'page_namespace IS NULL'
3397 __METHOD__, array(),
3398 array(
3399 'page' => array(
3400 'LEFT JOIN',
3401 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3406 $retVal = array();
3407 foreach ( $res as $row ) {
3408 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
3410 return $retVal;
3415 * Get a list of URLs to purge from the Squid cache when this
3416 * page changes
3418 * @return Array of String the URLs
3420 public function getSquidURLs() {
3421 $urls = array(
3422 $this->getInternalURL(),
3423 $this->getInternalURL( 'action=history' )
3426 $pageLang = $this->getPageLanguage();
3427 if ( $pageLang->hasVariants() ) {
3428 $variants = $pageLang->getVariants();
3429 foreach ( $variants as $vCode ) {
3430 $urls[] = $this->getInternalURL( '', $vCode );
3434 return $urls;
3438 * Purge all applicable Squid URLs
3440 public function purgeSquid() {
3441 global $wgUseSquid;
3442 if ( $wgUseSquid ) {
3443 $urls = $this->getSquidURLs();
3444 $u = new SquidUpdate( $urls );
3445 $u->doUpdate();
3450 * Move this page without authentication
3452 * @param $nt Title the new page Title
3453 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3455 public function moveNoAuth( &$nt ) {
3456 return $this->moveTo( $nt, false );
3460 * Check whether a given move operation would be valid.
3461 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3463 * @param $nt Title the new title
3464 * @param $auth Bool indicates whether $wgUser's permissions
3465 * should be checked
3466 * @param $reason String is the log summary of the move, used for spam checking
3467 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
3469 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3470 global $wgUser, $wgContentHandlerUseDB;
3472 $errors = array();
3473 if ( !$nt ) {
3474 // Normally we'd add this to $errors, but we'll get
3475 // lots of syntax errors if $nt is not an object
3476 return array( array( 'badtitletext' ) );
3478 if ( $this->equals( $nt ) ) {
3479 $errors[] = array( 'selfmove' );
3481 if ( !$this->isMovable() ) {
3482 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3484 if ( $nt->getInterwiki() != '' ) {
3485 $errors[] = array( 'immobile-target-namespace-iw' );
3487 if ( !$nt->isMovable() ) {
3488 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3491 $oldid = $this->getArticleID();
3492 $newid = $nt->getArticleID();
3494 if ( strlen( $nt->getDBkey() ) < 1 ) {
3495 $errors[] = array( 'articleexists' );
3497 if ( ( $this->getDBkey() == '' ) ||
3498 ( !$oldid ) ||
3499 ( $nt->getDBkey() == '' ) ) {
3500 $errors[] = array( 'badarticleerror' );
3503 // Content model checks
3504 if ( !$wgContentHandlerUseDB &&
3505 $this->getContentModel() !== $nt->getContentModel() ) {
3506 // can't move a page if that would change the page's content model
3507 $errors[] = array( 'bad-target-model',
3508 ContentHandler::getLocalizedName( $this->getContentModel() ),
3509 ContentHandler::getLocalizedName( $nt->getContentModel() ) );
3512 // Image-specific checks
3513 if ( $this->getNamespace() == NS_FILE ) {
3514 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3517 if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) {
3518 $errors[] = array( 'nonfile-cannot-move-to-file' );
3521 if ( $auth ) {
3522 $errors = wfMergeErrorArrays( $errors,
3523 $this->getUserPermissionsErrors( 'move', $wgUser ),
3524 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3525 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3526 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3529 $match = EditPage::matchSummarySpamRegex( $reason );
3530 if ( $match !== false ) {
3531 // This is kind of lame, won't display nice
3532 $errors[] = array( 'spamprotectiontext' );
3535 $err = null;
3536 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3537 $errors[] = array( 'hookaborted', $err );
3540 # The move is allowed only if (1) the target doesn't exist, or
3541 # (2) the target is a redirect to the source, and has no history
3542 # (so we can undo bad moves right after they're done).
3544 if ( 0 != $newid ) { # Target exists; check for validity
3545 if ( !$this->isValidMoveTarget( $nt ) ) {
3546 $errors[] = array( 'articleexists' );
3548 } else {
3549 $tp = $nt->getTitleProtection();
3550 $right = ( $tp['pt_create_perm'] == 'sysop' ) ? 'protect' : $tp['pt_create_perm'];
3551 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3552 $errors[] = array( 'cantmove-titleprotected' );
3555 if ( empty( $errors ) ) {
3556 return true;
3558 return $errors;
3562 * Check if the requested move target is a valid file move target
3563 * @param Title $nt Target title
3564 * @return array List of errors
3566 protected function validateFileMoveOperation( $nt ) {
3567 global $wgUser;
3569 $errors = array();
3571 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3573 $file = wfLocalFile( $this );
3574 if ( $file->exists() ) {
3575 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3576 $errors[] = array( 'imageinvalidfilename' );
3578 if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3579 $errors[] = array( 'imagetypemismatch' );
3583 if ( $nt->getNamespace() != NS_FILE ) {
3584 $errors[] = array( 'imagenocrossnamespace' );
3585 // From here we want to do checks on a file object, so if we can't
3586 // create one, we must return.
3587 return $errors;
3590 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3592 $destFile = wfLocalFile( $nt );
3593 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3594 $errors[] = array( 'file-exists-sharedrepo' );
3597 return $errors;
3601 * Move a title to a new location
3603 * @param $nt Title the new title
3604 * @param $auth Bool indicates whether $wgUser's permissions
3605 * should be checked
3606 * @param $reason String the reason for the move
3607 * @param $createRedirect Bool Whether to create a redirect from the old title to the new title.
3608 * Ignored if the user doesn't have the suppressredirect right.
3609 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3611 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3612 global $wgUser;
3613 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3614 if ( is_array( $err ) ) {
3615 // Auto-block user's IP if the account was "hard" blocked
3616 $wgUser->spreadAnyEditBlock();
3617 return $err;
3619 // Check suppressredirect permission
3620 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3621 $createRedirect = true;
3624 // If it is a file, move it first.
3625 // It is done before all other moving stuff is done because it's hard to revert.
3626 $dbw = wfGetDB( DB_MASTER );
3627 if ( $this->getNamespace() == NS_FILE ) {
3628 $file = wfLocalFile( $this );
3629 if ( $file->exists() ) {
3630 $status = $file->move( $nt );
3631 if ( !$status->isOk() ) {
3632 return $status->getErrorsArray();
3635 // Clear RepoGroup process cache
3636 RepoGroup::singleton()->clearCache( $this );
3637 RepoGroup::singleton()->clearCache( $nt ); # clear false negative cache
3640 $dbw->begin( __METHOD__ ); # If $file was a LocalFile, its transaction would have closed our own.
3641 $pageid = $this->getArticleID( self::GAID_FOR_UPDATE );
3642 $protected = $this->isProtected();
3644 // Do the actual move
3645 $this->moveToInternal( $nt, $reason, $createRedirect );
3647 // Refresh the sortkey for this row. Be careful to avoid resetting
3648 // cl_timestamp, which may disturb time-based lists on some sites.
3649 $prefixes = $dbw->select(
3650 'categorylinks',
3651 array( 'cl_sortkey_prefix', 'cl_to' ),
3652 array( 'cl_from' => $pageid ),
3653 __METHOD__
3655 foreach ( $prefixes as $prefixRow ) {
3656 $prefix = $prefixRow->cl_sortkey_prefix;
3657 $catTo = $prefixRow->cl_to;
3658 $dbw->update( 'categorylinks',
3659 array(
3660 'cl_sortkey' => Collation::singleton()->getSortKey(
3661 $nt->getCategorySortkey( $prefix ) ),
3662 'cl_timestamp=cl_timestamp' ),
3663 array(
3664 'cl_from' => $pageid,
3665 'cl_to' => $catTo ),
3666 __METHOD__
3670 $redirid = $this->getArticleID();
3672 if ( $protected ) {
3673 # Protect the redirect title as the title used to be...
3674 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3675 array(
3676 'pr_page' => $redirid,
3677 'pr_type' => 'pr_type',
3678 'pr_level' => 'pr_level',
3679 'pr_cascade' => 'pr_cascade',
3680 'pr_user' => 'pr_user',
3681 'pr_expiry' => 'pr_expiry'
3683 array( 'pr_page' => $pageid ),
3684 __METHOD__,
3685 array( 'IGNORE' )
3687 # Update the protection log
3688 $log = new LogPage( 'protect' );
3689 $comment = wfMessage(
3690 'prot_1movedto2',
3691 $this->getPrefixedText(),
3692 $nt->getPrefixedText()
3693 )->inContentLanguage()->text();
3694 if ( $reason ) {
3695 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3697 // @todo FIXME: $params?
3698 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) );
3701 # Update watchlists
3702 $oldnamespace = MWNamespace::getSubject( $this->getNamespace() );
3703 $newnamespace = MWNamespace::getSubject( $nt->getNamespace() );
3704 $oldtitle = $this->getDBkey();
3705 $newtitle = $nt->getDBkey();
3707 if ( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
3708 WatchedItem::duplicateEntries( $this, $nt );
3711 $dbw->commit( __METHOD__ );
3713 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3714 return true;
3718 * Move page to a title which is either a redirect to the
3719 * source page or nonexistent
3721 * @param $nt Title the page to move to, which should be a redirect or nonexistent
3722 * @param $reason String The reason for the move
3723 * @param $createRedirect Bool Whether to leave a redirect at the old title. Does not check
3724 * if the user has the suppressredirect right
3725 * @throws MWException
3727 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3728 global $wgUser, $wgContLang;
3730 if ( $nt->exists() ) {
3731 $moveOverRedirect = true;
3732 $logType = 'move_redir';
3733 } else {
3734 $moveOverRedirect = false;
3735 $logType = 'move';
3738 if ( $createRedirect ) {
3739 $contentHandler = ContentHandler::getForTitle( $this );
3740 $redirectContent = $contentHandler->makeRedirectContent( $nt );
3742 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
3743 } else {
3744 $redirectContent = null;
3747 $logEntry = new ManualLogEntry( 'move', $logType );
3748 $logEntry->setPerformer( $wgUser );
3749 $logEntry->setTarget( $this );
3750 $logEntry->setComment( $reason );
3751 $logEntry->setParameters( array(
3752 '4::target' => $nt->getPrefixedText(),
3753 '5::noredir' => $redirectContent ? '0': '1',
3754 ) );
3756 $formatter = LogFormatter::newFromEntry( $logEntry );
3757 $formatter->setContext( RequestContext::newExtraneousContext( $this ) );
3758 $comment = $formatter->getPlainActionText();
3759 if ( $reason ) {
3760 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3762 # Truncate for whole multibyte characters.
3763 $comment = $wgContLang->truncate( $comment, 255 );
3765 $oldid = $this->getArticleID();
3767 $dbw = wfGetDB( DB_MASTER );
3769 $newpage = WikiPage::factory( $nt );
3771 if ( $moveOverRedirect ) {
3772 $newid = $nt->getArticleID();
3774 # Delete the old redirect. We don't save it to history since
3775 # by definition if we've got here it's rather uninteresting.
3776 # We have to remove it so that the next step doesn't trigger
3777 # a conflict on the unique namespace+title index...
3778 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ );
3780 $newpage->doDeleteUpdates( $newid );
3783 # Save a null revision in the page's history notifying of the move
3784 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
3785 if ( !is_object( $nullRevision ) ) {
3786 throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
3789 $nullRevision->insertOn( $dbw );
3791 # Change the name of the target page:
3792 $dbw->update( 'page',
3793 /* SET */ array(
3794 'page_namespace' => $nt->getNamespace(),
3795 'page_title' => $nt->getDBkey(),
3797 /* WHERE */ array( 'page_id' => $oldid ),
3798 __METHOD__
3801 $this->resetArticleID( 0 );
3802 $nt->resetArticleID( $oldid );
3804 $newpage->updateRevisionOn( $dbw, $nullRevision );
3806 wfRunHooks( 'NewRevisionFromEditComplete',
3807 array( $newpage, $nullRevision, $nullRevision->getParentId(), $wgUser ) );
3809 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3811 if ( !$moveOverRedirect ) {
3812 WikiPage::onArticleCreate( $nt );
3815 # Recreate the redirect, this time in the other direction.
3816 if ( !$redirectContent ) {
3817 WikiPage::onArticleDelete( $this );
3818 } else {
3819 $redirectArticle = WikiPage::factory( $this );
3820 $newid = $redirectArticle->insertOn( $dbw );
3821 if ( $newid ) { // sanity
3822 $redirectRevision = new Revision( array(
3823 'title' => $this, // for determining the default content model
3824 'page' => $newid,
3825 'comment' => $comment,
3826 'content' => $redirectContent ) );
3827 $redirectRevision->insertOn( $dbw );
3828 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3830 wfRunHooks( 'NewRevisionFromEditComplete',
3831 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3833 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3837 # Log the move
3838 $logid = $logEntry->insert();
3839 $logEntry->publish( $logid );
3843 * Move this page's subpages to be subpages of $nt
3845 * @param $nt Title Move target
3846 * @param $auth bool Whether $wgUser's permissions should be checked
3847 * @param $reason string The reason for the move
3848 * @param $createRedirect bool Whether to create redirects from the old subpages to
3849 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3850 * @return mixed array with old page titles as keys, and strings (new page titles) or
3851 * arrays (errors) as values, or an error array with numeric indices if no pages
3852 * were moved
3854 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3855 global $wgMaximumMovedPages;
3856 // Check permissions
3857 if ( !$this->userCan( 'move-subpages' ) ) {
3858 return array( 'cant-move-subpages' );
3860 // Do the source and target namespaces support subpages?
3861 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
3862 return array( 'namespace-nosubpages',
3863 MWNamespace::getCanonicalName( $this->getNamespace() ) );
3865 if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) {
3866 return array( 'namespace-nosubpages',
3867 MWNamespace::getCanonicalName( $nt->getNamespace() ) );
3870 $subpages = $this->getSubpages( $wgMaximumMovedPages + 1 );
3871 $retval = array();
3872 $count = 0;
3873 foreach ( $subpages as $oldSubpage ) {
3874 $count++;
3875 if ( $count > $wgMaximumMovedPages ) {
3876 $retval[$oldSubpage->getPrefixedTitle()] =
3877 array( 'movepage-max-pages',
3878 $wgMaximumMovedPages );
3879 break;
3882 // We don't know whether this function was called before
3883 // or after moving the root page, so check both
3884 // $this and $nt
3885 if ( $oldSubpage->getArticleID() == $this->getArticleID() ||
3886 $oldSubpage->getArticleID() == $nt->getArticleID() )
3888 // When moving a page to a subpage of itself,
3889 // don't move it twice
3890 continue;
3892 $newPageName = preg_replace(
3893 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3894 StringUtils::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3895 $oldSubpage->getDBkey() );
3896 if ( $oldSubpage->isTalkPage() ) {
3897 $newNs = $nt->getTalkPage()->getNamespace();
3898 } else {
3899 $newNs = $nt->getSubjectPage()->getNamespace();
3901 # Bug 14385: we need makeTitleSafe because the new page names may
3902 # be longer than 255 characters.
3903 $newSubpage = Title::makeTitleSafe( $newNs, $newPageName );
3905 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3906 if ( $success === true ) {
3907 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3908 } else {
3909 $retval[$oldSubpage->getPrefixedText()] = $success;
3912 return $retval;
3916 * Checks if this page is just a one-rev redirect.
3917 * Adds lock, so don't use just for light purposes.
3919 * @return Bool
3921 public function isSingleRevRedirect() {
3922 global $wgContentHandlerUseDB;
3924 $dbw = wfGetDB( DB_MASTER );
3926 # Is it a redirect?
3927 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
3928 if ( $wgContentHandlerUseDB ) $fields[] = 'page_content_model';
3930 $row = $dbw->selectRow( 'page',
3931 $fields,
3932 $this->pageCond(),
3933 __METHOD__,
3934 array( 'FOR UPDATE' )
3936 # Cache some fields we may want
3937 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
3938 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
3939 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
3940 $this->mContentModel = $row && isset( $row->page_content_model ) ? strval( $row->page_content_model ) : false;
3941 if ( !$this->mRedirect ) {
3942 return false;
3944 # Does the article have a history?
3945 $row = $dbw->selectField( array( 'page', 'revision' ),
3946 'rev_id',
3947 array( 'page_namespace' => $this->getNamespace(),
3948 'page_title' => $this->getDBkey(),
3949 'page_id=rev_page',
3950 'page_latest != rev_id'
3952 __METHOD__,
3953 array( 'FOR UPDATE' )
3955 # Return true if there was no history
3956 return ( $row === false );
3960 * Checks if $this can be moved to a given Title
3961 * - Selects for update, so don't call it unless you mean business
3963 * @param $nt Title the new title to check
3964 * @return Bool
3966 public function isValidMoveTarget( $nt ) {
3967 # Is it an existing file?
3968 if ( $nt->getNamespace() == NS_FILE ) {
3969 $file = wfLocalFile( $nt );
3970 if ( $file->exists() ) {
3971 wfDebug( __METHOD__ . ": file exists\n" );
3972 return false;
3975 # Is it a redirect with no history?
3976 if ( !$nt->isSingleRevRedirect() ) {
3977 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
3978 return false;
3980 # Get the article text
3981 $rev = Revision::newFromTitle( $nt, false, Revision::READ_LATEST );
3982 if( !is_object( $rev ) ){
3983 return false;
3985 $content = $rev->getContent();
3986 # Does the redirect point to the source?
3987 # Or is it a broken self-redirect, usually caused by namespace collisions?
3988 $redirTitle = $content ? $content->getRedirectTarget() : null;
3990 if ( $redirTitle ) {
3991 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3992 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3993 wfDebug( __METHOD__ . ": redirect points to other page\n" );
3994 return false;
3995 } else {
3996 return true;
3998 } else {
3999 # Fail safe (not a redirect after all. strange.)
4000 wfDebug( __METHOD__ . ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4001 " is a redirect, but it doesn't contain a valid redirect.\n" );
4002 return false;
4007 * Get categories to which this Title belongs and return an array of
4008 * categories' names.
4010 * @return Array of parents in the form:
4011 * $parent => $currentarticle
4013 public function getParentCategories() {
4014 global $wgContLang;
4016 $data = array();
4018 $titleKey = $this->getArticleID();
4020 if ( $titleKey === 0 ) {
4021 return $data;
4024 $dbr = wfGetDB( DB_SLAVE );
4026 $res = $dbr->select( 'categorylinks', '*',
4027 array(
4028 'cl_from' => $titleKey,
4030 __METHOD__,
4031 array()
4034 if ( $res->numRows() > 0 ) {
4035 foreach ( $res as $row ) {
4036 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
4037 $data[$wgContLang->getNSText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText();
4040 return $data;
4044 * Get a tree of parent categories
4046 * @param $children Array with the children in the keys, to check for circular refs
4047 * @return Array Tree of parent categories
4049 public function getParentCategoryTree( $children = array() ) {
4050 $stack = array();
4051 $parents = $this->getParentCategories();
4053 if ( $parents ) {
4054 foreach ( $parents as $parent => $current ) {
4055 if ( array_key_exists( $parent, $children ) ) {
4056 # Circular reference
4057 $stack[$parent] = array();
4058 } else {
4059 $nt = Title::newFromText( $parent );
4060 if ( $nt ) {
4061 $stack[$parent] = $nt->getParentCategoryTree( $children + array( $parent => 1 ) );
4067 return $stack;
4071 * Get an associative array for selecting this title from
4072 * the "page" table
4074 * @return Array suitable for the $where parameter of DB::select()
4076 public function pageCond() {
4077 if ( $this->mArticleID > 0 ) {
4078 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4079 return array( 'page_id' => $this->mArticleID );
4080 } else {
4081 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
4086 * Get the revision ID of the previous revision
4088 * @param $revId Int Revision ID. Get the revision that was before this one.
4089 * @param $flags Int Title::GAID_FOR_UPDATE
4090 * @return Int|Bool Old revision ID, or FALSE if none exists
4092 public function getPreviousRevisionID( $revId, $flags = 0 ) {
4093 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4094 $revId = $db->selectField( 'revision', 'rev_id',
4095 array(
4096 'rev_page' => $this->getArticleID( $flags ),
4097 'rev_id < ' . intval( $revId )
4099 __METHOD__,
4100 array( 'ORDER BY' => 'rev_id DESC' )
4103 if ( $revId === false ) {
4104 return false;
4105 } else {
4106 return intval( $revId );
4111 * Get the revision ID of the next revision
4113 * @param $revId Int Revision ID. Get the revision that was after this one.
4114 * @param $flags Int Title::GAID_FOR_UPDATE
4115 * @return Int|Bool Next revision ID, or FALSE if none exists
4117 public function getNextRevisionID( $revId, $flags = 0 ) {
4118 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4119 $revId = $db->selectField( 'revision', 'rev_id',
4120 array(
4121 'rev_page' => $this->getArticleID( $flags ),
4122 'rev_id > ' . intval( $revId )
4124 __METHOD__,
4125 array( 'ORDER BY' => 'rev_id' )
4128 if ( $revId === false ) {
4129 return false;
4130 } else {
4131 return intval( $revId );
4136 * Get the first revision of the page
4138 * @param $flags Int Title::GAID_FOR_UPDATE
4139 * @return Revision|Null if page doesn't exist
4141 public function getFirstRevision( $flags = 0 ) {
4142 $pageId = $this->getArticleID( $flags );
4143 if ( $pageId ) {
4144 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4145 $row = $db->selectRow( 'revision', Revision::selectFields(),
4146 array( 'rev_page' => $pageId ),
4147 __METHOD__,
4148 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
4150 if ( $row ) {
4151 return new Revision( $row );
4154 return null;
4158 * Get the oldest revision timestamp of this page
4160 * @param $flags Int Title::GAID_FOR_UPDATE
4161 * @return String: MW timestamp
4163 public function getEarliestRevTime( $flags = 0 ) {
4164 $rev = $this->getFirstRevision( $flags );
4165 return $rev ? $rev->getTimestamp() : null;
4169 * Check if this is a new page
4171 * @return bool
4173 public function isNewPage() {
4174 $dbr = wfGetDB( DB_SLAVE );
4175 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
4179 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4181 * @return bool
4183 public function isBigDeletion() {
4184 global $wgDeleteRevisionsLimit;
4186 if ( !$wgDeleteRevisionsLimit ) {
4187 return false;
4190 $revCount = $this->estimateRevisionCount();
4191 return $revCount > $wgDeleteRevisionsLimit;
4195 * Get the approximate revision count of this page.
4197 * @return int
4199 public function estimateRevisionCount() {
4200 if ( !$this->exists() ) {
4201 return 0;
4204 if ( $this->mEstimateRevisions === null ) {
4205 $dbr = wfGetDB( DB_SLAVE );
4206 $this->mEstimateRevisions = $dbr->estimateRowCount( 'revision', '*',
4207 array( 'rev_page' => $this->getArticleID() ), __METHOD__ );
4210 return $this->mEstimateRevisions;
4214 * Get the number of revisions between the given revision.
4215 * Used for diffs and other things that really need it.
4217 * @param $old int|Revision Old revision or rev ID (first before range)
4218 * @param $new int|Revision New revision or rev ID (first after range)
4219 * @return Int Number of revisions between these revisions.
4221 public function countRevisionsBetween( $old, $new ) {
4222 if ( !( $old instanceof Revision ) ) {
4223 $old = Revision::newFromTitle( $this, (int)$old );
4225 if ( !( $new instanceof Revision ) ) {
4226 $new = Revision::newFromTitle( $this, (int)$new );
4228 if ( !$old || !$new ) {
4229 return 0; // nothing to compare
4231 $dbr = wfGetDB( DB_SLAVE );
4232 return (int)$dbr->selectField( 'revision', 'count(*)',
4233 array(
4234 'rev_page' => $this->getArticleID(),
4235 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4236 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4238 __METHOD__
4243 * Get the number of authors between the given revisions or revision IDs.
4244 * Used for diffs and other things that really need it.
4246 * @param $old int|Revision Old revision or rev ID (first before range by default)
4247 * @param $new int|Revision New revision or rev ID (first after range by default)
4248 * @param $limit int Maximum number of authors
4249 * @param $options string|array (Optional): Single option, or an array of options:
4250 * 'include_old' Include $old in the range; $new is excluded.
4251 * 'include_new' Include $new in the range; $old is excluded.
4252 * 'include_both' Include both $old and $new in the range.
4253 * Unknown option values are ignored.
4254 * @return int Number of revision authors in the range; zero if not both revisions exist
4256 public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4257 if ( !( $old instanceof Revision ) ) {
4258 $old = Revision::newFromTitle( $this, (int)$old );
4260 if ( !( $new instanceof Revision ) ) {
4261 $new = Revision::newFromTitle( $this, (int)$new );
4263 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4264 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4265 // in the sanity check below?
4266 if ( !$old || !$new ) {
4267 return 0; // nothing to compare
4269 $old_cmp = '>';
4270 $new_cmp = '<';
4271 $options = (array) $options;
4272 if ( in_array( 'include_old', $options ) ) {
4273 $old_cmp = '>=';
4275 if ( in_array( 'include_new', $options ) ) {
4276 $new_cmp = '<=';
4278 if ( in_array( 'include_both', $options ) ) {
4279 $old_cmp = '>=';
4280 $new_cmp = '<=';
4282 // No DB query needed if $old and $new are the same or successive revisions:
4283 if ( $old->getId() === $new->getId() ) {
4284 return ( $old_cmp === '>' && $new_cmp === '<' ) ? 0 : 1;
4285 } else if ( $old->getId() === $new->getParentId() ) {
4286 if ( $old_cmp === '>' || $new_cmp === '<' ) {
4287 return ( $old_cmp === '>' && $new_cmp === '<' ) ? 0 : 1;
4289 return ( $old->getRawUserText() === $new->getRawUserText() ) ? 1 : 2;
4291 $dbr = wfGetDB( DB_SLAVE );
4292 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4293 array(
4294 'rev_page' => $this->getArticleID(),
4295 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4296 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4297 ), __METHOD__,
4298 array( 'LIMIT' => $limit + 1 ) // add one so caller knows it was truncated
4300 return (int)$dbr->numRows( $res );
4304 * Compare with another title.
4306 * @param $title Title
4307 * @return Bool
4309 public function equals( Title $title ) {
4310 // Note: === is necessary for proper matching of number-like titles.
4311 return $this->getInterwiki() === $title->getInterwiki()
4312 && $this->getNamespace() == $title->getNamespace()
4313 && $this->getDBkey() === $title->getDBkey();
4317 * Check if this title is a subpage of another title
4319 * @param $title Title
4320 * @return Bool
4322 public function isSubpageOf( Title $title ) {
4323 return $this->getInterwiki() === $title->getInterwiki()
4324 && $this->getNamespace() == $title->getNamespace()
4325 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4329 * Check if page exists. For historical reasons, this function simply
4330 * checks for the existence of the title in the page table, and will
4331 * thus return false for interwiki links, special pages and the like.
4332 * If you want to know if a title can be meaningfully viewed, you should
4333 * probably call the isKnown() method instead.
4335 * @return Bool
4337 public function exists() {
4338 return $this->getArticleID() != 0;
4342 * Should links to this title be shown as potentially viewable (i.e. as
4343 * "bluelinks"), even if there's no record by this title in the page
4344 * table?
4346 * This function is semi-deprecated for public use, as well as somewhat
4347 * misleadingly named. You probably just want to call isKnown(), which
4348 * calls this function internally.
4350 * (ISSUE: Most of these checks are cheap, but the file existence check
4351 * can potentially be quite expensive. Including it here fixes a lot of
4352 * existing code, but we might want to add an optional parameter to skip
4353 * it and any other expensive checks.)
4355 * @return Bool
4357 public function isAlwaysKnown() {
4358 $isKnown = null;
4361 * Allows overriding default behaviour for determining if a page exists.
4362 * If $isKnown is kept as null, regular checks happen. If it's
4363 * a boolean, this value is returned by the isKnown method.
4365 * @since 1.20
4367 * @param Title $title
4368 * @param boolean|null $isKnown
4370 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4372 if ( !is_null( $isKnown ) ) {
4373 return $isKnown;
4376 if ( $this->mInterwiki != '' ) {
4377 return true; // any interwiki link might be viewable, for all we know
4380 switch( $this->mNamespace ) {
4381 case NS_MEDIA:
4382 case NS_FILE:
4383 // file exists, possibly in a foreign repo
4384 return (bool)wfFindFile( $this );
4385 case NS_SPECIAL:
4386 // valid special page
4387 return SpecialPageFactory::exists( $this->getDBkey() );
4388 case NS_MAIN:
4389 // selflink, possibly with fragment
4390 return $this->mDbkeyform == '';
4391 case NS_MEDIAWIKI:
4392 // known system message
4393 return $this->hasSourceText() !== false;
4394 default:
4395 return false;
4400 * Does this title refer to a page that can (or might) be meaningfully
4401 * viewed? In particular, this function may be used to determine if
4402 * links to the title should be rendered as "bluelinks" (as opposed to
4403 * "redlinks" to non-existent pages).
4404 * Adding something else to this function will cause inconsistency
4405 * since LinkHolderArray calls isAlwaysKnown() and does its own
4406 * page existence check.
4408 * @return Bool
4410 public function isKnown() {
4411 return $this->isAlwaysKnown() || $this->exists();
4415 * Does this page have source text?
4417 * @return Boolean
4419 public function hasSourceText() {
4420 if ( $this->exists() ) {
4421 return true;
4424 if ( $this->mNamespace == NS_MEDIAWIKI ) {
4425 // If the page doesn't exist but is a known system message, default
4426 // message content will be displayed, same for language subpages-
4427 // Use always content language to avoid loading hundreds of languages
4428 // to get the link color.
4429 global $wgContLang;
4430 list( $name, $lang ) = MessageCache::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4431 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4432 return $message->exists();
4435 return false;
4439 * Get the default message text or false if the message doesn't exist
4441 * @return String or false
4443 public function getDefaultMessageText() {
4444 global $wgContLang;
4446 if ( $this->getNamespace() != NS_MEDIAWIKI ) { // Just in case
4447 return false;
4450 list( $name, $lang ) = MessageCache::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4451 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4453 if ( $message->exists() ) {
4454 return $message->plain();
4455 } else {
4456 return false;
4461 * Updates page_touched for this page; called from LinksUpdate.php
4463 * @return Bool true if the update succeded
4465 public function invalidateCache() {
4466 global $wgMemc;
4467 if ( wfReadOnly() ) {
4468 return false;
4470 $dbw = wfGetDB( DB_MASTER );
4471 $success = $dbw->update(
4472 'page',
4473 array( 'page_touched' => $dbw->timestamp() ),
4474 $this->pageCond(),
4475 __METHOD__
4477 HTMLFileCache::clearFileCache( $this );
4479 // Clear page info.
4480 $revision = WikiPage::factory( $this )->getRevision();
4481 if( $revision !== null ) {
4482 $memcKey = wfMemcKey( 'infoaction', $this->getPrefixedText(), $revision->getId() );
4483 $success = $success && $wgMemc->delete( $memcKey );
4486 return $success;
4490 * Update page_touched timestamps and send squid purge messages for
4491 * pages linking to this title. May be sent to the job queue depending
4492 * on the number of links. Typically called on create and delete.
4494 public function touchLinks() {
4495 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4496 $u->doUpdate();
4498 if ( $this->getNamespace() == NS_CATEGORY ) {
4499 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4500 $u->doUpdate();
4505 * Get the last touched timestamp
4507 * @param $db DatabaseBase: optional db
4508 * @return String last-touched timestamp
4510 public function getTouched( $db = null ) {
4511 $db = isset( $db ) ? $db : wfGetDB( DB_SLAVE );
4512 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
4513 return $touched;
4517 * Get the timestamp when this page was updated since the user last saw it.
4519 * @param $user User
4520 * @return String|Null
4522 public function getNotificationTimestamp( $user = null ) {
4523 global $wgUser, $wgShowUpdatedMarker;
4524 // Assume current user if none given
4525 if ( !$user ) {
4526 $user = $wgUser;
4528 // Check cache first
4529 $uid = $user->getId();
4530 // avoid isset here, as it'll return false for null entries
4531 if ( array_key_exists( $uid, $this->mNotificationTimestamp ) ) {
4532 return $this->mNotificationTimestamp[$uid];
4534 if ( !$uid || !$wgShowUpdatedMarker ) {
4535 return $this->mNotificationTimestamp[$uid] = false;
4537 // Don't cache too much!
4538 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
4539 $this->mNotificationTimestamp = array();
4541 $dbr = wfGetDB( DB_SLAVE );
4542 $this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
4543 'wl_notificationtimestamp',
4544 array(
4545 'wl_user' => $user->getId(),
4546 'wl_namespace' => $this->getNamespace(),
4547 'wl_title' => $this->getDBkey(),
4549 __METHOD__
4551 return $this->mNotificationTimestamp[$uid];
4555 * Generate strings used for xml 'id' names in monobook tabs
4557 * @param $prepend string defaults to 'nstab-'
4558 * @return String XML 'id' name
4560 public function getNamespaceKey( $prepend = 'nstab-' ) {
4561 global $wgContLang;
4562 // Gets the subject namespace if this title
4563 $namespace = MWNamespace::getSubject( $this->getNamespace() );
4564 // Checks if cononical namespace name exists for namespace
4565 if ( MWNamespace::exists( $this->getNamespace() ) ) {
4566 // Uses canonical namespace name
4567 $namespaceKey = MWNamespace::getCanonicalName( $namespace );
4568 } else {
4569 // Uses text of namespace
4570 $namespaceKey = $this->getSubjectNsText();
4572 // Makes namespace key lowercase
4573 $namespaceKey = $wgContLang->lc( $namespaceKey );
4574 // Uses main
4575 if ( $namespaceKey == '' ) {
4576 $namespaceKey = 'main';
4578 // Changes file to image for backwards compatibility
4579 if ( $namespaceKey == 'file' ) {
4580 $namespaceKey = 'image';
4582 return $prepend . $namespaceKey;
4586 * Get all extant redirects to this Title
4588 * @param $ns Int|Null Single namespace to consider; NULL to consider all namespaces
4589 * @return Array of Title redirects to this title
4591 public function getRedirectsHere( $ns = null ) {
4592 $redirs = array();
4594 $dbr = wfGetDB( DB_SLAVE );
4595 $where = array(
4596 'rd_namespace' => $this->getNamespace(),
4597 'rd_title' => $this->getDBkey(),
4598 'rd_from = page_id'
4600 if ( $this->isExternal() ) {
4601 $where['rd_interwiki'] = $this->getInterwiki();
4602 } else {
4603 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4605 if ( !is_null( $ns ) ) {
4606 $where['page_namespace'] = $ns;
4609 $res = $dbr->select(
4610 array( 'redirect', 'page' ),
4611 array( 'page_namespace', 'page_title' ),
4612 $where,
4613 __METHOD__
4616 foreach ( $res as $row ) {
4617 $redirs[] = self::newFromRow( $row );
4619 return $redirs;
4623 * Check if this Title is a valid redirect target
4625 * @return Bool
4627 public function isValidRedirectTarget() {
4628 global $wgInvalidRedirectTargets;
4630 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4631 if ( $this->isSpecial( 'Userlogout' ) ) {
4632 return false;
4635 foreach ( $wgInvalidRedirectTargets as $target ) {
4636 if ( $this->isSpecial( $target ) ) {
4637 return false;
4641 return true;
4645 * Get a backlink cache object
4647 * @return BacklinkCache
4649 public function getBacklinkCache() {
4650 return BacklinkCache::get( $this );
4654 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4656 * @return Boolean
4658 public function canUseNoindex() {
4659 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4661 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4662 ? $wgContentNamespaces
4663 : $wgExemptFromUserRobotsControl;
4665 return !in_array( $this->mNamespace, $bannedNamespaces );
4670 * Returns the raw sort key to be used for categories, with the specified
4671 * prefix. This will be fed to Collation::getSortKey() to get a
4672 * binary sortkey that can be used for actual sorting.
4674 * @param $prefix string The prefix to be used, specified using
4675 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4676 * prefix.
4677 * @return string
4679 public function getCategorySortkey( $prefix = '' ) {
4680 $unprefixed = $this->getText();
4682 // Anything that uses this hook should only depend
4683 // on the Title object passed in, and should probably
4684 // tell the users to run updateCollations.php --force
4685 // in order to re-sort existing category relations.
4686 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4687 if ( $prefix !== '' ) {
4688 # Separate with a line feed, so the unprefixed part is only used as
4689 # a tiebreaker when two pages have the exact same prefix.
4690 # In UCA, tab is the only character that can sort above LF
4691 # so we strip both of them from the original prefix.
4692 $prefix = strtr( $prefix, "\n\t", ' ' );
4693 return "$prefix\n$unprefixed";
4695 return $unprefixed;
4699 * Get the language in which the content of this page is written in
4700 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4701 * e.g. $wgLang (such as special pages, which are in the user language).
4703 * @since 1.18
4704 * @return Language
4706 public function getPageLanguage() {
4707 global $wgLang;
4708 if ( $this->isSpecialPage() ) {
4709 // special pages are in the user language
4710 return $wgLang;
4713 //TODO: use the LinkCache to cache this! Note that this may depend on user settings, so the cache should be only per-request.
4714 //NOTE: ContentHandler::getPageLanguage() may need to load the content to determine the page language!
4715 $contentHandler = ContentHandler::getForTitle( $this );
4716 $pageLang = $contentHandler->getPageLanguage( $this );
4718 return wfGetLangObj( $pageLang );
4722 * Get the language in which the content of this page is written when
4723 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4724 * e.g. $wgLang (such as special pages, which are in the user language).
4726 * @since 1.20
4727 * @return Language
4729 public function getPageViewLanguage() {
4730 global $wgLang;
4732 if ( $this->isSpecialPage() ) {
4733 // If the user chooses a variant, the content is actually
4734 // in a language whose code is the variant code.
4735 $variant = $wgLang->getPreferredVariant();
4736 if ( $wgLang->getCode() !== $variant ) {
4737 return Language::factory( $variant );
4740 return $wgLang;
4743 //NOTE: can't be cached persistently, depends on user settings
4744 //NOTE: ContentHandler::getPageViewLanguage() may need to load the content to determine the page language!
4745 $contentHandler = ContentHandler::getForTitle( $this );
4746 $pageLang = $contentHandler->getPageViewLanguage( $this );
4747 return $pageLang;
4751 * Get a list of rendered edit notices for this page.
4753 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4754 * they will already be wrapped in paragraphs.
4756 * @since 1.21
4757 * @return Array
4759 public function getEditNotices() {
4760 $notices = array();
4762 # Optional notices on a per-namespace and per-page basis
4763 $editnotice_ns = 'editnotice-' . $this->getNamespace();
4764 $editnotice_ns_message = wfMessage( $editnotice_ns );
4765 if ( $editnotice_ns_message->exists() ) {
4766 $notices[$editnotice_ns] = $editnotice_ns_message->parseAsBlock();
4768 if ( MWNamespace::hasSubpages( $this->getNamespace() ) ) {
4769 $parts = explode( '/', $this->getDBkey() );
4770 $editnotice_base = $editnotice_ns;
4771 while ( count( $parts ) > 0 ) {
4772 $editnotice_base .= '-' . array_shift( $parts );
4773 $editnotice_base_msg = wfMessage( $editnotice_base );
4774 if ( $editnotice_base_msg->exists() ) {
4775 $notices[$editnotice_base] = $editnotice_base_msg->parseAsBlock();
4778 } else {
4779 # Even if there are no subpages in namespace, we still don't want / in MW ns.
4780 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->getDBkey() );
4781 $editnoticeMsg = wfMessage( $editnoticeText );
4782 if ( $editnoticeMsg->exists() ) {
4783 $notices[$editnoticeText] = $editnoticeMsg->parseAsBlock();
4786 return $notices;