Localisation updates from http://translatewiki.net.
[mediawiki.git] / includes / Title.php
blob70e8cd442f093c2fe6fef746afc20eee7b178133
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 // @}
91 /**
92 * Constructor
94 /*protected*/ function __construct() { }
96 /**
97 * Create a new Title from a prefixed DB key
99 * @param string $key the database key, which has underscores
100 * instead of spaces, possibly including namespace and
101 * interwiki prefixes
102 * @return Title, or NULL on an error
104 public static function newFromDBkey( $key ) {
105 $t = new Title();
106 $t->mDbkeyform = $key;
107 if ( $t->secureAndSplit() ) {
108 return $t;
109 } else {
110 return null;
115 * Create a new Title from text, such as what one would find in a link. De-
116 * codes any HTML entities in the text.
118 * @param string $text the link text; spaces, prefixes, and an
119 * initial ':' indicating the main namespace are accepted.
120 * @param int $defaultNamespace the namespace to use if none is specified
121 * by a prefix. If you want to force a specific namespace even if
122 * $text might begin with a namespace prefix, use makeTitle() or
123 * makeTitleSafe().
124 * @throws MWException
125 * @return Title|null - Title or null on an error.
127 public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
128 if ( is_object( $text ) ) {
129 throw new MWException( 'Title::newFromText given an object' );
133 * Wiki pages often contain multiple links to the same page.
134 * Title normalization and parsing can become expensive on
135 * pages with many links, so we can save a little time by
136 * caching them.
138 * In theory these are value objects and won't get changed...
140 if ( $defaultNamespace == NS_MAIN && isset( Title::$titleCache[$text] ) ) {
141 return Title::$titleCache[$text];
144 # Convert things like &eacute; &#257; or &#x3017; into normalized (bug 14952) text
145 $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text );
147 $t = new Title();
148 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
149 $t->mDefaultNamespace = $defaultNamespace;
151 static $cachedcount = 0;
152 if ( $t->secureAndSplit() ) {
153 if ( $defaultNamespace == NS_MAIN ) {
154 if ( $cachedcount >= self::CACHE_MAX ) {
155 # Avoid memory leaks on mass operations...
156 Title::$titleCache = array();
157 $cachedcount = 0;
159 $cachedcount++;
160 Title::$titleCache[$text] =& $t;
162 return $t;
163 } else {
164 $ret = null;
165 return $ret;
170 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
172 * Example of wrong and broken code:
173 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
175 * Example of right code:
176 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
178 * Create a new Title from URL-encoded text. Ensures that
179 * the given title's length does not exceed the maximum.
181 * @param string $url the title, as might be taken from a URL
182 * @return Title the new object, or NULL on an error
184 public static function newFromURL( $url ) {
185 $t = new Title();
187 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
188 # but some URLs used it as a space replacement and they still come
189 # from some external search tools.
190 if ( strpos( self::legalChars(), '+' ) === false ) {
191 $url = str_replace( '+', ' ', $url );
194 $t->mDbkeyform = str_replace( ' ', '_', $url );
195 if ( $t->secureAndSplit() ) {
196 return $t;
197 } else {
198 return null;
203 * Returns a list of fields that are to be selected for initializing Title objects or LinkCache entries.
204 * Uses $wgContentHandlerUseDB to determine whether to include page_content_model.
206 * @return array
208 protected static function getSelectFields() {
209 global $wgContentHandlerUseDB;
211 $fields = array(
212 'page_namespace', 'page_title', 'page_id',
213 'page_len', 'page_is_redirect', 'page_latest',
216 if ( $wgContentHandlerUseDB ) {
217 $fields[] = 'page_content_model';
220 return $fields;
224 * Create a new Title from an article ID
226 * @param int $id the page_id corresponding to the Title to create
227 * @param int $flags use Title::GAID_FOR_UPDATE to use master
228 * @return Title|null the new object, or NULL on an error
230 public static function newFromID( $id, $flags = 0 ) {
231 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
232 $row = $db->selectRow(
233 'page',
234 self::getSelectFields(),
235 array( 'page_id' => $id ),
236 __METHOD__
238 if ( $row !== false ) {
239 $title = Title::newFromRow( $row );
240 } else {
241 $title = null;
243 return $title;
247 * Make an array of titles from an array of IDs
249 * @param array $ids of Int Array of IDs
250 * @return Array of Titles
252 public static function newFromIDs( $ids ) {
253 if ( !count( $ids ) ) {
254 return array();
256 $dbr = wfGetDB( DB_SLAVE );
258 $res = $dbr->select(
259 'page',
260 self::getSelectFields(),
261 array( 'page_id' => $ids ),
262 __METHOD__
265 $titles = array();
266 foreach ( $res as $row ) {
267 $titles[] = Title::newFromRow( $row );
269 return $titles;
273 * Make a Title object from a DB row
275 * @param $row Object database row (needs at least page_title,page_namespace)
276 * @return Title corresponding Title
278 public static function newFromRow( $row ) {
279 $t = self::makeTitle( $row->page_namespace, $row->page_title );
280 $t->loadFromRow( $row );
281 return $t;
285 * Load Title object fields from a DB row.
286 * If false is given, the title will be treated as non-existing.
288 * @param $row Object|bool database row
290 public function loadFromRow( $row ) {
291 if ( $row ) { // page found
292 if ( isset( $row->page_id ) ) {
293 $this->mArticleID = (int)$row->page_id;
295 if ( isset( $row->page_len ) ) {
296 $this->mLength = (int)$row->page_len;
298 if ( isset( $row->page_is_redirect ) ) {
299 $this->mRedirect = (bool)$row->page_is_redirect;
301 if ( isset( $row->page_latest ) ) {
302 $this->mLatestID = (int)$row->page_latest;
304 if ( isset( $row->page_content_model ) ) {
305 $this->mContentModel = strval( $row->page_content_model );
306 } else {
307 $this->mContentModel = false; # initialized lazily in getContentModel()
309 } else { // page not found
310 $this->mArticleID = 0;
311 $this->mLength = 0;
312 $this->mRedirect = false;
313 $this->mLatestID = 0;
314 $this->mContentModel = false; # initialized lazily in getContentModel()
319 * Create a new Title from a namespace index and a DB key.
320 * It's assumed that $ns and $title are *valid*, for instance when
321 * they came directly from the database or a special page name.
322 * For convenience, spaces are converted to underscores so that
323 * eg user_text fields can be used directly.
325 * @param int $ns the namespace of the article
326 * @param string $title the unprefixed database key form
327 * @param string $fragment the link fragment (after the "#")
328 * @param string $interwiki the interwiki prefix
329 * @return Title the new object
331 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
332 $t = new Title();
333 $t->mInterwiki = $interwiki;
334 $t->mFragment = $fragment;
335 $t->mNamespace = $ns = intval( $ns );
336 $t->mDbkeyform = str_replace( ' ', '_', $title );
337 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
338 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
339 $t->mTextform = str_replace( '_', ' ', $title );
340 $t->mContentModel = false; # initialized lazily in getContentModel()
341 return $t;
345 * Create a new Title from a namespace index and a DB key.
346 * The parameters will be checked for validity, which is a bit slower
347 * than makeTitle() but safer for user-provided data.
349 * @param int $ns the namespace of the article
350 * @param string $title database key form
351 * @param string $fragment the link fragment (after the "#")
352 * @param string $interwiki interwiki prefix
353 * @return Title the new object, or NULL on an error
355 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
356 if ( !MWNamespace::exists( $ns ) ) {
357 return null;
360 $t = new Title();
361 $t->mDbkeyform = Title::makeName( $ns, $title, $fragment, $interwiki );
362 if ( $t->secureAndSplit() ) {
363 return $t;
364 } else {
365 return null;
370 * Create a new Title for the Main Page
372 * @return Title the new object
374 public static function newMainPage() {
375 $title = Title::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
376 // Don't give fatal errors if the message is broken
377 if ( !$title ) {
378 $title = Title::newFromText( 'Main Page' );
380 return $title;
384 * Extract a redirect destination from a string and return the
385 * Title, or null if the text doesn't contain a valid redirect
386 * This will only return the very next target, useful for
387 * the redirect table and other checks that don't need full recursion
389 * @param string $text Text with possible redirect
390 * @return Title: The corresponding Title
391 * @deprecated since 1.21, use Content::getRedirectTarget instead.
393 public static function newFromRedirect( $text ) {
394 ContentHandler::deprecated( __METHOD__, '1.21' );
396 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
397 return $content->getRedirectTarget();
401 * Extract a redirect destination from a string and return the
402 * Title, or null if the text doesn't contain a valid redirect
403 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
404 * in order to provide (hopefully) the Title of the final destination instead of another redirect
406 * @param string $text Text with possible redirect
407 * @return Title
408 * @deprecated since 1.21, use Content::getUltimateRedirectTarget instead.
410 public static function newFromRedirectRecurse( $text ) {
411 ContentHandler::deprecated( __METHOD__, '1.21' );
413 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
414 return $content->getUltimateRedirectTarget();
418 * Extract a redirect destination from a string and return an
419 * array of Titles, or null if the text doesn't contain a valid redirect
420 * The last element in the array is the final destination after all redirects
421 * have been resolved (up to $wgMaxRedirects times)
423 * @param string $text Text with possible redirect
424 * @return Array of Titles, with the destination last
425 * @deprecated since 1.21, use Content::getRedirectChain instead.
427 public static function newFromRedirectArray( $text ) {
428 ContentHandler::deprecated( __METHOD__, '1.21' );
430 $content = ContentHandler::makeContent( $text, null, CONTENT_MODEL_WIKITEXT );
431 return $content->getRedirectChain();
435 * Get the prefixed DB key associated with an ID
437 * @param int $id the page_id of the article
438 * @return Title an object representing the article, or NULL if no such article was found
440 public static function nameOf( $id ) {
441 $dbr = wfGetDB( DB_SLAVE );
443 $s = $dbr->selectRow(
444 'page',
445 array( 'page_namespace', 'page_title' ),
446 array( 'page_id' => $id ),
447 __METHOD__
449 if ( $s === false ) {
450 return null;
453 $n = self::makeName( $s->page_namespace, $s->page_title );
454 return $n;
458 * Get a regex character class describing the legal characters in a link
460 * @return String the list of characters, not delimited
462 public static function legalChars() {
463 global $wgLegalTitleChars;
464 return $wgLegalTitleChars;
468 * Returns a simple regex that will match on characters and sequences invalid in titles.
469 * Note that this doesn't pick up many things that could be wrong with titles, but that
470 * replacing this regex with something valid will make many titles valid.
472 * @return String regex string
474 static function getTitleInvalidRegex() {
475 static $rxTc = false;
476 if ( !$rxTc ) {
477 # Matching titles will be held as illegal.
478 $rxTc = '/' .
479 # Any character not allowed is forbidden...
480 '[^' . self::legalChars() . ']' .
481 # URL percent encoding sequences interfere with the ability
482 # to round-trip titles -- you can't link to them consistently.
483 '|%[0-9A-Fa-f]{2}' .
484 # XML/HTML character references produce similar issues.
485 '|&[A-Za-z0-9\x80-\xff]+;' .
486 '|&#[0-9]+;' .
487 '|&#x[0-9A-Fa-f]+;' .
488 '/S';
491 return $rxTc;
495 * Get a string representation of a title suitable for
496 * including in a search index
498 * @param int $ns a namespace index
499 * @param string $title text-form main part
500 * @return String a stripped-down title string ready for the search index
502 public static function indexTitle( $ns, $title ) {
503 global $wgContLang;
505 $lc = SearchEngine::legalSearchChars() . '&#;';
506 $t = $wgContLang->normalizeForSearch( $title );
507 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
508 $t = $wgContLang->lc( $t );
510 # Handle 's, s'
511 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
512 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
514 $t = preg_replace( "/\\s+/", ' ', $t );
516 if ( $ns == NS_FILE ) {
517 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
519 return trim( $t );
523 * Make a prefixed DB key from a DB key and a namespace index
525 * @param int $ns numerical representation of the namespace
526 * @param string $title the DB key form the title
527 * @param string $fragment The link fragment (after the "#")
528 * @param string $interwiki The interwiki prefix
529 * @return String the prefixed form of the title
531 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
532 global $wgContLang;
534 $namespace = $wgContLang->getNsText( $ns );
535 $name = $namespace == '' ? $title : "$namespace:$title";
536 if ( strval( $interwiki ) != '' ) {
537 $name = "$interwiki:$name";
539 if ( strval( $fragment ) != '' ) {
540 $name .= '#' . $fragment;
542 return $name;
546 * Escape a text fragment, say from a link, for a URL
548 * @param string $fragment containing a URL or link fragment (after the "#")
549 * @return String: escaped string
551 static function escapeFragmentForURL( $fragment ) {
552 # Note that we don't urlencode the fragment. urlencoded Unicode
553 # fragments appear not to work in IE (at least up to 7) or in at least
554 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
555 # to care if they aren't encoded.
556 return Sanitizer::escapeId( $fragment, 'noninitial' );
560 * Callback for usort() to do title sorts by (namespace, title)
562 * @param $a Title
563 * @param $b Title
565 * @return Integer: result of string comparison, or namespace comparison
567 public static function compare( $a, $b ) {
568 if ( $a->getNamespace() == $b->getNamespace() ) {
569 return strcmp( $a->getText(), $b->getText() );
570 } else {
571 return $a->getNamespace() - $b->getNamespace();
576 * Determine whether the object refers to a page within
577 * this project.
579 * @return Bool TRUE if this is an in-project interwiki link or a wikilink, FALSE otherwise
581 public function isLocal() {
582 if ( $this->mInterwiki != '' ) {
583 $iw = Interwiki::fetch( $this->mInterwiki );
584 if ( $iw ) {
585 return $iw->isLocal();
588 return true;
592 * Is this Title interwiki?
594 * @return Bool
596 public function isExternal() {
597 return ( $this->mInterwiki != '' );
601 * Get the interwiki prefix (or null string)
603 * @return String Interwiki prefix
605 public function getInterwiki() {
606 return $this->mInterwiki;
610 * Determine whether the object refers to a page within
611 * this project and is transcludable.
613 * @return Bool TRUE if this is transcludable
615 public function isTrans() {
616 if ( $this->mInterwiki == '' ) {
617 return false;
620 return Interwiki::fetch( $this->mInterwiki )->isTranscludable();
624 * Returns the DB name of the distant wiki which owns the object.
626 * @return String the DB name
628 public function getTransWikiID() {
629 if ( $this->mInterwiki == '' ) {
630 return false;
633 return Interwiki::fetch( $this->mInterwiki )->getWikiID();
637 * Get the text form (spaces not underscores) of the main part
639 * @return String Main part of the title
641 public function getText() {
642 return $this->mTextform;
646 * Get the URL-encoded form of the main part
648 * @return String Main part of the title, URL-encoded
650 public function getPartialURL() {
651 return $this->mUrlform;
655 * Get the main part with underscores
657 * @return String: Main part of the title, with underscores
659 public function getDBkey() {
660 return $this->mDbkeyform;
664 * Get the DB key with the initial letter case as specified by the user
666 * @return String DB key
668 function getUserCaseDBKey() {
669 return $this->mUserCaseDBKey;
673 * Get the namespace index, i.e. one of the NS_xxxx constants.
675 * @return Integer: Namespace index
677 public function getNamespace() {
678 return $this->mNamespace;
682 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
684 * @throws MWException
685 * @return String: Content model id
687 public function getContentModel() {
688 if ( !$this->mContentModel ) {
689 $linkCache = LinkCache::singleton();
690 $this->mContentModel = $linkCache->getGoodLinkFieldObj( $this, 'model' );
693 if ( !$this->mContentModel ) {
694 $this->mContentModel = ContentHandler::getDefaultModelFor( $this );
697 if ( !$this->mContentModel ) {
698 throw new MWException( 'Failed to determine content model!' );
701 return $this->mContentModel;
705 * Convenience method for checking a title's content model name
707 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
708 * @return Boolean true if $this->getContentModel() == $id
710 public function hasContentModel( $id ) {
711 return $this->getContentModel() == $id;
715 * Get the namespace text
717 * @return String: Namespace text
719 public function getNsText() {
720 global $wgContLang;
722 if ( $this->mInterwiki != '' ) {
723 // This probably shouldn't even happen. ohh man, oh yuck.
724 // But for interwiki transclusion it sometimes does.
725 // Shit. Shit shit shit.
727 // Use the canonical namespaces if possible to try to
728 // resolve a foreign namespace.
729 if ( MWNamespace::exists( $this->mNamespace ) ) {
730 return MWNamespace::getCanonicalName( $this->mNamespace );
734 if ( $wgContLang->needsGenderDistinction() &&
735 MWNamespace::hasGenderDistinction( $this->mNamespace ) ) {
736 $gender = GenderCache::singleton()->getGenderOf( $this->getText(), __METHOD__ );
737 return $wgContLang->getGenderNsText( $this->mNamespace, $gender );
740 return $wgContLang->getNsText( $this->mNamespace );
744 * Get the namespace text of the subject (rather than talk) page
746 * @return String Namespace text
748 public function getSubjectNsText() {
749 global $wgContLang;
750 return $wgContLang->getNsText( MWNamespace::getSubject( $this->mNamespace ) );
754 * Get the namespace text of the talk page
756 * @return String Namespace text
758 public function getTalkNsText() {
759 global $wgContLang;
760 return $wgContLang->getNsText( MWNamespace::getTalk( $this->mNamespace ) );
764 * Could this title have a corresponding talk page?
766 * @return Bool TRUE or FALSE
768 public function canTalk() {
769 return MWNamespace::canTalk( $this->mNamespace );
773 * Is this in a namespace that allows actual pages?
775 * @return Bool
776 * @internal note -- uses hardcoded namespace index instead of constants
778 public function canExist() {
779 return $this->mNamespace >= NS_MAIN;
783 * Can this title be added to a user's watchlist?
785 * @return Bool TRUE or FALSE
787 public function isWatchable() {
788 return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() );
792 * Returns true if this is a special page.
794 * @return boolean
796 public function isSpecialPage() {
797 return $this->getNamespace() == NS_SPECIAL;
801 * Returns true if this title resolves to the named special page
803 * @param string $name The special page name
804 * @return boolean
806 public function isSpecial( $name ) {
807 if ( $this->isSpecialPage() ) {
808 list( $thisName, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $this->getDBkey() );
809 if ( $name == $thisName ) {
810 return true;
813 return false;
817 * If the Title refers to a special page alias which is not the local default, resolve
818 * the alias, and localise the name as necessary. Otherwise, return $this
820 * @return Title
822 public function fixSpecialName() {
823 if ( $this->isSpecialPage() ) {
824 list( $canonicalName, $par ) = SpecialPageFactory::resolveAlias( $this->mDbkeyform );
825 if ( $canonicalName ) {
826 $localName = SpecialPageFactory::getLocalNameFor( $canonicalName, $par );
827 if ( $localName != $this->mDbkeyform ) {
828 return Title::makeTitle( NS_SPECIAL, $localName );
832 return $this;
836 * Returns true if the title is inside the specified namespace.
838 * Please make use of this instead of comparing to getNamespace()
839 * This function is much more resistant to changes we may make
840 * to namespaces than code that makes direct comparisons.
841 * @param int $ns The namespace
842 * @return bool
843 * @since 1.19
845 public function inNamespace( $ns ) {
846 return MWNamespace::equals( $this->getNamespace(), $ns );
850 * Returns true if the title is inside one of the specified namespaces.
852 * @param ...$namespaces The namespaces to check for
853 * @return bool
854 * @since 1.19
856 public function inNamespaces( /* ... */ ) {
857 $namespaces = func_get_args();
858 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
859 $namespaces = $namespaces[0];
862 foreach ( $namespaces as $ns ) {
863 if ( $this->inNamespace( $ns ) ) {
864 return true;
868 return false;
872 * Returns true if the title has the same subject namespace as the
873 * namespace specified.
874 * For example this method will take NS_USER and return true if namespace
875 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
876 * as their subject namespace.
878 * This is MUCH simpler than individually testing for equivalence
879 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
880 * @since 1.19
881 * @param $ns int
882 * @return bool
884 public function hasSubjectNamespace( $ns ) {
885 return MWNamespace::subjectEquals( $this->getNamespace(), $ns );
889 * Is this Title in a namespace which contains content?
890 * In other words, is this a content page, for the purposes of calculating
891 * statistics, etc?
893 * @return Boolean
895 public function isContentPage() {
896 return MWNamespace::isContent( $this->getNamespace() );
900 * Would anybody with sufficient privileges be able to move this page?
901 * Some pages just aren't movable.
903 * @return Bool TRUE or FALSE
905 public function isMovable() {
906 if ( !MWNamespace::isMovable( $this->getNamespace() ) || $this->getInterwiki() != '' ) {
907 // Interwiki title or immovable namespace. Hooks don't get to override here
908 return false;
911 $result = true;
912 wfRunHooks( 'TitleIsMovable', array( $this, &$result ) );
913 return $result;
917 * Is this the mainpage?
918 * @note Title::newFromText seems to be sufficiently optimized by the title
919 * cache that we don't need to over-optimize by doing direct comparisons and
920 * accidentally creating new bugs where $title->equals( Title::newFromText() )
921 * ends up reporting something differently than $title->isMainPage();
923 * @since 1.18
924 * @return Bool
926 public function isMainPage() {
927 return $this->equals( Title::newMainPage() );
931 * Is this a subpage?
933 * @return Bool
935 public function isSubpage() {
936 return MWNamespace::hasSubpages( $this->mNamespace )
937 ? strpos( $this->getText(), '/' ) !== false
938 : false;
942 * Is this a conversion table for the LanguageConverter?
944 * @return Bool
946 public function isConversionTable() {
947 //@todo: ConversionTable should become a separate content model.
949 return $this->getNamespace() == NS_MEDIAWIKI &&
950 strpos( $this->getText(), 'Conversiontable/' ) === 0;
954 * Does that page contain wikitext, or it is JS, CSS or whatever?
956 * @return Bool
958 public function isWikitextPage() {
959 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT );
963 * Could this page contain custom CSS or JavaScript for the global UI.
964 * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
965 * or CONTENT_MODEL_JAVASCRIPT.
967 * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage() for that!
969 * Note that this method should not return true for pages that contain and show "inactive" CSS or JS.
971 * @return Bool
973 public function isCssOrJsPage() {
974 $isCssOrJsPage = NS_MEDIAWIKI == $this->mNamespace
975 && ( $this->hasContentModel( CONTENT_MODEL_CSS )
976 || $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) );
978 #NOTE: this hook is also called in ContentHandler::getDefaultModel. It's called here again to make sure
979 # hook functions can force this method to return true even outside the mediawiki namespace.
981 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$isCssOrJsPage ) );
983 return $isCssOrJsPage;
987 * Is this a .css or .js subpage of a user page?
988 * @return Bool
990 public function isCssJsSubpage() {
991 return ( NS_USER == $this->mNamespace && $this->isSubpage()
992 && ( $this->hasContentModel( CONTENT_MODEL_CSS )
993 || $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) ) );
997 * Trim down a .css or .js subpage title to get the corresponding skin name
999 * @return string containing skin name from .css or .js subpage title
1001 public function getSkinFromCssJsSubpage() {
1002 $subpage = explode( '/', $this->mTextform );
1003 $subpage = $subpage[count( $subpage ) - 1];
1004 $lastdot = strrpos( $subpage, '.' );
1005 if ( $lastdot === false ) {
1006 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
1008 return substr( $subpage, 0, $lastdot );
1012 * Is this a .css subpage of a user page?
1014 * @return Bool
1016 public function isCssSubpage() {
1017 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1018 && $this->hasContentModel( CONTENT_MODEL_CSS ) );
1022 * Is this a .js subpage of a user page?
1024 * @return Bool
1026 public function isJsSubpage() {
1027 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1028 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) );
1032 * Is this a talk page of some sort?
1034 * @return Bool
1036 public function isTalkPage() {
1037 return MWNamespace::isTalk( $this->getNamespace() );
1041 * Get a Title object associated with the talk page of this article
1043 * @return Title the object for the talk page
1045 public function getTalkPage() {
1046 return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1050 * Get a title object associated with the subject page of this
1051 * talk page
1053 * @return Title the object for the subject page
1055 public function getSubjectPage() {
1056 // Is this the same title?
1057 $subjectNS = MWNamespace::getSubject( $this->getNamespace() );
1058 if ( $this->getNamespace() == $subjectNS ) {
1059 return $this;
1061 return Title::makeTitle( $subjectNS, $this->getDBkey() );
1065 * Get the default namespace index, for when there is no namespace
1067 * @return Int Default namespace index
1069 public function getDefaultNamespace() {
1070 return $this->mDefaultNamespace;
1074 * Get title for search index
1076 * @return String a stripped-down title string ready for the
1077 * search index
1079 public function getIndexTitle() {
1080 return Title::indexTitle( $this->mNamespace, $this->mTextform );
1084 * Get the Title fragment (i.e.\ the bit after the #) in text form
1086 * @return String Title fragment
1088 public function getFragment() {
1089 return $this->mFragment;
1093 * Get the fragment in URL form, including the "#" character if there is one
1094 * @return String Fragment in URL form
1096 public function getFragmentForURL() {
1097 if ( $this->mFragment == '' ) {
1098 return '';
1099 } else {
1100 return '#' . Title::escapeFragmentForURL( $this->mFragment );
1105 * Set the fragment for this title. Removes the first character from the
1106 * specified fragment before setting, so it assumes you're passing it with
1107 * an initial "#".
1109 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1110 * Still in active use privately.
1112 * @param string $fragment text
1114 public function setFragment( $fragment ) {
1115 $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
1119 * Prefix some arbitrary text with the namespace or interwiki prefix
1120 * of this object
1122 * @param string $name the text
1123 * @return String the prefixed text
1124 * @private
1126 private function prefix( $name ) {
1127 $p = '';
1128 if ( $this->mInterwiki != '' ) {
1129 $p = $this->mInterwiki . ':';
1132 if ( 0 != $this->mNamespace ) {
1133 $p .= $this->getNsText() . ':';
1135 return $p . $name;
1139 * Get the prefixed database key form
1141 * @return String the prefixed title, with underscores and
1142 * any interwiki and namespace prefixes
1144 public function getPrefixedDBkey() {
1145 $s = $this->prefix( $this->mDbkeyform );
1146 $s = str_replace( ' ', '_', $s );
1147 return $s;
1151 * Get the prefixed title with spaces.
1152 * This is the form usually used for display
1154 * @return String the prefixed title, with spaces
1156 public function getPrefixedText() {
1157 // @todo FIXME: Bad usage of empty() ?
1158 if ( empty( $this->mPrefixedText ) ) {
1159 $s = $this->prefix( $this->mTextform );
1160 $s = str_replace( '_', ' ', $s );
1161 $this->mPrefixedText = $s;
1163 return $this->mPrefixedText;
1167 * Return a string representation of this title
1169 * @return String representation of this title
1171 public function __toString() {
1172 return $this->getPrefixedText();
1176 * Get the prefixed title with spaces, plus any fragment
1177 * (part beginning with '#')
1179 * @return String the prefixed title, with spaces and the fragment, including '#'
1181 public function getFullText() {
1182 $text = $this->getPrefixedText();
1183 if ( $this->mFragment != '' ) {
1184 $text .= '#' . $this->mFragment;
1186 return $text;
1190 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1192 * @par Example:
1193 * @code
1194 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1195 * # returns: 'Foo'
1196 * @endcode
1198 * @return String Root name
1199 * @since 1.20
1201 public function getRootText() {
1202 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1203 return $this->getText();
1206 return strtok( $this->getText(), '/' );
1210 * Get the root page name title, i.e. the leftmost part before any slashes
1212 * @par Example:
1213 * @code
1214 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1215 * # returns: Title{User:Foo}
1216 * @endcode
1218 * @return Title Root title
1219 * @since 1.20
1221 public function getRootTitle() {
1222 return Title::makeTitle( $this->getNamespace(), $this->getRootText() );
1226 * Get the base page name without a namespace, i.e. the part before the subpage name
1228 * @par Example:
1229 * @code
1230 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1231 * # returns: 'Foo/Bar'
1232 * @endcode
1234 * @return String Base name
1236 public function getBaseText() {
1237 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1238 return $this->getText();
1241 $parts = explode( '/', $this->getText() );
1242 # Don't discard the real title if there's no subpage involved
1243 if ( count( $parts ) > 1 ) {
1244 unset( $parts[count( $parts ) - 1] );
1246 return implode( '/', $parts );
1250 * Get the base page name title, i.e. the part before the subpage name
1252 * @par Example:
1253 * @code
1254 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1255 * # returns: Title{User:Foo/Bar}
1256 * @endcode
1258 * @return Title Base title
1259 * @since 1.20
1261 public function getBaseTitle() {
1262 return Title::makeTitle( $this->getNamespace(), $this->getBaseText() );
1266 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1268 * @par Example:
1269 * @code
1270 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1271 * # returns: "Baz"
1272 * @endcode
1274 * @return String Subpage name
1276 public function getSubpageText() {
1277 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1278 return $this->mTextform;
1280 $parts = explode( '/', $this->mTextform );
1281 return $parts[count( $parts ) - 1];
1285 * Get the title for a subpage of the current page
1287 * @par Example:
1288 * @code
1289 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1290 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1291 * @endcode
1293 * @param string $text The subpage name to add to the title
1294 * @return Title Subpage title
1295 * @since 1.20
1297 public function getSubpage( $text ) {
1298 return Title::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1302 * Get the HTML-escaped displayable text form.
1303 * Used for the title field in <a> tags.
1305 * @return String the text, including any prefixes
1306 * @deprecated since 1.19
1308 public function getEscapedText() {
1309 wfDeprecated( __METHOD__, '1.19' );
1310 return htmlspecialchars( $this->getPrefixedText() );
1314 * Get a URL-encoded form of the subpage text
1316 * @return String URL-encoded subpage name
1318 public function getSubpageUrlForm() {
1319 $text = $this->getSubpageText();
1320 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1321 return $text;
1325 * Get a URL-encoded title (not an actual URL) including interwiki
1327 * @return String the URL-encoded form
1329 public function getPrefixedURL() {
1330 $s = $this->prefix( $this->mDbkeyform );
1331 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1332 return $s;
1336 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1337 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1338 * second argument named variant. This was deprecated in favor
1339 * of passing an array of option with a "variant" key
1340 * Once $query2 is removed for good, this helper can be dropped
1341 * and the wfArrayToCgi moved to getLocalURL();
1343 * @since 1.19 (r105919)
1344 * @param $query
1345 * @param $query2 bool
1346 * @return String
1348 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1349 if ( $query2 !== false ) {
1350 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1351 "method called with a second parameter is deprecated. Add your " .
1352 "parameter to an array passed as the first parameter.", "1.19" );
1354 if ( is_array( $query ) ) {
1355 $query = wfArrayToCgi( $query );
1357 if ( $query2 ) {
1358 if ( is_string( $query2 ) ) {
1359 // $query2 is a string, we will consider this to be
1360 // a deprecated $variant argument and add it to the query
1361 $query2 = wfArrayToCgi( array( 'variant' => $query2 ) );
1362 } else {
1363 $query2 = wfArrayToCgi( $query2 );
1365 // If we have $query content add a & to it first
1366 if ( $query ) {
1367 $query .= '&';
1369 // Now append the queries together
1370 $query .= $query2;
1372 return $query;
1376 * Get a real URL referring to this title, with interwiki link and
1377 * fragment
1379 * See getLocalURL for the arguments.
1381 * @see self::getLocalURL
1382 * @see wfExpandUrl
1383 * @param $query
1384 * @param $query2 bool
1385 * @param $proto Protocol type to use in URL
1386 * @return String the URL
1388 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1389 $query = self::fixUrlQueryArgs( $query, $query2 );
1391 # Hand off all the decisions on urls to getLocalURL
1392 $url = $this->getLocalURL( $query );
1394 # Expand the url to make it a full url. Note that getLocalURL has the
1395 # potential to output full urls for a variety of reasons, so we use
1396 # wfExpandUrl instead of simply prepending $wgServer
1397 $url = wfExpandUrl( $url, $proto );
1399 # Finally, add the fragment.
1400 $url .= $this->getFragmentForURL();
1402 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
1403 return $url;
1407 * Get a URL with no fragment or server name. If this page is generated
1408 * with action=render, $wgServer is prepended.
1410 * @param string|array $query an optional query string,
1411 * not used for interwiki links. Can be specified as an associative array as well,
1412 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1413 * Some query patterns will trigger various shorturl path replacements.
1414 * @param $query2 Mixed: An optional secondary query array. This one MUST
1415 * be an array. If a string is passed it will be interpreted as a deprecated
1416 * variant argument and urlencoded into a variant= argument.
1417 * This second query argument will be added to the $query
1418 * The second parameter is deprecated since 1.19. Pass it as a key,value
1419 * pair in the first parameter array instead.
1421 * @return String the URL
1423 public function getLocalURL( $query = '', $query2 = false ) {
1424 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1426 $query = self::fixUrlQueryArgs( $query, $query2 );
1428 $interwiki = Interwiki::fetch( $this->mInterwiki );
1429 if ( $interwiki ) {
1430 $namespace = $this->getNsText();
1431 if ( $namespace != '' ) {
1432 # Can this actually happen? Interwikis shouldn't be parsed.
1433 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1434 $namespace .= ':';
1436 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1437 $url = wfAppendQuery( $url, $query );
1438 } else {
1439 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1440 if ( $query == '' ) {
1441 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1442 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1443 } else {
1444 global $wgVariantArticlePath, $wgActionPaths;
1445 $url = false;
1446 $matches = array();
1448 if ( !empty( $wgActionPaths ) &&
1449 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
1451 $action = urldecode( $matches[2] );
1452 if ( isset( $wgActionPaths[$action] ) ) {
1453 $query = $matches[1];
1454 if ( isset( $matches[4] ) ) {
1455 $query .= $matches[4];
1457 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1458 if ( $query != '' ) {
1459 $url = wfAppendQuery( $url, $query );
1464 if ( $url === false &&
1465 $wgVariantArticlePath &&
1466 $this->getPageLanguage()->hasVariants() &&
1467 preg_match( '/^variant=([^&]*)$/', $query, $matches ) )
1469 $variant = urldecode( $matches[1] );
1470 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1471 // Only do the variant replacement if the given variant is a valid
1472 // variant for the page's language.
1473 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1474 $url = str_replace( '$1', $dbkey, $url );
1478 if ( $url === false ) {
1479 if ( $query == '-' ) {
1480 $query = '';
1482 $url = "{$wgScript}?title={$dbkey}&{$query}";
1486 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1488 // @todo FIXME: This causes breakage in various places when we
1489 // actually expected a local URL and end up with dupe prefixes.
1490 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1491 $url = $wgServer . $url;
1494 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1495 return $url;
1499 * Get a URL that's the simplest URL that will be valid to link, locally,
1500 * to the current Title. It includes the fragment, but does not include
1501 * the server unless action=render is used (or the link is external). If
1502 * there's a fragment but the prefixed text is empty, we just return a link
1503 * to the fragment.
1505 * The result obviously should not be URL-escaped, but does need to be
1506 * HTML-escaped if it's being output in HTML.
1508 * See getLocalURL for the arguments.
1510 * @param $query
1511 * @param $query2 bool
1512 * @param $proto Protocol to use; setting this will cause a full URL to be used
1513 * @see self::getLocalURL
1514 * @return String the URL
1516 public function getLinkURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1517 wfProfileIn( __METHOD__ );
1518 if ( $this->isExternal() || $proto !== PROTO_RELATIVE ) {
1519 $ret = $this->getFullURL( $query, $query2, $proto );
1520 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
1521 $ret = $this->getFragmentForURL();
1522 } else {
1523 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1525 wfProfileOut( __METHOD__ );
1526 return $ret;
1530 * Get an HTML-escaped version of the URL form, suitable for
1531 * using in a link, without a server name or fragment
1533 * See getLocalURL for the arguments.
1535 * @see self::getLocalURL
1536 * @param $query string
1537 * @param $query2 bool|string
1538 * @return String the URL
1539 * @deprecated since 1.19
1541 public function escapeLocalURL( $query = '', $query2 = false ) {
1542 wfDeprecated( __METHOD__, '1.19' );
1543 return htmlspecialchars( $this->getLocalURL( $query, $query2 ) );
1547 * Get an HTML-escaped version of the URL form, suitable for
1548 * using in a link, including the server name and fragment
1550 * See getLocalURL for the arguments.
1552 * @see self::getLocalURL
1553 * @return String the URL
1554 * @deprecated since 1.19
1556 public function escapeFullURL( $query = '', $query2 = false ) {
1557 wfDeprecated( __METHOD__, '1.19' );
1558 return htmlspecialchars( $this->getFullURL( $query, $query2 ) );
1562 * Get the URL form for an internal link.
1563 * - Used in various Squid-related code, in case we have a different
1564 * internal hostname for the server from the exposed one.
1566 * This uses $wgInternalServer to qualify the path, or $wgServer
1567 * if $wgInternalServer is not set. If the server variable used is
1568 * protocol-relative, the URL will be expanded to http://
1570 * See getLocalURL for the arguments.
1572 * @see self::getLocalURL
1573 * @return String the URL
1575 public function getInternalURL( $query = '', $query2 = false ) {
1576 global $wgInternalServer, $wgServer;
1577 $query = self::fixUrlQueryArgs( $query, $query2 );
1578 $server = $wgInternalServer !== false ? $wgInternalServer : $wgServer;
1579 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP );
1580 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1581 return $url;
1585 * Get the URL for a canonical link, for use in things like IRC and
1586 * e-mail notifications. Uses $wgCanonicalServer and the
1587 * GetCanonicalURL hook.
1589 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1591 * See getLocalURL for the arguments.
1593 * @see self::getLocalURL
1594 * @return string The URL
1595 * @since 1.18
1597 public function getCanonicalURL( $query = '', $query2 = false ) {
1598 $query = self::fixUrlQueryArgs( $query, $query2 );
1599 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL );
1600 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1601 return $url;
1605 * HTML-escaped version of getCanonicalURL()
1607 * See getLocalURL for the arguments.
1609 * @see self::getLocalURL
1610 * @since 1.18
1611 * @return string
1612 * @deprecated since 1.19
1614 public function escapeCanonicalURL( $query = '', $query2 = false ) {
1615 wfDeprecated( __METHOD__, '1.19' );
1616 return htmlspecialchars( $this->getCanonicalURL( $query, $query2 ) );
1620 * Get the edit URL for this Title
1622 * @return String the URL, or a null string if this is an
1623 * interwiki link
1625 public function getEditURL() {
1626 if ( $this->mInterwiki != '' ) {
1627 return '';
1629 $s = $this->getLocalURL( 'action=edit' );
1631 return $s;
1635 * Is $wgUser watching this page?
1637 * @deprecated in 1.20; use User::isWatched() instead.
1638 * @return Bool
1640 public function userIsWatching() {
1641 global $wgUser;
1643 if ( is_null( $this->mWatched ) ) {
1644 if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn() ) {
1645 $this->mWatched = false;
1646 } else {
1647 $this->mWatched = $wgUser->isWatched( $this );
1650 return $this->mWatched;
1654 * Can $wgUser read this page?
1656 * @deprecated in 1.19; use userCan(), quickUserCan() or getUserPermissionsErrors() instead
1657 * @return Bool
1658 * @todo fold these checks into userCan()
1660 public function userCanRead() {
1661 wfDeprecated( __METHOD__, '1.19' );
1662 return $this->userCan( 'read' );
1666 * Can $user perform $action on this page?
1667 * This skips potentially expensive cascading permission checks
1668 * as well as avoids expensive error formatting
1670 * Suitable for use for nonessential UI controls in common cases, but
1671 * _not_ for functional access control.
1673 * May provide false positives, but should never provide a false negative.
1675 * @param string $action 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 * @return Bool
1680 public function quickUserCan( $action, $user = null ) {
1681 return $this->userCan( $action, $user, false );
1685 * Can $user perform $action on this page?
1687 * @param string $action action that permission needs to be checked for
1688 * @param $user User to check (since 1.19); $wgUser will be used if not
1689 * provided.
1690 * @param bool $doExpensiveQueries Set this to false to avoid doing
1691 * unnecessary queries.
1692 * @return Bool
1694 public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1695 if ( !$user instanceof User ) {
1696 global $wgUser;
1697 $user = $wgUser;
1699 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries, true ) );
1703 * Can $user perform $action on this page?
1705 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1707 * @param string $action action that permission needs to be checked for
1708 * @param $user User to check
1709 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary
1710 * queries by skipping checks for cascading protections and user blocks.
1711 * @param array $ignoreErrors of Strings Set this to a list of message keys
1712 * whose corresponding errors may be ignored.
1713 * @return Array of arguments to wfMessage to explain permissions problems.
1715 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1716 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1718 // Remove the errors being ignored.
1719 foreach ( $errors as $index => $error ) {
1720 $error_key = is_array( $error ) ? $error[0] : $error;
1722 if ( in_array( $error_key, $ignoreErrors ) ) {
1723 unset( $errors[$index] );
1727 return $errors;
1731 * Permissions checks that fail most often, and which are easiest to test.
1733 * @param string $action the action to check
1734 * @param $user User user to check
1735 * @param array $errors list of current errors
1736 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1737 * @param $short Boolean short circuit on first error
1739 * @return Array list of errors
1741 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1742 if ( $action == 'create' ) {
1743 if (
1744 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1745 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
1747 $errors[] = $user->isAnon() ? array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1749 } elseif ( $action == 'move' ) {
1750 if ( !$user->isAllowed( 'move-rootuserpages' )
1751 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1752 // Show user page-specific message only if the user can move other pages
1753 $errors[] = array( 'cant-move-user-page' );
1756 // Check if user is allowed to move files if it's a file
1757 if ( $this->mNamespace == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
1758 $errors[] = array( 'movenotallowedfile' );
1761 if ( !$user->isAllowed( 'move' ) ) {
1762 // User can't move anything
1763 $userCanMove = User::groupHasPermission( 'user', 'move' );
1764 $autoconfirmedCanMove = User::groupHasPermission( 'autoconfirmed', 'move' );
1765 if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) {
1766 // custom message if logged-in users without any special rights can move
1767 $errors[] = array( 'movenologintext' );
1768 } else {
1769 $errors[] = array( 'movenotallowed' );
1772 } elseif ( $action == 'move-target' ) {
1773 if ( !$user->isAllowed( 'move' ) ) {
1774 // User can't move anything
1775 $errors[] = array( 'movenotallowed' );
1776 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1777 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1778 // Show user page-specific message only if the user can move other pages
1779 $errors[] = array( 'cant-move-to-user-page' );
1781 } elseif ( !$user->isAllowed( $action ) ) {
1782 $errors[] = $this->missingPermissionError( $action, $short );
1785 return $errors;
1789 * Add the resulting error code to the errors array
1791 * @param array $errors list of current errors
1792 * @param $result Mixed result of errors
1794 * @return Array list of errors
1796 private function resultToError( $errors, $result ) {
1797 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1798 // A single array representing an error
1799 $errors[] = $result;
1800 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
1801 // A nested array representing multiple errors
1802 $errors = array_merge( $errors, $result );
1803 } elseif ( $result !== '' && is_string( $result ) ) {
1804 // A string representing a message-id
1805 $errors[] = array( $result );
1806 } elseif ( $result === false ) {
1807 // a generic "We don't want them to do that"
1808 $errors[] = array( 'badaccess-group0' );
1810 return $errors;
1814 * Check various permission hooks
1816 * @param string $action the action to check
1817 * @param $user User user to check
1818 * @param array $errors list of current errors
1819 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1820 * @param $short Boolean short circuit on first error
1822 * @return Array list of errors
1824 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1825 // Use getUserPermissionsErrors instead
1826 $result = '';
1827 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1828 return $result ? array() : array( array( 'badaccess-group0' ) );
1830 // Check getUserPermissionsErrors hook
1831 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1832 $errors = $this->resultToError( $errors, $result );
1834 // Check getUserPermissionsErrorsExpensive hook
1835 if (
1836 $doExpensiveQueries
1837 && !( $short && count( $errors ) > 0 )
1838 && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) )
1840 $errors = $this->resultToError( $errors, $result );
1843 return $errors;
1847 * Check permissions on special pages & namespaces
1849 * @param string $action the action to check
1850 * @param $user User user to check
1851 * @param array $errors list of current errors
1852 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1853 * @param $short Boolean short circuit on first error
1855 * @return Array list of errors
1857 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1858 # Only 'createaccount' can be performed on special pages,
1859 # which don't actually exist in the DB.
1860 if ( NS_SPECIAL == $this->mNamespace && $action !== 'createaccount' ) {
1861 $errors[] = array( 'ns-specialprotected' );
1864 # Check $wgNamespaceProtection for restricted namespaces
1865 if ( $this->isNamespaceProtected( $user ) ) {
1866 $ns = $this->mNamespace == NS_MAIN ?
1867 wfMessage( 'nstab-main' )->text() : $this->getNsText();
1868 $errors[] = $this->mNamespace == NS_MEDIAWIKI ?
1869 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1872 return $errors;
1876 * Check CSS/JS sub-page permissions
1878 * @param string $action the action to check
1879 * @param $user User user to check
1880 * @param array $errors list of current errors
1881 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1882 * @param $short Boolean short circuit on first error
1884 * @return Array list of errors
1886 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1887 # Protect css/js subpages of user pages
1888 # XXX: this might be better using restrictions
1889 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1890 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1891 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform ) ) {
1892 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1893 $errors[] = array( 'customcssprotected' );
1894 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1895 $errors[] = array( 'customjsprotected' );
1899 return $errors;
1903 * Check against page_restrictions table requirements on this
1904 * page. The user must possess all required rights for this
1905 * action.
1907 * @param string $action the action to check
1908 * @param $user User user to check
1909 * @param array $errors list of current errors
1910 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1911 * @param $short Boolean short circuit on first error
1913 * @return Array list of errors
1915 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1916 foreach ( $this->getRestrictions( $action ) as $right ) {
1917 // Backwards compatibility, rewrite sysop -> protect
1918 if ( $right == 'sysop' ) {
1919 $right = 'protect';
1921 if ( $right != '' && !$user->isAllowed( $right ) ) {
1922 // Users with 'editprotected' permission can edit protected pages
1923 // without cascading option turned on.
1924 if ( $action != 'edit' || !$user->isAllowed( 'editprotected' )
1925 || $this->mCascadeRestriction )
1927 $errors[] = array( 'protectedpagetext', $right );
1932 return $errors;
1936 * Check restrictions on cascading pages.
1938 * @param string $action the action to check
1939 * @param $user User to check
1940 * @param array $errors list of current errors
1941 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1942 * @param $short Boolean short circuit on first error
1944 * @return Array list of errors
1946 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1947 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1948 # We /could/ use the protection level on the source page, but it's
1949 # fairly ugly as we have to establish a precedence hierarchy for pages
1950 # included by multiple cascade-protected pages. So just restrict
1951 # it to people with 'protect' permission, as they could remove the
1952 # protection anyway.
1953 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1954 # Cascading protection depends on more than this page...
1955 # Several cascading protected pages may include this page...
1956 # Check each cascading level
1957 # This is only for protection restrictions, not for all actions
1958 if ( isset( $restrictions[$action] ) ) {
1959 foreach ( $restrictions[$action] as $right ) {
1960 $right = ( $right == 'sysop' ) ? 'protect' : $right;
1961 if ( $right != '' && !$user->isAllowed( $right ) ) {
1962 $pages = '';
1963 foreach ( $cascadingSources as $page ) {
1964 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1966 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1972 return $errors;
1976 * Check action permissions not already checked in checkQuickPermissions
1978 * @param string $action the action to check
1979 * @param $user User to check
1980 * @param array $errors list of current errors
1981 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1982 * @param $short Boolean short circuit on first error
1984 * @return Array list of errors
1986 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1987 global $wgDeleteRevisionsLimit, $wgLang;
1989 if ( $action == 'protect' ) {
1990 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $doExpensiveQueries, true ) ) ) {
1991 // If they can't edit, they shouldn't protect.
1992 $errors[] = array( 'protect-cantedit' );
1994 } elseif ( $action == 'create' ) {
1995 $title_protection = $this->getTitleProtection();
1996 if ( $title_protection ) {
1997 if ( $title_protection['pt_create_perm'] == 'sysop' ) {
1998 $title_protection['pt_create_perm'] = 'protect'; // B/C
2000 if ( $title_protection['pt_create_perm'] == '' ||
2001 !$user->isAllowed( $title_protection['pt_create_perm'] ) )
2003 $errors[] = array( 'titleprotected', User::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
2006 } elseif ( $action == 'move' ) {
2007 // Check for immobile pages
2008 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2009 // Specific message for this case
2010 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2011 } elseif ( !$this->isMovable() ) {
2012 // Less specific message for rarer cases
2013 $errors[] = array( 'immobile-source-page' );
2015 } elseif ( $action == 'move-target' ) {
2016 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2017 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
2018 } elseif ( !$this->isMovable() ) {
2019 $errors[] = array( 'immobile-target-page' );
2021 } elseif ( $action == 'delete' ) {
2022 if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
2023 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion() )
2025 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
2028 return $errors;
2032 * Check that the user isn't blocked from editing.
2034 * @param string $action the action to check
2035 * @param $user User to check
2036 * @param array $errors list of current errors
2037 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
2038 * @param $short Boolean short circuit on first error
2040 * @return Array list of errors
2042 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
2043 // Account creation blocks handled at userlogin.
2044 // Unblocking handled in SpecialUnblock
2045 if ( !$doExpensiveQueries || in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
2046 return $errors;
2049 global $wgEmailConfirmToEdit;
2051 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2052 $errors[] = array( 'confirmedittext' );
2055 if ( ( $action == 'edit' || $action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
2056 // Don't block the user from editing their own talk page unless they've been
2057 // explicitly blocked from that too.
2058 } elseif ( $user->isBlocked() && $user->mBlock->prevents( $action ) !== false ) {
2059 // @todo FIXME: Pass the relevant context into this function.
2060 $errors[] = $user->getBlock()->getPermissionsError( RequestContext::getMain() );
2063 return $errors;
2067 * Check that the user is allowed to read this page.
2069 * @param string $action the action to check
2070 * @param $user User to check
2071 * @param array $errors list of current errors
2072 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
2073 * @param $short Boolean short circuit on first error
2075 * @return Array list of errors
2077 private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2078 global $wgWhitelistRead, $wgWhitelistReadRegexp, $wgRevokePermissions;
2079 static $useShortcut = null;
2081 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
2082 if ( is_null( $useShortcut ) ) {
2083 $useShortcut = true;
2084 if ( !User::groupHasPermission( '*', 'read' ) ) {
2085 # Not a public wiki, so no shortcut
2086 $useShortcut = false;
2087 } elseif ( !empty( $wgRevokePermissions ) ) {
2089 * Iterate through each group with permissions being revoked (key not included since we don't care
2090 * what the group name is), then check if the read permission is being revoked. If it is, then
2091 * we don't use the shortcut below since the user might not be able to read, even though anon
2092 * reading is allowed.
2094 foreach ( $wgRevokePermissions as $perms ) {
2095 if ( !empty( $perms['read'] ) ) {
2096 # We might be removing the read right from the user, so no shortcut
2097 $useShortcut = false;
2098 break;
2104 $whitelisted = false;
2105 if ( $useShortcut ) {
2106 # Shortcut for public wikis, allows skipping quite a bit of code
2107 $whitelisted = true;
2108 } elseif ( $user->isAllowed( 'read' ) ) {
2109 # If the user is allowed to read pages, he is allowed to read all pages
2110 $whitelisted = true;
2111 } elseif ( $this->isSpecial( 'Userlogin' )
2112 || $this->isSpecial( 'ChangePassword' )
2113 || $this->isSpecial( 'PasswordReset' )
2115 # Always grant access to the login page.
2116 # Even anons need to be able to log in.
2117 $whitelisted = true;
2118 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2119 # Time to check the whitelist
2120 # Only do these checks is there's something to check against
2121 $name = $this->getPrefixedText();
2122 $dbName = $this->getPrefixedDBkey();
2124 // Check for explicit whitelisting with and without underscores
2125 if ( in_array( $name, $wgWhitelistRead, true ) || in_array( $dbName, $wgWhitelistRead, true ) ) {
2126 $whitelisted = true;
2127 } elseif ( $this->getNamespace() == NS_MAIN ) {
2128 # Old settings might have the title prefixed with
2129 # a colon for main-namespace pages
2130 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2131 $whitelisted = true;
2133 } elseif ( $this->isSpecialPage() ) {
2134 # If it's a special page, ditch the subpage bit and check again
2135 $name = $this->getDBkey();
2136 list( $name, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $name );
2137 if ( $name ) {
2138 $pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
2139 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2140 $whitelisted = true;
2146 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2147 $name = $this->getPrefixedText();
2148 // Check for regex whitelisting
2149 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2150 if ( preg_match( $listItem, $name ) ) {
2151 $whitelisted = true;
2152 break;
2157 if ( !$whitelisted ) {
2158 # If the title is not whitelisted, give extensions a chance to do so...
2159 wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2160 if ( !$whitelisted ) {
2161 $errors[] = $this->missingPermissionError( $action, $short );
2165 return $errors;
2169 * Get a description array when the user doesn't have the right to perform
2170 * $action (i.e. when User::isAllowed() returns false)
2172 * @param string $action the action to check
2173 * @param $short Boolean short circuit on first error
2174 * @return Array list of errors
2176 private function missingPermissionError( $action, $short ) {
2177 // We avoid expensive display logic for quickUserCan's and such
2178 if ( $short ) {
2179 return array( 'badaccess-group0' );
2182 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2183 User::getGroupsWithPermission( $action ) );
2185 if ( count( $groups ) ) {
2186 global $wgLang;
2187 return array(
2188 'badaccess-groups',
2189 $wgLang->commaList( $groups ),
2190 count( $groups )
2192 } else {
2193 return array( 'badaccess-group0' );
2198 * Can $user perform $action on this page? This is an internal function,
2199 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2200 * checks on wfReadOnly() and blocks)
2202 * @param string $action action that permission needs to be checked for
2203 * @param $user User to check
2204 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
2205 * @param bool $short Set this to true to stop after the first permission error.
2206 * @return Array of arrays of the arguments to wfMessage to explain permissions problems.
2208 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
2209 wfProfileIn( __METHOD__ );
2211 # Read has special handling
2212 if ( $action == 'read' ) {
2213 $checks = array(
2214 'checkPermissionHooks',
2215 'checkReadPermissions',
2217 } else {
2218 $checks = array(
2219 'checkQuickPermissions',
2220 'checkPermissionHooks',
2221 'checkSpecialsAndNSPermissions',
2222 'checkCSSandJSPermissions',
2223 'checkPageRestrictions',
2224 'checkCascadingSourcesRestrictions',
2225 'checkActionPermissions',
2226 'checkUserBlock'
2230 $errors = array();
2231 while ( count( $checks ) > 0 &&
2232 !( $short && count( $errors ) > 0 ) ) {
2233 $method = array_shift( $checks );
2234 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2237 wfProfileOut( __METHOD__ );
2238 return $errors;
2242 * Protect css subpages of user pages: can $wgUser edit
2243 * this page?
2245 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2246 * @return Bool
2248 public function userCanEditCssSubpage() {
2249 global $wgUser;
2250 wfDeprecated( __METHOD__, '1.19' );
2251 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'editusercss' ) )
2252 || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) );
2256 * Protect js subpages of user pages: can $wgUser edit
2257 * this page?
2259 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2260 * @return Bool
2262 public function userCanEditJsSubpage() {
2263 global $wgUser;
2264 wfDeprecated( __METHOD__, '1.19' );
2265 return (
2266 ( $wgUser->isAllowedAll( 'editusercssjs', 'edituserjs' ) )
2267 || 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(
2337 'protected_titles',
2338 array( 'pt_user', 'pt_reason', 'pt_expiry', 'pt_create_perm' ),
2339 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2340 __METHOD__
2343 // fetchRow returns false if there are no rows.
2344 $this->mTitleProtection = $dbr->fetchRow( $res );
2346 return $this->mTitleProtection;
2350 * Update the title protection status
2352 * @deprecated in 1.19; will be removed in 1.20. Use WikiPage::doUpdateRestrictions() instead.
2353 * @param $create_perm String Permission required for creation
2354 * @param string $reason Reason for protection
2355 * @param string $expiry Expiry timestamp
2356 * @return boolean true
2358 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
2359 wfDeprecated( __METHOD__, '1.19' );
2361 global $wgUser;
2363 $limit = array( 'create' => $create_perm );
2364 $expiry = array( 'create' => $expiry );
2366 $page = WikiPage::factory( $this );
2367 $cascade = false;
2368 $status = $page->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $wgUser );
2370 return $status->isOK();
2374 * Remove any title protection due to page existing
2376 public function deleteTitleProtection() {
2377 $dbw = wfGetDB( DB_MASTER );
2379 $dbw->delete(
2380 'protected_titles',
2381 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2382 __METHOD__
2384 $this->mTitleProtection = false;
2388 * Is this page "semi-protected" - the *only* protection is autoconfirm?
2390 * @param string $action Action to check (default: edit)
2391 * @return Bool
2393 public function isSemiProtected( $action = 'edit' ) {
2394 if ( $this->exists() ) {
2395 $restrictions = $this->getRestrictions( $action );
2396 if ( count( $restrictions ) > 0 ) {
2397 foreach ( $restrictions as $restriction ) {
2398 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
2399 return false;
2402 } else {
2403 # Not protected
2404 return false;
2406 return true;
2407 } else {
2408 # If it doesn't exist, it can't be protected
2409 return false;
2414 * Does the title correspond to a protected article?
2416 * @param string $action the action the page is protected from,
2417 * by default checks all actions.
2418 * @return Bool
2420 public function isProtected( $action = '' ) {
2421 global $wgRestrictionLevels;
2423 $restrictionTypes = $this->getRestrictionTypes();
2425 # Special pages have inherent protection
2426 if ( $this->isSpecialPage() ) {
2427 return true;
2430 # Check regular protection levels
2431 foreach ( $restrictionTypes as $type ) {
2432 if ( $action == $type || $action == '' ) {
2433 $r = $this->getRestrictions( $type );
2434 foreach ( $wgRestrictionLevels as $level ) {
2435 if ( in_array( $level, $r ) && $level != '' ) {
2436 return true;
2442 return false;
2446 * Determines if $user is unable to edit this page because it has been protected
2447 * by $wgNamespaceProtection.
2449 * @param $user User object to check permissions
2450 * @return Bool
2452 public function isNamespaceProtected( User $user ) {
2453 global $wgNamespaceProtection;
2455 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
2456 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
2457 if ( $right != '' && !$user->isAllowed( $right ) ) {
2458 return true;
2462 return false;
2466 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2468 * @return Bool If the page is subject to cascading restrictions.
2470 public function isCascadeProtected() {
2471 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2472 return ( $sources > 0 );
2476 * Cascading protection: Get the source of any cascading restrictions on this page.
2478 * @param bool $getPages Whether or not to retrieve the actual pages
2479 * that the restrictions have come from.
2480 * @return Mixed Array of Title objects of the pages from which cascading restrictions
2481 * have come, false for none, or true if such restrictions exist, but $getPages
2482 * was not set. The restriction array is an array of each type, each of which
2483 * contains a array of unique groups.
2485 public function getCascadeProtectionSources( $getPages = true ) {
2486 global $wgContLang;
2487 $pagerestrictions = array();
2489 if ( isset( $this->mCascadeSources ) && $getPages ) {
2490 return array( $this->mCascadeSources, $this->mCascadingRestrictions );
2491 } elseif ( isset( $this->mHasCascadingRestrictions ) && !$getPages ) {
2492 return array( $this->mHasCascadingRestrictions, $pagerestrictions );
2495 wfProfileIn( __METHOD__ );
2497 $dbr = wfGetDB( DB_SLAVE );
2499 if ( $this->getNamespace() == NS_FILE ) {
2500 $tables = array( 'imagelinks', 'page_restrictions' );
2501 $where_clauses = array(
2502 'il_to' => $this->getDBkey(),
2503 'il_from=pr_page',
2504 'pr_cascade' => 1
2506 } else {
2507 $tables = array( 'templatelinks', 'page_restrictions' );
2508 $where_clauses = array(
2509 'tl_namespace' => $this->getNamespace(),
2510 'tl_title' => $this->getDBkey(),
2511 'tl_from=pr_page',
2512 'pr_cascade' => 1
2516 if ( $getPages ) {
2517 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2518 'pr_expiry', 'pr_type', 'pr_level' );
2519 $where_clauses[] = 'page_id=pr_page';
2520 $tables[] = 'page';
2521 } else {
2522 $cols = array( 'pr_expiry' );
2525 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2527 $sources = $getPages ? array() : false;
2528 $now = wfTimestampNow();
2529 $purgeExpired = false;
2531 foreach ( $res as $row ) {
2532 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2533 if ( $expiry > $now ) {
2534 if ( $getPages ) {
2535 $page_id = $row->pr_page;
2536 $page_ns = $row->page_namespace;
2537 $page_title = $row->page_title;
2538 $sources[$page_id] = Title::makeTitle( $page_ns, $page_title );
2539 # Add groups needed for each restriction type if its not already there
2540 # Make sure this restriction type still exists
2542 if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2543 $pagerestrictions[$row->pr_type] = array();
2546 if (
2547 isset( $pagerestrictions[$row->pr_type] )
2548 && !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] )
2550 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2552 } else {
2553 $sources = true;
2555 } else {
2556 // Trigger lazy purge of expired restrictions from the db
2557 $purgeExpired = true;
2560 if ( $purgeExpired ) {
2561 Title::purgeExpiredRestrictions();
2564 if ( $getPages ) {
2565 $this->mCascadeSources = $sources;
2566 $this->mCascadingRestrictions = $pagerestrictions;
2567 } else {
2568 $this->mHasCascadingRestrictions = $sources;
2571 wfProfileOut( __METHOD__ );
2572 return array( $sources, $pagerestrictions );
2576 * Accessor/initialisation for mRestrictions
2578 * @param string $action action that permission needs to be checked for
2579 * @return Array of Strings the array of groups allowed to edit this article
2581 public function getRestrictions( $action ) {
2582 if ( !$this->mRestrictionsLoaded ) {
2583 $this->loadRestrictions();
2585 return isset( $this->mRestrictions[$action] )
2586 ? $this->mRestrictions[$action]
2587 : array();
2591 * Get the expiry time for the restriction against a given action
2593 * @param $action
2594 * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever
2595 * or not protected at all, or false if the action is not recognised.
2597 public function getRestrictionExpiry( $action ) {
2598 if ( !$this->mRestrictionsLoaded ) {
2599 $this->loadRestrictions();
2601 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
2605 * Returns cascading restrictions for the current article
2607 * @return Boolean
2609 function areRestrictionsCascading() {
2610 if ( !$this->mRestrictionsLoaded ) {
2611 $this->loadRestrictions();
2614 return $this->mCascadeRestriction;
2618 * Loads a string into mRestrictions array
2620 * @param $res Resource restrictions as an SQL result.
2621 * @param string $oldFashionedRestrictions comma-separated list of page
2622 * restrictions from page table (pre 1.10)
2624 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2625 $rows = array();
2627 foreach ( $res as $row ) {
2628 $rows[] = $row;
2631 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2635 * Compiles list of active page restrictions from both page table (pre 1.10)
2636 * and page_restrictions table for this existing page.
2637 * Public for usage by LiquidThreads.
2639 * @param array $rows of db result objects
2640 * @param string $oldFashionedRestrictions comma-separated list of page
2641 * restrictions from page table (pre 1.10)
2643 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2644 global $wgContLang;
2645 $dbr = wfGetDB( DB_SLAVE );
2647 $restrictionTypes = $this->getRestrictionTypes();
2649 foreach ( $restrictionTypes as $type ) {
2650 $this->mRestrictions[$type] = array();
2651 $this->mRestrictionsExpiry[$type] = $wgContLang->formatExpiry( '', TS_MW );
2654 $this->mCascadeRestriction = false;
2656 # Backwards-compatibility: also load the restrictions from the page record (old format).
2658 if ( $oldFashionedRestrictions === null ) {
2659 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2660 array( 'page_id' => $this->getArticleID() ), __METHOD__ );
2663 if ( $oldFashionedRestrictions != '' ) {
2665 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2666 $temp = explode( '=', trim( $restrict ) );
2667 if ( count( $temp ) == 1 ) {
2668 // old old format should be treated as edit/move restriction
2669 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
2670 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
2671 } else {
2672 $restriction = trim( $temp[1] );
2673 if ( $restriction != '' ) { //some old entries are empty
2674 $this->mRestrictions[$temp[0]] = explode( ',', $restriction );
2679 $this->mOldRestrictions = true;
2683 if ( count( $rows ) ) {
2684 # Current system - load second to make them override.
2685 $now = wfTimestampNow();
2686 $purgeExpired = false;
2688 # Cycle through all the restrictions.
2689 foreach ( $rows as $row ) {
2691 // Don't take care of restrictions types that aren't allowed
2692 if ( !in_array( $row->pr_type, $restrictionTypes ) ) {
2693 continue;
2696 // This code should be refactored, now that it's being used more generally,
2697 // But I don't really see any harm in leaving it in Block for now -werdna
2698 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2700 // Only apply the restrictions if they haven't expired!
2701 if ( !$expiry || $expiry > $now ) {
2702 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
2703 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
2705 $this->mCascadeRestriction |= $row->pr_cascade;
2706 } else {
2707 // Trigger a lazy purge of expired restrictions
2708 $purgeExpired = true;
2712 if ( $purgeExpired ) {
2713 Title::purgeExpiredRestrictions();
2717 $this->mRestrictionsLoaded = true;
2721 * Load restrictions from the page_restrictions table
2723 * @param string $oldFashionedRestrictions comma-separated list of page
2724 * restrictions from page table (pre 1.10)
2726 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2727 global $wgContLang;
2728 if ( !$this->mRestrictionsLoaded ) {
2729 if ( $this->exists() ) {
2730 $dbr = wfGetDB( DB_SLAVE );
2732 $res = $dbr->select(
2733 'page_restrictions',
2734 array( 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ),
2735 array( 'pr_page' => $this->getArticleID() ),
2736 __METHOD__
2739 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2740 } else {
2741 $title_protection = $this->getTitleProtection();
2743 if ( $title_protection ) {
2744 $now = wfTimestampNow();
2745 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW );
2747 if ( !$expiry || $expiry > $now ) {
2748 // Apply the restrictions
2749 $this->mRestrictionsExpiry['create'] = $expiry;
2750 $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2751 } else { // Get rid of the old restrictions
2752 Title::purgeExpiredRestrictions();
2753 $this->mTitleProtection = false;
2755 } else {
2756 $this->mRestrictionsExpiry['create'] = $wgContLang->formatExpiry( '', TS_MW );
2758 $this->mRestrictionsLoaded = true;
2764 * Flush the protection cache in this object and force reload from the database.
2765 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2767 public function flushRestrictions() {
2768 $this->mRestrictionsLoaded = false;
2769 $this->mTitleProtection = null;
2773 * Purge expired restrictions from the page_restrictions table
2775 static function purgeExpiredRestrictions() {
2776 if ( wfReadOnly() ) {
2777 return;
2780 $method = __METHOD__;
2781 $dbw = wfGetDB( DB_MASTER );
2782 $dbw->onTransactionIdle( function() use ( $dbw, $method ) {
2783 $dbw->delete(
2784 'page_restrictions',
2785 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2786 $method
2788 $dbw->delete(
2789 'protected_titles',
2790 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2791 $method
2793 } );
2797 * Does this have subpages? (Warning, usually requires an extra DB query.)
2799 * @return Bool
2801 public function hasSubpages() {
2802 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
2803 # Duh
2804 return false;
2807 # We dynamically add a member variable for the purpose of this method
2808 # alone to cache the result. There's no point in having it hanging
2809 # around uninitialized in every Title object; therefore we only add it
2810 # if needed and don't declare it statically.
2811 if ( isset( $this->mHasSubpages ) ) {
2812 return $this->mHasSubpages;
2815 $subpages = $this->getSubpages( 1 );
2816 if ( $subpages instanceof TitleArray ) {
2817 return $this->mHasSubpages = (bool)$subpages->count();
2819 return $this->mHasSubpages = false;
2823 * Get all subpages of this page.
2825 * @param int $limit maximum number of subpages to fetch; -1 for no limit
2826 * @return mixed TitleArray, or empty array if this page's namespace
2827 * doesn't allow subpages
2829 public function getSubpages( $limit = -1 ) {
2830 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
2831 return array();
2834 $dbr = wfGetDB( DB_SLAVE );
2835 $conds['page_namespace'] = $this->getNamespace();
2836 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
2837 $options = array();
2838 if ( $limit > -1 ) {
2839 $options['LIMIT'] = $limit;
2841 return $this->mSubpages = TitleArray::newFromResult(
2842 $dbr->select( 'page',
2843 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
2844 $conds,
2845 __METHOD__,
2846 $options
2852 * Is there a version of this page in the deletion archive?
2854 * @return Int the number of archived revisions
2856 public function isDeleted() {
2857 if ( $this->getNamespace() < 0 ) {
2858 $n = 0;
2859 } else {
2860 $dbr = wfGetDB( DB_SLAVE );
2862 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2863 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2864 __METHOD__
2866 if ( $this->getNamespace() == NS_FILE ) {
2867 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
2868 array( 'fa_name' => $this->getDBkey() ),
2869 __METHOD__
2873 return (int)$n;
2877 * Is there a version of this page in the deletion archive?
2879 * @return Boolean
2881 public function isDeletedQuick() {
2882 if ( $this->getNamespace() < 0 ) {
2883 return false;
2885 $dbr = wfGetDB( DB_SLAVE );
2886 $deleted = (bool)$dbr->selectField( 'archive', '1',
2887 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2888 __METHOD__
2890 if ( !$deleted && $this->getNamespace() == NS_FILE ) {
2891 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2892 array( 'fa_name' => $this->getDBkey() ),
2893 __METHOD__
2896 return $deleted;
2900 * Get the article ID for this Title from the link cache,
2901 * adding it if necessary
2903 * @param int $flags a bit field; may be Title::GAID_FOR_UPDATE to select
2904 * for update
2905 * @return Int the ID
2907 public function getArticleID( $flags = 0 ) {
2908 if ( $this->getNamespace() < 0 ) {
2909 return $this->mArticleID = 0;
2911 $linkCache = LinkCache::singleton();
2912 if ( $flags & self::GAID_FOR_UPDATE ) {
2913 $oldUpdate = $linkCache->forUpdate( true );
2914 $linkCache->clearLink( $this );
2915 $this->mArticleID = $linkCache->addLinkObj( $this );
2916 $linkCache->forUpdate( $oldUpdate );
2917 } else {
2918 if ( -1 == $this->mArticleID ) {
2919 $this->mArticleID = $linkCache->addLinkObj( $this );
2922 return $this->mArticleID;
2926 * Is this an article that is a redirect page?
2927 * Uses link cache, adding it if necessary
2929 * @param int $flags a bit field; may be Title::GAID_FOR_UPDATE to select for update
2930 * @return Bool
2932 public function isRedirect( $flags = 0 ) {
2933 if ( !is_null( $this->mRedirect ) ) {
2934 return $this->mRedirect;
2936 # Calling getArticleID() loads the field from cache as needed
2937 if ( !$this->getArticleID( $flags ) ) {
2938 return $this->mRedirect = false;
2941 $linkCache = LinkCache::singleton();
2942 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2943 if ( $cached === null ) {
2944 // TODO: check the assumption that the cache actually knows about this title
2945 // and handle this, such as get the title from the database.
2946 // See https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2947 wfDebug( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2948 wfDebug( wfBacktrace() );
2951 $this->mRedirect = (bool)$cached;
2953 return $this->mRedirect;
2957 * What is the length of this page?
2958 * Uses link cache, adding it if necessary
2960 * @param int $flags a bit field; may be Title::GAID_FOR_UPDATE to select for update
2961 * @return Int
2963 public function getLength( $flags = 0 ) {
2964 if ( $this->mLength != -1 ) {
2965 return $this->mLength;
2967 # Calling getArticleID() loads the field from cache as needed
2968 if ( !$this->getArticleID( $flags ) ) {
2969 return $this->mLength = 0;
2971 $linkCache = LinkCache::singleton();
2972 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
2973 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
2974 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2975 # as a stop gap, perhaps log this, but don't throw an exception?
2976 wfDebug( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2977 wfDebug( wfBacktrace() );
2980 $this->mLength = intval( $cached );
2982 return $this->mLength;
2986 * What is the page_latest field for this page?
2988 * @param int $flags a bit field; may be Title::GAID_FOR_UPDATE to select for update
2989 * @throws MWException
2990 * @return Int or 0 if the page doesn't exist
2992 public function getLatestRevID( $flags = 0 ) {
2993 if ( !( $flags & Title::GAID_FOR_UPDATE ) && $this->mLatestID !== false ) {
2994 return intval( $this->mLatestID );
2996 # Calling getArticleID() loads the field from cache as needed
2997 if ( !$this->getArticleID( $flags ) ) {
2998 return $this->mLatestID = 0;
3000 $linkCache = LinkCache::singleton();
3001 $linkCache->addLinkObj( $this );
3002 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3003 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
3004 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
3005 # as a stop gap, perhaps log this, but don't throw an exception?
3006 throw new MWException( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
3009 $this->mLatestID = intval( $cached );
3011 return $this->mLatestID;
3015 * This clears some fields in this object, and clears any associated
3016 * keys in the "bad links" section of the link cache.
3018 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
3019 * loading of the new page_id. It's also called from
3020 * WikiPage::doDeleteArticleReal()
3022 * @param int $newid the new Article ID
3024 public function resetArticleID( $newid ) {
3025 $linkCache = LinkCache::singleton();
3026 $linkCache->clearLink( $this );
3028 if ( $newid === false ) {
3029 $this->mArticleID = -1;
3030 } else {
3031 $this->mArticleID = intval( $newid );
3033 $this->mRestrictionsLoaded = false;
3034 $this->mRestrictions = array();
3035 $this->mRedirect = null;
3036 $this->mLength = -1;
3037 $this->mLatestID = false;
3038 $this->mContentModel = false;
3039 $this->mEstimateRevisions = null;
3043 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3045 * @param string $text containing title to capitalize
3046 * @param int $ns namespace index, defaults to NS_MAIN
3047 * @return String containing capitalized title
3049 public static function capitalize( $text, $ns = NS_MAIN ) {
3050 global $wgContLang;
3052 if ( MWNamespace::isCapitalized( $ns ) ) {
3053 return $wgContLang->ucfirst( $text );
3054 } else {
3055 return $text;
3060 * Secure and split - main initialisation function for this object
3062 * Assumes that mDbkeyform has been set, and is urldecoded
3063 * and uses underscores, but not otherwise munged. This function
3064 * removes illegal characters, splits off the interwiki and
3065 * namespace prefixes, sets the other forms, and canonicalizes
3066 * everything.
3068 * @return Bool true on success
3070 private function secureAndSplit() {
3071 global $wgContLang, $wgLocalInterwiki;
3073 # Initialisation
3074 $this->mInterwiki = $this->mFragment = '';
3075 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
3077 $dbkey = $this->mDbkeyform;
3079 # Strip Unicode bidi override characters.
3080 # Sometimes they slip into cut-n-pasted page titles, where the
3081 # override chars get included in list displays.
3082 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
3084 # Clean up whitespace
3085 # Note: use of the /u option on preg_replace here will cause
3086 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
3087 # conveniently disabling them.
3088 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
3089 $dbkey = trim( $dbkey, '_' );
3091 if ( $dbkey == '' ) {
3092 return false;
3095 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
3096 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
3097 return false;
3100 $this->mDbkeyform = $dbkey;
3102 # Initial colon indicates main namespace rather than specified default
3103 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
3104 if ( ':' == $dbkey[0] ) {
3105 $this->mNamespace = NS_MAIN;
3106 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
3107 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
3110 # Namespace or interwiki prefix
3111 $firstPass = true;
3112 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
3113 do {
3114 $m = array();
3115 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
3116 $p = $m[1];
3117 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
3118 # Ordinary namespace
3119 $dbkey = $m[2];
3120 $this->mNamespace = $ns;
3121 # For Talk:X pages, check if X has a "namespace" prefix
3122 if ( $ns == NS_TALK && preg_match( $prefixRegexp, $dbkey, $x ) ) {
3123 if ( $wgContLang->getNsIndex( $x[1] ) ) {
3124 # Disallow Talk:File:x type titles...
3125 return false;
3126 } elseif ( Interwiki::isValidInterwiki( $x[1] ) ) {
3127 # Disallow Talk:Interwiki:x type titles...
3128 return false;
3131 } elseif ( Interwiki::isValidInterwiki( $p ) ) {
3132 if ( !$firstPass ) {
3133 # Can't make a local interwiki link to an interwiki link.
3134 # That's just crazy!
3135 return false;
3138 # Interwiki link
3139 $dbkey = $m[2];
3140 $this->mInterwiki = $wgContLang->lc( $p );
3142 # Redundant interwiki prefix to the local wiki
3143 if ( $wgLocalInterwiki !== false
3144 && 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) )
3146 if ( $dbkey == '' ) {
3147 # Can't have an empty self-link
3148 return false;
3150 $this->mInterwiki = '';
3151 $firstPass = false;
3152 # Do another namespace split...
3153 continue;
3156 # If there's an initial colon after the interwiki, that also
3157 # resets the default namespace
3158 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
3159 $this->mNamespace = NS_MAIN;
3160 $dbkey = substr( $dbkey, 1 );
3163 # If there's no recognized interwiki or namespace,
3164 # then let the colon expression be part of the title.
3166 break;
3167 } while ( true );
3169 # We already know that some pages won't be in the database!
3170 if ( $this->mInterwiki != '' || NS_SPECIAL == $this->mNamespace ) {
3171 $this->mArticleID = 0;
3173 $fragment = strstr( $dbkey, '#' );
3174 if ( false !== $fragment ) {
3175 $this->setFragment( $fragment );
3176 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
3177 # remove whitespace again: prevents "Foo_bar_#"
3178 # becoming "Foo_bar_"
3179 $dbkey = preg_replace( '/_*$/', '', $dbkey );
3182 # Reject illegal characters.
3183 $rxTc = self::getTitleInvalidRegex();
3184 if ( preg_match( $rxTc, $dbkey ) ) {
3185 return false;
3188 # Pages with "/./" or "/../" appearing in the URLs will often be un-
3189 # reachable due to the way web browsers deal with 'relative' URLs.
3190 # Also, they conflict with subpage syntax. Forbid them explicitly.
3191 if (
3192 strpos( $dbkey, '.' ) !== false &&
3194 $dbkey === '.' || $dbkey === '..' ||
3195 strpos( $dbkey, './' ) === 0 ||
3196 strpos( $dbkey, '../' ) === 0 ||
3197 strpos( $dbkey, '/./' ) !== false ||
3198 strpos( $dbkey, '/../' ) !== false ||
3199 substr( $dbkey, -2 ) == '/.' ||
3200 substr( $dbkey, -3 ) == '/..'
3203 return false;
3206 # Magic tilde sequences? Nu-uh!
3207 if ( strpos( $dbkey, '~~~' ) !== false ) {
3208 return false;
3211 # Limit the size of titles to 255 bytes. This is typically the size of the
3212 # underlying database field. We make an exception for special pages, which
3213 # don't need to be stored in the database, and may edge over 255 bytes due
3214 # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
3215 if (
3216 ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 )
3217 || strlen( $dbkey ) > 512
3219 return false;
3222 # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
3223 # and [[Foo]] point to the same place. Don't force it for interwikis, since the
3224 # other site might be case-sensitive.
3225 $this->mUserCaseDBKey = $dbkey;
3226 if ( $this->mInterwiki == '' ) {
3227 $dbkey = self::capitalize( $dbkey, $this->mNamespace );
3230 # Can't make a link to a namespace alone... "empty" local links can only be
3231 # self-links with a fragment identifier.
3232 if ( $dbkey == '' && $this->mInterwiki == '' && $this->mNamespace != NS_MAIN ) {
3233 return false;
3236 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
3237 // IP names are not allowed for accounts, and can only be referring to
3238 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
3239 // there are numerous ways to present the same IP. Having sp:contribs scan
3240 // them all is silly and having some show the edits and others not is
3241 // inconsistent. Same for talk/userpages. Keep them normalized instead.
3242 $dbkey = ( $this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK )
3243 ? IP::sanitizeIP( $dbkey )
3244 : $dbkey;
3246 // Any remaining initial :s are illegal.
3247 if ( $dbkey !== '' && ':' == $dbkey[0] ) {
3248 return false;
3251 # Fill fields
3252 $this->mDbkeyform = $dbkey;
3253 $this->mUrlform = wfUrlencode( $dbkey );
3255 $this->mTextform = str_replace( '_', ' ', $dbkey );
3257 return true;
3261 * Get an array of Title objects linking to this Title
3262 * Also stores the IDs in the link cache.
3264 * WARNING: do not use this function on arbitrary user-supplied titles!
3265 * On heavily-used templates it will max out the memory.
3267 * @param array $options may be FOR UPDATE
3268 * @param string $table table name
3269 * @param string $prefix fields prefix
3270 * @return Array of Title objects linking here
3272 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3273 if ( count( $options ) > 0 ) {
3274 $db = wfGetDB( DB_MASTER );
3275 } else {
3276 $db = wfGetDB( DB_SLAVE );
3279 $res = $db->select(
3280 array( 'page', $table ),
3281 self::getSelectFields(),
3282 array(
3283 "{$prefix}_from=page_id",
3284 "{$prefix}_namespace" => $this->getNamespace(),
3285 "{$prefix}_title" => $this->getDBkey() ),
3286 __METHOD__,
3287 $options
3290 $retVal = array();
3291 if ( $res->numRows() ) {
3292 $linkCache = LinkCache::singleton();
3293 foreach ( $res as $row ) {
3294 $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title );
3295 if ( $titleObj ) {
3296 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3297 $retVal[] = $titleObj;
3301 return $retVal;
3305 * Get an array of Title objects using this Title as a template
3306 * Also stores the IDs in the link cache.
3308 * WARNING: do not use this function on arbitrary user-supplied titles!
3309 * On heavily-used templates it will max out the memory.
3311 * @param array $options may be FOR UPDATE
3312 * @return Array of Title the Title objects linking here
3314 public function getTemplateLinksTo( $options = array() ) {
3315 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3319 * Get an array of Title objects linked from this Title
3320 * Also stores the IDs in the link cache.
3322 * WARNING: do not use this function on arbitrary user-supplied titles!
3323 * On heavily-used templates it will max out the memory.
3325 * @param array $options may be FOR UPDATE
3326 * @param string $table table name
3327 * @param string $prefix fields prefix
3328 * @return Array of Title objects linking here
3330 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3331 global $wgContentHandlerUseDB;
3333 $id = $this->getArticleID();
3335 # If the page doesn't exist; there can't be any link from this page
3336 if ( !$id ) {
3337 return array();
3340 if ( count( $options ) > 0 ) {
3341 $db = wfGetDB( DB_MASTER );
3342 } else {
3343 $db = wfGetDB( DB_SLAVE );
3346 $namespaceFiled = "{$prefix}_namespace";
3347 $titleField = "{$prefix}_title";
3349 $fields = array( $namespaceFiled, $titleField, 'page_id', 'page_len', 'page_is_redirect', 'page_latest' );
3350 if ( $wgContentHandlerUseDB ) {
3351 $fields[] = 'page_content_model';
3354 $res = $db->select(
3355 array( $table, 'page' ),
3356 $fields,
3357 array( "{$prefix}_from" => $id ),
3358 __METHOD__,
3359 $options,
3360 array( 'page' => array( 'LEFT JOIN', array( "page_namespace=$namespaceFiled", "page_title=$titleField" ) ) )
3363 $retVal = array();
3364 if ( $res->numRows() ) {
3365 $linkCache = LinkCache::singleton();
3366 foreach ( $res as $row ) {
3367 $titleObj = Title::makeTitle( $row->$namespaceFiled, $row->$titleField );
3368 if ( $titleObj ) {
3369 if ( $row->page_id ) {
3370 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3371 } else {
3372 $linkCache->addBadLinkObj( $titleObj );
3374 $retVal[] = $titleObj;
3378 return $retVal;
3382 * Get an array of Title objects used on this Title as a template
3383 * Also stores the IDs in the link cache.
3385 * WARNING: do not use this function on arbitrary user-supplied titles!
3386 * On heavily-used templates it will max out the memory.
3388 * @param array $options may be FOR UPDATE
3389 * @return Array of Title the Title objects used here
3391 public function getTemplateLinksFrom( $options = array() ) {
3392 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3396 * Get an array of Title objects referring to non-existent articles linked from this page
3398 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
3399 * @return Array of Title the Title objects
3401 public function getBrokenLinksFrom() {
3402 if ( $this->getArticleID() == 0 ) {
3403 # All links from article ID 0 are false positives
3404 return array();
3407 $dbr = wfGetDB( DB_SLAVE );
3408 $res = $dbr->select(
3409 array( 'page', 'pagelinks' ),
3410 array( 'pl_namespace', 'pl_title' ),
3411 array(
3412 'pl_from' => $this->getArticleID(),
3413 'page_namespace IS NULL'
3415 __METHOD__, array(),
3416 array(
3417 'page' => array(
3418 'LEFT JOIN',
3419 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3424 $retVal = array();
3425 foreach ( $res as $row ) {
3426 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
3428 return $retVal;
3432 * Get a list of URLs to purge from the Squid cache when this
3433 * page changes
3435 * @return Array of String the URLs
3437 public function getSquidURLs() {
3438 $urls = array(
3439 $this->getInternalURL(),
3440 $this->getInternalURL( 'action=history' )
3443 $pageLang = $this->getPageLanguage();
3444 if ( $pageLang->hasVariants() ) {
3445 $variants = $pageLang->getVariants();
3446 foreach ( $variants as $vCode ) {
3447 $urls[] = $this->getInternalURL( '', $vCode );
3451 return $urls;
3455 * Purge all applicable Squid URLs
3457 public function purgeSquid() {
3458 global $wgUseSquid;
3459 if ( $wgUseSquid ) {
3460 $urls = $this->getSquidURLs();
3461 $u = new SquidUpdate( $urls );
3462 $u->doUpdate();
3467 * Move this page without authentication
3469 * @param $nt Title the new page Title
3470 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3472 public function moveNoAuth( &$nt ) {
3473 return $this->moveTo( $nt, false );
3477 * Check whether a given move operation would be valid.
3478 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3480 * @param $nt Title the new title
3481 * @param bool $auth indicates whether $wgUser's permissions
3482 * should be checked
3483 * @param string $reason is the log summary of the move, used for spam checking
3484 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
3486 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3487 global $wgUser, $wgContentHandlerUseDB;
3489 $errors = array();
3490 if ( !$nt ) {
3491 // Normally we'd add this to $errors, but we'll get
3492 // lots of syntax errors if $nt is not an object
3493 return array( array( 'badtitletext' ) );
3495 if ( $this->equals( $nt ) ) {
3496 $errors[] = array( 'selfmove' );
3498 if ( !$this->isMovable() ) {
3499 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3501 if ( $nt->getInterwiki() != '' ) {
3502 $errors[] = array( 'immobile-target-namespace-iw' );
3504 if ( !$nt->isMovable() ) {
3505 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3508 $oldid = $this->getArticleID();
3509 $newid = $nt->getArticleID();
3511 if ( strlen( $nt->getDBkey() ) < 1 ) {
3512 $errors[] = array( 'articleexists' );
3514 if (
3515 ( $this->getDBkey() == '' ) ||
3516 ( !$oldid ) ||
3517 ( $nt->getDBkey() == '' )
3519 $errors[] = array( 'badarticleerror' );
3522 // Content model checks
3523 if ( !$wgContentHandlerUseDB &&
3524 $this->getContentModel() !== $nt->getContentModel() ) {
3525 // can't move a page if that would change the page's content model
3526 $errors[] = array(
3527 'bad-target-model',
3528 ContentHandler::getLocalizedName( $this->getContentModel() ),
3529 ContentHandler::getLocalizedName( $nt->getContentModel() )
3533 // Image-specific checks
3534 if ( $this->getNamespace() == NS_FILE ) {
3535 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3538 if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) {
3539 $errors[] = array( 'nonfile-cannot-move-to-file' );
3542 if ( $auth ) {
3543 $errors = wfMergeErrorArrays( $errors,
3544 $this->getUserPermissionsErrors( 'move', $wgUser ),
3545 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3546 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3547 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3550 $match = EditPage::matchSummarySpamRegex( $reason );
3551 if ( $match !== false ) {
3552 // This is kind of lame, won't display nice
3553 $errors[] = array( 'spamprotectiontext' );
3556 $err = null;
3557 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3558 $errors[] = array( 'hookaborted', $err );
3561 # The move is allowed only if (1) the target doesn't exist, or
3562 # (2) the target is a redirect to the source, and has no history
3563 # (so we can undo bad moves right after they're done).
3565 if ( 0 != $newid ) { # Target exists; check for validity
3566 if ( !$this->isValidMoveTarget( $nt ) ) {
3567 $errors[] = array( 'articleexists' );
3569 } else {
3570 $tp = $nt->getTitleProtection();
3571 $right = ( $tp['pt_create_perm'] == 'sysop' ) ? 'protect' : $tp['pt_create_perm'];
3572 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3573 $errors[] = array( 'cantmove-titleprotected' );
3576 if ( empty( $errors ) ) {
3577 return true;
3579 return $errors;
3583 * Check if the requested move target is a valid file move target
3584 * @param Title $nt Target title
3585 * @return array List of errors
3587 protected function validateFileMoveOperation( $nt ) {
3588 global $wgUser;
3590 $errors = array();
3592 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3594 $file = wfLocalFile( $this );
3595 if ( $file->exists() ) {
3596 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3597 $errors[] = array( 'imageinvalidfilename' );
3599 if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3600 $errors[] = array( 'imagetypemismatch' );
3604 if ( $nt->getNamespace() != NS_FILE ) {
3605 $errors[] = array( 'imagenocrossnamespace' );
3606 // From here we want to do checks on a file object, so if we can't
3607 // create one, we must return.
3608 return $errors;
3611 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3613 $destFile = wfLocalFile( $nt );
3614 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3615 $errors[] = array( 'file-exists-sharedrepo' );
3618 return $errors;
3622 * Move a title to a new location
3624 * @param $nt Title the new title
3625 * @param bool $auth indicates whether $wgUser's permissions
3626 * should be checked
3627 * @param string $reason the reason for the move
3628 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3629 * Ignored if the user doesn't have the suppressredirect right.
3630 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3632 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3633 global $wgUser;
3634 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3635 if ( is_array( $err ) ) {
3636 // Auto-block user's IP if the account was "hard" blocked
3637 $wgUser->spreadAnyEditBlock();
3638 return $err;
3640 // Check suppressredirect permission
3641 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3642 $createRedirect = true;
3645 // If it is a file, move it first.
3646 // It is done before all other moving stuff is done because it's hard to revert.
3647 $dbw = wfGetDB( DB_MASTER );
3648 if ( $this->getNamespace() == NS_FILE ) {
3649 $file = wfLocalFile( $this );
3650 if ( $file->exists() ) {
3651 $status = $file->move( $nt );
3652 if ( !$status->isOk() ) {
3653 return $status->getErrorsArray();
3656 // Clear RepoGroup process cache
3657 RepoGroup::singleton()->clearCache( $this );
3658 RepoGroup::singleton()->clearCache( $nt ); # clear false negative cache
3661 $dbw->begin( __METHOD__ ); # If $file was a LocalFile, its transaction would have closed our own.
3662 $pageid = $this->getArticleID( self::GAID_FOR_UPDATE );
3663 $protected = $this->isProtected();
3665 // Do the actual move
3666 $this->moveToInternal( $nt, $reason, $createRedirect );
3668 // Refresh the sortkey for this row. Be careful to avoid resetting
3669 // cl_timestamp, which may disturb time-based lists on some sites.
3670 $prefixes = $dbw->select(
3671 'categorylinks',
3672 array( 'cl_sortkey_prefix', 'cl_to' ),
3673 array( 'cl_from' => $pageid ),
3674 __METHOD__
3676 foreach ( $prefixes as $prefixRow ) {
3677 $prefix = $prefixRow->cl_sortkey_prefix;
3678 $catTo = $prefixRow->cl_to;
3679 $dbw->update( 'categorylinks',
3680 array(
3681 'cl_sortkey' => Collation::singleton()->getSortKey(
3682 $nt->getCategorySortkey( $prefix ) ),
3683 'cl_timestamp=cl_timestamp' ),
3684 array(
3685 'cl_from' => $pageid,
3686 'cl_to' => $catTo ),
3687 __METHOD__
3691 $redirid = $this->getArticleID();
3693 if ( $protected ) {
3694 # Protect the redirect title as the title used to be...
3695 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3696 array(
3697 'pr_page' => $redirid,
3698 'pr_type' => 'pr_type',
3699 'pr_level' => 'pr_level',
3700 'pr_cascade' => 'pr_cascade',
3701 'pr_user' => 'pr_user',
3702 'pr_expiry' => 'pr_expiry'
3704 array( 'pr_page' => $pageid ),
3705 __METHOD__,
3706 array( 'IGNORE' )
3708 # Update the protection log
3709 $log = new LogPage( 'protect' );
3710 $comment = wfMessage(
3711 'prot_1movedto2',
3712 $this->getPrefixedText(),
3713 $nt->getPrefixedText()
3714 )->inContentLanguage()->text();
3715 if ( $reason ) {
3716 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3718 // @todo FIXME: $params?
3719 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) );
3722 # Update watchlists
3723 $oldnamespace = MWNamespace::getSubject( $this->getNamespace() );
3724 $newnamespace = MWNamespace::getSubject( $nt->getNamespace() );
3725 $oldtitle = $this->getDBkey();
3726 $newtitle = $nt->getDBkey();
3728 if ( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
3729 WatchedItem::duplicateEntries( $this, $nt );
3732 $dbw->commit( __METHOD__ );
3734 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3735 return true;
3739 * Move page to a title which is either a redirect to the
3740 * source page or nonexistent
3742 * @param $nt Title the page to move to, which should be a redirect or nonexistent
3743 * @param string $reason The reason for the move
3744 * @param bool $createRedirect Whether to leave a redirect at the old title. Does not check
3745 * if the user has the suppressredirect right
3746 * @throws MWException
3748 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3749 global $wgUser, $wgContLang;
3751 if ( $nt->exists() ) {
3752 $moveOverRedirect = true;
3753 $logType = 'move_redir';
3754 } else {
3755 $moveOverRedirect = false;
3756 $logType = 'move';
3759 if ( $createRedirect ) {
3760 $contentHandler = ContentHandler::getForTitle( $this );
3761 $redirectContent = $contentHandler->makeRedirectContent( $nt );
3763 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
3764 } else {
3765 $redirectContent = null;
3768 $logEntry = new ManualLogEntry( 'move', $logType );
3769 $logEntry->setPerformer( $wgUser );
3770 $logEntry->setTarget( $this );
3771 $logEntry->setComment( $reason );
3772 $logEntry->setParameters( array(
3773 '4::target' => $nt->getPrefixedText(),
3774 '5::noredir' => $redirectContent ? '0': '1',
3775 ) );
3777 $formatter = LogFormatter::newFromEntry( $logEntry );
3778 $formatter->setContext( RequestContext::newExtraneousContext( $this ) );
3779 $comment = $formatter->getPlainActionText();
3780 if ( $reason ) {
3781 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3783 # Truncate for whole multibyte characters.
3784 $comment = $wgContLang->truncate( $comment, 255 );
3786 $oldid = $this->getArticleID();
3788 $dbw = wfGetDB( DB_MASTER );
3790 $newpage = WikiPage::factory( $nt );
3792 if ( $moveOverRedirect ) {
3793 $newid = $nt->getArticleID();
3795 # Delete the old redirect. We don't save it to history since
3796 # by definition if we've got here it's rather uninteresting.
3797 # We have to remove it so that the next step doesn't trigger
3798 # a conflict on the unique namespace+title index...
3799 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ );
3801 $newpage->doDeleteUpdates( $newid );
3804 # Save a null revision in the page's history notifying of the move
3805 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
3806 if ( !is_object( $nullRevision ) ) {
3807 throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
3810 $nullRevision->insertOn( $dbw );
3812 # Change the name of the target page:
3813 $dbw->update( 'page',
3814 /* SET */ array(
3815 'page_namespace' => $nt->getNamespace(),
3816 'page_title' => $nt->getDBkey(),
3818 /* WHERE */ array( 'page_id' => $oldid ),
3819 __METHOD__
3822 $this->resetArticleID( 0 );
3823 $nt->resetArticleID( $oldid );
3824 $newpage->loadPageData( WikiPage::READ_LOCKING ); // bug 46397
3826 $newpage->updateRevisionOn( $dbw, $nullRevision );
3828 wfRunHooks( 'NewRevisionFromEditComplete',
3829 array( $newpage, $nullRevision, $nullRevision->getParentId(), $wgUser ) );
3831 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3833 if ( !$moveOverRedirect ) {
3834 WikiPage::onArticleCreate( $nt );
3837 # Recreate the redirect, this time in the other direction.
3838 if ( !$redirectContent ) {
3839 WikiPage::onArticleDelete( $this );
3840 } else {
3841 $redirectArticle = WikiPage::factory( $this );
3842 $redirectArticle->loadFromRow( false, WikiPage::READ_LOCKING ); // bug 46397
3843 $newid = $redirectArticle->insertOn( $dbw );
3844 if ( $newid ) { // sanity
3845 $redirectRevision = new Revision( array(
3846 'title' => $this, // for determining the default content model
3847 'page' => $newid,
3848 'comment' => $comment,
3849 'content' => $redirectContent ) );
3850 $redirectRevision->insertOn( $dbw );
3851 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3853 wfRunHooks( 'NewRevisionFromEditComplete',
3854 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3856 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3860 # Log the move
3861 $logid = $logEntry->insert();
3862 $logEntry->publish( $logid );
3866 * Move this page's subpages to be subpages of $nt
3868 * @param $nt Title Move target
3869 * @param bool $auth Whether $wgUser's permissions should be checked
3870 * @param string $reason The reason for the move
3871 * @param bool $createRedirect Whether to create redirects from the old subpages to
3872 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3873 * @return mixed array with old page titles as keys, and strings (new page titles) or
3874 * arrays (errors) as values, or an error array with numeric indices if no pages
3875 * were moved
3877 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3878 global $wgMaximumMovedPages;
3879 // Check permissions
3880 if ( !$this->userCan( 'move-subpages' ) ) {
3881 return array( 'cant-move-subpages' );
3883 // Do the source and target namespaces support subpages?
3884 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
3885 return array( 'namespace-nosubpages',
3886 MWNamespace::getCanonicalName( $this->getNamespace() ) );
3888 if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) {
3889 return array( 'namespace-nosubpages',
3890 MWNamespace::getCanonicalName( $nt->getNamespace() ) );
3893 $subpages = $this->getSubpages( $wgMaximumMovedPages + 1 );
3894 $retval = array();
3895 $count = 0;
3896 foreach ( $subpages as $oldSubpage ) {
3897 $count++;
3898 if ( $count > $wgMaximumMovedPages ) {
3899 $retval[$oldSubpage->getPrefixedTitle()] =
3900 array( 'movepage-max-pages',
3901 $wgMaximumMovedPages );
3902 break;
3905 // We don't know whether this function was called before
3906 // or after moving the root page, so check both
3907 // $this and $nt
3908 if ( $oldSubpage->getArticleID() == $this->getArticleID() ||
3909 $oldSubpage->getArticleID() == $nt->getArticleID() )
3911 // When moving a page to a subpage of itself,
3912 // don't move it twice
3913 continue;
3915 $newPageName = preg_replace(
3916 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3917 StringUtils::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3918 $oldSubpage->getDBkey() );
3919 if ( $oldSubpage->isTalkPage() ) {
3920 $newNs = $nt->getTalkPage()->getNamespace();
3921 } else {
3922 $newNs = $nt->getSubjectPage()->getNamespace();
3924 # Bug 14385: we need makeTitleSafe because the new page names may
3925 # be longer than 255 characters.
3926 $newSubpage = Title::makeTitleSafe( $newNs, $newPageName );
3928 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3929 if ( $success === true ) {
3930 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3931 } else {
3932 $retval[$oldSubpage->getPrefixedText()] = $success;
3935 return $retval;
3939 * Checks if this page is just a one-rev redirect.
3940 * Adds lock, so don't use just for light purposes.
3942 * @return Bool
3944 public function isSingleRevRedirect() {
3945 global $wgContentHandlerUseDB;
3947 $dbw = wfGetDB( DB_MASTER );
3949 # Is it a redirect?
3950 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
3951 if ( $wgContentHandlerUseDB ) {
3952 $fields[] = 'page_content_model';
3955 $row = $dbw->selectRow( 'page',
3956 $fields,
3957 $this->pageCond(),
3958 __METHOD__,
3959 array( 'FOR UPDATE' )
3961 # Cache some fields we may want
3962 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
3963 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
3964 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
3965 $this->mContentModel = $row && isset( $row->page_content_model ) ? strval( $row->page_content_model ) : false;
3966 if ( !$this->mRedirect ) {
3967 return false;
3969 # Does the article have a history?
3970 $row = $dbw->selectField( array( 'page', 'revision' ),
3971 'rev_id',
3972 array( 'page_namespace' => $this->getNamespace(),
3973 'page_title' => $this->getDBkey(),
3974 'page_id=rev_page',
3975 'page_latest != rev_id'
3977 __METHOD__,
3978 array( 'FOR UPDATE' )
3980 # Return true if there was no history
3981 return ( $row === false );
3985 * Checks if $this can be moved to a given Title
3986 * - Selects for update, so don't call it unless you mean business
3988 * @param $nt Title the new title to check
3989 * @return Bool
3991 public function isValidMoveTarget( $nt ) {
3992 # Is it an existing file?
3993 if ( $nt->getNamespace() == NS_FILE ) {
3994 $file = wfLocalFile( $nt );
3995 if ( $file->exists() ) {
3996 wfDebug( __METHOD__ . ": file exists\n" );
3997 return false;
4000 # Is it a redirect with no history?
4001 if ( !$nt->isSingleRevRedirect() ) {
4002 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
4003 return false;
4005 # Get the article text
4006 $rev = Revision::newFromTitle( $nt, false, Revision::READ_LATEST );
4007 if ( !is_object( $rev ) ) {
4008 return false;
4010 $content = $rev->getContent();
4011 # Does the redirect point to the source?
4012 # Or is it a broken self-redirect, usually caused by namespace collisions?
4013 $redirTitle = $content ? $content->getRedirectTarget() : null;
4015 if ( $redirTitle ) {
4016 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
4017 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
4018 wfDebug( __METHOD__ . ": redirect points to other page\n" );
4019 return false;
4020 } else {
4021 return true;
4023 } else {
4024 # Fail safe (not a redirect after all. strange.)
4025 wfDebug( __METHOD__ . ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4026 " is a redirect, but it doesn't contain a valid redirect.\n" );
4027 return false;
4032 * Get categories to which this Title belongs and return an array of
4033 * categories' names.
4035 * @return Array of parents in the form:
4036 * $parent => $currentarticle
4038 public function getParentCategories() {
4039 global $wgContLang;
4041 $data = array();
4043 $titleKey = $this->getArticleID();
4045 if ( $titleKey === 0 ) {
4046 return $data;
4049 $dbr = wfGetDB( DB_SLAVE );
4051 $res = $dbr->select(
4052 'categorylinks',
4053 'cl_to',
4054 array( 'cl_from' => $titleKey ),
4055 __METHOD__
4058 if ( $res->numRows() > 0 ) {
4059 foreach ( $res as $row ) {
4060 // $data[] = Title::newFromText($wgContLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
4061 $data[$wgContLang->getNsText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText();
4064 return $data;
4068 * Get a tree of parent categories
4070 * @param array $children with the children in the keys, to check for circular refs
4071 * @return Array Tree of parent categories
4073 public function getParentCategoryTree( $children = array() ) {
4074 $stack = array();
4075 $parents = $this->getParentCategories();
4077 if ( $parents ) {
4078 foreach ( $parents as $parent => $current ) {
4079 if ( array_key_exists( $parent, $children ) ) {
4080 # Circular reference
4081 $stack[$parent] = array();
4082 } else {
4083 $nt = Title::newFromText( $parent );
4084 if ( $nt ) {
4085 $stack[$parent] = $nt->getParentCategoryTree( $children + array( $parent => 1 ) );
4091 return $stack;
4095 * Get an associative array for selecting this title from
4096 * the "page" table
4098 * @return Array suitable for the $where parameter of DB::select()
4100 public function pageCond() {
4101 if ( $this->mArticleID > 0 ) {
4102 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4103 return array( 'page_id' => $this->mArticleID );
4104 } else {
4105 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
4110 * Get the revision ID of the previous revision
4112 * @param int $revId Revision ID. Get the revision that was before this one.
4113 * @param int $flags Title::GAID_FOR_UPDATE
4114 * @return Int|Bool Old revision ID, or FALSE if none exists
4116 public function getPreviousRevisionID( $revId, $flags = 0 ) {
4117 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4118 $revId = $db->selectField( 'revision', 'rev_id',
4119 array(
4120 'rev_page' => $this->getArticleID( $flags ),
4121 'rev_id < ' . intval( $revId )
4123 __METHOD__,
4124 array( 'ORDER BY' => 'rev_id DESC' )
4127 if ( $revId === false ) {
4128 return false;
4129 } else {
4130 return intval( $revId );
4135 * Get the revision ID of the next revision
4137 * @param int $revId Revision ID. Get the revision that was after this one.
4138 * @param int $flags Title::GAID_FOR_UPDATE
4139 * @return Int|Bool Next revision ID, or FALSE if none exists
4141 public function getNextRevisionID( $revId, $flags = 0 ) {
4142 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4143 $revId = $db->selectField( 'revision', 'rev_id',
4144 array(
4145 'rev_page' => $this->getArticleID( $flags ),
4146 'rev_id > ' . intval( $revId )
4148 __METHOD__,
4149 array( 'ORDER BY' => 'rev_id' )
4152 if ( $revId === false ) {
4153 return false;
4154 } else {
4155 return intval( $revId );
4160 * Get the first revision of the page
4162 * @param int $flags Title::GAID_FOR_UPDATE
4163 * @return Revision|Null if page doesn't exist
4165 public function getFirstRevision( $flags = 0 ) {
4166 $pageId = $this->getArticleID( $flags );
4167 if ( $pageId ) {
4168 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4169 $row = $db->selectRow( 'revision', Revision::selectFields(),
4170 array( 'rev_page' => $pageId ),
4171 __METHOD__,
4172 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
4174 if ( $row ) {
4175 return new Revision( $row );
4178 return null;
4182 * Get the oldest revision timestamp of this page
4184 * @param int $flags Title::GAID_FOR_UPDATE
4185 * @return String: MW timestamp
4187 public function getEarliestRevTime( $flags = 0 ) {
4188 $rev = $this->getFirstRevision( $flags );
4189 return $rev ? $rev->getTimestamp() : null;
4193 * Check if this is a new page
4195 * @return bool
4197 public function isNewPage() {
4198 $dbr = wfGetDB( DB_SLAVE );
4199 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
4203 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4205 * @return bool
4207 public function isBigDeletion() {
4208 global $wgDeleteRevisionsLimit;
4210 if ( !$wgDeleteRevisionsLimit ) {
4211 return false;
4214 $revCount = $this->estimateRevisionCount();
4215 return $revCount > $wgDeleteRevisionsLimit;
4219 * Get the approximate revision count of this page.
4221 * @return int
4223 public function estimateRevisionCount() {
4224 if ( !$this->exists() ) {
4225 return 0;
4228 if ( $this->mEstimateRevisions === null ) {
4229 $dbr = wfGetDB( DB_SLAVE );
4230 $this->mEstimateRevisions = $dbr->estimateRowCount( 'revision', '*',
4231 array( 'rev_page' => $this->getArticleID() ), __METHOD__ );
4234 return $this->mEstimateRevisions;
4238 * Get the number of revisions between the given revision.
4239 * Used for diffs and other things that really need it.
4241 * @param int|Revision $old Old revision or rev ID (first before range)
4242 * @param int|Revision $new New revision or rev ID (first after range)
4243 * @return Int Number of revisions between these revisions.
4245 public function countRevisionsBetween( $old, $new ) {
4246 if ( !( $old instanceof Revision ) ) {
4247 $old = Revision::newFromTitle( $this, (int)$old );
4249 if ( !( $new instanceof Revision ) ) {
4250 $new = Revision::newFromTitle( $this, (int)$new );
4252 if ( !$old || !$new ) {
4253 return 0; // nothing to compare
4255 $dbr = wfGetDB( DB_SLAVE );
4256 return (int)$dbr->selectField( 'revision', 'count(*)',
4257 array(
4258 'rev_page' => $this->getArticleID(),
4259 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4260 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4262 __METHOD__
4267 * Get the number of authors between the given revisions or revision IDs.
4268 * Used for diffs and other things that really need it.
4270 * @param int|Revision $old Old revision or rev ID (first before range by default)
4271 * @param int|Revision $new New revision or rev ID (first after range by default)
4272 * @param int $limit Maximum number of authors
4273 * @param string|array $options (Optional): Single option, or an array of options:
4274 * 'include_old' Include $old in the range; $new is excluded.
4275 * 'include_new' Include $new in the range; $old is excluded.
4276 * 'include_both' Include both $old and $new in the range.
4277 * Unknown option values are ignored.
4278 * @return int Number of revision authors in the range; zero if not both revisions exist
4280 public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4281 if ( !( $old instanceof Revision ) ) {
4282 $old = Revision::newFromTitle( $this, (int)$old );
4284 if ( !( $new instanceof Revision ) ) {
4285 $new = Revision::newFromTitle( $this, (int)$new );
4287 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4288 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4289 // in the sanity check below?
4290 if ( !$old || !$new ) {
4291 return 0; // nothing to compare
4293 $old_cmp = '>';
4294 $new_cmp = '<';
4295 $options = (array)$options;
4296 if ( in_array( 'include_old', $options ) ) {
4297 $old_cmp = '>=';
4299 if ( in_array( 'include_new', $options ) ) {
4300 $new_cmp = '<=';
4302 if ( in_array( 'include_both', $options ) ) {
4303 $old_cmp = '>=';
4304 $new_cmp = '<=';
4306 // No DB query needed if $old and $new are the same or successive revisions:
4307 if ( $old->getId() === $new->getId() ) {
4308 return ( $old_cmp === '>' && $new_cmp === '<' ) ? 0 : 1;
4309 } elseif ( $old->getId() === $new->getParentId() ) {
4310 if ( $old_cmp === '>' || $new_cmp === '<' ) {
4311 return ( $old_cmp === '>' && $new_cmp === '<' ) ? 0 : 1;
4313 return ( $old->getRawUserText() === $new->getRawUserText() ) ? 1 : 2;
4315 $dbr = wfGetDB( DB_SLAVE );
4316 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4317 array(
4318 'rev_page' => $this->getArticleID(),
4319 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4320 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4321 ), __METHOD__,
4322 array( 'LIMIT' => $limit + 1 ) // add one so caller knows it was truncated
4324 return (int)$dbr->numRows( $res );
4328 * Compare with another title.
4330 * @param $title Title
4331 * @return Bool
4333 public function equals( Title $title ) {
4334 // Note: === is necessary for proper matching of number-like titles.
4335 return $this->getInterwiki() === $title->getInterwiki()
4336 && $this->getNamespace() == $title->getNamespace()
4337 && $this->getDBkey() === $title->getDBkey();
4341 * Check if this title is a subpage of another title
4343 * @param $title Title
4344 * @return Bool
4346 public function isSubpageOf( Title $title ) {
4347 return $this->getInterwiki() === $title->getInterwiki()
4348 && $this->getNamespace() == $title->getNamespace()
4349 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4353 * Check if page exists. For historical reasons, this function simply
4354 * checks for the existence of the title in the page table, and will
4355 * thus return false for interwiki links, special pages and the like.
4356 * If you want to know if a title can be meaningfully viewed, you should
4357 * probably call the isKnown() method instead.
4359 * @return Bool
4361 public function exists() {
4362 return $this->getArticleID() != 0;
4366 * Should links to this title be shown as potentially viewable (i.e. as
4367 * "bluelinks"), even if there's no record by this title in the page
4368 * table?
4370 * This function is semi-deprecated for public use, as well as somewhat
4371 * misleadingly named. You probably just want to call isKnown(), which
4372 * calls this function internally.
4374 * (ISSUE: Most of these checks are cheap, but the file existence check
4375 * can potentially be quite expensive. Including it here fixes a lot of
4376 * existing code, but we might want to add an optional parameter to skip
4377 * it and any other expensive checks.)
4379 * @return Bool
4381 public function isAlwaysKnown() {
4382 $isKnown = null;
4385 * Allows overriding default behavior for determining if a page exists.
4386 * If $isKnown is kept as null, regular checks happen. If it's
4387 * a boolean, this value is returned by the isKnown method.
4389 * @since 1.20
4391 * @param Title $title
4392 * @param boolean|null $isKnown
4394 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4396 if ( !is_null( $isKnown ) ) {
4397 return $isKnown;
4400 if ( $this->mInterwiki != '' ) {
4401 return true; // any interwiki link might be viewable, for all we know
4404 switch ( $this->mNamespace ) {
4405 case NS_MEDIA:
4406 case NS_FILE:
4407 // file exists, possibly in a foreign repo
4408 return (bool)wfFindFile( $this );
4409 case NS_SPECIAL:
4410 // valid special page
4411 return SpecialPageFactory::exists( $this->getDBkey() );
4412 case NS_MAIN:
4413 // selflink, possibly with fragment
4414 return $this->mDbkeyform == '';
4415 case NS_MEDIAWIKI:
4416 // known system message
4417 return $this->hasSourceText() !== false;
4418 default:
4419 return false;
4424 * Does this title refer to a page that can (or might) be meaningfully
4425 * viewed? In particular, this function may be used to determine if
4426 * links to the title should be rendered as "bluelinks" (as opposed to
4427 * "redlinks" to non-existent pages).
4428 * Adding something else to this function will cause inconsistency
4429 * since LinkHolderArray calls isAlwaysKnown() and does its own
4430 * page existence check.
4432 * @return Bool
4434 public function isKnown() {
4435 return $this->isAlwaysKnown() || $this->exists();
4439 * Does this page have source text?
4441 * @return Boolean
4443 public function hasSourceText() {
4444 if ( $this->exists() ) {
4445 return true;
4448 if ( $this->mNamespace == NS_MEDIAWIKI ) {
4449 // If the page doesn't exist but is a known system message, default
4450 // message content will be displayed, same for language subpages-
4451 // Use always content language to avoid loading hundreds of languages
4452 // to get the link color.
4453 global $wgContLang;
4454 list( $name, ) = MessageCache::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4455 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4456 return $message->exists();
4459 return false;
4463 * Get the default message text or false if the message doesn't exist
4465 * @return String or false
4467 public function getDefaultMessageText() {
4468 global $wgContLang;
4470 if ( $this->getNamespace() != NS_MEDIAWIKI ) { // Just in case
4471 return false;
4474 list( $name, $lang ) = MessageCache::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4475 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4477 if ( $message->exists() ) {
4478 return $message->plain();
4479 } else {
4480 return false;
4485 * Updates page_touched for this page; called from LinksUpdate.php
4487 * @return Bool true if the update succeeded
4489 public function invalidateCache() {
4490 global $wgMemc;
4492 if ( wfReadOnly() ) {
4493 return false;
4496 $method = __METHOD__;
4497 $dbw = wfGetDB( DB_MASTER );
4498 $conds = $this->pageCond();
4499 $dbw->onTransactionIdle( function() use ( $dbw, $conds, $method ) {
4500 $dbw->update(
4501 'page',
4502 array( 'page_touched' => $dbw->timestamp() ),
4503 $conds,
4504 $method
4506 } );
4507 HTMLFileCache::clearFileCache( $this );
4509 // Clear page info.
4510 $revision = WikiPage::factory( $this )->getRevision();
4511 if ( $revision !== null ) {
4512 $memcKey = wfMemcKey( 'infoaction', $this->getPrefixedText(), $revision->getId() );
4513 $success = $wgMemc->delete( $memcKey );
4514 } else {
4515 $success = true;
4518 return $success;
4522 * Update page_touched timestamps and send squid purge messages for
4523 * pages linking to this title. May be sent to the job queue depending
4524 * on the number of links. Typically called on create and delete.
4526 public function touchLinks() {
4527 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4528 $u->doUpdate();
4530 if ( $this->getNamespace() == NS_CATEGORY ) {
4531 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4532 $u->doUpdate();
4537 * Get the last touched timestamp
4539 * @param $db DatabaseBase: optional db
4540 * @return String last-touched timestamp
4542 public function getTouched( $db = null ) {
4543 $db = isset( $db ) ? $db : wfGetDB( DB_SLAVE );
4544 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
4545 return $touched;
4549 * Get the timestamp when this page was updated since the user last saw it.
4551 * @param $user User
4552 * @return String|Null
4554 public function getNotificationTimestamp( $user = null ) {
4555 global $wgUser, $wgShowUpdatedMarker;
4556 // Assume current user if none given
4557 if ( !$user ) {
4558 $user = $wgUser;
4560 // Check cache first
4561 $uid = $user->getId();
4562 // avoid isset here, as it'll return false for null entries
4563 if ( array_key_exists( $uid, $this->mNotificationTimestamp ) ) {
4564 return $this->mNotificationTimestamp[$uid];
4566 if ( !$uid || !$wgShowUpdatedMarker ) {
4567 return $this->mNotificationTimestamp[$uid] = false;
4569 // Don't cache too much!
4570 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
4571 $this->mNotificationTimestamp = array();
4573 $dbr = wfGetDB( DB_SLAVE );
4574 $this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
4575 'wl_notificationtimestamp',
4576 array(
4577 'wl_user' => $user->getId(),
4578 'wl_namespace' => $this->getNamespace(),
4579 'wl_title' => $this->getDBkey(),
4581 __METHOD__
4583 return $this->mNotificationTimestamp[$uid];
4587 * Generate strings used for xml 'id' names in monobook tabs
4589 * @param string $prepend defaults to 'nstab-'
4590 * @return String XML 'id' name
4592 public function getNamespaceKey( $prepend = 'nstab-' ) {
4593 global $wgContLang;
4594 // Gets the subject namespace if this title
4595 $namespace = MWNamespace::getSubject( $this->getNamespace() );
4596 // Checks if canonical namespace name exists for namespace
4597 if ( MWNamespace::exists( $this->getNamespace() ) ) {
4598 // Uses canonical namespace name
4599 $namespaceKey = MWNamespace::getCanonicalName( $namespace );
4600 } else {
4601 // Uses text of namespace
4602 $namespaceKey = $this->getSubjectNsText();
4604 // Makes namespace key lowercase
4605 $namespaceKey = $wgContLang->lc( $namespaceKey );
4606 // Uses main
4607 if ( $namespaceKey == '' ) {
4608 $namespaceKey = 'main';
4610 // Changes file to image for backwards compatibility
4611 if ( $namespaceKey == 'file' ) {
4612 $namespaceKey = 'image';
4614 return $prepend . $namespaceKey;
4618 * Get all extant redirects to this Title
4620 * @param int|Null $ns Single namespace to consider; NULL to consider all namespaces
4621 * @return Array of Title redirects to this title
4623 public function getRedirectsHere( $ns = null ) {
4624 $redirs = array();
4626 $dbr = wfGetDB( DB_SLAVE );
4627 $where = array(
4628 'rd_namespace' => $this->getNamespace(),
4629 'rd_title' => $this->getDBkey(),
4630 'rd_from = page_id'
4632 if ( $this->isExternal() ) {
4633 $where['rd_interwiki'] = $this->getInterwiki();
4634 } else {
4635 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4637 if ( !is_null( $ns ) ) {
4638 $where['page_namespace'] = $ns;
4641 $res = $dbr->select(
4642 array( 'redirect', 'page' ),
4643 array( 'page_namespace', 'page_title' ),
4644 $where,
4645 __METHOD__
4648 foreach ( $res as $row ) {
4649 $redirs[] = self::newFromRow( $row );
4651 return $redirs;
4655 * Check if this Title is a valid redirect target
4657 * @return Bool
4659 public function isValidRedirectTarget() {
4660 global $wgInvalidRedirectTargets;
4662 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4663 if ( $this->isSpecial( 'Userlogout' ) ) {
4664 return false;
4667 foreach ( $wgInvalidRedirectTargets as $target ) {
4668 if ( $this->isSpecial( $target ) ) {
4669 return false;
4673 return true;
4677 * Get a backlink cache object
4679 * @return BacklinkCache
4681 public function getBacklinkCache() {
4682 return BacklinkCache::get( $this );
4686 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4688 * @return Boolean
4690 public function canUseNoindex() {
4691 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4693 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4694 ? $wgContentNamespaces
4695 : $wgExemptFromUserRobotsControl;
4697 return !in_array( $this->mNamespace, $bannedNamespaces );
4702 * Returns the raw sort key to be used for categories, with the specified
4703 * prefix. This will be fed to Collation::getSortKey() to get a
4704 * binary sortkey that can be used for actual sorting.
4706 * @param string $prefix The prefix to be used, specified using
4707 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4708 * prefix.
4709 * @return string
4711 public function getCategorySortkey( $prefix = '' ) {
4712 $unprefixed = $this->getText();
4714 // Anything that uses this hook should only depend
4715 // on the Title object passed in, and should probably
4716 // tell the users to run updateCollations.php --force
4717 // in order to re-sort existing category relations.
4718 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4719 if ( $prefix !== '' ) {
4720 # Separate with a line feed, so the unprefixed part is only used as
4721 # a tiebreaker when two pages have the exact same prefix.
4722 # In UCA, tab is the only character that can sort above LF
4723 # so we strip both of them from the original prefix.
4724 $prefix = strtr( $prefix, "\n\t", ' ' );
4725 return "$prefix\n$unprefixed";
4727 return $unprefixed;
4731 * Get the language in which the content of this page is written in
4732 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4733 * e.g. $wgLang (such as special pages, which are in the user language).
4735 * @since 1.18
4736 * @return Language
4738 public function getPageLanguage() {
4739 global $wgLang;
4740 if ( $this->isSpecialPage() ) {
4741 // special pages are in the user language
4742 return $wgLang;
4745 //TODO: use the LinkCache to cache this! Note that this may depend on user settings, so the cache should be only per-request.
4746 //NOTE: ContentHandler::getPageLanguage() may need to load the content to determine the page language!
4747 $contentHandler = ContentHandler::getForTitle( $this );
4748 $pageLang = $contentHandler->getPageLanguage( $this );
4750 return wfGetLangObj( $pageLang );
4754 * Get the language in which the content of this page is written when
4755 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4756 * e.g. $wgLang (such as special pages, which are in the user language).
4758 * @since 1.20
4759 * @return Language
4761 public function getPageViewLanguage() {
4762 global $wgLang;
4764 if ( $this->isSpecialPage() ) {
4765 // If the user chooses a variant, the content is actually
4766 // in a language whose code is the variant code.
4767 $variant = $wgLang->getPreferredVariant();
4768 if ( $wgLang->getCode() !== $variant ) {
4769 return Language::factory( $variant );
4772 return $wgLang;
4775 //NOTE: can't be cached persistently, depends on user settings
4776 //NOTE: ContentHandler::getPageViewLanguage() may need to load the content to determine the page language!
4777 $contentHandler = ContentHandler::getForTitle( $this );
4778 $pageLang = $contentHandler->getPageViewLanguage( $this );
4779 return $pageLang;
4783 * Get a list of rendered edit notices for this page.
4785 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4786 * they will already be wrapped in paragraphs.
4788 * @since 1.21
4789 * @return Array
4791 public function getEditNotices() {
4792 $notices = array();
4794 # Optional notices on a per-namespace and per-page basis
4795 $editnotice_ns = 'editnotice-' . $this->getNamespace();
4796 $editnotice_ns_message = wfMessage( $editnotice_ns );
4797 if ( $editnotice_ns_message->exists() ) {
4798 $notices[$editnotice_ns] = $editnotice_ns_message->parseAsBlock();
4800 if ( MWNamespace::hasSubpages( $this->getNamespace() ) ) {
4801 $parts = explode( '/', $this->getDBkey() );
4802 $editnotice_base = $editnotice_ns;
4803 while ( count( $parts ) > 0 ) {
4804 $editnotice_base .= '-' . array_shift( $parts );
4805 $editnotice_base_msg = wfMessage( $editnotice_base );
4806 if ( $editnotice_base_msg->exists() ) {
4807 $notices[$editnotice_base] = $editnotice_base_msg->parseAsBlock();
4810 } else {
4811 # Even if there are no subpages in namespace, we still don't want / in MW ns.
4812 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->getDBkey() );
4813 $editnoticeMsg = wfMessage( $editnoticeText );
4814 if ( $editnoticeMsg->exists() ) {
4815 $notices[$editnoticeText] = $editnoticeMsg->parseAsBlock();
4818 return $notices;