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.
34 /** @var MapCacheLRU */
35 static private $titleCache = null;
38 * Title::newFromText maintains a cache to avoid expensive re-normalization of
39 * commonly used titles. On a batch operation this can become a memory leak
40 * if not bounded. After hitting this many titles reset the cache.
42 const CACHE_MAX
= 1000;
45 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
46 * to use the master DB
48 const GAID_FOR_UPDATE
= 1;
51 * @name Private member variables
52 * Please use the accessor functions instead.
57 /** @var string Text form (spaces not underscores) of the main part */
58 public $mTextform = '';
60 /** @var string URL-encoded form of the main part */
61 public $mUrlform = '';
63 /** @var string Main part with underscores */
64 public $mDbkeyform = '';
66 /** @var string Database key with the initial letter in the case specified by the user */
67 protected $mUserCaseDBKey;
69 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
70 public $mNamespace = NS_MAIN
;
72 /** @var string Interwiki prefix */
73 public $mInterwiki = '';
75 /** @var bool Was this Title created from a string with a local interwiki prefix? */
76 private $mLocalInterwiki = false;
78 /** @var string Title fragment (i.e. the bit after the #) */
79 public $mFragment = '';
81 /** @var int Article ID, fetched from the link cache on demand */
82 public $mArticleID = -1;
84 /** @var bool|int ID of most recent revision */
85 protected $mLatestID = false;
88 * @var bool|string ID of the page's content model, i.e. one of the
89 * CONTENT_MODEL_XXX constants
91 public $mContentModel = false;
93 /** @var int Estimated number of revisions; null of not loaded */
94 private $mEstimateRevisions;
96 /** @var array Array of groups allowed to edit this article */
97 public $mRestrictions = array();
99 /** @var string|bool */
100 protected $mOldRestrictions = false;
102 /** @var bool Cascade restrictions on this page to included templates and images? */
103 public $mCascadeRestriction;
105 /** Caching the results of getCascadeProtectionSources */
106 public $mCascadingRestrictions;
108 /** @var array When do the restrictions on this page expire? */
109 protected $mRestrictionsExpiry = array();
111 /** @var bool Are cascading restrictions in effect on this page? */
112 protected $mHasCascadingRestrictions;
114 /** @var array Where are the cascading restrictions coming from on this page? */
115 public $mCascadeSources;
117 /** @var bool Boolean for initialisation on demand */
118 public $mRestrictionsLoaded = false;
120 /** @var string Text form including namespace/interwiki, initialised on demand */
121 protected $mPrefixedText = null;
123 /** @var mixed Cached value for getTitleProtection (create protection) */
124 public $mTitleProtection;
127 * @var int Namespace index when there is no namespace. Don't change the
128 * following default, NS_MAIN is hardcoded in several places. See bug 696.
129 * Zero except in {{transclusion}} tags.
131 public $mDefaultNamespace = NS_MAIN
;
134 * @var bool Is $wgUser watching this page? null if unfilled, accessed
135 * through userIsWatching()
137 protected $mWatched = null;
139 /** @var int The page length, 0 for special pages */
140 protected $mLength = -1;
142 /** @var null Is the article at this title a redirect? */
143 public $mRedirect = null;
145 /** @var array Associative array of user ID -> timestamp/false */
146 private $mNotificationTimestamp = array();
148 /** @var bool Whether a page has any subpages */
149 private $mHasSubpages;
151 /** @var bool The (string) language code of the page's language and content code. */
152 private $mPageLanguage = false;
154 /** @var string The page language code from the database */
155 private $mDbPageLanguage = null;
157 /** @var TitleValue A corresponding TitleValue object */
158 private $mTitleValue = null;
160 /** @var bool Would deleting this page be a big deletion? */
161 private $mIsBigDeletion = null;
165 * B/C kludge: provide a TitleParser for use by Title.
166 * Ideally, Title would have no methods that need this.
167 * Avoid usage of this singleton by using TitleValue
168 * and the associated services when possible.
170 * @return TitleParser
172 private static function getTitleParser() {
173 global $wgContLang, $wgLocalInterwikis;
175 static $titleCodec = null;
176 static $titleCodecFingerprint = null;
178 // $wgContLang and $wgLocalInterwikis may change (especially while testing),
179 // make sure we are using the right one. To detect changes over the course
180 // of a request, we remember a fingerprint of the config used to create the
181 // codec singleton, and re-create it if the fingerprint doesn't match.
182 $fingerprint = spl_object_hash( $wgContLang ) . '|' . join( '+', $wgLocalInterwikis );
184 if ( $fingerprint !== $titleCodecFingerprint ) {
188 if ( !$titleCodec ) {
189 $titleCodec = new MediaWikiTitleCodec(
191 GenderCache
::singleton(),
194 $titleCodecFingerprint = $fingerprint;
201 * B/C kludge: provide a TitleParser for use by Title.
202 * Ideally, Title would have no methods that need this.
203 * Avoid usage of this singleton by using TitleValue
204 * and the associated services when possible.
206 * @return TitleFormatter
208 private static function getTitleFormatter() {
209 //NOTE: we know that getTitleParser() returns a MediaWikiTitleCodec,
210 // which implements TitleFormatter.
211 return self
::getTitleParser();
214 function __construct() {
218 * Create a new Title from a prefixed DB key
220 * @param string $key The database key, which has underscores
221 * instead of spaces, possibly including namespace and
223 * @return Title|null Title, or null on an error
225 public static function newFromDBkey( $key ) {
227 $t->mDbkeyform
= $key;
228 if ( $t->secureAndSplit() ) {
236 * Create a new Title from a TitleValue
238 * @param TitleValue $titleValue Assumed to be safe.
242 public static function newFromTitleValue( TitleValue
$titleValue ) {
243 return self
::makeTitle(
244 $titleValue->getNamespace(),
245 $titleValue->getText(),
246 $titleValue->getFragment() );
250 * Create a new Title from text, such as what one would find in a link. De-
251 * codes any HTML entities in the text.
253 * @param string $text The link text; spaces, prefixes, and an
254 * initial ':' indicating the main namespace are accepted.
255 * @param int $defaultNamespace The namespace to use if none is specified
256 * by a prefix. If you want to force a specific namespace even if
257 * $text might begin with a namespace prefix, use makeTitle() or
259 * @throws InvalidArgumentException
260 * @return Title|null Title or null on an error.
262 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
263 if ( is_object( $text ) ) {
264 throw new InvalidArgumentException( '$text must be a string.' );
265 } elseif ( !is_string( $text ) ) {
266 wfWarn( __METHOD__
. ': $text must be a string. This will throw an InvalidArgumentException in future.', 2 );
269 $cache = self
::getTitleCache();
272 * Wiki pages often contain multiple links to the same page.
273 * Title normalization and parsing can become expensive on
274 * pages with many links, so we can save a little time by
277 * In theory these are value objects and won't get changed...
279 if ( $defaultNamespace == NS_MAIN
&& $cache->has( $text ) ) {
280 return $cache->get( $text );
283 # Convert things like é ā or 〗 into normalized (bug 14952) text
284 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
287 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
288 $t->mDefaultNamespace
= intval( $defaultNamespace );
290 if ( $t->secureAndSplit() ) {
291 if ( $defaultNamespace == NS_MAIN
) {
292 $cache->set( $text, $t );
301 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
303 * Example of wrong and broken code:
304 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
306 * Example of right code:
307 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
309 * Create a new Title from URL-encoded text. Ensures that
310 * the given title's length does not exceed the maximum.
312 * @param string $url The title, as might be taken from a URL
313 * @return Title|null The new object, or null on an error
315 public static function newFromURL( $url ) {
318 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
319 # but some URLs used it as a space replacement and they still come
320 # from some external search tools.
321 if ( strpos( self
::legalChars(), '+' ) === false ) {
322 $url = str_replace( '+', ' ', $url );
325 $t->mDbkeyform
= str_replace( ' ', '_', $url );
326 if ( $t->secureAndSplit() ) {
334 * @return MapCacheLRU
336 private static function getTitleCache() {
337 if ( self
::$titleCache == null ) {
338 self
::$titleCache = new MapCacheLRU( self
::CACHE_MAX
);
340 return self
::$titleCache;
344 * Returns a list of fields that are to be selected for initializing Title
345 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
346 * whether to include page_content_model.
350 protected static function getSelectFields() {
351 global $wgContentHandlerUseDB;
354 'page_namespace', 'page_title', 'page_id',
355 'page_len', 'page_is_redirect', 'page_latest',
358 if ( $wgContentHandlerUseDB ) {
359 $fields[] = 'page_content_model';
366 * Create a new Title from an article ID
368 * @param int $id The page_id corresponding to the Title to create
369 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
370 * @return Title|null The new object, or null on an error
372 public static function newFromID( $id, $flags = 0 ) {
373 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
374 $row = $db->selectRow(
376 self
::getSelectFields(),
377 array( 'page_id' => $id ),
380 if ( $row !== false ) {
381 $title = Title
::newFromRow( $row );
389 * Make an array of titles from an array of IDs
391 * @param int[] $ids Array of IDs
392 * @return Title[] Array of Titles
394 public static function newFromIDs( $ids ) {
395 if ( !count( $ids ) ) {
398 $dbr = wfGetDB( DB_SLAVE
);
402 self
::getSelectFields(),
403 array( 'page_id' => $ids ),
408 foreach ( $res as $row ) {
409 $titles[] = Title
::newFromRow( $row );
415 * Make a Title object from a DB row
417 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
418 * @return Title Corresponding Title
420 public static function newFromRow( $row ) {
421 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
422 $t->loadFromRow( $row );
427 * Load Title object fields from a DB row.
428 * If false is given, the title will be treated as non-existing.
430 * @param stdClass|bool $row Database row
432 public function loadFromRow( $row ) {
433 if ( $row ) { // page found
434 if ( isset( $row->page_id
) ) {
435 $this->mArticleID
= (int)$row->page_id
;
437 if ( isset( $row->page_len
) ) {
438 $this->mLength
= (int)$row->page_len
;
440 if ( isset( $row->page_is_redirect
) ) {
441 $this->mRedirect
= (bool)$row->page_is_redirect
;
443 if ( isset( $row->page_latest
) ) {
444 $this->mLatestID
= (int)$row->page_latest
;
446 if ( isset( $row->page_content_model
) ) {
447 $this->mContentModel
= strval( $row->page_content_model
);
449 $this->mContentModel
= false; # initialized lazily in getContentModel()
451 if ( isset( $row->page_lang
) ) {
452 $this->mDbPageLanguage
= (string)$row->page_lang
;
454 if ( isset( $row->page_restrictions
) ) {
455 $this->mOldRestrictions
= $row->page_restrictions
;
457 } else { // page not found
458 $this->mArticleID
= 0;
460 $this->mRedirect
= false;
461 $this->mLatestID
= 0;
462 $this->mContentModel
= false; # initialized lazily in getContentModel()
467 * Create a new Title from a namespace index and a DB key.
468 * It's assumed that $ns and $title are *valid*, for instance when
469 * they came directly from the database or a special page name.
470 * For convenience, spaces are converted to underscores so that
471 * eg user_text fields can be used directly.
473 * @param int $ns The namespace of the article
474 * @param string $title The unprefixed database key form
475 * @param string $fragment The link fragment (after the "#")
476 * @param string $interwiki The interwiki prefix
477 * @return Title The new object
479 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
481 $t->mInterwiki
= $interwiki;
482 $t->mFragment
= $fragment;
483 $t->mNamespace
= $ns = intval( $ns );
484 $t->mDbkeyform
= str_replace( ' ', '_', $title );
485 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
486 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
487 $t->mTextform
= str_replace( '_', ' ', $title );
488 $t->mContentModel
= false; # initialized lazily in getContentModel()
493 * Create a new Title from a namespace index and a DB key.
494 * The parameters will be checked for validity, which is a bit slower
495 * than makeTitle() but safer for user-provided data.
497 * @param int $ns The namespace of the article
498 * @param string $title Database key form
499 * @param string $fragment The link fragment (after the "#")
500 * @param string $interwiki Interwiki prefix
501 * @return Title The new object, or null on an error
503 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
504 if ( !MWNamespace
::exists( $ns ) ) {
509 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki, true );
510 if ( $t->secureAndSplit() ) {
518 * Create a new Title for the Main Page
520 * @return Title The new object
522 public static function newMainPage() {
523 $title = Title
::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
524 // Don't give fatal errors if the message is broken
526 $title = Title
::newFromText( 'Main Page' );
532 * Extract a redirect destination from a string and return the
533 * Title, or null if the text doesn't contain a valid redirect
534 * This will only return the very next target, useful for
535 * the redirect table and other checks that don't need full recursion
537 * @param string $text Text with possible redirect
538 * @return Title The corresponding Title
539 * @deprecated since 1.21, use Content::getRedirectTarget instead.
541 public static function newFromRedirect( $text ) {
542 ContentHandler
::deprecated( __METHOD__
, '1.21' );
544 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
545 return $content->getRedirectTarget();
549 * Extract a redirect destination from a string and return the
550 * Title, or null if the text doesn't contain a valid redirect
551 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
552 * in order to provide (hopefully) the Title of the final destination instead of another redirect
554 * @param string $text Text with possible redirect
556 * @deprecated since 1.21, use Content::getUltimateRedirectTarget instead.
558 public static function newFromRedirectRecurse( $text ) {
559 ContentHandler
::deprecated( __METHOD__
, '1.21' );
561 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
562 return $content->getUltimateRedirectTarget();
566 * Extract a redirect destination from a string and return an
567 * array of Titles, or null if the text doesn't contain a valid redirect
568 * The last element in the array is the final destination after all redirects
569 * have been resolved (up to $wgMaxRedirects times)
571 * @param string $text Text with possible redirect
572 * @return Title[] Array of Titles, with the destination last
573 * @deprecated since 1.21, use Content::getRedirectChain instead.
575 public static function newFromRedirectArray( $text ) {
576 ContentHandler
::deprecated( __METHOD__
, '1.21' );
578 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
579 return $content->getRedirectChain();
583 * Get the prefixed DB key associated with an ID
585 * @param int $id The page_id of the article
586 * @return Title|null An object representing the article, or null if no such article was found
588 public static function nameOf( $id ) {
589 $dbr = wfGetDB( DB_SLAVE
);
591 $s = $dbr->selectRow(
593 array( 'page_namespace', 'page_title' ),
594 array( 'page_id' => $id ),
597 if ( $s === false ) {
601 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
606 * Get a regex character class describing the legal characters in a link
608 * @return string The list of characters, not delimited
610 public static function legalChars() {
611 global $wgLegalTitleChars;
612 return $wgLegalTitleChars;
616 * Returns a simple regex that will match on characters and sequences invalid in titles.
617 * Note that this doesn't pick up many things that could be wrong with titles, but that
618 * replacing this regex with something valid will make many titles valid.
620 * @deprecated since 1.25, use MediaWikiTitleCodec::getTitleInvalidRegex() instead
622 * @return string Regex string
624 static function getTitleInvalidRegex() {
625 wfDeprecated( __METHOD__
, '1.25' );
626 return MediaWikiTitleCodec
::getTitleInvalidRegex();
630 * Utility method for converting a character sequence from bytes to Unicode.
632 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
633 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
635 * @param string $byteClass
638 public static function convertByteClassToUnicodeClass( $byteClass ) {
639 $length = strlen( $byteClass );
641 $x0 = $x1 = $x2 = '';
643 $d0 = $d1 = $d2 = '';
644 // Decoded integer codepoints
645 $ord0 = $ord1 = $ord2 = 0;
647 $r0 = $r1 = $r2 = '';
651 $allowUnicode = false;
652 for ( $pos = 0; $pos < $length; $pos++
) {
653 // Shift the queues down
662 // Load the current input token and decoded values
663 $inChar = $byteClass[$pos];
664 if ( $inChar == '\\' ) {
665 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
666 $x0 = $inChar . $m[0];
667 $d0 = chr( hexdec( $m[1] ) );
668 $pos +
= strlen( $m[0] );
669 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
670 $x0 = $inChar . $m[0];
671 $d0 = chr( octdec( $m[0] ) );
672 $pos +
= strlen( $m[0] );
673 } elseif ( $pos +
1 >= $length ) {
676 $d0 = $byteClass[$pos +
1];
684 // Load the current re-encoded value
685 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
686 $r0 = sprintf( '\x%02x', $ord0 );
687 } elseif ( $ord0 >= 0x80 ) {
688 // Allow unicode if a single high-bit character appears
689 $r0 = sprintf( '\x%02x', $ord0 );
690 $allowUnicode = true;
691 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
697 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
699 if ( $ord2 > $ord0 ) {
701 } elseif ( $ord0 >= 0x80 ) {
703 $allowUnicode = true;
704 if ( $ord2 < 0x80 ) {
705 // Keep the non-unicode section of the range
712 // Reset state to the initial value
713 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
714 } elseif ( $ord2 < 0x80 ) {
719 if ( $ord1 < 0x80 ) {
722 if ( $ord0 < 0x80 ) {
725 if ( $allowUnicode ) {
726 $out .= '\u0080-\uFFFF';
732 * Make a prefixed DB key from a DB key and a namespace index
734 * @param int $ns Numerical representation of the namespace
735 * @param string $title The DB key form the title
736 * @param string $fragment The link fragment (after the "#")
737 * @param string $interwiki The interwiki prefix
738 * @param bool $canoncialNamespace If true, use the canonical name for
739 * $ns instead of the localized version.
740 * @return string The prefixed form of the title
742 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
743 $canoncialNamespace = false
747 if ( $canoncialNamespace ) {
748 $namespace = MWNamespace
::getCanonicalName( $ns );
750 $namespace = $wgContLang->getNsText( $ns );
752 $name = $namespace == '' ?
$title : "$namespace:$title";
753 if ( strval( $interwiki ) != '' ) {
754 $name = "$interwiki:$name";
756 if ( strval( $fragment ) != '' ) {
757 $name .= '#' . $fragment;
763 * Escape a text fragment, say from a link, for a URL
765 * @param string $fragment Containing a URL or link fragment (after the "#")
766 * @return string Escaped string
768 static function escapeFragmentForURL( $fragment ) {
769 # Note that we don't urlencode the fragment. urlencoded Unicode
770 # fragments appear not to work in IE (at least up to 7) or in at least
771 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
772 # to care if they aren't encoded.
773 return Sanitizer
::escapeId( $fragment, 'noninitial' );
777 * Callback for usort() to do title sorts by (namespace, title)
782 * @return int Result of string comparison, or namespace comparison
784 public static function compare( $a, $b ) {
785 if ( $a->getNamespace() == $b->getNamespace() ) {
786 return strcmp( $a->getText(), $b->getText() );
788 return $a->getNamespace() - $b->getNamespace();
793 * Determine whether the object refers to a page within
794 * this project (either this wiki or a wiki with a local
795 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
797 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
799 public function isLocal() {
800 if ( $this->isExternal() ) {
801 $iw = Interwiki
::fetch( $this->mInterwiki
);
803 return $iw->isLocal();
810 * Is this Title interwiki?
814 public function isExternal() {
815 return $this->mInterwiki
!== '';
819 * Get the interwiki prefix
821 * Use Title::isExternal to check if a interwiki is set
823 * @return string Interwiki prefix
825 public function getInterwiki() {
826 return $this->mInterwiki
;
830 * Was this a local interwiki link?
834 public function wasLocalInterwiki() {
835 return $this->mLocalInterwiki
;
839 * Determine whether the object refers to a page within
840 * this project and is transcludable.
842 * @return bool True if this is transcludable
844 public function isTrans() {
845 if ( !$this->isExternal() ) {
849 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
853 * Returns the DB name of the distant wiki which owns the object.
855 * @return string The DB name
857 public function getTransWikiID() {
858 if ( !$this->isExternal() ) {
862 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
866 * Get a TitleValue object representing this Title.
868 * @note Not all valid Titles have a corresponding valid TitleValue
869 * (e.g. TitleValues cannot represent page-local links that have a
870 * fragment but no title text).
872 * @return TitleValue|null
874 public function getTitleValue() {
875 if ( $this->mTitleValue
=== null ) {
877 $this->mTitleValue
= new TitleValue(
878 $this->getNamespace(),
880 $this->getFragment() );
881 } catch ( InvalidArgumentException
$ex ) {
882 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
883 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
887 return $this->mTitleValue
;
891 * Get the text form (spaces not underscores) of the main part
893 * @return string Main part of the title
895 public function getText() {
896 return $this->mTextform
;
900 * Get the URL-encoded form of the main part
902 * @return string Main part of the title, URL-encoded
904 public function getPartialURL() {
905 return $this->mUrlform
;
909 * Get the main part with underscores
911 * @return string Main part of the title, with underscores
913 public function getDBkey() {
914 return $this->mDbkeyform
;
918 * Get the DB key with the initial letter case as specified by the user
920 * @return string DB key
922 function getUserCaseDBKey() {
923 if ( !is_null( $this->mUserCaseDBKey
) ) {
924 return $this->mUserCaseDBKey
;
926 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
927 return $this->mDbkeyform
;
932 * Get the namespace index, i.e. one of the NS_xxxx constants.
934 * @return int Namespace index
936 public function getNamespace() {
937 return $this->mNamespace
;
941 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
943 * @throws MWException
944 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
945 * @return string Content model id
947 public function getContentModel( $flags = 0 ) {
948 if ( !$this->mContentModel
&& $this->getArticleID( $flags ) ) {
949 $linkCache = LinkCache
::singleton();
950 $linkCache->addLinkObj( $this ); # in case we already had an article ID
951 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
954 if ( !$this->mContentModel
) {
955 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
958 if ( !$this->mContentModel
) {
959 throw new MWException( 'Failed to determine content model!' );
962 return $this->mContentModel
;
966 * Convenience method for checking a title's content model name
968 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
969 * @return bool True if $this->getContentModel() == $id
971 public function hasContentModel( $id ) {
972 return $this->getContentModel() == $id;
976 * Get the namespace text
978 * @return string Namespace text
980 public function getNsText() {
981 if ( $this->isExternal() ) {
982 // This probably shouldn't even happen. ohh man, oh yuck.
983 // But for interwiki transclusion it sometimes does.
984 // Shit. Shit shit shit.
986 // Use the canonical namespaces if possible to try to
987 // resolve a foreign namespace.
988 if ( MWNamespace
::exists( $this->mNamespace
) ) {
989 return MWNamespace
::getCanonicalName( $this->mNamespace
);
994 $formatter = self
::getTitleFormatter();
995 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
996 } catch ( InvalidArgumentException
$ex ) {
997 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
1003 * Get the namespace text of the subject (rather than talk) page
1005 * @return string Namespace text
1007 public function getSubjectNsText() {
1009 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
1013 * Get the namespace text of the talk page
1015 * @return string Namespace text
1017 public function getTalkNsText() {
1019 return $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) );
1023 * Could this title have a corresponding talk page?
1027 public function canTalk() {
1028 return MWNamespace
::canTalk( $this->mNamespace
);
1032 * Is this in a namespace that allows actual pages?
1036 public function canExist() {
1037 return $this->mNamespace
>= NS_MAIN
;
1041 * Can this title be added to a user's watchlist?
1045 public function isWatchable() {
1046 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
1050 * Returns true if this is a special page.
1054 public function isSpecialPage() {
1055 return $this->getNamespace() == NS_SPECIAL
;
1059 * Returns true if this title resolves to the named special page
1061 * @param string $name The special page name
1064 public function isSpecial( $name ) {
1065 if ( $this->isSpecialPage() ) {
1066 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
1067 if ( $name == $thisName ) {
1075 * If the Title refers to a special page alias which is not the local default, resolve
1076 * the alias, and localise the name as necessary. Otherwise, return $this
1080 public function fixSpecialName() {
1081 if ( $this->isSpecialPage() ) {
1082 list( $canonicalName, $par ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
1083 if ( $canonicalName ) {
1084 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName, $par );
1085 if ( $localName != $this->mDbkeyform
) {
1086 return Title
::makeTitle( NS_SPECIAL
, $localName );
1094 * Returns true if the title is inside the specified namespace.
1096 * Please make use of this instead of comparing to getNamespace()
1097 * This function is much more resistant to changes we may make
1098 * to namespaces than code that makes direct comparisons.
1099 * @param int $ns The namespace
1103 public function inNamespace( $ns ) {
1104 return MWNamespace
::equals( $this->getNamespace(), $ns );
1108 * Returns true if the title is inside one of the specified namespaces.
1110 * @param int $namespaces,... The namespaces to check for
1114 public function inNamespaces( /* ... */ ) {
1115 $namespaces = func_get_args();
1116 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1117 $namespaces = $namespaces[0];
1120 foreach ( $namespaces as $ns ) {
1121 if ( $this->inNamespace( $ns ) ) {
1130 * Returns true if the title has the same subject namespace as the
1131 * namespace specified.
1132 * For example this method will take NS_USER and return true if namespace
1133 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1134 * as their subject namespace.
1136 * This is MUCH simpler than individually testing for equivalence
1137 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1142 public function hasSubjectNamespace( $ns ) {
1143 return MWNamespace
::subjectEquals( $this->getNamespace(), $ns );
1147 * Is this Title in a namespace which contains content?
1148 * In other words, is this a content page, for the purposes of calculating
1153 public function isContentPage() {
1154 return MWNamespace
::isContent( $this->getNamespace() );
1158 * Would anybody with sufficient privileges be able to move this page?
1159 * Some pages just aren't movable.
1163 public function isMovable() {
1164 if ( !MWNamespace
::isMovable( $this->getNamespace() ) ||
$this->isExternal() ) {
1165 // Interwiki title or immovable namespace. Hooks don't get to override here
1170 Hooks
::run( 'TitleIsMovable', array( $this, &$result ) );
1175 * Is this the mainpage?
1176 * @note Title::newFromText seems to be sufficiently optimized by the title
1177 * cache that we don't need to over-optimize by doing direct comparisons and
1178 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1179 * ends up reporting something differently than $title->isMainPage();
1184 public function isMainPage() {
1185 return $this->equals( Title
::newMainPage() );
1189 * Is this a subpage?
1193 public function isSubpage() {
1194 return MWNamespace
::hasSubpages( $this->mNamespace
)
1195 ?
strpos( $this->getText(), '/' ) !== false
1200 * Is this a conversion table for the LanguageConverter?
1204 public function isConversionTable() {
1205 // @todo ConversionTable should become a separate content model.
1207 return $this->getNamespace() == NS_MEDIAWIKI
&&
1208 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1212 * Does that page contain wikitext, or it is JS, CSS or whatever?
1216 public function isWikitextPage() {
1217 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1221 * Could this page contain custom CSS or JavaScript for the global UI.
1222 * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
1223 * or CONTENT_MODEL_JAVASCRIPT.
1225 * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage()
1228 * Note that this method should not return true for pages that contain and
1229 * show "inactive" CSS or JS.
1233 public function isCssOrJsPage() {
1234 $isCssOrJsPage = NS_MEDIAWIKI
== $this->mNamespace
1235 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1236 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1238 # @note This hook is also called in ContentHandler::getDefaultModel.
1239 # It's called here again to make sure hook functions can force this
1240 # method to return true even outside the MediaWiki namespace.
1242 Hooks
::run( 'TitleIsCssOrJsPage', array( $this, &$isCssOrJsPage ), '1.25' );
1244 return $isCssOrJsPage;
1248 * Is this a .css or .js subpage of a user page?
1251 public function isCssJsSubpage() {
1252 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1253 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1254 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
1258 * Trim down a .css or .js subpage title to get the corresponding skin name
1260 * @return string Containing skin name from .css or .js subpage title
1262 public function getSkinFromCssJsSubpage() {
1263 $subpage = explode( '/', $this->mTextform
);
1264 $subpage = $subpage[count( $subpage ) - 1];
1265 $lastdot = strrpos( $subpage, '.' );
1266 if ( $lastdot === false ) {
1267 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
1269 return substr( $subpage, 0, $lastdot );
1273 * Is this a .css subpage of a user page?
1277 public function isCssSubpage() {
1278 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1279 && $this->hasContentModel( CONTENT_MODEL_CSS
) );
1283 * Is this a .js subpage of a user page?
1287 public function isJsSubpage() {
1288 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1289 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1293 * Is this a talk page of some sort?
1297 public function isTalkPage() {
1298 return MWNamespace
::isTalk( $this->getNamespace() );
1302 * Get a Title object associated with the talk page of this article
1304 * @return Title The object for the talk page
1306 public function getTalkPage() {
1307 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
1311 * Get a title object associated with the subject page of this
1314 * @return Title The object for the subject page
1316 public function getSubjectPage() {
1317 // Is this the same title?
1318 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
1319 if ( $this->getNamespace() == $subjectNS ) {
1322 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
1326 * Get the other title for this page, if this is a subject page
1327 * get the talk page, if it is a subject page get the talk page
1330 * @throws MWException
1333 public function getOtherPage() {
1334 if ( $this->isSpecialPage() ) {
1335 throw new MWException( 'Special pages cannot have other pages' );
1337 if ( $this->isTalkPage() ) {
1338 return $this->getSubjectPage();
1340 return $this->getTalkPage();
1345 * Get the default namespace index, for when there is no namespace
1347 * @return int Default namespace index
1349 public function getDefaultNamespace() {
1350 return $this->mDefaultNamespace
;
1354 * Get the Title fragment (i.e.\ the bit after the #) in text form
1356 * Use Title::hasFragment to check for a fragment
1358 * @return string Title fragment
1360 public function getFragment() {
1361 return $this->mFragment
;
1365 * Check if a Title fragment is set
1370 public function hasFragment() {
1371 return $this->mFragment
!== '';
1375 * Get the fragment in URL form, including the "#" character if there is one
1376 * @return string Fragment in URL form
1378 public function getFragmentForURL() {
1379 if ( !$this->hasFragment() ) {
1382 return '#' . Title
::escapeFragmentForURL( $this->getFragment() );
1387 * Set the fragment for this title. Removes the first character from the
1388 * specified fragment before setting, so it assumes you're passing it with
1391 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1392 * Still in active use privately.
1394 * @param string $fragment Text
1396 public function setFragment( $fragment ) {
1397 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
1401 * Prefix some arbitrary text with the namespace or interwiki prefix
1404 * @param string $name The text
1405 * @return string The prefixed text
1407 private function prefix( $name ) {
1409 if ( $this->isExternal() ) {
1410 $p = $this->mInterwiki
. ':';
1413 if ( 0 != $this->mNamespace
) {
1414 $p .= $this->getNsText() . ':';
1420 * Get the prefixed database key form
1422 * @return string The prefixed title, with underscores and
1423 * any interwiki and namespace prefixes
1425 public function getPrefixedDBkey() {
1426 $s = $this->prefix( $this->mDbkeyform
);
1427 $s = str_replace( ' ', '_', $s );
1432 * Get the prefixed title with spaces.
1433 * This is the form usually used for display
1435 * @return string The prefixed title, with spaces
1437 public function getPrefixedText() {
1438 if ( $this->mPrefixedText
=== null ) {
1439 $s = $this->prefix( $this->mTextform
);
1440 $s = str_replace( '_', ' ', $s );
1441 $this->mPrefixedText
= $s;
1443 return $this->mPrefixedText
;
1447 * Return a string representation of this title
1449 * @return string Representation of this title
1451 public function __toString() {
1452 return $this->getPrefixedText();
1456 * Get the prefixed title with spaces, plus any fragment
1457 * (part beginning with '#')
1459 * @return string The prefixed title, with spaces and the fragment, including '#'
1461 public function getFullText() {
1462 $text = $this->getPrefixedText();
1463 if ( $this->hasFragment() ) {
1464 $text .= '#' . $this->getFragment();
1470 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1474 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1478 * @return string Root name
1481 public function getRootText() {
1482 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1483 return $this->getText();
1486 return strtok( $this->getText(), '/' );
1490 * Get the root page name title, i.e. the leftmost part before any slashes
1494 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1495 * # returns: Title{User:Foo}
1498 * @return Title Root title
1501 public function getRootTitle() {
1502 return Title
::makeTitle( $this->getNamespace(), $this->getRootText() );
1506 * Get the base page name without a namespace, i.e. the part before the subpage name
1510 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1511 * # returns: 'Foo/Bar'
1514 * @return string Base name
1516 public function getBaseText() {
1517 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1518 return $this->getText();
1521 $parts = explode( '/', $this->getText() );
1522 # Don't discard the real title if there's no subpage involved
1523 if ( count( $parts ) > 1 ) {
1524 unset( $parts[count( $parts ) - 1] );
1526 return implode( '/', $parts );
1530 * Get the base page name title, i.e. the part before the subpage name
1534 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1535 * # returns: Title{User:Foo/Bar}
1538 * @return Title Base title
1541 public function getBaseTitle() {
1542 return Title
::makeTitle( $this->getNamespace(), $this->getBaseText() );
1546 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1550 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1554 * @return string Subpage name
1556 public function getSubpageText() {
1557 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1558 return $this->mTextform
;
1560 $parts = explode( '/', $this->mTextform
);
1561 return $parts[count( $parts ) - 1];
1565 * Get the title for a subpage of the current page
1569 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1570 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1573 * @param string $text The subpage name to add to the title
1574 * @return Title Subpage title
1577 public function getSubpage( $text ) {
1578 return Title
::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1582 * Get a URL-encoded form of the subpage text
1584 * @return string URL-encoded subpage name
1586 public function getSubpageUrlForm() {
1587 $text = $this->getSubpageText();
1588 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1593 * Get a URL-encoded title (not an actual URL) including interwiki
1595 * @return string The URL-encoded form
1597 public function getPrefixedURL() {
1598 $s = $this->prefix( $this->mDbkeyform
);
1599 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1604 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1605 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1606 * second argument named variant. This was deprecated in favor
1607 * of passing an array of option with a "variant" key
1608 * Once $query2 is removed for good, this helper can be dropped
1609 * and the wfArrayToCgi moved to getLocalURL();
1611 * @since 1.19 (r105919)
1612 * @param array|string $query
1613 * @param bool $query2
1616 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1617 if ( $query2 !== false ) {
1618 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1619 "method called with a second parameter is deprecated. Add your " .
1620 "parameter to an array passed as the first parameter.", "1.19" );
1622 if ( is_array( $query ) ) {
1623 $query = wfArrayToCgi( $query );
1626 if ( is_string( $query2 ) ) {
1627 // $query2 is a string, we will consider this to be
1628 // a deprecated $variant argument and add it to the query
1629 $query2 = wfArrayToCgi( array( 'variant' => $query2 ) );
1631 $query2 = wfArrayToCgi( $query2 );
1633 // If we have $query content add a & to it first
1637 // Now append the queries together
1644 * Get a real URL referring to this title, with interwiki link and
1647 * @see self::getLocalURL for the arguments.
1649 * @param array|string $query
1650 * @param bool $query2
1651 * @param string $proto Protocol type to use in URL
1652 * @return string The URL
1654 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1655 $query = self
::fixUrlQueryArgs( $query, $query2 );
1657 # Hand off all the decisions on urls to getLocalURL
1658 $url = $this->getLocalURL( $query );
1660 # Expand the url to make it a full url. Note that getLocalURL has the
1661 # potential to output full urls for a variety of reasons, so we use
1662 # wfExpandUrl instead of simply prepending $wgServer
1663 $url = wfExpandUrl( $url, $proto );
1665 # Finally, add the fragment.
1666 $url .= $this->getFragmentForURL();
1668 Hooks
::run( 'GetFullURL', array( &$this, &$url, $query ) );
1673 * Get a URL with no fragment or server name (relative URL) from a Title object.
1674 * If this page is generated with action=render, however,
1675 * $wgServer is prepended to make an absolute URL.
1677 * @see self::getFullURL to always get an absolute URL.
1678 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
1679 * valid to link, locally, to the current Title.
1680 * @see self::newFromText to produce a Title object.
1682 * @param string|array $query An optional query string,
1683 * not used for interwiki links. Can be specified as an associative array as well,
1684 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1685 * Some query patterns will trigger various shorturl path replacements.
1686 * @param array $query2 An optional secondary query array. This one MUST
1687 * be an array. If a string is passed it will be interpreted as a deprecated
1688 * variant argument and urlencoded into a variant= argument.
1689 * This second query argument will be added to the $query
1690 * The second parameter is deprecated since 1.19. Pass it as a key,value
1691 * pair in the first parameter array instead.
1693 * @return string String of the URL.
1695 public function getLocalURL( $query = '', $query2 = false ) {
1696 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1698 $query = self
::fixUrlQueryArgs( $query, $query2 );
1700 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
1702 $namespace = $this->getNsText();
1703 if ( $namespace != '' ) {
1704 # Can this actually happen? Interwikis shouldn't be parsed.
1705 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1708 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1709 $url = wfAppendQuery( $url, $query );
1711 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1712 if ( $query == '' ) {
1713 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1714 Hooks
::run( 'GetLocalURL::Article', array( &$this, &$url ) );
1716 global $wgVariantArticlePath, $wgActionPaths, $wgContLang;
1720 if ( !empty( $wgActionPaths )
1721 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1723 $action = urldecode( $matches[2] );
1724 if ( isset( $wgActionPaths[$action] ) ) {
1725 $query = $matches[1];
1726 if ( isset( $matches[4] ) ) {
1727 $query .= $matches[4];
1729 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1730 if ( $query != '' ) {
1731 $url = wfAppendQuery( $url, $query );
1737 && $wgVariantArticlePath
1738 && $wgContLang->getCode() === $this->getPageLanguage()->getCode()
1739 && $this->getPageLanguage()->hasVariants()
1740 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1742 $variant = urldecode( $matches[1] );
1743 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1744 // Only do the variant replacement if the given variant is a valid
1745 // variant for the page's language.
1746 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1747 $url = str_replace( '$1', $dbkey, $url );
1751 if ( $url === false ) {
1752 if ( $query == '-' ) {
1755 $url = "{$wgScript}?title={$dbkey}&{$query}";
1759 Hooks
::run( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1761 // @todo FIXME: This causes breakage in various places when we
1762 // actually expected a local URL and end up with dupe prefixes.
1763 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1764 $url = $wgServer . $url;
1767 Hooks
::run( 'GetLocalURL', array( &$this, &$url, $query ) );
1772 * Get a URL that's the simplest URL that will be valid to link, locally,
1773 * to the current Title. It includes the fragment, but does not include
1774 * the server unless action=render is used (or the link is external). If
1775 * there's a fragment but the prefixed text is empty, we just return a link
1778 * The result obviously should not be URL-escaped, but does need to be
1779 * HTML-escaped if it's being output in HTML.
1781 * @param array $query
1782 * @param bool $query2
1783 * @param string $proto Protocol to use; setting this will cause a full URL to be used
1784 * @see self::getLocalURL for the arguments.
1785 * @return string The URL
1787 public function getLinkURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1788 if ( $this->isExternal() ||
$proto !== PROTO_RELATIVE
) {
1789 $ret = $this->getFullURL( $query, $query2, $proto );
1790 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
1791 $ret = $this->getFragmentForURL();
1793 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1799 * Get the URL form for an internal link.
1800 * - Used in various Squid-related code, in case we have a different
1801 * internal hostname for the server from the exposed one.
1803 * This uses $wgInternalServer to qualify the path, or $wgServer
1804 * if $wgInternalServer is not set. If the server variable used is
1805 * protocol-relative, the URL will be expanded to http://
1807 * @see self::getLocalURL for the arguments.
1808 * @return string The URL
1810 public function getInternalURL( $query = '', $query2 = false ) {
1811 global $wgInternalServer, $wgServer;
1812 $query = self
::fixUrlQueryArgs( $query, $query2 );
1813 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1814 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
1815 Hooks
::run( 'GetInternalURL', array( &$this, &$url, $query ) );
1820 * Get the URL for a canonical link, for use in things like IRC and
1821 * e-mail notifications. Uses $wgCanonicalServer and the
1822 * GetCanonicalURL hook.
1824 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1826 * @see self::getLocalURL for the arguments.
1827 * @return string The URL
1830 public function getCanonicalURL( $query = '', $query2 = false ) {
1831 $query = self
::fixUrlQueryArgs( $query, $query2 );
1832 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
1833 Hooks
::run( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1838 * Get the edit URL for this Title
1840 * @return string The URL, or a null string if this is an interwiki link
1842 public function getEditURL() {
1843 if ( $this->isExternal() ) {
1846 $s = $this->getLocalURL( 'action=edit' );
1852 * Is $wgUser watching this page?
1854 * @deprecated since 1.20; use User::isWatched() instead.
1857 public function userIsWatching() {
1860 if ( is_null( $this->mWatched
) ) {
1861 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1862 $this->mWatched
= false;
1864 $this->mWatched
= $wgUser->isWatched( $this );
1867 return $this->mWatched
;
1871 * Can $user perform $action on this page?
1872 * This skips potentially expensive cascading permission checks
1873 * as well as avoids expensive error formatting
1875 * Suitable for use for nonessential UI controls in common cases, but
1876 * _not_ for functional access control.
1878 * May provide false positives, but should never provide a false negative.
1880 * @param string $action Action that permission needs to be checked for
1881 * @param User $user User to check (since 1.19); $wgUser will be used if not provided.
1884 public function quickUserCan( $action, $user = null ) {
1885 return $this->userCan( $action, $user, false );
1889 * Can $user perform $action on this page?
1891 * @param string $action Action that permission needs to be checked for
1892 * @param User $user User to check (since 1.19); $wgUser will be used if not
1894 * @param string $rigor Same format as Title::getUserPermissionsErrors()
1897 public function userCan( $action, $user = null, $rigor = 'secure' ) {
1898 if ( !$user instanceof User
) {
1903 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $rigor, true ) );
1907 * Can $user perform $action on this page?
1909 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1911 * @param string $action Action that permission needs to be checked for
1912 * @param User $user User to check
1913 * @param string $rigor One of (quick,full,secure)
1914 * - quick : does cheap permission checks from slaves (usable for GUI creation)
1915 * - full : does cheap and expensive checks possibly from a slave
1916 * - secure : does cheap and expensive checks, using the master as needed
1917 * @param bool $short Set this to true to stop after the first permission error.
1918 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
1919 * whose corresponding errors may be ignored.
1920 * @return array Array of arguments to wfMessage to explain permissions problems.
1922 public function getUserPermissionsErrors(
1923 $action, $user, $rigor = 'secure', $ignoreErrors = array()
1925 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $rigor );
1927 // Remove the errors being ignored.
1928 foreach ( $errors as $index => $error ) {
1929 $error_key = is_array( $error ) ?
$error[0] : $error;
1931 if ( in_array( $error_key, $ignoreErrors ) ) {
1932 unset( $errors[$index] );
1940 * Permissions checks that fail most often, and which are easiest to test.
1942 * @param string $action The action to check
1943 * @param User $user User to check
1944 * @param array $errors List of current errors
1945 * @param string $rigor Same format as Title::getUserPermissionsErrors()
1946 * @param bool $short Short circuit on first error
1948 * @return array List of errors
1950 private function checkQuickPermissions( $action, $user, $errors, $rigor, $short ) {
1951 if ( !Hooks
::run( 'TitleQuickPermissions',
1952 array( $this, $user, $action, &$errors, ( $rigor !== 'quick' ), $short ) )
1957 if ( $action == 'create' ) {
1959 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1960 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
1962 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1964 } elseif ( $action == 'move' ) {
1965 if ( !$user->isAllowed( 'move-rootuserpages' )
1966 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1967 // Show user page-specific message only if the user can move other pages
1968 $errors[] = array( 'cant-move-user-page' );
1971 // Check if user is allowed to move files if it's a file
1972 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1973 $errors[] = array( 'movenotallowedfile' );
1976 // Check if user is allowed to move category pages if it's a category page
1977 if ( $this->mNamespace
== NS_CATEGORY
&& !$user->isAllowed( 'move-categorypages' ) ) {
1978 $errors[] = array( 'cant-move-category-page' );
1981 if ( !$user->isAllowed( 'move' ) ) {
1982 // User can't move anything
1983 $userCanMove = User
::groupHasPermission( 'user', 'move' );
1984 $autoconfirmedCanMove = User
::groupHasPermission( 'autoconfirmed', 'move' );
1985 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1986 // custom message if logged-in users without any special rights can move
1987 $errors[] = array( 'movenologintext' );
1989 $errors[] = array( 'movenotallowed' );
1992 } elseif ( $action == 'move-target' ) {
1993 if ( !$user->isAllowed( 'move' ) ) {
1994 // User can't move anything
1995 $errors[] = array( 'movenotallowed' );
1996 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1997 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1998 // Show user page-specific message only if the user can move other pages
1999 $errors[] = array( 'cant-move-to-user-page' );
2000 } elseif ( !$user->isAllowed( 'move-categorypages' )
2001 && $this->mNamespace
== NS_CATEGORY
) {
2002 // Show category page-specific message only if the user can move other pages
2003 $errors[] = array( 'cant-move-to-category-page' );
2005 } elseif ( !$user->isAllowed( $action ) ) {
2006 $errors[] = $this->missingPermissionError( $action, $short );
2013 * Add the resulting error code to the errors array
2015 * @param array $errors List of current errors
2016 * @param array $result Result of errors
2018 * @return array List of errors
2020 private function resultToError( $errors, $result ) {
2021 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2022 // A single array representing an error
2023 $errors[] = $result;
2024 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2025 // A nested array representing multiple errors
2026 $errors = array_merge( $errors, $result );
2027 } elseif ( $result !== '' && is_string( $result ) ) {
2028 // A string representing a message-id
2029 $errors[] = array( $result );
2030 } elseif ( $result === false ) {
2031 // a generic "We don't want them to do that"
2032 $errors[] = array( 'badaccess-group0' );
2038 * Check various permission hooks
2040 * @param string $action The action to check
2041 * @param User $user User to check
2042 * @param array $errors List of current errors
2043 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2044 * @param bool $short Short circuit on first error
2046 * @return array List of errors
2048 private function checkPermissionHooks( $action, $user, $errors, $rigor, $short ) {
2049 // Use getUserPermissionsErrors instead
2051 if ( !Hooks
::run( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
2052 return $result ?
array() : array( array( 'badaccess-group0' ) );
2054 // Check getUserPermissionsErrors hook
2055 if ( !Hooks
::run( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
2056 $errors = $this->resultToError( $errors, $result );
2058 // Check getUserPermissionsErrorsExpensive hook
2061 && !( $short && count( $errors ) > 0 )
2062 && !Hooks
::run( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) )
2064 $errors = $this->resultToError( $errors, $result );
2071 * Check permissions on special pages & namespaces
2073 * @param string $action The action to check
2074 * @param User $user User to check
2075 * @param array $errors List of current errors
2076 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2077 * @param bool $short Short circuit on first error
2079 * @return array List of errors
2081 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $rigor, $short ) {
2082 # Only 'createaccount' can be performed on special pages,
2083 # which don't actually exist in the DB.
2084 if ( NS_SPECIAL
== $this->mNamespace
&& $action !== 'createaccount' ) {
2085 $errors[] = array( 'ns-specialprotected' );
2088 # Check $wgNamespaceProtection for restricted namespaces
2089 if ( $this->isNamespaceProtected( $user ) ) {
2090 $ns = $this->mNamespace
== NS_MAIN ?
2091 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2092 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
2093 array( 'protectedinterface', $action ) : array( 'namespaceprotected', $ns, $action );
2100 * Check CSS/JS sub-page permissions
2102 * @param string $action The action to check
2103 * @param User $user User to check
2104 * @param array $errors List of current errors
2105 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2106 * @param bool $short Short circuit on first error
2108 * @return array List of errors
2110 private function checkCSSandJSPermissions( $action, $user, $errors, $rigor, $short ) {
2111 # Protect css/js subpages of user pages
2112 # XXX: this might be better using restrictions
2113 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
2114 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' ) ) {
2115 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
2116 if ( $this->isCssSubpage() && !$user->isAllowedAny( 'editmyusercss', 'editusercss' ) ) {
2117 $errors[] = array( 'mycustomcssprotected', $action );
2118 } elseif ( $this->isJsSubpage() && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' ) ) {
2119 $errors[] = array( 'mycustomjsprotected', $action );
2122 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
2123 $errors[] = array( 'customcssprotected', $action );
2124 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
2125 $errors[] = array( 'customjsprotected', $action );
2134 * Check against page_restrictions table requirements on this
2135 * page. The user must possess all required rights for this
2138 * @param string $action The action to check
2139 * @param User $user User to check
2140 * @param array $errors List of current errors
2141 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2142 * @param bool $short Short circuit on first error
2144 * @return array List of errors
2146 private function checkPageRestrictions( $action, $user, $errors, $rigor, $short ) {
2147 foreach ( $this->getRestrictions( $action ) as $right ) {
2148 // Backwards compatibility, rewrite sysop -> editprotected
2149 if ( $right == 'sysop' ) {
2150 $right = 'editprotected';
2152 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2153 if ( $right == 'autoconfirmed' ) {
2154 $right = 'editsemiprotected';
2156 if ( $right == '' ) {
2159 if ( !$user->isAllowed( $right ) ) {
2160 $errors[] = array( 'protectedpagetext', $right, $action );
2161 } elseif ( $this->mCascadeRestriction
&& !$user->isAllowed( 'protect' ) ) {
2162 $errors[] = array( 'protectedpagetext', 'protect', $action );
2170 * Check restrictions on cascading pages.
2172 * @param string $action The action to check
2173 * @param User $user User to check
2174 * @param array $errors List of current errors
2175 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2176 * @param bool $short Short circuit on first error
2178 * @return array List of errors
2180 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $rigor, $short ) {
2181 if ( $rigor !== 'quick' && !$this->isCssJsSubpage() ) {
2182 # We /could/ use the protection level on the source page, but it's
2183 # fairly ugly as we have to establish a precedence hierarchy for pages
2184 # included by multiple cascade-protected pages. So just restrict
2185 # it to people with 'protect' permission, as they could remove the
2186 # protection anyway.
2187 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2188 # Cascading protection depends on more than this page...
2189 # Several cascading protected pages may include this page...
2190 # Check each cascading level
2191 # This is only for protection restrictions, not for all actions
2192 if ( isset( $restrictions[$action] ) ) {
2193 foreach ( $restrictions[$action] as $right ) {
2194 // Backwards compatibility, rewrite sysop -> editprotected
2195 if ( $right == 'sysop' ) {
2196 $right = 'editprotected';
2198 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2199 if ( $right == 'autoconfirmed' ) {
2200 $right = 'editsemiprotected';
2202 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2204 foreach ( $cascadingSources as $page ) {
2205 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2207 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages, $action );
2217 * Check action permissions not already checked in checkQuickPermissions
2219 * @param string $action The action to check
2220 * @param User $user User to check
2221 * @param array $errors List of current errors
2222 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2223 * @param bool $short Short circuit on first error
2225 * @return array List of errors
2227 private function checkActionPermissions( $action, $user, $errors, $rigor, $short ) {
2228 global $wgDeleteRevisionsLimit, $wgLang;
2230 if ( $action == 'protect' ) {
2231 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, 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['permission'] == ''
2239 ||
!$user->isAllowed( $title_protection['permission'] )
2243 User
::whoIs( $title_protection['user'] ),
2244 $title_protection['reason']
2248 } elseif ( $action == 'move' ) {
2249 // Check for immobile pages
2250 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2251 // Specific message for this case
2252 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2253 } elseif ( !$this->isMovable() ) {
2254 // Less specific message for rarer cases
2255 $errors[] = array( 'immobile-source-page' );
2257 } elseif ( $action == 'move-target' ) {
2258 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2259 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
2260 } elseif ( !$this->isMovable() ) {
2261 $errors[] = array( 'immobile-target-page' );
2263 } elseif ( $action == 'delete' ) {
2264 $tempErrors = $this->checkPageRestrictions( 'edit', $user, array(), $rigor, true );
2265 if ( !$tempErrors ) {
2266 $tempErrors = $this->checkCascadingSourcesRestrictions( 'edit',
2267 $user, $tempErrors, $rigor, true );
2269 if ( $tempErrors ) {
2270 // If protection keeps them from editing, they shouldn't be able to delete.
2271 $errors[] = array( 'deleteprotected' );
2273 if ( $rigor !== 'quick' && $wgDeleteRevisionsLimit
2274 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2276 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
2283 * Check that the user isn't blocked from editing.
2285 * @param string $action The action to check
2286 * @param User $user User to check
2287 * @param array $errors List of current errors
2288 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2289 * @param bool $short Short circuit on first error
2291 * @return array List of errors
2293 private function checkUserBlock( $action, $user, $errors, $rigor, $short ) {
2294 // Account creation blocks handled at userlogin.
2295 // Unblocking handled in SpecialUnblock
2296 if ( $rigor === 'quick' ||
in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
2300 global $wgEmailConfirmToEdit;
2302 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2303 $errors[] = array( 'confirmedittext' );
2306 $useSlave = ( $rigor !== 'secure' );
2307 if ( ( $action == 'edit' ||
$action == 'create' )
2308 && !$user->isBlockedFrom( $this, $useSlave )
2310 // Don't block the user from editing their own talk page unless they've been
2311 // explicitly blocked from that too.
2312 } elseif ( $user->isBlocked() && $user->getBlock()->prevents( $action ) !== false ) {
2313 // @todo FIXME: Pass the relevant context into this function.
2314 $errors[] = $user->getBlock()->getPermissionsError( RequestContext
::getMain() );
2321 * Check that the user is allowed to read this page.
2323 * @param string $action The action to check
2324 * @param User $user User to check
2325 * @param array $errors List of current errors
2326 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2327 * @param bool $short Short circuit on first error
2329 * @return array List of errors
2331 private function checkReadPermissions( $action, $user, $errors, $rigor, $short ) {
2332 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2334 $whitelisted = false;
2335 if ( User
::isEveryoneAllowed( 'read' ) ) {
2336 # Shortcut for public wikis, allows skipping quite a bit of code
2337 $whitelisted = true;
2338 } elseif ( $user->isAllowed( 'read' ) ) {
2339 # If the user is allowed to read pages, he is allowed to read all pages
2340 $whitelisted = true;
2341 } elseif ( $this->isSpecial( 'Userlogin' )
2342 ||
$this->isSpecial( 'ChangePassword' )
2343 ||
$this->isSpecial( 'PasswordReset' )
2345 # Always grant access to the login page.
2346 # Even anons need to be able to log in.
2347 $whitelisted = true;
2348 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2349 # Time to check the whitelist
2350 # Only do these checks is there's something to check against
2351 $name = $this->getPrefixedText();
2352 $dbName = $this->getPrefixedDBkey();
2354 // Check for explicit whitelisting with and without underscores
2355 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2356 $whitelisted = true;
2357 } elseif ( $this->getNamespace() == NS_MAIN
) {
2358 # Old settings might have the title prefixed with
2359 # a colon for main-namespace pages
2360 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2361 $whitelisted = true;
2363 } elseif ( $this->isSpecialPage() ) {
2364 # If it's a special page, ditch the subpage bit and check again
2365 $name = $this->getDBkey();
2366 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
2368 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2369 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2370 $whitelisted = true;
2376 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2377 $name = $this->getPrefixedText();
2378 // Check for regex whitelisting
2379 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2380 if ( preg_match( $listItem, $name ) ) {
2381 $whitelisted = true;
2387 if ( !$whitelisted ) {
2388 # If the title is not whitelisted, give extensions a chance to do so...
2389 Hooks
::run( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2390 if ( !$whitelisted ) {
2391 $errors[] = $this->missingPermissionError( $action, $short );
2399 * Get a description array when the user doesn't have the right to perform
2400 * $action (i.e. when User::isAllowed() returns false)
2402 * @param string $action The action to check
2403 * @param bool $short Short circuit on first error
2404 * @return array List of errors
2406 private function missingPermissionError( $action, $short ) {
2407 // We avoid expensive display logic for quickUserCan's and such
2409 return array( 'badaccess-group0' );
2412 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2413 User
::getGroupsWithPermission( $action ) );
2415 if ( count( $groups ) ) {
2419 $wgLang->commaList( $groups ),
2423 return array( 'badaccess-group0' );
2428 * Can $user perform $action on this page? This is an internal function,
2429 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2430 * checks on wfReadOnly() and blocks)
2432 * @param string $action Action that permission needs to be checked for
2433 * @param User $user User to check
2434 * @param string $rigor One of (quick,full,secure)
2435 * - quick : does cheap permission checks from slaves (usable for GUI creation)
2436 * - full : does cheap and expensive checks possibly from a slave
2437 * - secure : does cheap and expensive checks, using the master as needed
2438 * @param bool $short Set this to true to stop after the first permission error.
2439 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2441 protected function getUserPermissionsErrorsInternal(
2442 $action, $user, $rigor = 'secure', $short = false
2444 if ( $rigor === true ) {
2445 $rigor = 'secure'; // b/c
2446 } elseif ( $rigor === false ) {
2447 $rigor = 'quick'; // b/c
2448 } elseif ( !in_array( $rigor, array( 'quick', 'full', 'secure' ) ) ) {
2449 throw new Exception( "Invalid rigor parameter '$rigor'." );
2452 # Read has special handling
2453 if ( $action == 'read' ) {
2455 'checkPermissionHooks',
2456 'checkReadPermissions',
2458 # Don't call checkSpecialsAndNSPermissions or checkCSSandJSPermissions
2459 # here as it will lead to duplicate error messages. This is okay to do
2460 # since anywhere that checks for create will also check for edit, and
2461 # those checks are called for edit.
2462 } elseif ( $action == 'create' ) {
2464 'checkQuickPermissions',
2465 'checkPermissionHooks',
2466 'checkPageRestrictions',
2467 'checkCascadingSourcesRestrictions',
2468 'checkActionPermissions',
2473 'checkQuickPermissions',
2474 'checkPermissionHooks',
2475 'checkSpecialsAndNSPermissions',
2476 'checkCSSandJSPermissions',
2477 'checkPageRestrictions',
2478 'checkCascadingSourcesRestrictions',
2479 'checkActionPermissions',
2485 while ( count( $checks ) > 0 &&
2486 !( $short && count( $errors ) > 0 ) ) {
2487 $method = array_shift( $checks );
2488 $errors = $this->$method( $action, $user, $errors, $rigor, $short );
2495 * Get a filtered list of all restriction types supported by this wiki.
2496 * @param bool $exists True to get all restriction types that apply to
2497 * titles that do exist, False for all restriction types that apply to
2498 * titles that do not exist
2501 public static function getFilteredRestrictionTypes( $exists = true ) {
2502 global $wgRestrictionTypes;
2503 $types = $wgRestrictionTypes;
2505 # Remove the create restriction for existing titles
2506 $types = array_diff( $types, array( 'create' ) );
2508 # Only the create and upload restrictions apply to non-existing titles
2509 $types = array_intersect( $types, array( 'create', 'upload' ) );
2515 * Returns restriction types for the current Title
2517 * @return array Applicable restriction types
2519 public function getRestrictionTypes() {
2520 if ( $this->isSpecialPage() ) {
2524 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2526 if ( $this->getNamespace() != NS_FILE
) {
2527 # Remove the upload restriction for non-file titles
2528 $types = array_diff( $types, array( 'upload' ) );
2531 Hooks
::run( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2533 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2534 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2540 * Is this title subject to title protection?
2541 * Title protection is the one applied against creation of such title.
2543 * @return array|bool An associative array representing any existent title
2544 * protection, or false if there's none.
2546 public function getTitleProtection() {
2547 // Can't protect pages in special namespaces
2548 if ( $this->getNamespace() < 0 ) {
2552 // Can't protect pages that exist.
2553 if ( $this->exists() ) {
2557 if ( $this->mTitleProtection
=== null ) {
2558 $dbr = wfGetDB( DB_SLAVE
);
2559 $res = $dbr->select(
2562 'user' => 'pt_user',
2563 'reason' => 'pt_reason',
2564 'expiry' => 'pt_expiry',
2565 'permission' => 'pt_create_perm'
2567 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2571 // fetchRow returns false if there are no rows.
2572 $row = $dbr->fetchRow( $res );
2574 if ( $row['permission'] == 'sysop' ) {
2575 $row['permission'] = 'editprotected'; // B/C
2577 if ( $row['permission'] == 'autoconfirmed' ) {
2578 $row['permission'] = 'editsemiprotected'; // B/C
2580 $row['expiry'] = $dbr->decodeExpiry( $row['expiry'] );
2582 $this->mTitleProtection
= $row;
2584 return $this->mTitleProtection
;
2588 * Remove any title protection due to page existing
2590 public function deleteTitleProtection() {
2591 $dbw = wfGetDB( DB_MASTER
);
2595 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2598 $this->mTitleProtection
= false;
2602 * Is this page "semi-protected" - the *only* protection levels are listed
2603 * in $wgSemiprotectedRestrictionLevels?
2605 * @param string $action Action to check (default: edit)
2608 public function isSemiProtected( $action = 'edit' ) {
2609 global $wgSemiprotectedRestrictionLevels;
2611 $restrictions = $this->getRestrictions( $action );
2612 $semi = $wgSemiprotectedRestrictionLevels;
2613 if ( !$restrictions ||
!$semi ) {
2614 // Not protected, or all protection is full protection
2618 // Remap autoconfirmed to editsemiprotected for BC
2619 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2620 $semi[$key] = 'editsemiprotected';
2622 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2623 $restrictions[$key] = 'editsemiprotected';
2626 return !array_diff( $restrictions, $semi );
2630 * Does the title correspond to a protected article?
2632 * @param string $action The action the page is protected from,
2633 * by default checks all actions.
2636 public function isProtected( $action = '' ) {
2637 global $wgRestrictionLevels;
2639 $restrictionTypes = $this->getRestrictionTypes();
2641 # Special pages have inherent protection
2642 if ( $this->isSpecialPage() ) {
2646 # Check regular protection levels
2647 foreach ( $restrictionTypes as $type ) {
2648 if ( $action == $type ||
$action == '' ) {
2649 $r = $this->getRestrictions( $type );
2650 foreach ( $wgRestrictionLevels as $level ) {
2651 if ( in_array( $level, $r ) && $level != '' ) {
2662 * Determines if $user is unable to edit this page because it has been protected
2663 * by $wgNamespaceProtection.
2665 * @param User $user User object to check permissions
2668 public function isNamespaceProtected( User
$user ) {
2669 global $wgNamespaceProtection;
2671 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2672 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2673 if ( $right != '' && !$user->isAllowed( $right ) ) {
2682 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2684 * @return bool If the page is subject to cascading restrictions.
2686 public function isCascadeProtected() {
2687 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2688 return ( $sources > 0 );
2692 * Determines whether cascading protection sources have already been loaded from
2695 * @param bool $getPages True to check if the pages are loaded, or false to check
2696 * if the status is loaded.
2697 * @return bool Whether or not the specified information has been loaded
2700 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2701 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
2705 * Cascading protection: Get the source of any cascading restrictions on this page.
2707 * @param bool $getPages Whether or not to retrieve the actual pages
2708 * that the restrictions have come from and the actual restrictions
2710 * @return array Two elements: First is an array of Title objects of the
2711 * pages from which cascading restrictions have come, false for
2712 * none, or true if such restrictions exist but $getPages was not
2713 * set. Second is an array like that returned by
2714 * Title::getAllRestrictions(), or an empty array if $getPages is
2717 public function getCascadeProtectionSources( $getPages = true ) {
2718 $pagerestrictions = array();
2720 if ( $this->mCascadeSources
!== null && $getPages ) {
2721 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2722 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
2723 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2726 $dbr = wfGetDB( DB_SLAVE
);
2728 if ( $this->getNamespace() == NS_FILE
) {
2729 $tables = array( 'imagelinks', 'page_restrictions' );
2730 $where_clauses = array(
2731 'il_to' => $this->getDBkey(),
2736 $tables = array( 'templatelinks', 'page_restrictions' );
2737 $where_clauses = array(
2738 'tl_namespace' => $this->getNamespace(),
2739 'tl_title' => $this->getDBkey(),
2746 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2747 'pr_expiry', 'pr_type', 'pr_level' );
2748 $where_clauses[] = 'page_id=pr_page';
2751 $cols = array( 'pr_expiry' );
2754 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2756 $sources = $getPages ?
array() : false;
2757 $now = wfTimestampNow();
2759 foreach ( $res as $row ) {
2760 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
2761 if ( $expiry > $now ) {
2763 $page_id = $row->pr_page
;
2764 $page_ns = $row->page_namespace
;
2765 $page_title = $row->page_title
;
2766 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2767 # Add groups needed for each restriction type if its not already there
2768 # Make sure this restriction type still exists
2770 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2771 $pagerestrictions[$row->pr_type
] = array();
2775 isset( $pagerestrictions[$row->pr_type
] )
2776 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
2778 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2787 $this->mCascadeSources
= $sources;
2788 $this->mCascadingRestrictions
= $pagerestrictions;
2790 $this->mHasCascadingRestrictions
= $sources;
2793 return array( $sources, $pagerestrictions );
2797 * Accessor for mRestrictionsLoaded
2799 * @return bool Whether or not the page's restrictions have already been
2800 * loaded from the database
2803 public function areRestrictionsLoaded() {
2804 return $this->mRestrictionsLoaded
;
2808 * Accessor/initialisation for mRestrictions
2810 * @param string $action Action that permission needs to be checked for
2811 * @return array Restriction levels needed to take the action. All levels are
2812 * required. Note that restriction levels are normally user rights, but 'sysop'
2813 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
2814 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
2816 public function getRestrictions( $action ) {
2817 if ( !$this->mRestrictionsLoaded
) {
2818 $this->loadRestrictions();
2820 return isset( $this->mRestrictions
[$action] )
2821 ?
$this->mRestrictions
[$action]
2826 * Accessor/initialisation for mRestrictions
2828 * @return array Keys are actions, values are arrays as returned by
2829 * Title::getRestrictions()
2832 public function getAllRestrictions() {
2833 if ( !$this->mRestrictionsLoaded
) {
2834 $this->loadRestrictions();
2836 return $this->mRestrictions
;
2840 * Get the expiry time for the restriction against a given action
2842 * @param string $action
2843 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2844 * or not protected at all, or false if the action is not recognised.
2846 public function getRestrictionExpiry( $action ) {
2847 if ( !$this->mRestrictionsLoaded
) {
2848 $this->loadRestrictions();
2850 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2854 * Returns cascading restrictions for the current article
2858 function areRestrictionsCascading() {
2859 if ( !$this->mRestrictionsLoaded
) {
2860 $this->loadRestrictions();
2863 return $this->mCascadeRestriction
;
2867 * Loads a string into mRestrictions array
2869 * @param ResultWrapper $res Resource restrictions as an SQL result.
2870 * @param string $oldFashionedRestrictions Comma-separated list of page
2871 * restrictions from page table (pre 1.10)
2873 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2876 foreach ( $res as $row ) {
2880 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2884 * Compiles list of active page restrictions from both page table (pre 1.10)
2885 * and page_restrictions table for this existing page.
2886 * Public for usage by LiquidThreads.
2888 * @param array $rows Array of db result objects
2889 * @param string $oldFashionedRestrictions Comma-separated list of page
2890 * restrictions from page table (pre 1.10)
2892 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2893 $dbr = wfGetDB( DB_SLAVE
);
2895 $restrictionTypes = $this->getRestrictionTypes();
2897 foreach ( $restrictionTypes as $type ) {
2898 $this->mRestrictions
[$type] = array();
2899 $this->mRestrictionsExpiry
[$type] = 'infinity';
2902 $this->mCascadeRestriction
= false;
2904 # Backwards-compatibility: also load the restrictions from the page record (old format).
2905 if ( $oldFashionedRestrictions !== null ) {
2906 $this->mOldRestrictions
= $oldFashionedRestrictions;
2909 if ( $this->mOldRestrictions
=== false ) {
2910 $this->mOldRestrictions
= $dbr->selectField( 'page', 'page_restrictions',
2911 array( 'page_id' => $this->getArticleID() ), __METHOD__
);
2914 if ( $this->mOldRestrictions
!= '' ) {
2915 foreach ( explode( ':', trim( $this->mOldRestrictions
) ) as $restrict ) {
2916 $temp = explode( '=', trim( $restrict ) );
2917 if ( count( $temp ) == 1 ) {
2918 // old old format should be treated as edit/move restriction
2919 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2920 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2922 $restriction = trim( $temp[1] );
2923 if ( $restriction != '' ) { //some old entries are empty
2924 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
2930 if ( count( $rows ) ) {
2931 # Current system - load second to make them override.
2932 $now = wfTimestampNow();
2934 # Cycle through all the restrictions.
2935 foreach ( $rows as $row ) {
2937 // Don't take care of restrictions types that aren't allowed
2938 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
2942 // This code should be refactored, now that it's being used more generally,
2943 // But I don't really see any harm in leaving it in Block for now -werdna
2944 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
2946 // Only apply the restrictions if they haven't expired!
2947 if ( !$expiry ||
$expiry > $now ) {
2948 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2949 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2951 $this->mCascadeRestriction |
= $row->pr_cascade
;
2956 $this->mRestrictionsLoaded
= true;
2960 * Load restrictions from the page_restrictions table
2962 * @param string $oldFashionedRestrictions Comma-separated list of page
2963 * restrictions from page table (pre 1.10)
2965 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2966 if ( !$this->mRestrictionsLoaded
) {
2967 $dbr = wfGetDB( DB_SLAVE
);
2968 if ( $this->exists() ) {
2969 $res = $dbr->select(
2970 'page_restrictions',
2971 array( 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ),
2972 array( 'pr_page' => $this->getArticleID() ),
2976 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2978 $title_protection = $this->getTitleProtection();
2980 if ( $title_protection ) {
2981 $now = wfTimestampNow();
2982 $expiry = $dbr->decodeExpiry( $title_protection['expiry'] );
2984 if ( !$expiry ||
$expiry > $now ) {
2985 // Apply the restrictions
2986 $this->mRestrictionsExpiry
['create'] = $expiry;
2987 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['permission'] ) );
2988 } else { // Get rid of the old restrictions
2989 $this->mTitleProtection
= false;
2992 $this->mRestrictionsExpiry
['create'] = 'infinity';
2994 $this->mRestrictionsLoaded
= true;
3000 * Flush the protection cache in this object and force reload from the database.
3001 * This is used when updating protection from WikiPage::doUpdateRestrictions().
3003 public function flushRestrictions() {
3004 $this->mRestrictionsLoaded
= false;
3005 $this->mTitleProtection
= null;
3009 * Purge expired restrictions from the page_restrictions table
3011 static function purgeExpiredRestrictions() {
3012 if ( wfReadOnly() ) {
3016 $method = __METHOD__
;
3017 $dbw = wfGetDB( DB_MASTER
);
3018 $dbw->onTransactionIdle( function () use ( $dbw, $method ) {
3020 'page_restrictions',
3021 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
3026 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
3033 * Does this have subpages? (Warning, usually requires an extra DB query.)
3037 public function hasSubpages() {
3038 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3043 # We dynamically add a member variable for the purpose of this method
3044 # alone to cache the result. There's no point in having it hanging
3045 # around uninitialized in every Title object; therefore we only add it
3046 # if needed and don't declare it statically.
3047 if ( $this->mHasSubpages
=== null ) {
3048 $this->mHasSubpages
= false;
3049 $subpages = $this->getSubpages( 1 );
3050 if ( $subpages instanceof TitleArray
) {
3051 $this->mHasSubpages
= (bool)$subpages->count();
3055 return $this->mHasSubpages
;
3059 * Get all subpages of this page.
3061 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3062 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3063 * doesn't allow subpages
3065 public function getSubpages( $limit = -1 ) {
3066 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3070 $dbr = wfGetDB( DB_SLAVE
);
3071 $conds['page_namespace'] = $this->getNamespace();
3072 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
3074 if ( $limit > -1 ) {
3075 $options['LIMIT'] = $limit;
3077 $this->mSubpages
= TitleArray
::newFromResult(
3078 $dbr->select( 'page',
3079 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
3085 return $this->mSubpages
;
3089 * Is there a version of this page in the deletion archive?
3091 * @return int The number of archived revisions
3093 public function isDeleted() {
3094 if ( $this->getNamespace() < 0 ) {
3097 $dbr = wfGetDB( DB_SLAVE
);
3099 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3100 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3103 if ( $this->getNamespace() == NS_FILE
) {
3104 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
3105 array( 'fa_name' => $this->getDBkey() ),
3114 * Is there a version of this page in the deletion archive?
3118 public function isDeletedQuick() {
3119 if ( $this->getNamespace() < 0 ) {
3122 $dbr = wfGetDB( DB_SLAVE
);
3123 $deleted = (bool)$dbr->selectField( 'archive', '1',
3124 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3127 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
3128 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3129 array( 'fa_name' => $this->getDBkey() ),
3137 * Get the article ID for this Title from the link cache,
3138 * adding it if necessary
3140 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3142 * @return int The ID
3144 public function getArticleID( $flags = 0 ) {
3145 if ( $this->getNamespace() < 0 ) {
3146 $this->mArticleID
= 0;
3147 return $this->mArticleID
;
3149 $linkCache = LinkCache
::singleton();
3150 if ( $flags & self
::GAID_FOR_UPDATE
) {
3151 $oldUpdate = $linkCache->forUpdate( true );
3152 $linkCache->clearLink( $this );
3153 $this->mArticleID
= $linkCache->addLinkObj( $this );
3154 $linkCache->forUpdate( $oldUpdate );
3156 if ( -1 == $this->mArticleID
) {
3157 $this->mArticleID
= $linkCache->addLinkObj( $this );
3160 return $this->mArticleID
;
3164 * Is this an article that is a redirect page?
3165 * Uses link cache, adding it if necessary
3167 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3170 public function isRedirect( $flags = 0 ) {
3171 if ( !is_null( $this->mRedirect
) ) {
3172 return $this->mRedirect
;
3174 if ( !$this->getArticleID( $flags ) ) {
3175 $this->mRedirect
= false;
3176 return $this->mRedirect
;
3179 $linkCache = LinkCache
::singleton();
3180 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3181 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3182 if ( $cached === null ) {
3183 # Trust LinkCache's state over our own
3184 # LinkCache is telling us that the page doesn't exist, despite there being cached
3185 # data relating to an existing page in $this->mArticleID. Updaters should clear
3186 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3187 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3188 # LinkCache to refresh its data from the master.
3189 $this->mRedirect
= false;
3190 return $this->mRedirect
;
3193 $this->mRedirect
= (bool)$cached;
3195 return $this->mRedirect
;
3199 * What is the length of this page?
3200 * Uses link cache, adding it if necessary
3202 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3205 public function getLength( $flags = 0 ) {
3206 if ( $this->mLength
!= -1 ) {
3207 return $this->mLength
;
3209 if ( !$this->getArticleID( $flags ) ) {
3211 return $this->mLength
;
3213 $linkCache = LinkCache
::singleton();
3214 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3215 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3216 if ( $cached === null ) {
3217 # Trust LinkCache's state over our own, as for isRedirect()
3219 return $this->mLength
;
3222 $this->mLength
= intval( $cached );
3224 return $this->mLength
;
3228 * What is the page_latest field for this page?
3230 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3231 * @return int Int or 0 if the page doesn't exist
3233 public function getLatestRevID( $flags = 0 ) {
3234 if ( !( $flags & Title
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
3235 return intval( $this->mLatestID
);
3237 if ( !$this->getArticleID( $flags ) ) {
3238 $this->mLatestID
= 0;
3239 return $this->mLatestID
;
3241 $linkCache = LinkCache
::singleton();
3242 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3243 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3244 if ( $cached === null ) {
3245 # Trust LinkCache's state over our own, as for isRedirect()
3246 $this->mLatestID
= 0;
3247 return $this->mLatestID
;
3250 $this->mLatestID
= intval( $cached );
3252 return $this->mLatestID
;
3256 * This clears some fields in this object, and clears any associated
3257 * keys in the "bad links" section of the link cache.
3259 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
3260 * loading of the new page_id. It's also called from
3261 * WikiPage::doDeleteArticleReal()
3263 * @param int $newid The new Article ID
3265 public function resetArticleID( $newid ) {
3266 $linkCache = LinkCache
::singleton();
3267 $linkCache->clearLink( $this );
3269 if ( $newid === false ) {
3270 $this->mArticleID
= -1;
3272 $this->mArticleID
= intval( $newid );
3274 $this->mRestrictionsLoaded
= false;
3275 $this->mRestrictions
= array();
3276 $this->mOldRestrictions
= false;
3277 $this->mRedirect
= null;
3278 $this->mLength
= -1;
3279 $this->mLatestID
= false;
3280 $this->mContentModel
= false;
3281 $this->mEstimateRevisions
= null;
3282 $this->mPageLanguage
= false;
3283 $this->mDbPageLanguage
= null;
3284 $this->mIsBigDeletion
= null;
3288 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3290 * @param string $text Containing title to capitalize
3291 * @param int $ns Namespace index, defaults to NS_MAIN
3292 * @return string Containing capitalized title
3294 public static function capitalize( $text, $ns = NS_MAIN
) {
3297 if ( MWNamespace
::isCapitalized( $ns ) ) {
3298 return $wgContLang->ucfirst( $text );
3305 * Secure and split - main initialisation function for this object
3307 * Assumes that mDbkeyform has been set, and is urldecoded
3308 * and uses underscores, but not otherwise munged. This function
3309 * removes illegal characters, splits off the interwiki and
3310 * namespace prefixes, sets the other forms, and canonicalizes
3313 * @return bool True on success
3315 private function secureAndSplit() {
3317 $this->mInterwiki
= '';
3318 $this->mFragment
= '';
3319 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
3321 $dbkey = $this->mDbkeyform
;
3324 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3325 // the parsing code with Title, while avoiding massive refactoring.
3326 // @todo: get rid of secureAndSplit, refactor parsing code.
3327 $titleParser = self
::getTitleParser();
3328 $parts = $titleParser->splitTitleString( $dbkey, $this->getDefaultNamespace() );
3329 } catch ( MalformedTitleException
$ex ) {
3334 $this->setFragment( '#' . $parts['fragment'] );
3335 $this->mInterwiki
= $parts['interwiki'];
3336 $this->mLocalInterwiki
= $parts['local_interwiki'];
3337 $this->mNamespace
= $parts['namespace'];
3338 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3340 $this->mDbkeyform
= $parts['dbkey'];
3341 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3342 $this->mTextform
= str_replace( '_', ' ', $this->mDbkeyform
);
3344 # We already know that some pages won't be in the database!
3345 if ( $this->isExternal() ||
$this->mNamespace
== NS_SPECIAL
) {
3346 $this->mArticleID
= 0;
3353 * Get an array of Title objects linking to this Title
3354 * Also stores the IDs in the link cache.
3356 * WARNING: do not use this function on arbitrary user-supplied titles!
3357 * On heavily-used templates it will max out the memory.
3359 * @param array $options May be FOR UPDATE
3360 * @param string $table Table name
3361 * @param string $prefix Fields prefix
3362 * @return Title[] Array of Title objects linking here
3364 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3365 if ( count( $options ) > 0 ) {
3366 $db = wfGetDB( DB_MASTER
);
3368 $db = wfGetDB( DB_SLAVE
);
3372 array( 'page', $table ),
3373 self
::getSelectFields(),
3375 "{$prefix}_from=page_id",
3376 "{$prefix}_namespace" => $this->getNamespace(),
3377 "{$prefix}_title" => $this->getDBkey() ),
3383 if ( $res->numRows() ) {
3384 $linkCache = LinkCache
::singleton();
3385 foreach ( $res as $row ) {
3386 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
3388 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3389 $retVal[] = $titleObj;
3397 * Get an array of Title objects using this Title as a template
3398 * Also stores the IDs in the link cache.
3400 * WARNING: do not use this function on arbitrary user-supplied titles!
3401 * On heavily-used templates it will max out the memory.
3403 * @param array $options May be FOR UPDATE
3404 * @return Title[] Array of Title the Title objects linking here
3406 public function getTemplateLinksTo( $options = array() ) {
3407 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3411 * Get an array of Title objects linked from this Title
3412 * Also stores the IDs in the link cache.
3414 * WARNING: do not use this function on arbitrary user-supplied titles!
3415 * On heavily-used templates it will max out the memory.
3417 * @param array $options May be FOR UPDATE
3418 * @param string $table Table name
3419 * @param string $prefix Fields prefix
3420 * @return array Array of Title objects linking here
3422 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3423 $id = $this->getArticleID();
3425 # If the page doesn't exist; there can't be any link from this page
3430 if ( count( $options ) > 0 ) {
3431 $db = wfGetDB( DB_MASTER
);
3433 $db = wfGetDB( DB_SLAVE
);
3436 $blNamespace = "{$prefix}_namespace";
3437 $blTitle = "{$prefix}_title";
3440 array( $table, 'page' ),
3442 array( $blNamespace, $blTitle ),
3443 WikiPage
::selectFields()
3445 array( "{$prefix}_from" => $id ),
3448 array( 'page' => array(
3450 array( "page_namespace=$blNamespace", "page_title=$blTitle" )
3455 $linkCache = LinkCache
::singleton();
3456 foreach ( $res as $row ) {
3457 if ( $row->page_id
) {
3458 $titleObj = Title
::newFromRow( $row );
3460 $titleObj = Title
::makeTitle( $row->$blNamespace, $row->$blTitle );
3461 $linkCache->addBadLinkObj( $titleObj );
3463 $retVal[] = $titleObj;
3470 * Get an array of Title objects used on this Title as a template
3471 * Also stores the IDs in the link cache.
3473 * WARNING: do not use this function on arbitrary user-supplied titles!
3474 * On heavily-used templates it will max out the memory.
3476 * @param array $options May be FOR UPDATE
3477 * @return Title[] Array of Title the Title objects used here
3479 public function getTemplateLinksFrom( $options = array() ) {
3480 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3484 * Get an array of Title objects referring to non-existent articles linked
3487 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3488 * should use redirect table in this case).
3489 * @return Title[] Array of Title the Title objects
3491 public function getBrokenLinksFrom() {
3492 if ( $this->getArticleID() == 0 ) {
3493 # All links from article ID 0 are false positives
3497 $dbr = wfGetDB( DB_SLAVE
);
3498 $res = $dbr->select(
3499 array( 'page', 'pagelinks' ),
3500 array( 'pl_namespace', 'pl_title' ),
3502 'pl_from' => $this->getArticleID(),
3503 'page_namespace IS NULL'
3505 __METHOD__
, array(),
3509 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3515 foreach ( $res as $row ) {
3516 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3522 * Get a list of URLs to purge from the Squid cache when this
3525 * @return string[] Array of String the URLs
3527 public function getSquidURLs() {
3529 $this->getInternalURL(),
3530 $this->getInternalURL( 'action=history' )
3533 $pageLang = $this->getPageLanguage();
3534 if ( $pageLang->hasVariants() ) {
3535 $variants = $pageLang->getVariants();
3536 foreach ( $variants as $vCode ) {
3537 $urls[] = $this->getInternalURL( '', $vCode );
3541 // If we are looking at a css/js user subpage, purge the action=raw.
3542 if ( $this->isJsSubpage() ) {
3543 $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/javascript' );
3544 } elseif ( $this->isCssSubpage() ) {
3545 $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/css' );
3548 Hooks
::run( 'TitleSquidURLs', array( $this, &$urls ) );
3553 * Purge all applicable Squid URLs
3555 public function purgeSquid() {
3557 if ( $wgUseSquid ) {
3558 $urls = $this->getSquidURLs();
3559 $u = new SquidUpdate( $urls );
3565 * Move this page without authentication
3567 * @deprecated since 1.25 use MovePage class instead
3568 * @param Title $nt The new page Title
3569 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3571 public function moveNoAuth( &$nt ) {
3572 wfDeprecated( __METHOD__
, '1.25' );
3573 return $this->moveTo( $nt, false );
3577 * Check whether a given move operation would be valid.
3578 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3580 * @deprecated since 1.25, use MovePage's methods instead
3581 * @param Title $nt The new title
3582 * @param bool $auth Whether to check user permissions (uses $wgUser)
3583 * @param string $reason Is the log summary of the move, used for spam checking
3584 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3586 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3589 if ( !( $nt instanceof Title
) ) {
3590 // Normally we'd add this to $errors, but we'll get
3591 // lots of syntax errors if $nt is not an object
3592 return array( array( 'badtitletext' ) );
3595 $mp = new MovePage( $this, $nt );
3596 $errors = $mp->isValidMove()->getErrorsArray();
3598 $errors = wfMergeErrorArrays(
3600 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
3604 return $errors ?
: true;
3608 * Check if the requested move target is a valid file move target
3609 * @todo move this to MovePage
3610 * @param Title $nt Target title
3611 * @return array List of errors
3613 protected function validateFileMoveOperation( $nt ) {
3618 $destFile = wfLocalFile( $nt );
3619 $destFile->load( File
::READ_LATEST
);
3620 if ( !$wgUser->isAllowed( 'reupload-shared' )
3621 && !$destFile->exists() && wfFindFile( $nt )
3623 $errors[] = array( 'file-exists-sharedrepo' );
3630 * Move a title to a new location
3632 * @deprecated since 1.25, use the MovePage class instead
3633 * @param Title $nt The new title
3634 * @param bool $auth Indicates whether $wgUser's permissions
3636 * @param string $reason The reason for the move
3637 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3638 * Ignored if the user doesn't have the suppressredirect right.
3639 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3641 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3643 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3644 if ( is_array( $err ) ) {
3645 // Auto-block user's IP if the account was "hard" blocked
3646 $wgUser->spreadAnyEditBlock();
3649 // Check suppressredirect permission
3650 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3651 $createRedirect = true;
3654 $mp = new MovePage( $this, $nt );
3655 $status = $mp->move( $wgUser, $reason, $createRedirect );
3656 if ( $status->isOK() ) {
3659 return $status->getErrorsArray();
3664 * Move this page's subpages to be subpages of $nt
3666 * @param Title $nt Move target
3667 * @param bool $auth Whether $wgUser's permissions should be checked
3668 * @param string $reason The reason for the move
3669 * @param bool $createRedirect Whether to create redirects from the old subpages to
3670 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3671 * @return array Array with old page titles as keys, and strings (new page titles) or
3672 * arrays (errors) as values, or an error array with numeric indices if no pages
3675 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3676 global $wgMaximumMovedPages;
3677 // Check permissions
3678 if ( !$this->userCan( 'move-subpages' ) ) {
3679 return array( 'cant-move-subpages' );
3681 // Do the source and target namespaces support subpages?
3682 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3683 return array( 'namespace-nosubpages',
3684 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3686 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3687 return array( 'namespace-nosubpages',
3688 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3691 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3694 foreach ( $subpages as $oldSubpage ) {
3696 if ( $count > $wgMaximumMovedPages ) {
3697 $retval[$oldSubpage->getPrefixedText()] =
3698 array( 'movepage-max-pages',
3699 $wgMaximumMovedPages );
3703 // We don't know whether this function was called before
3704 // or after moving the root page, so check both
3706 if ( $oldSubpage->getArticleID() == $this->getArticleID()
3707 ||
$oldSubpage->getArticleID() == $nt->getArticleID()
3709 // When moving a page to a subpage of itself,
3710 // don't move it twice
3713 $newPageName = preg_replace(
3714 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3715 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3716 $oldSubpage->getDBkey() );
3717 if ( $oldSubpage->isTalkPage() ) {
3718 $newNs = $nt->getTalkPage()->getNamespace();
3720 $newNs = $nt->getSubjectPage()->getNamespace();
3722 # Bug 14385: we need makeTitleSafe because the new page names may
3723 # be longer than 255 characters.
3724 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3726 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3727 if ( $success === true ) {
3728 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3730 $retval[$oldSubpage->getPrefixedText()] = $success;
3737 * Checks if this page is just a one-rev redirect.
3738 * Adds lock, so don't use just for light purposes.
3742 public function isSingleRevRedirect() {
3743 global $wgContentHandlerUseDB;
3745 $dbw = wfGetDB( DB_MASTER
);
3748 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
3749 if ( $wgContentHandlerUseDB ) {
3750 $fields[] = 'page_content_model';
3753 $row = $dbw->selectRow( 'page',
3757 array( 'FOR UPDATE' )
3759 # Cache some fields we may want
3760 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3761 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3762 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3763 $this->mContentModel
= $row && isset( $row->page_content_model
)
3764 ?
strval( $row->page_content_model
)
3767 if ( !$this->mRedirect
) {
3770 # Does the article have a history?
3771 $row = $dbw->selectField( array( 'page', 'revision' ),
3773 array( 'page_namespace' => $this->getNamespace(),
3774 'page_title' => $this->getDBkey(),
3776 'page_latest != rev_id'
3779 array( 'FOR UPDATE' )
3781 # Return true if there was no history
3782 return ( $row === false );
3786 * Checks if $this can be moved to a given Title
3787 * - Selects for update, so don't call it unless you mean business
3789 * @deprecated since 1.25, use MovePage's methods instead
3790 * @param Title $nt The new title to check
3793 public function isValidMoveTarget( $nt ) {
3794 # Is it an existing file?
3795 if ( $nt->getNamespace() == NS_FILE
) {
3796 $file = wfLocalFile( $nt );
3797 $file->load( File
::READ_LATEST
);
3798 if ( $file->exists() ) {
3799 wfDebug( __METHOD__
. ": file exists\n" );
3803 # Is it a redirect with no history?
3804 if ( !$nt->isSingleRevRedirect() ) {
3805 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3808 # Get the article text
3809 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
3810 if ( !is_object( $rev ) ) {
3813 $content = $rev->getContent();
3814 # Does the redirect point to the source?
3815 # Or is it a broken self-redirect, usually caused by namespace collisions?
3816 $redirTitle = $content ?
$content->getRedirectTarget() : null;
3818 if ( $redirTitle ) {
3819 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3820 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3821 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3827 # Fail safe (not a redirect after all. strange.)
3828 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
3829 " is a redirect, but it doesn't contain a valid redirect.\n" );
3835 * Get categories to which this Title belongs and return an array of
3836 * categories' names.
3838 * @return array Array of parents in the form:
3839 * $parent => $currentarticle
3841 public function getParentCategories() {
3846 $titleKey = $this->getArticleID();
3848 if ( $titleKey === 0 ) {
3852 $dbr = wfGetDB( DB_SLAVE
);
3854 $res = $dbr->select(
3857 array( 'cl_from' => $titleKey ),
3861 if ( $res->numRows() > 0 ) {
3862 foreach ( $res as $row ) {
3863 // $data[] = Title::newFromText($wgContLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
3864 $data[$wgContLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3871 * Get a tree of parent categories
3873 * @param array $children Array with the children in the keys, to check for circular refs
3874 * @return array Tree of parent categories
3876 public function getParentCategoryTree( $children = array() ) {
3878 $parents = $this->getParentCategories();
3881 foreach ( $parents as $parent => $current ) {
3882 if ( array_key_exists( $parent, $children ) ) {
3883 # Circular reference
3884 $stack[$parent] = array();
3886 $nt = Title
::newFromText( $parent );
3888 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3898 * Get an associative array for selecting this title from
3901 * @return array Array suitable for the $where parameter of DB::select()
3903 public function pageCond() {
3904 if ( $this->mArticleID
> 0 ) {
3905 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3906 return array( 'page_id' => $this->mArticleID
);
3908 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3913 * Get the revision ID of the previous revision
3915 * @param int $revId Revision ID. Get the revision that was before this one.
3916 * @param int $flags Title::GAID_FOR_UPDATE
3917 * @return int|bool Old revision ID, or false if none exists
3919 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3920 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3921 $revId = $db->selectField( 'revision', 'rev_id',
3923 'rev_page' => $this->getArticleID( $flags ),
3924 'rev_id < ' . intval( $revId )
3927 array( 'ORDER BY' => 'rev_id DESC' )
3930 if ( $revId === false ) {
3933 return intval( $revId );
3938 * Get the revision ID of the next revision
3940 * @param int $revId Revision ID. Get the revision that was after this one.
3941 * @param int $flags Title::GAID_FOR_UPDATE
3942 * @return int|bool Next revision ID, or false if none exists
3944 public function getNextRevisionID( $revId, $flags = 0 ) {
3945 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3946 $revId = $db->selectField( 'revision', 'rev_id',
3948 'rev_page' => $this->getArticleID( $flags ),
3949 'rev_id > ' . intval( $revId )
3952 array( 'ORDER BY' => 'rev_id' )
3955 if ( $revId === false ) {
3958 return intval( $revId );
3963 * Get the first revision of the page
3965 * @param int $flags Title::GAID_FOR_UPDATE
3966 * @return Revision|null If page doesn't exist
3968 public function getFirstRevision( $flags = 0 ) {
3969 $pageId = $this->getArticleID( $flags );
3971 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3972 $row = $db->selectRow( 'revision', Revision
::selectFields(),
3973 array( 'rev_page' => $pageId ),
3975 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3978 return new Revision( $row );
3985 * Get the oldest revision timestamp of this page
3987 * @param int $flags Title::GAID_FOR_UPDATE
3988 * @return string MW timestamp
3990 public function getEarliestRevTime( $flags = 0 ) {
3991 $rev = $this->getFirstRevision( $flags );
3992 return $rev ?
$rev->getTimestamp() : null;
3996 * Check if this is a new page
4000 public function isNewPage() {
4001 $dbr = wfGetDB( DB_SLAVE
);
4002 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4006 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4010 public function isBigDeletion() {
4011 global $wgDeleteRevisionsLimit;
4013 if ( !$wgDeleteRevisionsLimit ) {
4017 if ( $this->mIsBigDeletion
=== null ) {
4018 $dbr = wfGetDB( DB_SLAVE
);
4020 $revCount = $dbr->selectRowCount(
4023 array( 'rev_page' => $this->getArticleID() ),
4025 array( 'LIMIT' => $wgDeleteRevisionsLimit +
1 )
4028 $this->mIsBigDeletion
= $revCount > $wgDeleteRevisionsLimit;
4031 return $this->mIsBigDeletion
;
4035 * Get the approximate revision count of this page.
4039 public function estimateRevisionCount() {
4040 if ( !$this->exists() ) {
4044 if ( $this->mEstimateRevisions
=== null ) {
4045 $dbr = wfGetDB( DB_SLAVE
);
4046 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4047 array( 'rev_page' => $this->getArticleID() ), __METHOD__
);
4050 return $this->mEstimateRevisions
;
4054 * Get the number of revisions between the given revision.
4055 * Used for diffs and other things that really need it.
4057 * @param int|Revision $old Old revision or rev ID (first before range)
4058 * @param int|Revision $new New revision or rev ID (first after range)
4059 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4060 * @return int Number of revisions between these revisions.
4062 public function countRevisionsBetween( $old, $new, $max = null ) {
4063 if ( !( $old instanceof Revision
) ) {
4064 $old = Revision
::newFromTitle( $this, (int)$old );
4066 if ( !( $new instanceof Revision
) ) {
4067 $new = Revision
::newFromTitle( $this, (int)$new );
4069 if ( !$old ||
!$new ) {
4070 return 0; // nothing to compare
4072 $dbr = wfGetDB( DB_SLAVE
);
4074 'rev_page' => $this->getArticleID(),
4075 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4076 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4078 if ( $max !== null ) {
4079 return $dbr->selectRowCount( 'revision', '1',
4082 array( 'LIMIT' => $max +
1 ) // extra to detect truncation
4085 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
4090 * Get the authors between the given revisions or revision IDs.
4091 * Used for diffs and other things that really need it.
4095 * @param int|Revision $old Old revision or rev ID (first before range by default)
4096 * @param int|Revision $new New revision or rev ID (first after range by default)
4097 * @param int $limit Maximum number of authors
4098 * @param string|array $options (Optional): Single option, or an array of options:
4099 * 'include_old' Include $old in the range; $new is excluded.
4100 * 'include_new' Include $new in the range; $old is excluded.
4101 * 'include_both' Include both $old and $new in the range.
4102 * Unknown option values are ignored.
4103 * @return array|null Names of revision authors in the range; null if not both revisions exist
4105 public function getAuthorsBetween( $old, $new, $limit, $options = array() ) {
4106 if ( !( $old instanceof Revision
) ) {
4107 $old = Revision
::newFromTitle( $this, (int)$old );
4109 if ( !( $new instanceof Revision
) ) {
4110 $new = Revision
::newFromTitle( $this, (int)$new );
4112 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4113 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4114 // in the sanity check below?
4115 if ( !$old ||
!$new ) {
4116 return null; // nothing to compare
4121 $options = (array)$options;
4122 if ( in_array( 'include_old', $options ) ) {
4125 if ( in_array( 'include_new', $options ) ) {
4128 if ( in_array( 'include_both', $options ) ) {
4132 // No DB query needed if $old and $new are the same or successive revisions:
4133 if ( $old->getId() === $new->getId() ) {
4134 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
4136 array( $old->getUserText( Revision
::RAW
) );
4137 } elseif ( $old->getId() === $new->getParentId() ) {
4138 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4139 $authors[] = $old->getUserText( Revision
::RAW
);
4140 if ( $old->getUserText( Revision
::RAW
) != $new->getUserText( Revision
::RAW
) ) {
4141 $authors[] = $new->getUserText( Revision
::RAW
);
4143 } elseif ( $old_cmp === '>=' ) {
4144 $authors[] = $old->getUserText( Revision
::RAW
);
4145 } elseif ( $new_cmp === '<=' ) {
4146 $authors[] = $new->getUserText( Revision
::RAW
);
4150 $dbr = wfGetDB( DB_SLAVE
);
4151 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4153 'rev_page' => $this->getArticleID(),
4154 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4155 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4157 array( 'LIMIT' => $limit +
1 ) // add one so caller knows it was truncated
4159 foreach ( $res as $row ) {
4160 $authors[] = $row->rev_user_text
;
4166 * Get the number of authors between the given revisions or revision IDs.
4167 * Used for diffs and other things that really need it.
4169 * @param int|Revision $old Old revision or rev ID (first before range by default)
4170 * @param int|Revision $new New revision or rev ID (first after range by default)
4171 * @param int $limit Maximum number of authors
4172 * @param string|array $options (Optional): Single option, or an array of options:
4173 * 'include_old' Include $old in the range; $new is excluded.
4174 * 'include_new' Include $new in the range; $old is excluded.
4175 * 'include_both' Include both $old and $new in the range.
4176 * Unknown option values are ignored.
4177 * @return int Number of revision authors in the range; zero if not both revisions exist
4179 public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4180 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4181 return $authors ?
count( $authors ) : 0;
4185 * Compare with another title.
4187 * @param Title $title
4190 public function equals( Title
$title ) {
4191 // Note: === is necessary for proper matching of number-like titles.
4192 return $this->getInterwiki() === $title->getInterwiki()
4193 && $this->getNamespace() == $title->getNamespace()
4194 && $this->getDBkey() === $title->getDBkey();
4198 * Check if this title is a subpage of another title
4200 * @param Title $title
4203 public function isSubpageOf( Title
$title ) {
4204 return $this->getInterwiki() === $title->getInterwiki()
4205 && $this->getNamespace() == $title->getNamespace()
4206 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4210 * Check if page exists. For historical reasons, this function simply
4211 * checks for the existence of the title in the page table, and will
4212 * thus return false for interwiki links, special pages and the like.
4213 * If you want to know if a title can be meaningfully viewed, you should
4214 * probably call the isKnown() method instead.
4218 public function exists() {
4219 $exists = $this->getArticleID() != 0;
4220 Hooks
::run( 'TitleExists', array( $this, &$exists ) );
4225 * Should links to this title be shown as potentially viewable (i.e. as
4226 * "bluelinks"), even if there's no record by this title in the page
4229 * This function is semi-deprecated for public use, as well as somewhat
4230 * misleadingly named. You probably just want to call isKnown(), which
4231 * calls this function internally.
4233 * (ISSUE: Most of these checks are cheap, but the file existence check
4234 * can potentially be quite expensive. Including it here fixes a lot of
4235 * existing code, but we might want to add an optional parameter to skip
4236 * it and any other expensive checks.)
4240 public function isAlwaysKnown() {
4244 * Allows overriding default behavior for determining if a page exists.
4245 * If $isKnown is kept as null, regular checks happen. If it's
4246 * a boolean, this value is returned by the isKnown method.
4250 * @param Title $title
4251 * @param bool|null $isKnown
4253 Hooks
::run( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4255 if ( !is_null( $isKnown ) ) {
4259 if ( $this->isExternal() ) {
4260 return true; // any interwiki link might be viewable, for all we know
4263 switch ( $this->mNamespace
) {
4266 // file exists, possibly in a foreign repo
4267 return (bool)wfFindFile( $this );
4269 // valid special page
4270 return SpecialPageFactory
::exists( $this->getDBkey() );
4272 // selflink, possibly with fragment
4273 return $this->mDbkeyform
== '';
4275 // known system message
4276 return $this->hasSourceText() !== false;
4283 * Does this title refer to a page that can (or might) be meaningfully
4284 * viewed? In particular, this function may be used to determine if
4285 * links to the title should be rendered as "bluelinks" (as opposed to
4286 * "redlinks" to non-existent pages).
4287 * Adding something else to this function will cause inconsistency
4288 * since LinkHolderArray calls isAlwaysKnown() and does its own
4289 * page existence check.
4293 public function isKnown() {
4294 return $this->isAlwaysKnown() ||
$this->exists();
4298 * Does this page have source text?
4302 public function hasSourceText() {
4303 if ( $this->exists() ) {
4307 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4308 // If the page doesn't exist but is a known system message, default
4309 // message content will be displayed, same for language subpages-
4310 // Use always content language to avoid loading hundreds of languages
4311 // to get the link color.
4313 list( $name, ) = MessageCache
::singleton()->figureMessage(
4314 $wgContLang->lcfirst( $this->getText() )
4316 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4317 return $message->exists();
4324 * Get the default message text or false if the message doesn't exist
4326 * @return string|bool
4328 public function getDefaultMessageText() {
4331 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
4335 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4336 $wgContLang->lcfirst( $this->getText() )
4338 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4340 if ( $message->exists() ) {
4341 return $message->plain();
4348 * Updates page_touched for this page; called from LinksUpdate.php
4350 * @return bool True if the update succeeded
4352 public function invalidateCache() {
4353 if ( wfReadOnly() ) {
4357 if ( $this->mArticleID
=== 0 ) {
4358 return true; // avoid gap locking if we know it's not there
4361 $method = __METHOD__
;
4362 $dbw = wfGetDB( DB_MASTER
);
4363 $conds = $this->pageCond();
4364 $dbw->onTransactionIdle( function () use ( $dbw, $conds, $method ) {
4367 array( 'page_touched' => $dbw->timestamp() ),
4377 * Update page_touched timestamps and send squid purge messages for
4378 * pages linking to this title. May be sent to the job queue depending
4379 * on the number of links. Typically called on create and delete.
4381 public function touchLinks() {
4382 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4385 if ( $this->getNamespace() == NS_CATEGORY
) {
4386 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4392 * Get the last touched timestamp
4394 * @param DatabaseBase $db Optional db
4395 * @return string Last-touched timestamp
4397 public function getTouched( $db = null ) {
4398 if ( $db === null ) {
4399 $db = wfGetDB( DB_SLAVE
);
4401 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4406 * Get the timestamp when this page was updated since the user last saw it.
4409 * @return string|null
4411 public function getNotificationTimestamp( $user = null ) {
4414 // Assume current user if none given
4418 // Check cache first
4419 $uid = $user->getId();
4423 // avoid isset here, as it'll return false for null entries
4424 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4425 return $this->mNotificationTimestamp
[$uid];
4427 // Don't cache too much!
4428 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4429 $this->mNotificationTimestamp
= array();
4432 $watchedItem = WatchedItem
::fromUserTitle( $user, $this );
4433 $this->mNotificationTimestamp
[$uid] = $watchedItem->getNotificationTimestamp();
4435 return $this->mNotificationTimestamp
[$uid];
4439 * Generate strings used for xml 'id' names in monobook tabs
4441 * @param string $prepend Defaults to 'nstab-'
4442 * @return string XML 'id' name
4444 public function getNamespaceKey( $prepend = 'nstab-' ) {
4446 // Gets the subject namespace if this title
4447 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4448 // Checks if canonical namespace name exists for namespace
4449 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4450 // Uses canonical namespace name
4451 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4453 // Uses text of namespace
4454 $namespaceKey = $this->getSubjectNsText();
4456 // Makes namespace key lowercase
4457 $namespaceKey = $wgContLang->lc( $namespaceKey );
4459 if ( $namespaceKey == '' ) {
4460 $namespaceKey = 'main';
4462 // Changes file to image for backwards compatibility
4463 if ( $namespaceKey == 'file' ) {
4464 $namespaceKey = 'image';
4466 return $prepend . $namespaceKey;
4470 * Get all extant redirects to this Title
4472 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4473 * @return Title[] Array of Title redirects to this title
4475 public function getRedirectsHere( $ns = null ) {
4478 $dbr = wfGetDB( DB_SLAVE
);
4480 'rd_namespace' => $this->getNamespace(),
4481 'rd_title' => $this->getDBkey(),
4484 if ( $this->isExternal() ) {
4485 $where['rd_interwiki'] = $this->getInterwiki();
4487 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4489 if ( !is_null( $ns ) ) {
4490 $where['page_namespace'] = $ns;
4493 $res = $dbr->select(
4494 array( 'redirect', 'page' ),
4495 array( 'page_namespace', 'page_title' ),
4500 foreach ( $res as $row ) {
4501 $redirs[] = self
::newFromRow( $row );
4507 * Check if this Title is a valid redirect target
4511 public function isValidRedirectTarget() {
4512 global $wgInvalidRedirectTargets;
4514 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4515 if ( $this->isSpecial( 'Userlogout' ) ) {
4519 foreach ( $wgInvalidRedirectTargets as $target ) {
4520 if ( $this->isSpecial( $target ) ) {
4529 * Get a backlink cache object
4531 * @return BacklinkCache
4533 public function getBacklinkCache() {
4534 return BacklinkCache
::get( $this );
4538 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4542 public function canUseNoindex() {
4543 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4545 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4546 ?
$wgContentNamespaces
4547 : $wgExemptFromUserRobotsControl;
4549 return !in_array( $this->mNamespace
, $bannedNamespaces );
4554 * Returns the raw sort key to be used for categories, with the specified
4555 * prefix. This will be fed to Collation::getSortKey() to get a
4556 * binary sortkey that can be used for actual sorting.
4558 * @param string $prefix The prefix to be used, specified using
4559 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4563 public function getCategorySortkey( $prefix = '' ) {
4564 $unprefixed = $this->getText();
4566 // Anything that uses this hook should only depend
4567 // on the Title object passed in, and should probably
4568 // tell the users to run updateCollations.php --force
4569 // in order to re-sort existing category relations.
4570 Hooks
::run( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4571 if ( $prefix !== '' ) {
4572 # Separate with a line feed, so the unprefixed part is only used as
4573 # a tiebreaker when two pages have the exact same prefix.
4574 # In UCA, tab is the only character that can sort above LF
4575 # so we strip both of them from the original prefix.
4576 $prefix = strtr( $prefix, "\n\t", ' ' );
4577 return "$prefix\n$unprefixed";
4583 * Get the language in which the content of this page is written in
4584 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4585 * e.g. $wgLang (such as special pages, which are in the user language).
4590 public function getPageLanguage() {
4591 global $wgLang, $wgLanguageCode;
4592 if ( $this->isSpecialPage() ) {
4593 // special pages are in the user language
4597 // Checking if DB language is set
4598 if ( $this->mDbPageLanguage
) {
4599 return wfGetLangObj( $this->mDbPageLanguage
);
4602 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
4603 // Note that this may depend on user settings, so the cache should
4604 // be only per-request.
4605 // NOTE: ContentHandler::getPageLanguage() may need to load the
4606 // content to determine the page language!
4607 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4609 $contentHandler = ContentHandler
::getForTitle( $this );
4610 $langObj = wfGetLangObj( $contentHandler->getPageLanguage( $this ) );
4611 $this->mPageLanguage
= array( $langObj->getCode(), $wgLanguageCode );
4613 $langObj = wfGetLangObj( $this->mPageLanguage
[0] );
4620 * Get the language in which the content of this page is written when
4621 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4622 * e.g. $wgLang (such as special pages, which are in the user language).
4627 public function getPageViewLanguage() {
4630 if ( $this->isSpecialPage() ) {
4631 // If the user chooses a variant, the content is actually
4632 // in a language whose code is the variant code.
4633 $variant = $wgLang->getPreferredVariant();
4634 if ( $wgLang->getCode() !== $variant ) {
4635 return Language
::factory( $variant );
4641 // @note Can't be cached persistently, depends on user settings.
4642 // @note ContentHandler::getPageViewLanguage() may need to load the
4643 // content to determine the page language!
4644 $contentHandler = ContentHandler
::getForTitle( $this );
4645 $pageLang = $contentHandler->getPageViewLanguage( $this );
4650 * Get a list of rendered edit notices for this page.
4652 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4653 * they will already be wrapped in paragraphs.
4656 * @param int $oldid Revision ID that's being edited
4659 public function getEditNotices( $oldid = 0 ) {
4662 // Optional notice for the entire namespace
4663 $editnotice_ns = 'editnotice-' . $this->getNamespace();
4664 $msg = wfMessage( $editnotice_ns );
4665 if ( $msg->exists() ) {
4666 $html = $msg->parseAsBlock();
4667 // Edit notices may have complex logic, but output nothing (T91715)
4668 if ( trim( $html ) !== '' ) {
4669 $notices[$editnotice_ns] = Html
::rawElement(
4671 array( 'class' => array(
4673 'mw-editnotice-namespace',
4674 Sanitizer
::escapeClass( "mw-$editnotice_ns" )
4681 if ( MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
4682 // Optional notice for page itself and any parent page
4683 $parts = explode( '/', $this->getDBkey() );
4684 $editnotice_base = $editnotice_ns;
4685 while ( count( $parts ) > 0 ) {
4686 $editnotice_base .= '-' . array_shift( $parts );
4687 $msg = wfMessage( $editnotice_base );
4688 if ( $msg->exists() ) {
4689 $html = $msg->parseAsBlock();
4690 if ( trim( $html ) !== '' ) {
4691 $notices[$editnotice_base] = Html
::rawElement(
4693 array( 'class' => array(
4695 'mw-editnotice-base',
4696 Sanitizer
::escapeClass( "mw-$editnotice_base" )
4704 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
4705 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->getDBkey() );
4706 $msg = wfMessage( $editnoticeText );
4707 if ( $msg->exists() ) {
4708 $html = $msg->parseAsBlock();
4709 if ( trim( $html ) !== '' ) {
4710 $notices[$editnoticeText] = Html
::rawElement(
4712 array( 'class' => array(
4714 'mw-editnotice-page',
4715 Sanitizer
::escapeClass( "mw-$editnoticeText" )
4723 Hooks
::run( 'TitleGetEditNotices', array( $this, $oldid, &$notices ) );