3 * Representation of a title within %MediaWiki.
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
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.
30 * @note Consider using a TitleValue object instead. TitleValue is more lightweight
31 * and does not rely on global state or the database.
33 * @internal documentation reviewed 15 Mar 2010
36 /** @var MapCacheLRU */
37 static private $titleCache = null;
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;
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;
53 * @name Private member variables
54 * Please use the accessor functions instead.
59 /** @var string Text form (spaces not underscores) of the main part */
60 public $mTextform = '';
62 /** @var string URL-encoded form of the main part */
63 public $mUrlform = '';
65 /** @var string Main part with underscores */
66 public $mDbkeyform = '';
68 /** @var string Database key with the initial letter in the case specified by the user */
69 protected $mUserCaseDBKey;
71 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
72 public $mNamespace = NS_MAIN
;
74 /** @var string Interwiki prefix */
75 public $mInterwiki = '';
77 /** @var string Title fragment (i.e. the bit after the #) */
78 public $mFragment = '';
80 /** @var int Article ID, fetched from the link cache on demand */
81 public $mArticleID = -1;
83 /** @var bool|int ID of most recent revision */
84 protected $mLatestID = false;
87 * @var bool|string ID of the page's content model, i.e. one of the
88 * CONTENT_MODEL_XXX constants
90 public $mContentModel = false;
92 /** @var int Estimated number of revisions; null of not loaded */
93 private $mEstimateRevisions;
95 /** @var array Array of groups allowed to edit this article */
96 public $mRestrictions = array();
99 protected $mOldRestrictions = false;
101 /** @var bool Cascade restrictions on this page to included templates and images? */
102 public $mCascadeRestriction;
104 /** Caching the results of getCascadeProtectionSources */
105 public $mCascadingRestrictions;
107 /** @var array When do the restrictions on this page expire? */
108 protected $mRestrictionsExpiry = array();
110 /** @var bool Are cascading restrictions in effect on this page? */
111 protected $mHasCascadingRestrictions;
113 /** @var array Where are the cascading restrictions coming from on this page? */
114 public $mCascadeSources;
116 /** @var bool Boolean for initialisation on demand */
117 public $mRestrictionsLoaded = false;
119 /** @var string Text form including namespace/interwiki, initialised on demand */
120 protected $mPrefixedText = null;
122 /** @var mixed Cached value for getTitleProtection (create protection) */
123 public $mTitleProtection;
126 * @var int Namespace index when there is no namespace. Don't change the
127 * following default, NS_MAIN is hardcoded in several places. See bug 696.
128 * Zero except in {{transclusion}} tags.
130 public $mDefaultNamespace = NS_MAIN
;
133 * @var bool Is $wgUser watching this page? null if unfilled, accessed
134 * through userIsWatching()
136 protected $mWatched = null;
138 /** @var int The page length, 0 for special pages */
139 protected $mLength = -1;
141 /** @var null Is the article at this title a redirect? */
142 public $mRedirect = null;
144 /** @var array Associative array of user ID -> timestamp/false */
145 private $mNotificationTimestamp = array();
147 /** @var bool Whether a page has any subpages */
148 private $mHasSubpages;
150 /** @var bool The (string) language code of the page's language and content code. */
151 private $mPageLanguage = false;
153 /** @var string The page language code from the database */
154 private $mDbPageLanguage = null;
156 /** @var TitleValue A corresponding TitleValue object */
157 private $mTitleValue = null;
161 * B/C kludge: provide a TitleParser for use by Title.
162 * Ideally, Title would have no methods that need this.
163 * Avoid usage of this singleton by using TitleValue
164 * and the associated services when possible.
166 * @return TitleParser
168 private static function getTitleParser() {
169 global $wgContLang, $wgLocalInterwikis;
171 static $titleCodec = null;
172 static $titleCodecFingerprint = null;
174 // $wgContLang and $wgLocalInterwikis may change (especially while testing),
175 // make sure we are using the right one. To detect changes over the course
176 // of a request, we remember a fingerprint of the config used to create the
177 // codec singleton, and re-create it if the fingerprint doesn't match.
178 $fingerprint = spl_object_hash( $wgContLang ) . '|' . join( '+', $wgLocalInterwikis );
180 if ( $fingerprint !== $titleCodecFingerprint ) {
184 if ( !$titleCodec ) {
185 $titleCodec = new MediaWikiTitleCodec(
187 GenderCache
::singleton(),
190 $titleCodecFingerprint = $fingerprint;
197 * B/C kludge: provide a TitleParser for use by Title.
198 * Ideally, Title would have no methods that need this.
199 * Avoid usage of this singleton by using TitleValue
200 * and the associated services when possible.
202 * @return TitleFormatter
204 private static function getTitleFormatter() {
205 //NOTE: we know that getTitleParser() returns a MediaWikiTitleCodec,
206 // which implements TitleFormatter.
207 return self
::getTitleParser();
210 function __construct() {
214 * Create a new Title from a prefixed DB key
216 * @param string $key The database key, which has underscores
217 * instead of spaces, possibly including namespace and
219 * @return Title|null Title, or null on an error
221 public static function newFromDBkey( $key ) {
223 $t->mDbkeyform
= $key;
224 if ( $t->secureAndSplit() ) {
232 * Create a new Title from a TitleValue
234 * @param TitleValue $titleValue Assumed to be safe.
238 public static function newFromTitleValue( TitleValue
$titleValue ) {
239 return self
::makeTitle(
240 $titleValue->getNamespace(),
241 $titleValue->getText(),
242 $titleValue->getFragment() );
246 * Create a new Title from text, such as what one would find in a link. De-
247 * codes any HTML entities in the text.
249 * @param string $text The link text; spaces, prefixes, and an
250 * initial ':' indicating the main namespace are accepted.
251 * @param int $defaultNamespace The namespace to use if none is specified
252 * by a prefix. If you want to force a specific namespace even if
253 * $text might begin with a namespace prefix, use makeTitle() or
255 * @throws MWException
256 * @return Title|null Title or null on an error.
258 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
259 if ( is_object( $text ) ) {
260 throw new MWException( 'Title::newFromText given an object' );
263 $cache = self
::getTitleCache();
266 * Wiki pages often contain multiple links to the same page.
267 * Title normalization and parsing can become expensive on
268 * pages with many links, so we can save a little time by
271 * In theory these are value objects and won't get changed...
273 if ( $defaultNamespace == NS_MAIN
&& $cache->has( $text ) ) {
274 return $cache->get( $text );
277 # Convert things like é ā or 〗 into normalized (bug 14952) text
278 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
281 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
282 $t->mDefaultNamespace
= intval( $defaultNamespace );
284 if ( $t->secureAndSplit() ) {
285 if ( $defaultNamespace == NS_MAIN
) {
286 $cache->set( $text, $t );
295 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
297 * Example of wrong and broken code:
298 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
300 * Example of right code:
301 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
303 * Create a new Title from URL-encoded text. Ensures that
304 * the given title's length does not exceed the maximum.
306 * @param string $url The title, as might be taken from a URL
307 * @return Title|null The new object, or null on an error
309 public static function newFromURL( $url ) {
312 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
313 # but some URLs used it as a space replacement and they still come
314 # from some external search tools.
315 if ( strpos( self
::legalChars(), '+' ) === false ) {
316 $url = str_replace( '+', ' ', $url );
319 $t->mDbkeyform
= str_replace( ' ', '_', $url );
320 if ( $t->secureAndSplit() ) {
328 * @return MapCacheLRU
330 private static function getTitleCache() {
331 if ( self
::$titleCache == null ) {
332 self
::$titleCache = new MapCacheLRU( self
::CACHE_MAX
);
334 return self
::$titleCache;
338 * Returns a list of fields that are to be selected for initializing Title
339 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
340 * whether to include page_content_model.
344 protected static function getSelectFields() {
345 global $wgContentHandlerUseDB;
348 'page_namespace', 'page_title', 'page_id',
349 'page_len', 'page_is_redirect', 'page_latest',
352 if ( $wgContentHandlerUseDB ) {
353 $fields[] = 'page_content_model';
360 * Create a new Title from an article ID
362 * @param int $id The page_id corresponding to the Title to create
363 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
364 * @return Title|null The new object, or null on an error
366 public static function newFromID( $id, $flags = 0 ) {
367 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
368 $row = $db->selectRow(
370 self
::getSelectFields(),
371 array( 'page_id' => $id ),
374 if ( $row !== false ) {
375 $title = Title
::newFromRow( $row );
383 * Make an array of titles from an array of IDs
385 * @param int[] $ids Array of IDs
386 * @return Title[] Array of Titles
388 public static function newFromIDs( $ids ) {
389 if ( !count( $ids ) ) {
392 $dbr = wfGetDB( DB_SLAVE
);
396 self
::getSelectFields(),
397 array( 'page_id' => $ids ),
402 foreach ( $res as $row ) {
403 $titles[] = Title
::newFromRow( $row );
409 * Make a Title object from a DB row
411 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
412 * @return Title Corresponding Title
414 public static function newFromRow( $row ) {
415 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
416 $t->loadFromRow( $row );
421 * Load Title object fields from a DB row.
422 * If false is given, the title will be treated as non-existing.
424 * @param stdClass|bool $row Database row
426 public function loadFromRow( $row ) {
427 if ( $row ) { // page found
428 if ( isset( $row->page_id
) ) {
429 $this->mArticleID
= (int)$row->page_id
;
431 if ( isset( $row->page_len
) ) {
432 $this->mLength
= (int)$row->page_len
;
434 if ( isset( $row->page_is_redirect
) ) {
435 $this->mRedirect
= (bool)$row->page_is_redirect
;
437 if ( isset( $row->page_latest
) ) {
438 $this->mLatestID
= (int)$row->page_latest
;
440 if ( isset( $row->page_content_model
) ) {
441 $this->mContentModel
= strval( $row->page_content_model
);
443 $this->mContentModel
= false; # initialized lazily in getContentModel()
445 if ( isset( $row->page_lang
) ) {
446 $this->mDbPageLanguage
= (string)$row->page_lang
;
448 } else { // page not found
449 $this->mArticleID
= 0;
451 $this->mRedirect
= false;
452 $this->mLatestID
= 0;
453 $this->mContentModel
= false; # initialized lazily in getContentModel()
458 * Create a new Title from a namespace index and a DB key.
459 * It's assumed that $ns and $title are *valid*, for instance when
460 * they came directly from the database or a special page name.
461 * For convenience, spaces are converted to underscores so that
462 * eg user_text fields can be used directly.
464 * @param int $ns The namespace of the article
465 * @param string $title The unprefixed database key form
466 * @param string $fragment The link fragment (after the "#")
467 * @param string $interwiki The interwiki prefix
468 * @return Title The new object
470 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
472 $t->mInterwiki
= $interwiki;
473 $t->mFragment
= $fragment;
474 $t->mNamespace
= $ns = intval( $ns );
475 $t->mDbkeyform
= str_replace( ' ', '_', $title );
476 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
477 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
478 $t->mTextform
= str_replace( '_', ' ', $title );
479 $t->mContentModel
= false; # initialized lazily in getContentModel()
484 * Create a new Title from a namespace index and a DB key.
485 * The parameters will be checked for validity, which is a bit slower
486 * than makeTitle() but safer for user-provided data.
488 * @param int $ns The namespace of the article
489 * @param string $title Database key form
490 * @param string $fragment The link fragment (after the "#")
491 * @param string $interwiki Interwiki prefix
492 * @return Title The new object, or null on an error
494 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
495 if ( !MWNamespace
::exists( $ns ) ) {
500 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki );
501 if ( $t->secureAndSplit() ) {
509 * Create a new Title for the Main Page
511 * @return Title The new object
513 public static function newMainPage() {
514 $title = Title
::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
515 // Don't give fatal errors if the message is broken
517 $title = Title
::newFromText( 'Main Page' );
523 * Extract a redirect destination from a string and return the
524 * Title, or null if the text doesn't contain a valid redirect
525 * This will only return the very next target, useful for
526 * the redirect table and other checks that don't need full recursion
528 * @param string $text Text with possible redirect
529 * @return Title The corresponding Title
530 * @deprecated since 1.21, use Content::getRedirectTarget instead.
532 public static function newFromRedirect( $text ) {
533 ContentHandler
::deprecated( __METHOD__
, '1.21' );
535 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
536 return $content->getRedirectTarget();
540 * Extract a redirect destination from a string and return the
541 * Title, or null if the text doesn't contain a valid redirect
542 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
543 * in order to provide (hopefully) the Title of the final destination instead of another redirect
545 * @param string $text Text with possible redirect
547 * @deprecated since 1.21, use Content::getUltimateRedirectTarget instead.
549 public static function newFromRedirectRecurse( $text ) {
550 ContentHandler
::deprecated( __METHOD__
, '1.21' );
552 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
553 return $content->getUltimateRedirectTarget();
557 * Extract a redirect destination from a string and return an
558 * array of Titles, or null if the text doesn't contain a valid redirect
559 * The last element in the array is the final destination after all redirects
560 * have been resolved (up to $wgMaxRedirects times)
562 * @param string $text Text with possible redirect
563 * @return Title[] Array of Titles, with the destination last
564 * @deprecated since 1.21, use Content::getRedirectChain instead.
566 public static function newFromRedirectArray( $text ) {
567 ContentHandler
::deprecated( __METHOD__
, '1.21' );
569 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
570 return $content->getRedirectChain();
574 * Get the prefixed DB key associated with an ID
576 * @param int $id The page_id of the article
577 * @return Title|null An object representing the article, or null if no such article was found
579 public static function nameOf( $id ) {
580 $dbr = wfGetDB( DB_SLAVE
);
582 $s = $dbr->selectRow(
584 array( 'page_namespace', 'page_title' ),
585 array( 'page_id' => $id ),
588 if ( $s === false ) {
592 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
597 * Get a regex character class describing the legal characters in a link
599 * @return string The list of characters, not delimited
601 public static function legalChars() {
602 global $wgLegalTitleChars;
603 return $wgLegalTitleChars;
607 * Returns a simple regex that will match on characters and sequences invalid in titles.
608 * Note that this doesn't pick up many things that could be wrong with titles, but that
609 * replacing this regex with something valid will make many titles valid.
611 * @todo: move this into MediaWikiTitleCodec
613 * @return string Regex string
615 static function getTitleInvalidRegex() {
616 static $rxTc = false;
618 # Matching titles will be held as illegal.
620 # Any character not allowed is forbidden...
621 '[^' . self
::legalChars() . ']' .
622 # URL percent encoding sequences interfere with the ability
623 # to round-trip titles -- you can't link to them consistently.
625 # XML/HTML character references produce similar issues.
626 '|&[A-Za-z0-9\x80-\xff]+;' .
628 '|&#x[0-9A-Fa-f]+;' .
636 * Utility method for converting a character sequence from bytes to Unicode.
638 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
639 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
641 * @param string $byteClass
644 public static function convertByteClassToUnicodeClass( $byteClass ) {
645 $length = strlen( $byteClass );
647 $x0 = $x1 = $x2 = '';
649 $d0 = $d1 = $d2 = '';
650 // Decoded integer codepoints
651 $ord0 = $ord1 = $ord2 = 0;
653 $r0 = $r1 = $r2 = '';
657 $allowUnicode = false;
658 for ( $pos = 0; $pos < $length; $pos++
) {
659 // Shift the queues down
668 // Load the current input token and decoded values
669 $inChar = $byteClass[$pos];
670 if ( $inChar == '\\' ) {
671 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
672 $x0 = $inChar . $m[0];
673 $d0 = chr( hexdec( $m[1] ) );
674 $pos +
= strlen( $m[0] );
675 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
676 $x0 = $inChar . $m[0];
677 $d0 = chr( octdec( $m[0] ) );
678 $pos +
= strlen( $m[0] );
679 } elseif ( $pos +
1 >= $length ) {
682 $d0 = $byteClass[$pos +
1];
690 // Load the current re-encoded value
691 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
692 $r0 = sprintf( '\x%02x', $ord0 );
693 } elseif ( $ord0 >= 0x80 ) {
694 // Allow unicode if a single high-bit character appears
695 $r0 = sprintf( '\x%02x', $ord0 );
696 $allowUnicode = true;
697 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
703 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
705 if ( $ord2 > $ord0 ) {
707 } elseif ( $ord0 >= 0x80 ) {
709 $allowUnicode = true;
710 if ( $ord2 < 0x80 ) {
711 // Keep the non-unicode section of the range
718 // Reset state to the initial value
719 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
720 } elseif ( $ord2 < 0x80 ) {
725 if ( $ord1 < 0x80 ) {
728 if ( $ord0 < 0x80 ) {
731 if ( $allowUnicode ) {
732 $out .= '\u0080-\uFFFF';
738 * Make a prefixed DB key from a DB key and a namespace index
740 * @param int $ns Numerical representation of the namespace
741 * @param string $title The DB key form the title
742 * @param string $fragment The link fragment (after the "#")
743 * @param string $interwiki The interwiki prefix
744 * @return string The prefixed form of the title
746 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
749 $namespace = $wgContLang->getNsText( $ns );
750 $name = $namespace == '' ?
$title : "$namespace:$title";
751 if ( strval( $interwiki ) != '' ) {
752 $name = "$interwiki:$name";
754 if ( strval( $fragment ) != '' ) {
755 $name .= '#' . $fragment;
761 * Escape a text fragment, say from a link, for a URL
763 * @param string $fragment Containing a URL or link fragment (after the "#")
764 * @return string Escaped string
766 static function escapeFragmentForURL( $fragment ) {
767 # Note that we don't urlencode the fragment. urlencoded Unicode
768 # fragments appear not to work in IE (at least up to 7) or in at least
769 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
770 # to care if they aren't encoded.
771 return Sanitizer
::escapeId( $fragment, 'noninitial' );
775 * Callback for usort() to do title sorts by (namespace, title)
780 * @return int Result of string comparison, or namespace comparison
782 public static function compare( $a, $b ) {
783 if ( $a->getNamespace() == $b->getNamespace() ) {
784 return strcmp( $a->getText(), $b->getText() );
786 return $a->getNamespace() - $b->getNamespace();
791 * Determine whether the object refers to a page within
794 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
796 public function isLocal() {
797 if ( $this->isExternal() ) {
798 $iw = Interwiki
::fetch( $this->mInterwiki
);
800 return $iw->isLocal();
807 * Is this Title interwiki?
811 public function isExternal() {
812 return $this->mInterwiki
!== '';
816 * Get the interwiki prefix
818 * Use Title::isExternal to check if a interwiki is set
820 * @return string Interwiki prefix
822 public function getInterwiki() {
823 return $this->mInterwiki
;
827 * Determine whether the object refers to a page within
828 * this project and is transcludable.
830 * @return bool True if this is transcludable
832 public function isTrans() {
833 if ( !$this->isExternal() ) {
837 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
841 * Returns the DB name of the distant wiki which owns the object.
843 * @return string The DB name
845 public function getTransWikiID() {
846 if ( !$this->isExternal() ) {
850 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
854 * Get a TitleValue object representing this Title.
856 * @note: Not all valid Titles have a corresponding valid TitleValue
857 * (e.g. TitleValues cannot represent page-local links that have a
858 * fragment but no title text).
860 * @return TitleValue|null
862 public function getTitleValue() {
863 if ( $this->mTitleValue
=== null ) {
865 $this->mTitleValue
= new TitleValue(
866 $this->getNamespace(),
868 $this->getFragment() );
869 } catch ( InvalidArgumentException
$ex ) {
870 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
871 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
875 return $this->mTitleValue
;
879 * Get the text form (spaces not underscores) of the main part
881 * @return string Main part of the title
883 public function getText() {
884 return $this->mTextform
;
888 * Get the URL-encoded form of the main part
890 * @return string Main part of the title, URL-encoded
892 public function getPartialURL() {
893 return $this->mUrlform
;
897 * Get the main part with underscores
899 * @return string Main part of the title, with underscores
901 public function getDBkey() {
902 return $this->mDbkeyform
;
906 * Get the DB key with the initial letter case as specified by the user
908 * @return string DB key
910 function getUserCaseDBKey() {
911 if ( !is_null( $this->mUserCaseDBKey
) ) {
912 return $this->mUserCaseDBKey
;
914 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
915 return $this->mDbkeyform
;
920 * Get the namespace index, i.e. one of the NS_xxxx constants.
922 * @return int Namespace index
924 public function getNamespace() {
925 return $this->mNamespace
;
929 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
931 * @throws MWException
932 * @return string Content model id
934 public function getContentModel() {
935 if ( !$this->mContentModel
) {
936 $linkCache = LinkCache
::singleton();
937 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
940 if ( !$this->mContentModel
) {
941 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
944 if ( !$this->mContentModel
) {
945 throw new MWException( 'Failed to determine content model!' );
948 return $this->mContentModel
;
952 * Convenience method for checking a title's content model name
954 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
955 * @return bool True if $this->getContentModel() == $id
957 public function hasContentModel( $id ) {
958 return $this->getContentModel() == $id;
962 * Get the namespace text
964 * @return string Namespace text
966 public function getNsText() {
967 if ( $this->isExternal() ) {
968 // This probably shouldn't even happen. ohh man, oh yuck.
969 // But for interwiki transclusion it sometimes does.
970 // Shit. Shit shit shit.
972 // Use the canonical namespaces if possible to try to
973 // resolve a foreign namespace.
974 if ( MWNamespace
::exists( $this->mNamespace
) ) {
975 return MWNamespace
::getCanonicalName( $this->mNamespace
);
980 $formatter = $this->getTitleFormatter();
981 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
982 } catch ( InvalidArgumentException
$ex ) {
983 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
989 * Get the namespace text of the subject (rather than talk) page
991 * @return string Namespace text
993 public function getSubjectNsText() {
995 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
999 * Get the namespace text of the talk page
1001 * @return string Namespace text
1003 public function getTalkNsText() {
1005 return $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) );
1009 * Could this title have a corresponding talk page?
1013 public function canTalk() {
1014 return MWNamespace
::canTalk( $this->mNamespace
);
1018 * Is this in a namespace that allows actual pages?
1021 * @internal note -- uses hardcoded namespace index instead of constants
1023 public function canExist() {
1024 return $this->mNamespace
>= NS_MAIN
;
1028 * Can this title be added to a user's watchlist?
1032 public function isWatchable() {
1033 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
1037 * Returns true if this is a special page.
1041 public function isSpecialPage() {
1042 return $this->getNamespace() == NS_SPECIAL
;
1046 * Returns true if this title resolves to the named special page
1048 * @param string $name The special page name
1051 public function isSpecial( $name ) {
1052 if ( $this->isSpecialPage() ) {
1053 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
1054 if ( $name == $thisName ) {
1062 * If the Title refers to a special page alias which is not the local default, resolve
1063 * the alias, and localise the name as necessary. Otherwise, return $this
1067 public function fixSpecialName() {
1068 if ( $this->isSpecialPage() ) {
1069 list( $canonicalName, $par ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
1070 if ( $canonicalName ) {
1071 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName, $par );
1072 if ( $localName != $this->mDbkeyform
) {
1073 return Title
::makeTitle( NS_SPECIAL
, $localName );
1081 * Returns true if the title is inside the specified namespace.
1083 * Please make use of this instead of comparing to getNamespace()
1084 * This function is much more resistant to changes we may make
1085 * to namespaces than code that makes direct comparisons.
1086 * @param int $ns The namespace
1090 public function inNamespace( $ns ) {
1091 return MWNamespace
::equals( $this->getNamespace(), $ns );
1095 * Returns true if the title is inside one of the specified namespaces.
1097 * @param ...$namespaces The namespaces to check for
1101 public function inNamespaces( /* ... */ ) {
1102 $namespaces = func_get_args();
1103 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1104 $namespaces = $namespaces[0];
1107 foreach ( $namespaces as $ns ) {
1108 if ( $this->inNamespace( $ns ) ) {
1117 * Returns true if the title has the same subject namespace as the
1118 * namespace specified.
1119 * For example this method will take NS_USER and return true if namespace
1120 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1121 * as their subject namespace.
1123 * This is MUCH simpler than individually testing for equivalence
1124 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1129 public function hasSubjectNamespace( $ns ) {
1130 return MWNamespace
::subjectEquals( $this->getNamespace(), $ns );
1134 * Is this Title in a namespace which contains content?
1135 * In other words, is this a content page, for the purposes of calculating
1140 public function isContentPage() {
1141 return MWNamespace
::isContent( $this->getNamespace() );
1145 * Would anybody with sufficient privileges be able to move this page?
1146 * Some pages just aren't movable.
1150 public function isMovable() {
1151 if ( !MWNamespace
::isMovable( $this->getNamespace() ) ||
$this->isExternal() ) {
1152 // Interwiki title or immovable namespace. Hooks don't get to override here
1157 wfRunHooks( 'TitleIsMovable', array( $this, &$result ) );
1162 * Is this the mainpage?
1163 * @note Title::newFromText seems to be sufficiently optimized by the title
1164 * cache that we don't need to over-optimize by doing direct comparisons and
1165 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1166 * ends up reporting something differently than $title->isMainPage();
1171 public function isMainPage() {
1172 return $this->equals( Title
::newMainPage() );
1176 * Is this a subpage?
1180 public function isSubpage() {
1181 return MWNamespace
::hasSubpages( $this->mNamespace
)
1182 ?
strpos( $this->getText(), '/' ) !== false
1187 * Is this a conversion table for the LanguageConverter?
1191 public function isConversionTable() {
1192 // @todo ConversionTable should become a separate content model.
1194 return $this->getNamespace() == NS_MEDIAWIKI
&&
1195 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1199 * Does that page contain wikitext, or it is JS, CSS or whatever?
1203 public function isWikitextPage() {
1204 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1208 * Could this page contain custom CSS or JavaScript for the global UI.
1209 * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
1210 * or CONTENT_MODEL_JAVASCRIPT.
1212 * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage()
1215 * Note that this method should not return true for pages that contain and
1216 * show "inactive" CSS or JS.
1220 public function isCssOrJsPage() {
1221 $isCssOrJsPage = NS_MEDIAWIKI
== $this->mNamespace
1222 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1223 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1225 # @note This hook is also called in ContentHandler::getDefaultModel.
1226 # It's called here again to make sure hook functions can force this
1227 # method to return true even outside the mediawiki namespace.
1229 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$isCssOrJsPage ) );
1231 return $isCssOrJsPage;
1235 * Is this a .css or .js subpage of a user page?
1238 public function isCssJsSubpage() {
1239 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1240 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1241 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
1245 * Trim down a .css or .js subpage title to get the corresponding skin name
1247 * @return string Containing skin name from .css or .js subpage title
1249 public function getSkinFromCssJsSubpage() {
1250 $subpage = explode( '/', $this->mTextform
);
1251 $subpage = $subpage[count( $subpage ) - 1];
1252 $lastdot = strrpos( $subpage, '.' );
1253 if ( $lastdot === false ) {
1254 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
1256 return substr( $subpage, 0, $lastdot );
1260 * Is this a .css subpage of a user page?
1264 public function isCssSubpage() {
1265 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1266 && $this->hasContentModel( CONTENT_MODEL_CSS
) );
1270 * Is this a .js subpage of a user page?
1274 public function isJsSubpage() {
1275 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1276 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1280 * Is this a talk page of some sort?
1284 public function isTalkPage() {
1285 return MWNamespace
::isTalk( $this->getNamespace() );
1289 * Get a Title object associated with the talk page of this article
1291 * @return Title The object for the talk page
1293 public function getTalkPage() {
1294 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
1298 * Get a title object associated with the subject page of this
1301 * @return Title The object for the subject page
1303 public function getSubjectPage() {
1304 // Is this the same title?
1305 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
1306 if ( $this->getNamespace() == $subjectNS ) {
1309 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
1313 * Get the default namespace index, for when there is no namespace
1315 * @return int Default namespace index
1317 public function getDefaultNamespace() {
1318 return $this->mDefaultNamespace
;
1322 * Get the Title fragment (i.e.\ the bit after the #) in text form
1324 * Use Title::hasFragment to check for a fragment
1326 * @return string Title fragment
1328 public function getFragment() {
1329 return $this->mFragment
;
1333 * Check if a Title fragment is set
1338 public function hasFragment() {
1339 return $this->mFragment
!== '';
1343 * Get the fragment in URL form, including the "#" character if there is one
1344 * @return string Fragment in URL form
1346 public function getFragmentForURL() {
1347 if ( !$this->hasFragment() ) {
1350 return '#' . Title
::escapeFragmentForURL( $this->getFragment() );
1355 * Set the fragment for this title. Removes the first character from the
1356 * specified fragment before setting, so it assumes you're passing it with
1359 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1360 * Still in active use privately.
1362 * @param string $fragment Text
1364 public function setFragment( $fragment ) {
1365 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
1369 * Prefix some arbitrary text with the namespace or interwiki prefix
1372 * @param string $name The text
1373 * @return string The prefixed text
1375 private function prefix( $name ) {
1377 if ( $this->isExternal() ) {
1378 $p = $this->mInterwiki
. ':';
1381 if ( 0 != $this->mNamespace
) {
1382 $p .= $this->getNsText() . ':';
1388 * Get the prefixed database key form
1390 * @return string The prefixed title, with underscores and
1391 * any interwiki and namespace prefixes
1393 public function getPrefixedDBkey() {
1394 $s = $this->prefix( $this->mDbkeyform
);
1395 $s = str_replace( ' ', '_', $s );
1400 * Get the prefixed title with spaces.
1401 * This is the form usually used for display
1403 * @return string The prefixed title, with spaces
1405 public function getPrefixedText() {
1406 if ( $this->mPrefixedText
=== null ) {
1407 $s = $this->prefix( $this->mTextform
);
1408 $s = str_replace( '_', ' ', $s );
1409 $this->mPrefixedText
= $s;
1411 return $this->mPrefixedText
;
1415 * Return a string representation of this title
1417 * @return string Representation of this title
1419 public function __toString() {
1420 return $this->getPrefixedText();
1424 * Get the prefixed title with spaces, plus any fragment
1425 * (part beginning with '#')
1427 * @return string The prefixed title, with spaces and the fragment, including '#'
1429 public function getFullText() {
1430 $text = $this->getPrefixedText();
1431 if ( $this->hasFragment() ) {
1432 $text .= '#' . $this->getFragment();
1438 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1442 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1446 * @return string Root name
1449 public function getRootText() {
1450 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1451 return $this->getText();
1454 return strtok( $this->getText(), '/' );
1458 * Get the root page name title, i.e. the leftmost part before any slashes
1462 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1463 * # returns: Title{User:Foo}
1466 * @return Title Root title
1469 public function getRootTitle() {
1470 return Title
::makeTitle( $this->getNamespace(), $this->getRootText() );
1474 * Get the base page name without a namespace, i.e. the part before the subpage name
1478 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1479 * # returns: 'Foo/Bar'
1482 * @return string Base name
1484 public function getBaseText() {
1485 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1486 return $this->getText();
1489 $parts = explode( '/', $this->getText() );
1490 # Don't discard the real title if there's no subpage involved
1491 if ( count( $parts ) > 1 ) {
1492 unset( $parts[count( $parts ) - 1] );
1494 return implode( '/', $parts );
1498 * Get the base page name title, i.e. the part before the subpage name
1502 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1503 * # returns: Title{User:Foo/Bar}
1506 * @return Title Base title
1509 public function getBaseTitle() {
1510 return Title
::makeTitle( $this->getNamespace(), $this->getBaseText() );
1514 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1518 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1522 * @return string Subpage name
1524 public function getSubpageText() {
1525 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1526 return $this->mTextform
;
1528 $parts = explode( '/', $this->mTextform
);
1529 return $parts[count( $parts ) - 1];
1533 * Get the title for a subpage of the current page
1537 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1538 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1541 * @param string $text The subpage name to add to the title
1542 * @return Title Subpage title
1545 public function getSubpage( $text ) {
1546 return Title
::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1550 * Get the HTML-escaped displayable text form.
1551 * Used for the title field in <a> tags.
1553 * @return string The text, including any prefixes
1554 * @deprecated since 1.19
1556 public function getEscapedText() {
1557 wfDeprecated( __METHOD__
, '1.19' );
1558 return htmlspecialchars( $this->getPrefixedText() );
1562 * Get a URL-encoded form of the subpage text
1564 * @return string URL-encoded subpage name
1566 public function getSubpageUrlForm() {
1567 $text = $this->getSubpageText();
1568 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1573 * Get a URL-encoded title (not an actual URL) including interwiki
1575 * @return string The URL-encoded form
1577 public function getPrefixedURL() {
1578 $s = $this->prefix( $this->mDbkeyform
);
1579 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1584 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1585 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1586 * second argument named variant. This was deprecated in favor
1587 * of passing an array of option with a "variant" key
1588 * Once $query2 is removed for good, this helper can be dropped
1589 * and the wfArrayToCgi moved to getLocalURL();
1591 * @since 1.19 (r105919)
1592 * @param array|string $query
1593 * @param bool $query2
1596 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1597 if ( $query2 !== false ) {
1598 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1599 "method called with a second parameter is deprecated. Add your " .
1600 "parameter to an array passed as the first parameter.", "1.19" );
1602 if ( is_array( $query ) ) {
1603 $query = wfArrayToCgi( $query );
1606 if ( is_string( $query2 ) ) {
1607 // $query2 is a string, we will consider this to be
1608 // a deprecated $variant argument and add it to the query
1609 $query2 = wfArrayToCgi( array( 'variant' => $query2 ) );
1611 $query2 = wfArrayToCgi( $query2 );
1613 // If we have $query content add a & to it first
1617 // Now append the queries together
1624 * Get a real URL referring to this title, with interwiki link and
1627 * @see self::getLocalURL for the arguments.
1629 * @param array|string $query
1630 * @param bool $query2
1631 * @param string $proto Protocol type to use in URL
1632 * @return string The URL
1634 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1635 $query = self
::fixUrlQueryArgs( $query, $query2 );
1637 # Hand off all the decisions on urls to getLocalURL
1638 $url = $this->getLocalURL( $query );
1640 # Expand the url to make it a full url. Note that getLocalURL has the
1641 # potential to output full urls for a variety of reasons, so we use
1642 # wfExpandUrl instead of simply prepending $wgServer
1643 $url = wfExpandUrl( $url, $proto );
1645 # Finally, add the fragment.
1646 $url .= $this->getFragmentForURL();
1648 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
1653 * Get a URL with no fragment or server name (relative URL) from a Title object.
1654 * If this page is generated with action=render, however,
1655 * $wgServer is prepended to make an absolute URL.
1657 * @see self::getFullURL to always get an absolute URL.
1658 * @see self::newFromText to produce a Title object.
1660 * @param string|array $query an optional query string,
1661 * not used for interwiki links. Can be specified as an associative array as well,
1662 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1663 * Some query patterns will trigger various shorturl path replacements.
1664 * @param array $query2 An optional secondary query array. This one MUST
1665 * be an array. If a string is passed it will be interpreted as a deprecated
1666 * variant argument and urlencoded into a variant= argument.
1667 * This second query argument will be added to the $query
1668 * The second parameter is deprecated since 1.19. Pass it as a key,value
1669 * pair in the first parameter array instead.
1671 * @return string String of the URL.
1673 public function getLocalURL( $query = '', $query2 = false ) {
1674 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1676 $query = self
::fixUrlQueryArgs( $query, $query2 );
1678 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
1680 $namespace = $this->getNsText();
1681 if ( $namespace != '' ) {
1682 # Can this actually happen? Interwikis shouldn't be parsed.
1683 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1686 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1687 $url = wfAppendQuery( $url, $query );
1689 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1690 if ( $query == '' ) {
1691 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1692 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1694 global $wgVariantArticlePath, $wgActionPaths, $wgContLang;
1698 if ( !empty( $wgActionPaths )
1699 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1701 $action = urldecode( $matches[2] );
1702 if ( isset( $wgActionPaths[$action] ) ) {
1703 $query = $matches[1];
1704 if ( isset( $matches[4] ) ) {
1705 $query .= $matches[4];
1707 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1708 if ( $query != '' ) {
1709 $url = wfAppendQuery( $url, $query );
1715 && $wgVariantArticlePath
1716 && $wgContLang->getCode() === $this->getPageLanguage()->getCode()
1717 && $this->getPageLanguage()->hasVariants()
1718 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1720 $variant = urldecode( $matches[1] );
1721 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1722 // Only do the variant replacement if the given variant is a valid
1723 // variant for the page's language.
1724 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1725 $url = str_replace( '$1', $dbkey, $url );
1729 if ( $url === false ) {
1730 if ( $query == '-' ) {
1733 $url = "{$wgScript}?title={$dbkey}&{$query}";
1737 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1739 // @todo FIXME: This causes breakage in various places when we
1740 // actually expected a local URL and end up with dupe prefixes.
1741 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1742 $url = $wgServer . $url;
1745 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1750 * Get a URL that's the simplest URL that will be valid to link, locally,
1751 * to the current Title. It includes the fragment, but does not include
1752 * the server unless action=render is used (or the link is external). If
1753 * there's a fragment but the prefixed text is empty, we just return a link
1756 * The result obviously should not be URL-escaped, but does need to be
1757 * HTML-escaped if it's being output in HTML.
1759 * @param array $query
1760 * @param bool $query2
1761 * @param string $proto Protocol to use; setting this will cause a full URL to be used
1762 * @see self::getLocalURL for the arguments.
1763 * @return string The URL
1765 public function getLinkURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1766 wfProfileIn( __METHOD__
);
1767 if ( $this->isExternal() ||
$proto !== PROTO_RELATIVE
) {
1768 $ret = $this->getFullURL( $query, $query2, $proto );
1769 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
1770 $ret = $this->getFragmentForURL();
1772 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1774 wfProfileOut( __METHOD__
);
1779 * Get the URL form for an internal link.
1780 * - Used in various Squid-related code, in case we have a different
1781 * internal hostname for the server from the exposed one.
1783 * This uses $wgInternalServer to qualify the path, or $wgServer
1784 * if $wgInternalServer is not set. If the server variable used is
1785 * protocol-relative, the URL will be expanded to http://
1787 * @see self::getLocalURL for the arguments.
1788 * @return string The URL
1790 public function getInternalURL( $query = '', $query2 = false ) {
1791 global $wgInternalServer, $wgServer;
1792 $query = self
::fixUrlQueryArgs( $query, $query2 );
1793 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1794 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
1795 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1800 * Get the URL for a canonical link, for use in things like IRC and
1801 * e-mail notifications. Uses $wgCanonicalServer and the
1802 * GetCanonicalURL hook.
1804 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1806 * @see self::getLocalURL for the arguments.
1807 * @return string The URL
1810 public function getCanonicalURL( $query = '', $query2 = false ) {
1811 $query = self
::fixUrlQueryArgs( $query, $query2 );
1812 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
1813 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1818 * Get the edit URL for this Title
1820 * @return string The URL, or a null string if this is an interwiki link
1822 public function getEditURL() {
1823 if ( $this->isExternal() ) {
1826 $s = $this->getLocalURL( 'action=edit' );
1832 * Is $wgUser watching this page?
1834 * @deprecated since 1.20; use User::isWatched() instead.
1837 public function userIsWatching() {
1840 if ( is_null( $this->mWatched
) ) {
1841 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1842 $this->mWatched
= false;
1844 $this->mWatched
= $wgUser->isWatched( $this );
1847 return $this->mWatched
;
1851 * Can $wgUser read this page?
1853 * @deprecated since 1.19; use userCan(), quickUserCan() or getUserPermissionsErrors() instead
1856 public function userCanRead() {
1857 wfDeprecated( __METHOD__
, '1.19' );
1858 return $this->userCan( 'read' );
1862 * Can $user perform $action on this page?
1863 * This skips potentially expensive cascading permission checks
1864 * as well as avoids expensive error formatting
1866 * Suitable for use for nonessential UI controls in common cases, but
1867 * _not_ for functional access control.
1869 * May provide false positives, but should never provide a false negative.
1871 * @param string $action Action that permission needs to be checked for
1872 * @param User $user User to check (since 1.19); $wgUser will be used if not provided.
1875 public function quickUserCan( $action, $user = null ) {
1876 return $this->userCan( $action, $user, false );
1880 * Can $user perform $action on this page?
1882 * @param string $action Action that permission needs to be checked for
1883 * @param User $user User to check (since 1.19); $wgUser will be used if not
1885 * @param bool $doExpensiveQueries Set this to false to avoid doing
1886 * unnecessary queries.
1889 public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1890 if ( !$user instanceof User
) {
1895 return !count( $this->getUserPermissionsErrorsInternal(
1896 $action, $user, $doExpensiveQueries, true ) );
1900 * Can $user perform $action on this page?
1902 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1904 * @param string $action action that permission needs to be checked for
1905 * @param User $user User to check
1906 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary
1907 * queries by skipping checks for cascading protections and user blocks.
1908 * @param array $ignoreErrors of Strings Set this to a list of message keys
1909 * whose corresponding errors may be ignored.
1910 * @return array Array of arguments to wfMessage to explain permissions problems.
1912 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true,
1913 $ignoreErrors = array()
1915 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1917 // Remove the errors being ignored.
1918 foreach ( $errors as $index => $error ) {
1919 $error_key = is_array( $error ) ?
$error[0] : $error;
1921 if ( in_array( $error_key, $ignoreErrors ) ) {
1922 unset( $errors[$index] );
1930 * Permissions checks that fail most often, and which are easiest to test.
1932 * @param string $action the action to check
1933 * @param User $user User to check
1934 * @param array $errors List of current errors
1935 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
1936 * @param bool $short Short circuit on first error
1938 * @return array List of errors
1940 private function checkQuickPermissions( $action, $user, $errors,
1941 $doExpensiveQueries, $short
1943 if ( !wfRunHooks( 'TitleQuickPermissions',
1944 array( $this, $user, $action, &$errors, $doExpensiveQueries, $short ) )
1949 if ( $action == 'create' ) {
1951 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1952 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
1954 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1956 } elseif ( $action == 'move' ) {
1957 if ( !$user->isAllowed( 'move-rootuserpages' )
1958 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1959 // Show user page-specific message only if the user can move other pages
1960 $errors[] = array( 'cant-move-user-page' );
1963 // Check if user is allowed to move files if it's a file
1964 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1965 $errors[] = array( 'movenotallowedfile' );
1968 // Check if user is allowed to move category pages if it's a category page
1969 if ( $this->mNamespace
== NS_CATEGORY
&& !$user->isAllowed( 'move-categorypages' ) ) {
1970 $errors[] = array( 'cant-move-category-page' );
1973 if ( !$user->isAllowed( 'move' ) ) {
1974 // User can't move anything
1975 $userCanMove = User
::groupHasPermission( 'user', 'move' );
1976 $autoconfirmedCanMove = User
::groupHasPermission( 'autoconfirmed', 'move' );
1977 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1978 // custom message if logged-in users without any special rights can move
1979 $errors[] = array( 'movenologintext' );
1981 $errors[] = array( 'movenotallowed' );
1984 } elseif ( $action == 'move-target' ) {
1985 if ( !$user->isAllowed( 'move' ) ) {
1986 // User can't move anything
1987 $errors[] = array( 'movenotallowed' );
1988 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1989 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1990 // Show user page-specific message only if the user can move other pages
1991 $errors[] = array( 'cant-move-to-user-page' );
1992 } elseif ( !$user->isAllowed( 'move-categorypages' )
1993 && $this->mNamespace
== NS_CATEGORY
) {
1994 // Show category page-specific message only if the user can move other pages
1995 $errors[] = array( 'cant-move-to-category-page' );
1997 } elseif ( !$user->isAllowed( $action ) ) {
1998 $errors[] = $this->missingPermissionError( $action, $short );
2005 * Add the resulting error code to the errors array
2007 * @param array $errors List of current errors
2008 * @param array $result Result of errors
2010 * @return array List of errors
2012 private function resultToError( $errors, $result ) {
2013 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2014 // A single array representing an error
2015 $errors[] = $result;
2016 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2017 // A nested array representing multiple errors
2018 $errors = array_merge( $errors, $result );
2019 } elseif ( $result !== '' && is_string( $result ) ) {
2020 // A string representing a message-id
2021 $errors[] = array( $result );
2022 } elseif ( $result === false ) {
2023 // a generic "We don't want them to do that"
2024 $errors[] = array( 'badaccess-group0' );
2030 * Check various permission hooks
2032 * @param string $action The action to check
2033 * @param User $user User to check
2034 * @param array $errors List of current errors
2035 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2036 * @param bool $short Short circuit on first error
2038 * @return array List of errors
2040 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
2041 // Use getUserPermissionsErrors instead
2043 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
2044 return $result ?
array() : array( array( 'badaccess-group0' ) );
2046 // Check getUserPermissionsErrors hook
2047 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
2048 $errors = $this->resultToError( $errors, $result );
2050 // Check getUserPermissionsErrorsExpensive hook
2053 && !( $short && count( $errors ) > 0 )
2054 && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) )
2056 $errors = $this->resultToError( $errors, $result );
2063 * Check permissions on special pages & namespaces
2065 * @param string $action The action to check
2066 * @param User $user User to check
2067 * @param array $errors List of current errors
2068 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2069 * @param bool $short Short circuit on first error
2071 * @return array List of errors
2073 private function checkSpecialsAndNSPermissions( $action, $user, $errors,
2074 $doExpensiveQueries, $short
2076 # Only 'createaccount' can be performed on special pages,
2077 # which don't actually exist in the DB.
2078 if ( NS_SPECIAL
== $this->mNamespace
&& $action !== 'createaccount' ) {
2079 $errors[] = array( 'ns-specialprotected' );
2082 # Check $wgNamespaceProtection for restricted namespaces
2083 if ( $this->isNamespaceProtected( $user ) ) {
2084 $ns = $this->mNamespace
== NS_MAIN ?
2085 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2086 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
2087 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
2094 * Check CSS/JS sub-page permissions
2096 * @param string $action The action to check
2097 * @param User $user User to check
2098 * @param array $errors List of current errors
2099 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2100 * @param bool $short Short circuit on first error
2102 * @return array List of errors
2104 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2105 # Protect css/js subpages of user pages
2106 # XXX: this might be better using restrictions
2107 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
2108 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' ) ) {
2109 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
2110 if ( $this->isCssSubpage() && !$user->isAllowedAny( 'editmyusercss', 'editusercss' ) ) {
2111 $errors[] = array( 'mycustomcssprotected' );
2112 } elseif ( $this->isJsSubpage() && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' ) ) {
2113 $errors[] = array( 'mycustomjsprotected' );
2116 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
2117 $errors[] = array( 'customcssprotected' );
2118 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
2119 $errors[] = array( 'customjsprotected' );
2128 * Check against page_restrictions table requirements on this
2129 * page. The user must possess all required rights for this
2132 * @param string $action The action to check
2133 * @param User $user User to check
2134 * @param array $errors List of current errors
2135 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2136 * @param bool $short Short circuit on first error
2138 * @return array List of errors
2140 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2141 foreach ( $this->getRestrictions( $action ) as $right ) {
2142 // Backwards compatibility, rewrite sysop -> editprotected
2143 if ( $right == 'sysop' ) {
2144 $right = 'editprotected';
2146 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2147 if ( $right == 'autoconfirmed' ) {
2148 $right = 'editsemiprotected';
2150 if ( $right == '' ) {
2153 if ( !$user->isAllowed( $right ) ) {
2154 $errors[] = array( 'protectedpagetext', $right );
2155 } elseif ( $this->mCascadeRestriction
&& !$user->isAllowed( 'protect' ) ) {
2156 $errors[] = array( 'protectedpagetext', 'protect' );
2164 * Check restrictions on cascading pages.
2166 * @param string $action The action to check
2167 * @param User $user User to check
2168 * @param array $errors List of current errors
2169 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2170 * @param bool $short Short circuit on first error
2172 * @return array List of errors
2174 private function checkCascadingSourcesRestrictions( $action, $user, $errors,
2175 $doExpensiveQueries, $short
2177 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
2178 # We /could/ use the protection level on the source page, but it's
2179 # fairly ugly as we have to establish a precedence hierarchy for pages
2180 # included by multiple cascade-protected pages. So just restrict
2181 # it to people with 'protect' permission, as they could remove the
2182 # protection anyway.
2183 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2184 # Cascading protection depends on more than this page...
2185 # Several cascading protected pages may include this page...
2186 # Check each cascading level
2187 # This is only for protection restrictions, not for all actions
2188 if ( isset( $restrictions[$action] ) ) {
2189 foreach ( $restrictions[$action] as $right ) {
2190 // Backwards compatibility, rewrite sysop -> editprotected
2191 if ( $right == 'sysop' ) {
2192 $right = 'editprotected';
2194 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2195 if ( $right == 'autoconfirmed' ) {
2196 $right = 'editsemiprotected';
2198 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2200 foreach ( $cascadingSources as $page ) {
2201 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2203 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
2213 * Check action permissions not already checked in checkQuickPermissions
2215 * @param string $action The action to check
2216 * @param User $user User to check
2217 * @param array $errors List of current errors
2218 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2219 * @param bool $short Short circuit on first error
2221 * @return array List of errors
2223 private function checkActionPermissions( $action, $user, $errors,
2224 $doExpensiveQueries, $short
2226 global $wgDeleteRevisionsLimit, $wgLang;
2228 if ( $action == 'protect' ) {
2229 if ( count( $this->getUserPermissionsErrorsInternal( 'edit',
2230 $user, $doExpensiveQueries, true ) )
2232 // If they can't edit, they shouldn't protect.
2233 $errors[] = array( 'protect-cantedit' );
2235 } elseif ( $action == 'create' ) {
2236 $title_protection = $this->getTitleProtection();
2237 if ( $title_protection ) {
2238 if ( $title_protection['pt_create_perm'] == 'sysop' ) {
2239 $title_protection['pt_create_perm'] = 'editprotected'; // B/C
2241 if ( $title_protection['pt_create_perm'] == 'autoconfirmed' ) {
2242 $title_protection['pt_create_perm'] = 'editsemiprotected'; // B/C
2244 if ( $title_protection['pt_create_perm'] == ''
2245 ||
!$user->isAllowed( $title_protection['pt_create_perm'] )
2249 User
::whoIs( $title_protection['pt_user'] ),
2250 $title_protection['pt_reason']
2254 } elseif ( $action == 'move' ) {
2255 // Check for immobile pages
2256 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2257 // Specific message for this case
2258 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2259 } elseif ( !$this->isMovable() ) {
2260 // Less specific message for rarer cases
2261 $errors[] = array( 'immobile-source-page' );
2263 } elseif ( $action == 'move-target' ) {
2264 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2265 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
2266 } elseif ( !$this->isMovable() ) {
2267 $errors[] = array( 'immobile-target-page' );
2269 } elseif ( $action == 'delete' ) {
2270 if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
2271 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2273 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
2280 * Check that the user isn't blocked from editing.
2282 * @param string $action The action to check
2283 * @param User $user User to check
2284 * @param array $errors List of current errors
2285 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2286 * @param bool $short Short circuit on first error
2288 * @return array List of errors
2290 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
2291 // Account creation blocks handled at userlogin.
2292 // Unblocking handled in SpecialUnblock
2293 if ( !$doExpensiveQueries ||
in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
2297 global $wgEmailConfirmToEdit;
2299 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2300 $errors[] = array( 'confirmedittext' );
2303 if ( ( $action == 'edit' ||
$action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
2304 // Don't block the user from editing their own talk page unless they've been
2305 // explicitly blocked from that too.
2306 } elseif ( $user->isBlocked() && $user->mBlock
->prevents( $action ) !== false ) {
2307 // @todo FIXME: Pass the relevant context into this function.
2308 $errors[] = $user->getBlock()->getPermissionsError( RequestContext
::getMain() );
2315 * Check that the user is allowed to read this page.
2317 * @param string $action The action to check
2318 * @param User $user User to check
2319 * @param array $errors List of current errors
2320 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2321 * @param bool $short Short circuit on first error
2323 * @return array List of errors
2325 private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2326 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2328 $whitelisted = false;
2329 if ( User
::isEveryoneAllowed( 'read' ) ) {
2330 # Shortcut for public wikis, allows skipping quite a bit of code
2331 $whitelisted = true;
2332 } elseif ( $user->isAllowed( 'read' ) ) {
2333 # If the user is allowed to read pages, he is allowed to read all pages
2334 $whitelisted = true;
2335 } elseif ( $this->isSpecial( 'Userlogin' )
2336 ||
$this->isSpecial( 'ChangePassword' )
2337 ||
$this->isSpecial( 'PasswordReset' )
2339 # Always grant access to the login page.
2340 # Even anons need to be able to log in.
2341 $whitelisted = true;
2342 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2343 # Time to check the whitelist
2344 # Only do these checks is there's something to check against
2345 $name = $this->getPrefixedText();
2346 $dbName = $this->getPrefixedDBkey();
2348 // Check for explicit whitelisting with and without underscores
2349 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2350 $whitelisted = true;
2351 } elseif ( $this->getNamespace() == NS_MAIN
) {
2352 # Old settings might have the title prefixed with
2353 # a colon for main-namespace pages
2354 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2355 $whitelisted = true;
2357 } elseif ( $this->isSpecialPage() ) {
2358 # If it's a special page, ditch the subpage bit and check again
2359 $name = $this->getDBkey();
2360 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
2362 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2363 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2364 $whitelisted = true;
2370 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2371 $name = $this->getPrefixedText();
2372 // Check for regex whitelisting
2373 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2374 if ( preg_match( $listItem, $name ) ) {
2375 $whitelisted = true;
2381 if ( !$whitelisted ) {
2382 # If the title is not whitelisted, give extensions a chance to do so...
2383 wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2384 if ( !$whitelisted ) {
2385 $errors[] = $this->missingPermissionError( $action, $short );
2393 * Get a description array when the user doesn't have the right to perform
2394 * $action (i.e. when User::isAllowed() returns false)
2396 * @param string $action The action to check
2397 * @param bool $short Short circuit on first error
2398 * @return array List of errors
2400 private function missingPermissionError( $action, $short ) {
2401 // We avoid expensive display logic for quickUserCan's and such
2403 return array( 'badaccess-group0' );
2406 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2407 User
::getGroupsWithPermission( $action ) );
2409 if ( count( $groups ) ) {
2413 $wgLang->commaList( $groups ),
2417 return array( 'badaccess-group0' );
2422 * Can $user perform $action on this page? This is an internal function,
2423 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2424 * checks on wfReadOnly() and blocks)
2426 * @param string $action Action that permission needs to be checked for
2427 * @param User $user User to check
2428 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
2429 * @param bool $short Set this to true to stop after the first permission error.
2430 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2432 protected function getUserPermissionsErrorsInternal( $action, $user,
2433 $doExpensiveQueries = true, $short = false
2435 wfProfileIn( __METHOD__
);
2437 # Read has special handling
2438 if ( $action == 'read' ) {
2440 'checkPermissionHooks',
2441 'checkReadPermissions',
2445 'checkQuickPermissions',
2446 'checkPermissionHooks',
2447 'checkSpecialsAndNSPermissions',
2448 'checkCSSandJSPermissions',
2449 'checkPageRestrictions',
2450 'checkCascadingSourcesRestrictions',
2451 'checkActionPermissions',
2457 while ( count( $checks ) > 0 &&
2458 !( $short && count( $errors ) > 0 ) ) {
2459 $method = array_shift( $checks );
2460 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2463 wfProfileOut( __METHOD__
);
2468 * Get a filtered list of all restriction types supported by this wiki.
2469 * @param bool $exists True to get all restriction types that apply to
2470 * titles that do exist, False for all restriction types that apply to
2471 * titles that do not exist
2474 public static function getFilteredRestrictionTypes( $exists = true ) {
2475 global $wgRestrictionTypes;
2476 $types = $wgRestrictionTypes;
2478 # Remove the create restriction for existing titles
2479 $types = array_diff( $types, array( 'create' ) );
2481 # Only the create and upload restrictions apply to non-existing titles
2482 $types = array_intersect( $types, array( 'create', 'upload' ) );
2488 * Returns restriction types for the current Title
2490 * @return array Applicable restriction types
2492 public function getRestrictionTypes() {
2493 if ( $this->isSpecialPage() ) {
2497 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2499 if ( $this->getNamespace() != NS_FILE
) {
2500 # Remove the upload restriction for non-file titles
2501 $types = array_diff( $types, array( 'upload' ) );
2504 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2506 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2507 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2513 * Is this title subject to title protection?
2514 * Title protection is the one applied against creation of such title.
2516 * @return array|bool An associative array representing any existent title
2517 * protection, or false if there's none.
2519 private function getTitleProtection() {
2520 // Can't protect pages in special namespaces
2521 if ( $this->getNamespace() < 0 ) {
2525 // Can't protect pages that exist.
2526 if ( $this->exists() ) {
2530 if ( $this->mTitleProtection
=== null ) {
2531 $dbr = wfGetDB( DB_SLAVE
);
2532 $res = $dbr->select(
2534 array( 'pt_user', 'pt_reason', 'pt_expiry', 'pt_create_perm' ),
2535 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2539 // fetchRow returns false if there are no rows.
2540 $this->mTitleProtection
= $dbr->fetchRow( $res );
2542 return $this->mTitleProtection
;
2546 * Remove any title protection due to page existing
2548 public function deleteTitleProtection() {
2549 $dbw = wfGetDB( DB_MASTER
);
2553 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2556 $this->mTitleProtection
= false;
2560 * Is this page "semi-protected" - the *only* protection levels are listed
2561 * in $wgSemiprotectedRestrictionLevels?
2563 * @param string $action Action to check (default: edit)
2566 public function isSemiProtected( $action = 'edit' ) {
2567 global $wgSemiprotectedRestrictionLevels;
2569 $restrictions = $this->getRestrictions( $action );
2570 $semi = $wgSemiprotectedRestrictionLevels;
2571 if ( !$restrictions ||
!$semi ) {
2572 // Not protected, or all protection is full protection
2576 // Remap autoconfirmed to editsemiprotected for BC
2577 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2578 $semi[$key] = 'editsemiprotected';
2580 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2581 $restrictions[$key] = 'editsemiprotected';
2584 return !array_diff( $restrictions, $semi );
2588 * Does the title correspond to a protected article?
2590 * @param string $action the action the page is protected from,
2591 * by default checks all actions.
2594 public function isProtected( $action = '' ) {
2595 global $wgRestrictionLevels;
2597 $restrictionTypes = $this->getRestrictionTypes();
2599 # Special pages have inherent protection
2600 if ( $this->isSpecialPage() ) {
2604 # Check regular protection levels
2605 foreach ( $restrictionTypes as $type ) {
2606 if ( $action == $type ||
$action == '' ) {
2607 $r = $this->getRestrictions( $type );
2608 foreach ( $wgRestrictionLevels as $level ) {
2609 if ( in_array( $level, $r ) && $level != '' ) {
2620 * Determines if $user is unable to edit this page because it has been protected
2621 * by $wgNamespaceProtection.
2623 * @param User $user User object to check permissions
2626 public function isNamespaceProtected( User
$user ) {
2627 global $wgNamespaceProtection;
2629 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2630 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2631 if ( $right != '' && !$user->isAllowed( $right ) ) {
2640 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2642 * @return bool If the page is subject to cascading restrictions.
2644 public function isCascadeProtected() {
2645 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2646 return ( $sources > 0 );
2650 * Determines whether cascading protection sources have already been loaded from
2653 * @param bool $getPages True to check if the pages are loaded, or false to check
2654 * if the status is loaded.
2655 * @return bool Whether or not the specified information has been loaded
2658 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2659 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
2663 * Cascading protection: Get the source of any cascading restrictions on this page.
2665 * @param bool $getPages Whether or not to retrieve the actual pages
2666 * that the restrictions have come from and the actual restrictions
2668 * @return array Two elements: First is an array of Title objects of the
2669 * pages from which cascading restrictions have come, false for
2670 * none, or true if such restrictions exist but $getPages was not
2671 * set. Second is an array like that returned by
2672 * Title::getAllRestrictions(), or an empty array if $getPages is
2675 public function getCascadeProtectionSources( $getPages = true ) {
2677 $pagerestrictions = array();
2679 if ( $this->mCascadeSources
!== null && $getPages ) {
2680 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2681 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
2682 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2685 wfProfileIn( __METHOD__
);
2687 $dbr = wfGetDB( DB_SLAVE
);
2689 if ( $this->getNamespace() == NS_FILE
) {
2690 $tables = array( 'imagelinks', 'page_restrictions' );
2691 $where_clauses = array(
2692 'il_to' => $this->getDBkey(),
2697 $tables = array( 'templatelinks', 'page_restrictions' );
2698 $where_clauses = array(
2699 'tl_namespace' => $this->getNamespace(),
2700 'tl_title' => $this->getDBkey(),
2707 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2708 'pr_expiry', 'pr_type', 'pr_level' );
2709 $where_clauses[] = 'page_id=pr_page';
2712 $cols = array( 'pr_expiry' );
2715 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2717 $sources = $getPages ?
array() : false;
2718 $now = wfTimestampNow();
2719 $purgeExpired = false;
2721 foreach ( $res as $row ) {
2722 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2723 if ( $expiry > $now ) {
2725 $page_id = $row->pr_page
;
2726 $page_ns = $row->page_namespace
;
2727 $page_title = $row->page_title
;
2728 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2729 # Add groups needed for each restriction type if its not already there
2730 # Make sure this restriction type still exists
2732 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2733 $pagerestrictions[$row->pr_type
] = array();
2737 isset( $pagerestrictions[$row->pr_type
] )
2738 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
2740 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2746 // Trigger lazy purge of expired restrictions from the db
2747 $purgeExpired = true;
2750 if ( $purgeExpired ) {
2751 Title
::purgeExpiredRestrictions();
2755 $this->mCascadeSources
= $sources;
2756 $this->mCascadingRestrictions
= $pagerestrictions;
2758 $this->mHasCascadingRestrictions
= $sources;
2761 wfProfileOut( __METHOD__
);
2762 return array( $sources, $pagerestrictions );
2766 * Accessor for mRestrictionsLoaded
2768 * @return bool Whether or not the page's restrictions have already been
2769 * loaded from the database
2772 public function areRestrictionsLoaded() {
2773 return $this->mRestrictionsLoaded
;
2777 * Accessor/initialisation for mRestrictions
2779 * @param string $action Action that permission needs to be checked for
2780 * @return array Restriction levels needed to take the action. All levels
2783 public function getRestrictions( $action ) {
2784 if ( !$this->mRestrictionsLoaded
) {
2785 $this->loadRestrictions();
2787 return isset( $this->mRestrictions
[$action] )
2788 ?
$this->mRestrictions
[$action]
2793 * Accessor/initialisation for mRestrictions
2795 * @return array Keys are actions, values are arrays as returned by
2796 * Title::getRestrictions()
2799 public function getAllRestrictions() {
2800 if ( !$this->mRestrictionsLoaded
) {
2801 $this->loadRestrictions();
2803 return $this->mRestrictions
;
2807 * Get the expiry time for the restriction against a given action
2809 * @param string $action
2810 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2811 * or not protected at all, or false if the action is not recognised.
2813 public function getRestrictionExpiry( $action ) {
2814 if ( !$this->mRestrictionsLoaded
) {
2815 $this->loadRestrictions();
2817 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2821 * Returns cascading restrictions for the current article
2825 function areRestrictionsCascading() {
2826 if ( !$this->mRestrictionsLoaded
) {
2827 $this->loadRestrictions();
2830 return $this->mCascadeRestriction
;
2834 * Loads a string into mRestrictions array
2836 * @param ResultWrapper $res Resource restrictions as an SQL result.
2837 * @param string $oldFashionedRestrictions Comma-separated list of page
2838 * restrictions from page table (pre 1.10)
2840 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2843 foreach ( $res as $row ) {
2847 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2851 * Compiles list of active page restrictions from both page table (pre 1.10)
2852 * and page_restrictions table for this existing page.
2853 * Public for usage by LiquidThreads.
2855 * @param array $rows Array of db result objects
2856 * @param string $oldFashionedRestrictions Comma-separated list of page
2857 * restrictions from page table (pre 1.10)
2859 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2861 $dbr = wfGetDB( DB_SLAVE
);
2863 $restrictionTypes = $this->getRestrictionTypes();
2865 foreach ( $restrictionTypes as $type ) {
2866 $this->mRestrictions
[$type] = array();
2867 $this->mRestrictionsExpiry
[$type] = $wgContLang->formatExpiry( '', TS_MW
);
2870 $this->mCascadeRestriction
= false;
2872 # Backwards-compatibility: also load the restrictions from the page record (old format).
2874 if ( $oldFashionedRestrictions === null ) {
2875 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2876 array( 'page_id' => $this->getArticleID() ), __METHOD__
);
2879 if ( $oldFashionedRestrictions != '' ) {
2881 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2882 $temp = explode( '=', trim( $restrict ) );
2883 if ( count( $temp ) == 1 ) {
2884 // old old format should be treated as edit/move restriction
2885 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2886 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2888 $restriction = trim( $temp[1] );
2889 if ( $restriction != '' ) { //some old entries are empty
2890 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
2895 $this->mOldRestrictions
= true;
2899 if ( count( $rows ) ) {
2900 # Current system - load second to make them override.
2901 $now = wfTimestampNow();
2902 $purgeExpired = false;
2904 # Cycle through all the restrictions.
2905 foreach ( $rows as $row ) {
2907 // Don't take care of restrictions types that aren't allowed
2908 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
2912 // This code should be refactored, now that it's being used more generally,
2913 // But I don't really see any harm in leaving it in Block for now -werdna
2914 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2916 // Only apply the restrictions if they haven't expired!
2917 if ( !$expiry ||
$expiry > $now ) {
2918 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2919 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2921 $this->mCascadeRestriction |
= $row->pr_cascade
;
2923 // Trigger a lazy purge of expired restrictions
2924 $purgeExpired = true;
2928 if ( $purgeExpired ) {
2929 Title
::purgeExpiredRestrictions();
2933 $this->mRestrictionsLoaded
= true;
2937 * Load restrictions from the page_restrictions table
2939 * @param string $oldFashionedRestrictions Comma-separated list of page
2940 * restrictions from page table (pre 1.10)
2942 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2944 if ( !$this->mRestrictionsLoaded
) {
2945 if ( $this->exists() ) {
2946 $dbr = wfGetDB( DB_SLAVE
);
2948 $res = $dbr->select(
2949 'page_restrictions',
2950 array( 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ),
2951 array( 'pr_page' => $this->getArticleID() ),
2955 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2957 $title_protection = $this->getTitleProtection();
2959 if ( $title_protection ) {
2960 $now = wfTimestampNow();
2961 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW
);
2963 if ( !$expiry ||
$expiry > $now ) {
2964 // Apply the restrictions
2965 $this->mRestrictionsExpiry
['create'] = $expiry;
2966 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2967 } else { // Get rid of the old restrictions
2968 Title
::purgeExpiredRestrictions();
2969 $this->mTitleProtection
= false;
2972 $this->mRestrictionsExpiry
['create'] = $wgContLang->formatExpiry( '', TS_MW
);
2974 $this->mRestrictionsLoaded
= true;
2980 * Flush the protection cache in this object and force reload from the database.
2981 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2983 public function flushRestrictions() {
2984 $this->mRestrictionsLoaded
= false;
2985 $this->mTitleProtection
= null;
2989 * Purge expired restrictions from the page_restrictions table
2991 static function purgeExpiredRestrictions() {
2992 if ( wfReadOnly() ) {
2996 $method = __METHOD__
;
2997 $dbw = wfGetDB( DB_MASTER
);
2998 $dbw->onTransactionIdle( function() use ( $dbw, $method ) {
3000 'page_restrictions',
3001 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
3006 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
3013 * Does this have subpages? (Warning, usually requires an extra DB query.)
3017 public function hasSubpages() {
3018 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3023 # We dynamically add a member variable for the purpose of this method
3024 # alone to cache the result. There's no point in having it hanging
3025 # around uninitialized in every Title object; therefore we only add it
3026 # if needed and don't declare it statically.
3027 if ( $this->mHasSubpages
=== null ) {
3028 $this->mHasSubpages
= false;
3029 $subpages = $this->getSubpages( 1 );
3030 if ( $subpages instanceof TitleArray
) {
3031 $this->mHasSubpages
= (bool)$subpages->count();
3035 return $this->mHasSubpages
;
3039 * Get all subpages of this page.
3041 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3042 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3043 * doesn't allow subpages
3045 public function getSubpages( $limit = -1 ) {
3046 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3050 $dbr = wfGetDB( DB_SLAVE
);
3051 $conds['page_namespace'] = $this->getNamespace();
3052 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
3054 if ( $limit > -1 ) {
3055 $options['LIMIT'] = $limit;
3057 $this->mSubpages
= TitleArray
::newFromResult(
3058 $dbr->select( 'page',
3059 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
3065 return $this->mSubpages
;
3069 * Is there a version of this page in the deletion archive?
3071 * @return int The number of archived revisions
3073 public function isDeleted() {
3074 if ( $this->getNamespace() < 0 ) {
3077 $dbr = wfGetDB( DB_SLAVE
);
3079 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3080 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3083 if ( $this->getNamespace() == NS_FILE
) {
3084 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
3085 array( 'fa_name' => $this->getDBkey() ),
3094 * Is there a version of this page in the deletion archive?
3098 public function isDeletedQuick() {
3099 if ( $this->getNamespace() < 0 ) {
3102 $dbr = wfGetDB( DB_SLAVE
);
3103 $deleted = (bool)$dbr->selectField( 'archive', '1',
3104 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3107 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
3108 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3109 array( 'fa_name' => $this->getDBkey() ),
3117 * Get the article ID for this Title from the link cache,
3118 * adding it if necessary
3120 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3122 * @return int The ID
3124 public function getArticleID( $flags = 0 ) {
3125 if ( $this->getNamespace() < 0 ) {
3126 $this->mArticleID
= 0;
3127 return $this->mArticleID
;
3129 $linkCache = LinkCache
::singleton();
3130 if ( $flags & self
::GAID_FOR_UPDATE
) {
3131 $oldUpdate = $linkCache->forUpdate( true );
3132 $linkCache->clearLink( $this );
3133 $this->mArticleID
= $linkCache->addLinkObj( $this );
3134 $linkCache->forUpdate( $oldUpdate );
3136 if ( -1 == $this->mArticleID
) {
3137 $this->mArticleID
= $linkCache->addLinkObj( $this );
3140 return $this->mArticleID
;
3144 * Is this an article that is a redirect page?
3145 * Uses link cache, adding it if necessary
3147 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3150 public function isRedirect( $flags = 0 ) {
3151 if ( !is_null( $this->mRedirect
) ) {
3152 return $this->mRedirect
;
3154 # Calling getArticleID() loads the field from cache as needed
3155 if ( !$this->getArticleID( $flags ) ) {
3156 $this->mRedirect
= false;
3157 return $this->mRedirect
;
3160 $linkCache = LinkCache
::singleton();
3161 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3162 if ( $cached === null ) {
3163 # Trust LinkCache's state over our own
3164 # LinkCache is telling us that the page doesn't exist, despite there being cached
3165 # data relating to an existing page in $this->mArticleID. Updaters should clear
3166 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3167 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3168 # LinkCache to refresh its data from the master.
3169 $this->mRedirect
= false;
3170 return $this->mRedirect
;
3173 $this->mRedirect
= (bool)$cached;
3175 return $this->mRedirect
;
3179 * What is the length of this page?
3180 * Uses link cache, adding it if necessary
3182 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3185 public function getLength( $flags = 0 ) {
3186 if ( $this->mLength
!= -1 ) {
3187 return $this->mLength
;
3189 # Calling getArticleID() loads the field from cache as needed
3190 if ( !$this->getArticleID( $flags ) ) {
3192 return $this->mLength
;
3194 $linkCache = LinkCache
::singleton();
3195 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3196 if ( $cached === null ) {
3197 # Trust LinkCache's state over our own, as for isRedirect()
3199 return $this->mLength
;
3202 $this->mLength
= intval( $cached );
3204 return $this->mLength
;
3208 * What is the page_latest field for this page?
3210 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3211 * @return int Int or 0 if the page doesn't exist
3213 public function getLatestRevID( $flags = 0 ) {
3214 if ( !( $flags & Title
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
3215 return intval( $this->mLatestID
);
3217 # Calling getArticleID() loads the field from cache as needed
3218 if ( !$this->getArticleID( $flags ) ) {
3219 $this->mLatestID
= 0;
3220 return $this->mLatestID
;
3222 $linkCache = LinkCache
::singleton();
3223 $linkCache->addLinkObj( $this );
3224 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3225 if ( $cached === null ) {
3226 # Trust LinkCache's state over our own, as for isRedirect()
3227 $this->mLatestID
= 0;
3228 return $this->mLatestID
;
3231 $this->mLatestID
= intval( $cached );
3233 return $this->mLatestID
;
3237 * This clears some fields in this object, and clears any associated
3238 * keys in the "bad links" section of the link cache.
3240 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
3241 * loading of the new page_id. It's also called from
3242 * WikiPage::doDeleteArticleReal()
3244 * @param int $newid The new Article ID
3246 public function resetArticleID( $newid ) {
3247 $linkCache = LinkCache
::singleton();
3248 $linkCache->clearLink( $this );
3250 if ( $newid === false ) {
3251 $this->mArticleID
= -1;
3253 $this->mArticleID
= intval( $newid );
3255 $this->mRestrictionsLoaded
= false;
3256 $this->mRestrictions
= array();
3257 $this->mRedirect
= null;
3258 $this->mLength
= -1;
3259 $this->mLatestID
= false;
3260 $this->mContentModel
= false;
3261 $this->mEstimateRevisions
= null;
3262 $this->mPageLanguage
= false;
3263 $this->mDbPageLanguage
= null;
3267 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3269 * @param string $text Containing title to capitalize
3270 * @param int $ns Namespace index, defaults to NS_MAIN
3271 * @return string Containing capitalized title
3273 public static function capitalize( $text, $ns = NS_MAIN
) {
3276 if ( MWNamespace
::isCapitalized( $ns ) ) {
3277 return $wgContLang->ucfirst( $text );
3284 * Secure and split - main initialisation function for this object
3286 * Assumes that mDbkeyform has been set, and is urldecoded
3287 * and uses underscores, but not otherwise munged. This function
3288 * removes illegal characters, splits off the interwiki and
3289 * namespace prefixes, sets the other forms, and canonicalizes
3292 * @return bool True on success
3294 private function secureAndSplit() {
3296 $this->mInterwiki
= '';
3297 $this->mFragment
= '';
3298 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
3300 $dbkey = $this->mDbkeyform
;
3303 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3304 // the parsing code with Title, while avoiding massive refactoring.
3305 // @todo: get rid of secureAndSplit, refactor parsing code.
3306 $parser = $this->getTitleParser();
3307 $parts = $parser->splitTitleString( $dbkey, $this->getDefaultNamespace() );
3308 } catch ( MalformedTitleException
$ex ) {
3313 $this->setFragment( '#' . $parts['fragment'] );
3314 $this->mInterwiki
= $parts['interwiki'];
3315 $this->mNamespace
= $parts['namespace'];
3316 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3318 $this->mDbkeyform
= $parts['dbkey'];
3319 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3320 $this->mTextform
= str_replace( '_', ' ', $this->mDbkeyform
);
3322 # We already know that some pages won't be in the database!
3323 if ( $this->isExternal() ||
$this->mNamespace
== NS_SPECIAL
) {
3324 $this->mArticleID
= 0;
3331 * Get an array of Title objects linking to this Title
3332 * Also stores the IDs in the link cache.
3334 * WARNING: do not use this function on arbitrary user-supplied titles!
3335 * On heavily-used templates it will max out the memory.
3337 * @param array $options May be FOR UPDATE
3338 * @param string $table Table name
3339 * @param string $prefix Fields prefix
3340 * @return Title[] Array of Title objects linking here
3342 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3343 if ( count( $options ) > 0 ) {
3344 $db = wfGetDB( DB_MASTER
);
3346 $db = wfGetDB( DB_SLAVE
);
3350 array( 'page', $table ),
3351 self
::getSelectFields(),
3353 "{$prefix}_from=page_id",
3354 "{$prefix}_namespace" => $this->getNamespace(),
3355 "{$prefix}_title" => $this->getDBkey() ),
3361 if ( $res->numRows() ) {
3362 $linkCache = LinkCache
::singleton();
3363 foreach ( $res as $row ) {
3364 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
3366 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3367 $retVal[] = $titleObj;
3375 * Get an array of Title objects using this Title as a template
3376 * Also stores the IDs in the link cache.
3378 * WARNING: do not use this function on arbitrary user-supplied titles!
3379 * On heavily-used templates it will max out the memory.
3381 * @param array $options May be FOR UPDATE
3382 * @return Title[] Array of Title the Title objects linking here
3384 public function getTemplateLinksTo( $options = array() ) {
3385 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3389 * Get an array of Title objects linked from this Title
3390 * Also stores the IDs in the link cache.
3392 * WARNING: do not use this function on arbitrary user-supplied titles!
3393 * On heavily-used templates it will max out the memory.
3395 * @param array $options May be FOR UPDATE
3396 * @param string $table Table name
3397 * @param string $prefix Fields prefix
3398 * @return array Array of Title objects linking here
3400 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3401 global $wgContentHandlerUseDB;
3403 $id = $this->getArticleID();
3405 # If the page doesn't exist; there can't be any link from this page
3410 if ( count( $options ) > 0 ) {
3411 $db = wfGetDB( DB_MASTER
);
3413 $db = wfGetDB( DB_SLAVE
);
3416 $namespaceFiled = "{$prefix}_namespace";
3417 $titleField = "{$prefix}_title";
3428 if ( $wgContentHandlerUseDB ) {
3429 $fields[] = 'page_content_model';
3433 array( $table, 'page' ),
3435 array( "{$prefix}_from" => $id ),
3438 array( 'page' => array(
3440 array( "page_namespace=$namespaceFiled", "page_title=$titleField" )
3445 if ( $res->numRows() ) {
3446 $linkCache = LinkCache
::singleton();
3447 foreach ( $res as $row ) {
3448 $titleObj = Title
::makeTitle( $row->$namespaceFiled, $row->$titleField );
3450 if ( $row->page_id
) {
3451 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3453 $linkCache->addBadLinkObj( $titleObj );
3455 $retVal[] = $titleObj;
3463 * Get an array of Title objects used on this Title as a template
3464 * Also stores the IDs in the link cache.
3466 * WARNING: do not use this function on arbitrary user-supplied titles!
3467 * On heavily-used templates it will max out the memory.
3469 * @param array $options May be FOR UPDATE
3470 * @return Title[] Array of Title the Title objects used here
3472 public function getTemplateLinksFrom( $options = array() ) {
3473 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3477 * Get an array of Title objects referring to non-existent articles linked
3480 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3481 * should use redirect table in this case).
3482 * @return Title[] Array of Title the Title objects
3484 public function getBrokenLinksFrom() {
3485 if ( $this->getArticleID() == 0 ) {
3486 # All links from article ID 0 are false positives
3490 $dbr = wfGetDB( DB_SLAVE
);
3491 $res = $dbr->select(
3492 array( 'page', 'pagelinks' ),
3493 array( 'pl_namespace', 'pl_title' ),
3495 'pl_from' => $this->getArticleID(),
3496 'page_namespace IS NULL'
3498 __METHOD__
, array(),
3502 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3508 foreach ( $res as $row ) {
3509 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3515 * Get a list of URLs to purge from the Squid cache when this
3518 * @return string[] Array of String the URLs
3520 public function getSquidURLs() {
3522 $this->getInternalURL(),
3523 $this->getInternalURL( 'action=history' )
3526 $pageLang = $this->getPageLanguage();
3527 if ( $pageLang->hasVariants() ) {
3528 $variants = $pageLang->getVariants();
3529 foreach ( $variants as $vCode ) {
3530 $urls[] = $this->getInternalURL( '', $vCode );
3534 // If we are looking at a css/js user subpage, purge the action=raw.
3535 if ( $this->isJsSubpage() ) {
3536 $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/javascript' );
3537 } elseif ( $this->isCssSubpage() ) {
3538 $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/css' );
3541 wfRunHooks( 'TitleSquidURLs', array( $this, &$urls ) );
3546 * Purge all applicable Squid URLs
3548 public function purgeSquid() {
3550 if ( $wgUseSquid ) {
3551 $urls = $this->getSquidURLs();
3552 $u = new SquidUpdate( $urls );
3558 * Move this page without authentication
3560 * @param Title $nt The new page Title
3561 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3563 public function moveNoAuth( &$nt ) {
3564 return $this->moveTo( $nt, false );
3568 * Check whether a given move operation would be valid.
3569 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3571 * @param Title $nt The new title
3572 * @param bool $auth Indicates whether $wgUser's permissions
3574 * @param string $reason Is the log summary of the move, used for spam checking
3575 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3577 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3578 global $wgUser, $wgContentHandlerUseDB;
3582 // Normally we'd add this to $errors, but we'll get
3583 // lots of syntax errors if $nt is not an object
3584 return array( array( 'badtitletext' ) );
3586 if ( $this->equals( $nt ) ) {
3587 $errors[] = array( 'selfmove' );
3589 if ( !$this->isMovable() ) {
3590 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3592 if ( $nt->isExternal() ) {
3593 $errors[] = array( 'immobile-target-namespace-iw' );
3595 if ( !$nt->isMovable() ) {
3596 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3599 $oldid = $this->getArticleID();
3600 $newid = $nt->getArticleID();
3602 if ( strlen( $nt->getDBkey() ) < 1 ) {
3603 $errors[] = array( 'articleexists' );
3606 ( $this->getDBkey() == '' ) ||
3608 ( $nt->getDBkey() == '' )
3610 $errors[] = array( 'badarticleerror' );
3613 // Content model checks
3614 if ( !$wgContentHandlerUseDB &&
3615 $this->getContentModel() !== $nt->getContentModel() ) {
3616 // can't move a page if that would change the page's content model
3619 ContentHandler
::getLocalizedName( $this->getContentModel() ),
3620 ContentHandler
::getLocalizedName( $nt->getContentModel() )
3624 // Image-specific checks
3625 if ( $this->getNamespace() == NS_FILE
) {
3626 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3629 if ( $nt->getNamespace() == NS_FILE
&& $this->getNamespace() != NS_FILE
) {
3630 $errors[] = array( 'nonfile-cannot-move-to-file' );
3634 $errors = wfMergeErrorArrays( $errors,
3635 $this->getUserPermissionsErrors( 'move', $wgUser ),
3636 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3637 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3638 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3641 $match = EditPage
::matchSummarySpamRegex( $reason );
3642 if ( $match !== false ) {
3643 // This is kind of lame, won't display nice
3644 $errors[] = array( 'spamprotectiontext' );
3648 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3649 $errors[] = array( 'hookaborted', $err );
3652 # The move is allowed only if (1) the target doesn't exist, or
3653 # (2) the target is a redirect to the source, and has no history
3654 # (so we can undo bad moves right after they're done).
3656 if ( 0 != $newid ) { # Target exists; check for validity
3657 if ( !$this->isValidMoveTarget( $nt ) ) {
3658 $errors[] = array( 'articleexists' );
3661 $tp = $nt->getTitleProtection();
3662 $right = $tp['pt_create_perm'];
3663 if ( $right == 'sysop' ) {
3664 $right = 'editprotected'; // B/C
3666 if ( $right == 'autoconfirmed' ) {
3667 $right = 'editsemiprotected'; // B/C
3669 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3670 $errors[] = array( 'cantmove-titleprotected' );
3673 if ( empty( $errors ) ) {
3680 * Check if the requested move target is a valid file move target
3681 * @param Title $nt Target title
3682 * @return array List of errors
3684 protected function validateFileMoveOperation( $nt ) {
3689 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3691 $file = wfLocalFile( $this );
3692 if ( $file->exists() ) {
3693 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3694 $errors[] = array( 'imageinvalidfilename' );
3696 if ( !File
::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3697 $errors[] = array( 'imagetypemismatch' );
3701 if ( $nt->getNamespace() != NS_FILE
) {
3702 $errors[] = array( 'imagenocrossnamespace' );
3703 // From here we want to do checks on a file object, so if we can't
3704 // create one, we must return.
3708 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3710 $destFile = wfLocalFile( $nt );
3711 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3712 $errors[] = array( 'file-exists-sharedrepo' );
3719 * Move a title to a new location
3721 * @param Title $nt The new title
3722 * @param bool $auth Indicates whether $wgUser's permissions
3724 * @param string $reason The reason for the move
3725 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3726 * Ignored if the user doesn't have the suppressredirect right.
3727 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3729 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3731 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3732 if ( is_array( $err ) ) {
3733 // Auto-block user's IP if the account was "hard" blocked
3734 $wgUser->spreadAnyEditBlock();
3737 // Check suppressredirect permission
3738 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3739 $createRedirect = true;
3742 wfRunHooks( 'TitleMove', array( $this, $nt, $wgUser ) );
3744 // If it is a file, move it first.
3745 // It is done before all other moving stuff is done because it's hard to revert.
3746 $dbw = wfGetDB( DB_MASTER
);
3747 if ( $this->getNamespace() == NS_FILE
) {
3748 $file = wfLocalFile( $this );
3749 if ( $file->exists() ) {
3750 $status = $file->move( $nt );
3751 if ( !$status->isOk() ) {
3752 return $status->getErrorsArray();
3755 // Clear RepoGroup process cache
3756 RepoGroup
::singleton()->clearCache( $this );
3757 RepoGroup
::singleton()->clearCache( $nt ); # clear false negative cache
3760 $dbw->begin( __METHOD__
); # If $file was a LocalFile, its transaction would have closed our own.
3761 $pageid = $this->getArticleID( self
::GAID_FOR_UPDATE
);
3762 $protected = $this->isProtected();
3764 // Do the actual move
3765 $this->moveToInternal( $nt, $reason, $createRedirect );
3767 // Refresh the sortkey for this row. Be careful to avoid resetting
3768 // cl_timestamp, which may disturb time-based lists on some sites.
3769 $prefixes = $dbw->select(
3771 array( 'cl_sortkey_prefix', 'cl_to' ),
3772 array( 'cl_from' => $pageid ),
3775 foreach ( $prefixes as $prefixRow ) {
3776 $prefix = $prefixRow->cl_sortkey_prefix
;
3777 $catTo = $prefixRow->cl_to
;
3778 $dbw->update( 'categorylinks',
3780 'cl_sortkey' => Collation
::singleton()->getSortKey(
3781 $nt->getCategorySortkey( $prefix ) ),
3782 'cl_timestamp=cl_timestamp' ),
3784 'cl_from' => $pageid,
3785 'cl_to' => $catTo ),
3790 $redirid = $this->getArticleID();
3793 # Protect the redirect title as the title used to be...
3794 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3796 'pr_page' => $redirid,
3797 'pr_type' => 'pr_type',
3798 'pr_level' => 'pr_level',
3799 'pr_cascade' => 'pr_cascade',
3800 'pr_user' => 'pr_user',
3801 'pr_expiry' => 'pr_expiry'
3803 array( 'pr_page' => $pageid ),
3807 # Update the protection log
3808 $log = new LogPage( 'protect' );
3809 $comment = wfMessage(
3811 $this->getPrefixedText(),
3812 $nt->getPrefixedText()
3813 )->inContentLanguage()->text();
3815 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3817 // @todo FIXME: $params?
3818 $logId = $log->addEntry(
3822 array( $this->getPrefixedText() ),
3826 // reread inserted pr_ids for log relation
3827 $insertedPrIds = $dbw->select(
3828 'page_restrictions',
3830 array( 'pr_page' => $redirid ),
3833 $logRelationsValues = array();
3834 foreach ( $insertedPrIds as $prid ) {
3835 $logRelationsValues[] = $prid->pr_id
;
3837 $log->addRelations( 'pr_id', $logRelationsValues, $logId );
3841 $oldnamespace = MWNamespace
::getSubject( $this->getNamespace() );
3842 $newnamespace = MWNamespace
::getSubject( $nt->getNamespace() );
3843 $oldtitle = $this->getDBkey();
3844 $newtitle = $nt->getDBkey();
3846 if ( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
3847 WatchedItem
::duplicateEntries( $this, $nt );
3850 $dbw->commit( __METHOD__
);
3852 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid, $reason ) );
3857 * Move page to a title which is either a redirect to the
3858 * source page or nonexistent
3860 * @param Title $nt The page to move to, which should be a redirect or nonexistent
3861 * @param string $reason The reason for the move
3862 * @param bool $createRedirect Whether to leave a redirect at the old title. Does not check
3863 * if the user has the suppressredirect right
3864 * @throws MWException
3866 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3867 global $wgUser, $wgContLang;
3869 if ( $nt->exists() ) {
3870 $moveOverRedirect = true;
3871 $logType = 'move_redir';
3873 $moveOverRedirect = false;
3877 if ( $createRedirect ) {
3878 if ( $this->getNamespace() == NS_CATEGORY
3879 && !wfMessage( 'category-move-redirect-override' )->inContentLanguage()->isDisabled()
3881 $redirectContent = new WikitextContent(
3882 wfMessage( 'category-move-redirect-override' )
3883 ->params( $nt->getPrefixedText() )->inContentLanguage()->plain() );
3885 $contentHandler = ContentHandler
::getForTitle( $this );
3886 $redirectContent = $contentHandler->makeRedirectContent( $nt,
3887 wfMessage( 'move-redirect-text' )->inContentLanguage()->plain() );
3890 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
3892 $redirectContent = null;
3895 $logEntry = new ManualLogEntry( 'move', $logType );
3896 $logEntry->setPerformer( $wgUser );
3897 $logEntry->setTarget( $this );
3898 $logEntry->setComment( $reason );
3899 $logEntry->setParameters( array(
3900 '4::target' => $nt->getPrefixedText(),
3901 '5::noredir' => $redirectContent ?
'0': '1',
3904 $formatter = LogFormatter
::newFromEntry( $logEntry );
3905 $formatter->setContext( RequestContext
::newExtraneousContext( $this ) );
3906 $comment = $formatter->getPlainActionText();
3908 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3910 # Truncate for whole multibyte characters.
3911 $comment = $wgContLang->truncate( $comment, 255 );
3913 $oldid = $this->getArticleID();
3915 $dbw = wfGetDB( DB_MASTER
);
3917 $newpage = WikiPage
::factory( $nt );
3919 if ( $moveOverRedirect ) {
3920 $newid = $nt->getArticleID();
3921 $newcontent = $newpage->getContent();
3923 # Delete the old redirect. We don't save it to history since
3924 # by definition if we've got here it's rather uninteresting.
3925 # We have to remove it so that the next step doesn't trigger
3926 # a conflict on the unique namespace+title index...
3927 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__
);
3929 $newpage->doDeleteUpdates( $newid, $newcontent );
3932 # Save a null revision in the page's history notifying of the move
3933 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true, $wgUser );
3934 if ( !is_object( $nullRevision ) ) {
3935 throw new MWException( 'No valid null revision produced in ' . __METHOD__
);
3938 $nullRevision->insertOn( $dbw );
3940 # Change the name of the target page:
3941 $dbw->update( 'page',
3943 'page_namespace' => $nt->getNamespace(),
3944 'page_title' => $nt->getDBkey(),
3946 /* WHERE */ array( 'page_id' => $oldid ),
3950 // clean up the old title before reset article id - bug 45348
3951 if ( !$redirectContent ) {
3952 WikiPage
::onArticleDelete( $this );
3955 $this->resetArticleID( 0 ); // 0 == non existing
3956 $nt->resetArticleID( $oldid );
3957 $newpage->loadPageData( WikiPage
::READ_LOCKING
); // bug 46397
3959 $newpage->updateRevisionOn( $dbw, $nullRevision );
3961 wfRunHooks( 'NewRevisionFromEditComplete',
3962 array( $newpage, $nullRevision, $nullRevision->getParentId(), $wgUser ) );
3964 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3966 if ( !$moveOverRedirect ) {
3967 WikiPage
::onArticleCreate( $nt );
3970 # Recreate the redirect, this time in the other direction.
3971 if ( $redirectContent ) {
3972 $redirectArticle = WikiPage
::factory( $this );
3973 $redirectArticle->loadFromRow( false, WikiPage
::READ_LOCKING
); // bug 46397
3974 $newid = $redirectArticle->insertOn( $dbw );
3975 if ( $newid ) { // sanity
3976 $this->resetArticleID( $newid );
3977 $redirectRevision = new Revision( array(
3978 'title' => $this, // for determining the default content model
3980 'user_text' => $wgUser->getName(),
3981 'user' => $wgUser->getId(),
3982 'comment' => $comment,
3983 'content' => $redirectContent ) );
3984 $redirectRevision->insertOn( $dbw );
3985 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3987 wfRunHooks( 'NewRevisionFromEditComplete',
3988 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3990 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3995 $logid = $logEntry->insert();
3996 $logEntry->publish( $logid );
4000 * Move this page's subpages to be subpages of $nt
4002 * @param Title $nt Move target
4003 * @param bool $auth Whether $wgUser's permissions should be checked
4004 * @param string $reason The reason for the move
4005 * @param bool $createRedirect Whether to create redirects from the old subpages to
4006 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
4007 * @return array Array with old page titles as keys, and strings (new page titles) or
4008 * arrays (errors) as values, or an error array with numeric indices if no pages
4011 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
4012 global $wgMaximumMovedPages;
4013 // Check permissions
4014 if ( !$this->userCan( 'move-subpages' ) ) {
4015 return array( 'cant-move-subpages' );
4017 // Do the source and target namespaces support subpages?
4018 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
4019 return array( 'namespace-nosubpages',
4020 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
4022 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
4023 return array( 'namespace-nosubpages',
4024 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
4027 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
4030 foreach ( $subpages as $oldSubpage ) {
4032 if ( $count > $wgMaximumMovedPages ) {
4033 $retval[$oldSubpage->getPrefixedText()] =
4034 array( 'movepage-max-pages',
4035 $wgMaximumMovedPages );
4039 // We don't know whether this function was called before
4040 // or after moving the root page, so check both
4042 if ( $oldSubpage->getArticleID() == $this->getArticleID()
4043 ||
$oldSubpage->getArticleID() == $nt->getArticleID()
4045 // When moving a page to a subpage of itself,
4046 // don't move it twice
4049 $newPageName = preg_replace(
4050 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
4051 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
4052 $oldSubpage->getDBkey() );
4053 if ( $oldSubpage->isTalkPage() ) {
4054 $newNs = $nt->getTalkPage()->getNamespace();
4056 $newNs = $nt->getSubjectPage()->getNamespace();
4058 # Bug 14385: we need makeTitleSafe because the new page names may
4059 # be longer than 255 characters.
4060 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
4062 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
4063 if ( $success === true ) {
4064 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
4066 $retval[$oldSubpage->getPrefixedText()] = $success;
4073 * Checks if this page is just a one-rev redirect.
4074 * Adds lock, so don't use just for light purposes.
4078 public function isSingleRevRedirect() {
4079 global $wgContentHandlerUseDB;
4081 $dbw = wfGetDB( DB_MASTER
);
4084 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
4085 if ( $wgContentHandlerUseDB ) {
4086 $fields[] = 'page_content_model';
4089 $row = $dbw->selectRow( 'page',
4093 array( 'FOR UPDATE' )
4095 # Cache some fields we may want
4096 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
4097 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
4098 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
4099 $this->mContentModel
= $row && isset( $row->page_content_model
)
4100 ?
strval( $row->page_content_model
)
4103 if ( !$this->mRedirect
) {
4106 # Does the article have a history?
4107 $row = $dbw->selectField( array( 'page', 'revision' ),
4109 array( 'page_namespace' => $this->getNamespace(),
4110 'page_title' => $this->getDBkey(),
4112 'page_latest != rev_id'
4115 array( 'FOR UPDATE' )
4117 # Return true if there was no history
4118 return ( $row === false );
4122 * Checks if $this can be moved to a given Title
4123 * - Selects for update, so don't call it unless you mean business
4125 * @param Title $nt The new title to check
4128 public function isValidMoveTarget( $nt ) {
4129 # Is it an existing file?
4130 if ( $nt->getNamespace() == NS_FILE
) {
4131 $file = wfLocalFile( $nt );
4132 if ( $file->exists() ) {
4133 wfDebug( __METHOD__
. ": file exists\n" );
4137 # Is it a redirect with no history?
4138 if ( !$nt->isSingleRevRedirect() ) {
4139 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
4142 # Get the article text
4143 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
4144 if ( !is_object( $rev ) ) {
4147 $content = $rev->getContent();
4148 # Does the redirect point to the source?
4149 # Or is it a broken self-redirect, usually caused by namespace collisions?
4150 $redirTitle = $content ?
$content->getRedirectTarget() : null;
4152 if ( $redirTitle ) {
4153 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
4154 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
4155 wfDebug( __METHOD__
. ": redirect points to other page\n" );
4161 # Fail safe (not a redirect after all. strange.)
4162 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4163 " is a redirect, but it doesn't contain a valid redirect.\n" );
4169 * Get categories to which this Title belongs and return an array of
4170 * categories' names.
4172 * @return array Array of parents in the form:
4173 * $parent => $currentarticle
4175 public function getParentCategories() {
4180 $titleKey = $this->getArticleID();
4182 if ( $titleKey === 0 ) {
4186 $dbr = wfGetDB( DB_SLAVE
);
4188 $res = $dbr->select(
4191 array( 'cl_from' => $titleKey ),
4195 if ( $res->numRows() > 0 ) {
4196 foreach ( $res as $row ) {
4197 // $data[] = Title::newFromText($wgContLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
4198 $data[$wgContLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
4205 * Get a tree of parent categories
4207 * @param array $children Array with the children in the keys, to check for circular refs
4208 * @return array Tree of parent categories
4210 public function getParentCategoryTree( $children = array() ) {
4212 $parents = $this->getParentCategories();
4215 foreach ( $parents as $parent => $current ) {
4216 if ( array_key_exists( $parent, $children ) ) {
4217 # Circular reference
4218 $stack[$parent] = array();
4220 $nt = Title
::newFromText( $parent );
4222 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
4232 * Get an associative array for selecting this title from
4235 * @return array Array suitable for the $where parameter of DB::select()
4237 public function pageCond() {
4238 if ( $this->mArticleID
> 0 ) {
4239 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4240 return array( 'page_id' => $this->mArticleID
);
4242 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
4247 * Get the revision ID of the previous revision
4249 * @param int $revId Revision ID. Get the revision that was before this one.
4250 * @param int $flags Title::GAID_FOR_UPDATE
4251 * @return int|bool Old revision ID, or false if none exists
4253 public function getPreviousRevisionID( $revId, $flags = 0 ) {
4254 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
4255 $revId = $db->selectField( 'revision', 'rev_id',
4257 'rev_page' => $this->getArticleID( $flags ),
4258 'rev_id < ' . intval( $revId )
4261 array( 'ORDER BY' => 'rev_id DESC' )
4264 if ( $revId === false ) {
4267 return intval( $revId );
4272 * Get the revision ID of the next revision
4274 * @param int $revId Revision ID. Get the revision that was after this one.
4275 * @param int $flags Title::GAID_FOR_UPDATE
4276 * @return int|bool Next revision ID, or false if none exists
4278 public function getNextRevisionID( $revId, $flags = 0 ) {
4279 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
4280 $revId = $db->selectField( 'revision', 'rev_id',
4282 'rev_page' => $this->getArticleID( $flags ),
4283 'rev_id > ' . intval( $revId )
4286 array( 'ORDER BY' => 'rev_id' )
4289 if ( $revId === false ) {
4292 return intval( $revId );
4297 * Get the first revision of the page
4299 * @param int $flags Title::GAID_FOR_UPDATE
4300 * @return Revision|null If page doesn't exist
4302 public function getFirstRevision( $flags = 0 ) {
4303 $pageId = $this->getArticleID( $flags );
4305 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
4306 $row = $db->selectRow( 'revision', Revision
::selectFields(),
4307 array( 'rev_page' => $pageId ),
4309 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
4312 return new Revision( $row );
4319 * Get the oldest revision timestamp of this page
4321 * @param int $flags Title::GAID_FOR_UPDATE
4322 * @return string MW timestamp
4324 public function getEarliestRevTime( $flags = 0 ) {
4325 $rev = $this->getFirstRevision( $flags );
4326 return $rev ?
$rev->getTimestamp() : null;
4330 * Check if this is a new page
4334 public function isNewPage() {
4335 $dbr = wfGetDB( DB_SLAVE
);
4336 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4340 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4344 public function isBigDeletion() {
4345 global $wgDeleteRevisionsLimit;
4347 if ( !$wgDeleteRevisionsLimit ) {
4351 $revCount = $this->estimateRevisionCount();
4352 return $revCount > $wgDeleteRevisionsLimit;
4356 * Get the approximate revision count of this page.
4360 public function estimateRevisionCount() {
4361 if ( !$this->exists() ) {
4365 if ( $this->mEstimateRevisions
=== null ) {
4366 $dbr = wfGetDB( DB_SLAVE
);
4367 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4368 array( 'rev_page' => $this->getArticleID() ), __METHOD__
);
4371 return $this->mEstimateRevisions
;
4375 * Get the number of revisions between the given revision.
4376 * Used for diffs and other things that really need it.
4378 * @param int|Revision $old Old revision or rev ID (first before range)
4379 * @param int|Revision $new New revision or rev ID (first after range)
4380 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4381 * @return int Number of revisions between these revisions.
4383 public function countRevisionsBetween( $old, $new, $max = null ) {
4384 if ( !( $old instanceof Revision
) ) {
4385 $old = Revision
::newFromTitle( $this, (int)$old );
4387 if ( !( $new instanceof Revision
) ) {
4388 $new = Revision
::newFromTitle( $this, (int)$new );
4390 if ( !$old ||
!$new ) {
4391 return 0; // nothing to compare
4393 $dbr = wfGetDB( DB_SLAVE
);
4395 'rev_page' => $this->getArticleID(),
4396 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4397 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4399 if ( $max !== null ) {
4400 $res = $dbr->select( 'revision', '1',
4403 array( 'LIMIT' => $max +
1 ) // extra to detect truncation
4405 return $res->numRows();
4407 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
4412 * Get the authors between the given revisions or revision IDs.
4413 * Used for diffs and other things that really need it.
4417 * @param int|Revision $old Old revision or rev ID (first before range by default)
4418 * @param int|Revision $new New revision or rev ID (first after range by default)
4419 * @param int $limit Maximum number of authors
4420 * @param string|array $options (Optional): Single option, or an array of options:
4421 * 'include_old' Include $old in the range; $new is excluded.
4422 * 'include_new' Include $new in the range; $old is excluded.
4423 * 'include_both' Include both $old and $new in the range.
4424 * Unknown option values are ignored.
4425 * @return array|null Names of revision authors in the range; null if not both revisions exist
4427 public function getAuthorsBetween( $old, $new, $limit, $options = array() ) {
4428 if ( !( $old instanceof Revision
) ) {
4429 $old = Revision
::newFromTitle( $this, (int)$old );
4431 if ( !( $new instanceof Revision
) ) {
4432 $new = Revision
::newFromTitle( $this, (int)$new );
4434 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4435 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4436 // in the sanity check below?
4437 if ( !$old ||
!$new ) {
4438 return null; // nothing to compare
4443 $options = (array)$options;
4444 if ( in_array( 'include_old', $options ) ) {
4447 if ( in_array( 'include_new', $options ) ) {
4450 if ( in_array( 'include_both', $options ) ) {
4454 // No DB query needed if $old and $new are the same or successive revisions:
4455 if ( $old->getId() === $new->getId() ) {
4456 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
array() : array( $old->getRawUserText() );
4457 } elseif ( $old->getId() === $new->getParentId() ) {
4458 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4459 $authors[] = $old->getRawUserText();
4460 if ( $old->getRawUserText() != $new->getRawUserText() ) {
4461 $authors[] = $new->getRawUserText();
4463 } elseif ( $old_cmp === '>=' ) {
4464 $authors[] = $old->getRawUserText();
4465 } elseif ( $new_cmp === '<=' ) {
4466 $authors[] = $new->getRawUserText();
4470 $dbr = wfGetDB( DB_SLAVE
);
4471 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4473 'rev_page' => $this->getArticleID(),
4474 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4475 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4477 array( 'LIMIT' => $limit +
1 ) // add one so caller knows it was truncated
4479 foreach ( $res as $row ) {
4480 $authors[] = $row->rev_user_text
;
4486 * Get the number of authors between the given revisions or revision IDs.
4487 * Used for diffs and other things that really need it.
4489 * @param int|Revision $old Old revision or rev ID (first before range by default)
4490 * @param int|Revision $new New revision or rev ID (first after range by default)
4491 * @param int $limit Maximum number of authors
4492 * @param string|array $options (Optional): Single option, or an array of options:
4493 * 'include_old' Include $old in the range; $new is excluded.
4494 * 'include_new' Include $new in the range; $old is excluded.
4495 * 'include_both' Include both $old and $new in the range.
4496 * Unknown option values are ignored.
4497 * @return int Number of revision authors in the range; zero if not both revisions exist
4499 public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4500 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4501 return $authors ?
count( $authors ) : 0;
4505 * Compare with another title.
4507 * @param Title $title
4510 public function equals( Title
$title ) {
4511 // Note: === is necessary for proper matching of number-like titles.
4512 return $this->getInterwiki() === $title->getInterwiki()
4513 && $this->getNamespace() == $title->getNamespace()
4514 && $this->getDBkey() === $title->getDBkey();
4518 * Check if this title is a subpage of another title
4520 * @param Title $title
4523 public function isSubpageOf( Title
$title ) {
4524 return $this->getInterwiki() === $title->getInterwiki()
4525 && $this->getNamespace() == $title->getNamespace()
4526 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4530 * Check if page exists. For historical reasons, this function simply
4531 * checks for the existence of the title in the page table, and will
4532 * thus return false for interwiki links, special pages and the like.
4533 * If you want to know if a title can be meaningfully viewed, you should
4534 * probably call the isKnown() method instead.
4538 public function exists() {
4539 return $this->getArticleID() != 0;
4543 * Should links to this title be shown as potentially viewable (i.e. as
4544 * "bluelinks"), even if there's no record by this title in the page
4547 * This function is semi-deprecated for public use, as well as somewhat
4548 * misleadingly named. You probably just want to call isKnown(), which
4549 * calls this function internally.
4551 * (ISSUE: Most of these checks are cheap, but the file existence check
4552 * can potentially be quite expensive. Including it here fixes a lot of
4553 * existing code, but we might want to add an optional parameter to skip
4554 * it and any other expensive checks.)
4558 public function isAlwaysKnown() {
4562 * Allows overriding default behavior for determining if a page exists.
4563 * If $isKnown is kept as null, regular checks happen. If it's
4564 * a boolean, this value is returned by the isKnown method.
4568 * @param Title $title
4569 * @param bool|null $isKnown
4571 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4573 if ( !is_null( $isKnown ) ) {
4577 if ( $this->isExternal() ) {
4578 return true; // any interwiki link might be viewable, for all we know
4581 switch ( $this->mNamespace
) {
4584 // file exists, possibly in a foreign repo
4585 return (bool)wfFindFile( $this );
4587 // valid special page
4588 return SpecialPageFactory
::exists( $this->getDBkey() );
4590 // selflink, possibly with fragment
4591 return $this->mDbkeyform
== '';
4593 // known system message
4594 return $this->hasSourceText() !== false;
4601 * Does this title refer to a page that can (or might) be meaningfully
4602 * viewed? In particular, this function may be used to determine if
4603 * links to the title should be rendered as "bluelinks" (as opposed to
4604 * "redlinks" to non-existent pages).
4605 * Adding something else to this function will cause inconsistency
4606 * since LinkHolderArray calls isAlwaysKnown() and does its own
4607 * page existence check.
4611 public function isKnown() {
4612 return $this->isAlwaysKnown() ||
$this->exists();
4616 * Does this page have source text?
4620 public function hasSourceText() {
4621 if ( $this->exists() ) {
4625 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4626 // If the page doesn't exist but is a known system message, default
4627 // message content will be displayed, same for language subpages-
4628 // Use always content language to avoid loading hundreds of languages
4629 // to get the link color.
4631 list( $name, ) = MessageCache
::singleton()->figureMessage(
4632 $wgContLang->lcfirst( $this->getText() )
4634 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4635 return $message->exists();
4642 * Get the default message text or false if the message doesn't exist
4644 * @return string|bool
4646 public function getDefaultMessageText() {
4649 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
4653 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4654 $wgContLang->lcfirst( $this->getText() )
4656 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4658 if ( $message->exists() ) {
4659 return $message->plain();
4666 * Updates page_touched for this page; called from LinksUpdate.php
4668 * @return bool True if the update succeeded
4670 public function invalidateCache() {
4671 if ( wfReadOnly() ) {
4675 if ( $this->mArticleID
=== 0 ) {
4676 return true; // avoid gap locking if we know it's not there
4679 $method = __METHOD__
;
4680 $dbw = wfGetDB( DB_MASTER
);
4681 $conds = $this->pageCond();
4682 $dbw->onTransactionIdle( function() use ( $dbw, $conds, $method ) {
4685 array( 'page_touched' => $dbw->timestamp() ),
4695 * Update page_touched timestamps and send squid purge messages for
4696 * pages linking to this title. May be sent to the job queue depending
4697 * on the number of links. Typically called on create and delete.
4699 public function touchLinks() {
4700 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4703 if ( $this->getNamespace() == NS_CATEGORY
) {
4704 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4710 * Get the last touched timestamp
4712 * @param DatabaseBase $db Optional db
4713 * @return string Last-touched timestamp
4715 public function getTouched( $db = null ) {
4716 if ( $db === null ) {
4717 $db = wfGetDB( DB_SLAVE
);
4719 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4724 * Get the timestamp when this page was updated since the user last saw it.
4727 * @return string|null
4729 public function getNotificationTimestamp( $user = null ) {
4730 global $wgUser, $wgShowUpdatedMarker;
4731 // Assume current user if none given
4735 // Check cache first
4736 $uid = $user->getId();
4737 // avoid isset here, as it'll return false for null entries
4738 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4739 return $this->mNotificationTimestamp
[$uid];
4741 if ( !$uid ||
!$wgShowUpdatedMarker ||
!$user->isAllowed( 'viewmywatchlist' ) ) {
4742 $this->mNotificationTimestamp
[$uid] = false;
4743 return $this->mNotificationTimestamp
[$uid];
4745 // Don't cache too much!
4746 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4747 $this->mNotificationTimestamp
= array();
4749 $dbr = wfGetDB( DB_SLAVE
);
4750 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
4751 'wl_notificationtimestamp',
4753 'wl_user' => $user->getId(),
4754 'wl_namespace' => $this->getNamespace(),
4755 'wl_title' => $this->getDBkey(),
4759 return $this->mNotificationTimestamp
[$uid];
4763 * Generate strings used for xml 'id' names in monobook tabs
4765 * @param string $prepend Defaults to 'nstab-'
4766 * @return string XML 'id' name
4768 public function getNamespaceKey( $prepend = 'nstab-' ) {
4770 // Gets the subject namespace if this title
4771 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4772 // Checks if canonical namespace name exists for namespace
4773 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4774 // Uses canonical namespace name
4775 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4777 // Uses text of namespace
4778 $namespaceKey = $this->getSubjectNsText();
4780 // Makes namespace key lowercase
4781 $namespaceKey = $wgContLang->lc( $namespaceKey );
4783 if ( $namespaceKey == '' ) {
4784 $namespaceKey = 'main';
4786 // Changes file to image for backwards compatibility
4787 if ( $namespaceKey == 'file' ) {
4788 $namespaceKey = 'image';
4790 return $prepend . $namespaceKey;
4794 * Get all extant redirects to this Title
4796 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4797 * @return Title[] Array of Title redirects to this title
4799 public function getRedirectsHere( $ns = null ) {
4802 $dbr = wfGetDB( DB_SLAVE
);
4804 'rd_namespace' => $this->getNamespace(),
4805 'rd_title' => $this->getDBkey(),
4808 if ( $this->isExternal() ) {
4809 $where['rd_interwiki'] = $this->getInterwiki();
4811 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4813 if ( !is_null( $ns ) ) {
4814 $where['page_namespace'] = $ns;
4817 $res = $dbr->select(
4818 array( 'redirect', 'page' ),
4819 array( 'page_namespace', 'page_title' ),
4824 foreach ( $res as $row ) {
4825 $redirs[] = self
::newFromRow( $row );
4831 * Check if this Title is a valid redirect target
4835 public function isValidRedirectTarget() {
4836 global $wgInvalidRedirectTargets;
4838 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4839 if ( $this->isSpecial( 'Userlogout' ) ) {
4843 foreach ( $wgInvalidRedirectTargets as $target ) {
4844 if ( $this->isSpecial( $target ) ) {
4853 * Get a backlink cache object
4855 * @return BacklinkCache
4857 public function getBacklinkCache() {
4858 return BacklinkCache
::get( $this );
4862 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4866 public function canUseNoindex() {
4867 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4869 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4870 ?
$wgContentNamespaces
4871 : $wgExemptFromUserRobotsControl;
4873 return !in_array( $this->mNamespace
, $bannedNamespaces );
4878 * Returns the raw sort key to be used for categories, with the specified
4879 * prefix. This will be fed to Collation::getSortKey() to get a
4880 * binary sortkey that can be used for actual sorting.
4882 * @param string $prefix The prefix to be used, specified using
4883 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4887 public function getCategorySortkey( $prefix = '' ) {
4888 $unprefixed = $this->getText();
4890 // Anything that uses this hook should only depend
4891 // on the Title object passed in, and should probably
4892 // tell the users to run updateCollations.php --force
4893 // in order to re-sort existing category relations.
4894 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4895 if ( $prefix !== '' ) {
4896 # Separate with a line feed, so the unprefixed part is only used as
4897 # a tiebreaker when two pages have the exact same prefix.
4898 # In UCA, tab is the only character that can sort above LF
4899 # so we strip both of them from the original prefix.
4900 $prefix = strtr( $prefix, "\n\t", ' ' );
4901 return "$prefix\n$unprefixed";
4907 * Get the language in which the content of this page is written in
4908 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4909 * e.g. $wgLang (such as special pages, which are in the user language).
4914 public function getPageLanguage() {
4915 global $wgLang, $wgLanguageCode;
4916 wfProfileIn( __METHOD__
);
4917 if ( $this->isSpecialPage() ) {
4918 // special pages are in the user language
4919 wfProfileOut( __METHOD__
);
4923 // Checking if DB language is set
4924 if ( $this->mDbPageLanguage
) {
4925 wfProfileOut( __METHOD__
);
4926 return wfGetLangObj( $this->mDbPageLanguage
);
4929 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
4930 // Note that this may depend on user settings, so the cache should
4931 // be only per-request.
4932 // NOTE: ContentHandler::getPageLanguage() may need to load the
4933 // content to determine the page language!
4934 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4936 $contentHandler = ContentHandler
::getForTitle( $this );
4937 $langObj = wfGetLangObj( $contentHandler->getPageLanguage( $this ) );
4938 $this->mPageLanguage
= array( $langObj->getCode(), $wgLanguageCode );
4940 $langObj = wfGetLangObj( $this->mPageLanguage
[0] );
4943 wfProfileOut( __METHOD__
);
4948 * Get the language in which the content of this page is written when
4949 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4950 * e.g. $wgLang (such as special pages, which are in the user language).
4955 public function getPageViewLanguage() {
4958 if ( $this->isSpecialPage() ) {
4959 // If the user chooses a variant, the content is actually
4960 // in a language whose code is the variant code.
4961 $variant = $wgLang->getPreferredVariant();
4962 if ( $wgLang->getCode() !== $variant ) {
4963 return Language
::factory( $variant );
4969 // @note Can't be cached persistently, depends on user settings.
4970 // @note ContentHandler::getPageViewLanguage() may need to load the
4971 // content to determine the page language!
4972 $contentHandler = ContentHandler
::getForTitle( $this );
4973 $pageLang = $contentHandler->getPageViewLanguage( $this );
4978 * Get a list of rendered edit notices for this page.
4980 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4981 * they will already be wrapped in paragraphs.
4984 * @param int $oldid Revision ID that's being edited
4987 public function getEditNotices( $oldid = 0 ) {
4990 # Optional notices on a per-namespace and per-page basis
4991 $editnotice_ns = 'editnotice-' . $this->getNamespace();
4992 $editnotice_ns_message = wfMessage( $editnotice_ns );
4993 if ( $editnotice_ns_message->exists() ) {
4994 $notices[$editnotice_ns] = $editnotice_ns_message->parseAsBlock();
4996 if ( MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
4997 $parts = explode( '/', $this->getDBkey() );
4998 $editnotice_base = $editnotice_ns;
4999 while ( count( $parts ) > 0 ) {
5000 $editnotice_base .= '-' . array_shift( $parts );
5001 $editnotice_base_msg = wfMessage( $editnotice_base );
5002 if ( $editnotice_base_msg->exists() ) {
5003 $notices[$editnotice_base] = $editnotice_base_msg->parseAsBlock();
5007 # Even if there are no subpages in namespace, we still don't want / in MW ns.
5008 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->getDBkey() );
5009 $editnoticeMsg = wfMessage( $editnoticeText );
5010 if ( $editnoticeMsg->exists() ) {
5011 $notices[$editnoticeText] = $editnoticeMsg->parseAsBlock();
5015 wfRunHooks( 'TitleGetEditNotices', array( $this, $oldid, &$notices ) );