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
24 use MediaWiki\Linker\LinkTarget
;
25 use MediaWiki\Interwiki\InterwikiLookup
;
26 use MediaWiki\MediaWikiServices
;
29 * Represents a title within MediaWiki.
30 * Optionally may contain an interwiki designation or namespace.
31 * @note This class can fetch various kinds of data from the database;
32 * however, it does so inefficiently.
33 * @note Consider using a TitleValue object instead. TitleValue is more lightweight
34 * and does not rely on global state or the database.
36 class Title
implements LinkTarget
{
37 /** @var HashBagOStuff */
38 static private $titleCache = null;
41 * Title::newFromText maintains a cache to avoid expensive re-normalization of
42 * commonly used titles. On a batch operation this can become a memory leak
43 * if not bounded. After hitting this many titles reset the cache.
45 const CACHE_MAX
= 1000;
48 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
49 * to use the master DB
51 const GAID_FOR_UPDATE
= 1;
54 * @name Private member variables
55 * Please use the accessor functions instead.
60 /** @var string Text form (spaces not underscores) of the main part */
61 public $mTextform = '';
63 /** @var string URL-encoded form of the main part */
64 public $mUrlform = '';
66 /** @var string Main part with underscores */
67 public $mDbkeyform = '';
69 /** @var string Database key with the initial letter in the case specified by the user */
70 protected $mUserCaseDBKey;
72 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
73 public $mNamespace = NS_MAIN
;
75 /** @var string Interwiki prefix */
76 public $mInterwiki = '';
78 /** @var bool Was this Title created from a string with a local interwiki prefix? */
79 private $mLocalInterwiki = false;
81 /** @var string Title fragment (i.e. the bit after the #) */
82 public $mFragment = '';
84 /** @var int Article ID, fetched from the link cache on demand */
85 public $mArticleID = -1;
87 /** @var bool|int ID of most recent revision */
88 protected $mLatestID = false;
91 * @var bool|string ID of the page's content model, i.e. one of the
92 * CONTENT_MODEL_XXX constants
94 private $mContentModel = false;
97 * @var bool If a content model was forced via setContentModel()
98 * this will be true to avoid having other code paths reset it
100 private $mForcedContentModel = false;
102 /** @var int Estimated number of revisions; null of not loaded */
103 private $mEstimateRevisions;
105 /** @var array Array of groups allowed to edit this article */
106 public $mRestrictions = [];
108 /** @var string|bool */
109 protected $mOldRestrictions = false;
111 /** @var bool Cascade restrictions on this page to included templates and images? */
112 public $mCascadeRestriction;
114 /** Caching the results of getCascadeProtectionSources */
115 public $mCascadingRestrictions;
117 /** @var array When do the restrictions on this page expire? */
118 protected $mRestrictionsExpiry = [];
120 /** @var bool Are cascading restrictions in effect on this page? */
121 protected $mHasCascadingRestrictions;
123 /** @var array Where are the cascading restrictions coming from on this page? */
124 public $mCascadeSources;
126 /** @var bool Boolean for initialisation on demand */
127 public $mRestrictionsLoaded = false;
129 /** @var string Text form including namespace/interwiki, initialised on demand */
130 protected $mPrefixedText = null;
132 /** @var mixed Cached value for getTitleProtection (create protection) */
133 public $mTitleProtection;
136 * @var int Namespace index when there is no namespace. Don't change the
137 * following default, NS_MAIN is hardcoded in several places. See bug 696.
138 * Zero except in {{transclusion}} tags.
140 public $mDefaultNamespace = NS_MAIN
;
142 /** @var int The page length, 0 for special pages */
143 protected $mLength = -1;
145 /** @var null Is the article at this title a redirect? */
146 public $mRedirect = null;
148 /** @var array Associative array of user ID -> timestamp/false */
149 private $mNotificationTimestamp = [];
151 /** @var bool Whether a page has any subpages */
152 private $mHasSubpages;
154 /** @var bool The (string) language code of the page's language and content code. */
155 private $mPageLanguage = false;
157 /** @var string|bool|null The page language code from the database, null if not saved in
158 * the database or false if not loaded, yet. */
159 private $mDbPageLanguage = false;
161 /** @var TitleValue A corresponding TitleValue object */
162 private $mTitleValue = null;
164 /** @var bool Would deleting this page be a big deletion? */
165 private $mIsBigDeletion = null;
169 * B/C kludge: provide a TitleParser for use by Title.
170 * Ideally, Title would have no methods that need this.
171 * Avoid usage of this singleton by using TitleValue
172 * and the associated services when possible.
174 * @return TitleFormatter
176 private static function getTitleFormatter() {
177 return MediaWikiServices
::getInstance()->getTitleFormatter();
181 * B/C kludge: provide an InterwikiLookup for use by Title.
182 * Ideally, Title would have no methods that need this.
183 * Avoid usage of this singleton by using TitleValue
184 * and the associated services when possible.
186 * @return InterwikiLookup
188 private static function getInterwikiLookup() {
189 return MediaWikiServices
::getInstance()->getInterwikiLookup();
195 function __construct() {
199 * Create a new Title from a prefixed DB key
201 * @param string $key The database key, which has underscores
202 * instead of spaces, possibly including namespace and
204 * @return Title|null Title, or null on an error
206 public static function newFromDBkey( $key ) {
208 $t->mDbkeyform
= $key;
211 $t->secureAndSplit();
213 } catch ( MalformedTitleException
$ex ) {
219 * Create a new Title from a TitleValue
221 * @param TitleValue $titleValue Assumed to be safe.
225 public static function newFromTitleValue( TitleValue
$titleValue ) {
226 return self
::newFromLinkTarget( $titleValue );
230 * Create a new Title from a LinkTarget
232 * @param LinkTarget $linkTarget Assumed to be safe.
236 public static function newFromLinkTarget( LinkTarget
$linkTarget ) {
237 if ( $linkTarget instanceof Title
) {
238 // Special case if it's already a Title object
241 return self
::makeTitle(
242 $linkTarget->getNamespace(),
243 $linkTarget->getText(),
244 $linkTarget->getFragment(),
245 $linkTarget->getInterwiki()
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|int|null $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 // DWIM: Integers can be passed in here when page titles are used as array keys.
264 if ( $text !== null && !is_string( $text ) && !is_int( $text ) ) {
265 throw new InvalidArgumentException( '$text must be a string.' );
267 if ( $text === null ) {
272 return Title
::newFromTextThrow( strval( $text ), $defaultNamespace );
273 } catch ( MalformedTitleException
$ex ) {
279 * Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,
280 * rather than returning null.
282 * The exception subclasses encode detailed information about why the title is invalid.
284 * @see Title::newFromText
287 * @param string $text Title text to check
288 * @param int $defaultNamespace
289 * @throws MalformedTitleException If the title is invalid
292 public static function newFromTextThrow( $text, $defaultNamespace = NS_MAIN
) {
293 if ( is_object( $text ) ) {
294 throw new MWException( '$text must be a string, given an object' );
297 $titleCache = self
::getTitleCache();
299 // Wiki pages often contain multiple links to the same page.
300 // Title normalization and parsing can become expensive on pages with many
301 // links, so we can save a little time by caching them.
302 // In theory these are value objects and won't get changed...
303 if ( $defaultNamespace == NS_MAIN
) {
304 $t = $titleCache->get( $text );
310 // Convert things like é ā or 〗 into normalized (bug 14952) text
311 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
314 $t->mDbkeyform
= strtr( $filteredText, ' ', '_' );
315 $t->mDefaultNamespace
= intval( $defaultNamespace );
317 $t->secureAndSplit();
318 if ( $defaultNamespace == NS_MAIN
) {
319 $titleCache->set( $text, $t );
325 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
327 * Example of wrong and broken code:
328 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
330 * Example of right code:
331 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
333 * Create a new Title from URL-encoded text. Ensures that
334 * the given title's length does not exceed the maximum.
336 * @param string $url The title, as might be taken from a URL
337 * @return Title|null The new object, or null on an error
339 public static function newFromURL( $url ) {
342 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
343 # but some URLs used it as a space replacement and they still come
344 # from some external search tools.
345 if ( strpos( self
::legalChars(), '+' ) === false ) {
346 $url = strtr( $url, '+', ' ' );
349 $t->mDbkeyform
= strtr( $url, ' ', '_' );
352 $t->secureAndSplit();
354 } catch ( MalformedTitleException
$ex ) {
360 * @return HashBagOStuff
362 private static function getTitleCache() {
363 if ( self
::$titleCache == null ) {
364 self
::$titleCache = new HashBagOStuff( [ 'maxKeys' => self
::CACHE_MAX
] );
366 return self
::$titleCache;
370 * Returns a list of fields that are to be selected for initializing Title
371 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
372 * whether to include page_content_model.
376 protected static function getSelectFields() {
377 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
380 'page_namespace', 'page_title', 'page_id',
381 'page_len', 'page_is_redirect', 'page_latest',
384 if ( $wgContentHandlerUseDB ) {
385 $fields[] = 'page_content_model';
388 if ( $wgPageLanguageUseDB ) {
389 $fields[] = 'page_lang';
396 * Create a new Title from an article ID
398 * @param int $id The page_id corresponding to the Title to create
399 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
400 * @return Title|null The new object, or null on an error
402 public static function newFromID( $id, $flags = 0 ) {
403 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
404 $row = $db->selectRow(
406 self
::getSelectFields(),
407 [ 'page_id' => $id ],
410 if ( $row !== false ) {
411 $title = Title
::newFromRow( $row );
419 * Make an array of titles from an array of IDs
421 * @param int[] $ids Array of IDs
422 * @return Title[] Array of Titles
424 public static function newFromIDs( $ids ) {
425 if ( !count( $ids ) ) {
428 $dbr = wfGetDB( DB_REPLICA
);
432 self
::getSelectFields(),
433 [ 'page_id' => $ids ],
438 foreach ( $res as $row ) {
439 $titles[] = Title
::newFromRow( $row );
445 * Make a Title object from a DB row
447 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
448 * @return Title Corresponding Title
450 public static function newFromRow( $row ) {
451 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
452 $t->loadFromRow( $row );
457 * Load Title object fields from a DB row.
458 * If false is given, the title will be treated as non-existing.
460 * @param stdClass|bool $row Database row
462 public function loadFromRow( $row ) {
463 if ( $row ) { // page found
464 if ( isset( $row->page_id
) ) {
465 $this->mArticleID
= (int)$row->page_id
;
467 if ( isset( $row->page_len
) ) {
468 $this->mLength
= (int)$row->page_len
;
470 if ( isset( $row->page_is_redirect
) ) {
471 $this->mRedirect
= (bool)$row->page_is_redirect
;
473 if ( isset( $row->page_latest
) ) {
474 $this->mLatestID
= (int)$row->page_latest
;
476 if ( !$this->mForcedContentModel
&& isset( $row->page_content_model
) ) {
477 $this->mContentModel
= strval( $row->page_content_model
);
478 } elseif ( !$this->mForcedContentModel
) {
479 $this->mContentModel
= false; # initialized lazily in getContentModel()
481 if ( isset( $row->page_lang
) ) {
482 $this->mDbPageLanguage
= (string)$row->page_lang
;
484 if ( isset( $row->page_restrictions
) ) {
485 $this->mOldRestrictions
= $row->page_restrictions
;
487 } else { // page not found
488 $this->mArticleID
= 0;
490 $this->mRedirect
= false;
491 $this->mLatestID
= 0;
492 if ( !$this->mForcedContentModel
) {
493 $this->mContentModel
= false; # initialized lazily in getContentModel()
499 * Create a new Title from a namespace index and a DB key.
500 * It's assumed that $ns and $title are *valid*, for instance when
501 * they came directly from the database or a special page name.
502 * For convenience, spaces are converted to underscores so that
503 * eg user_text fields can be used directly.
505 * @param int $ns The namespace of the article
506 * @param string $title The unprefixed database key form
507 * @param string $fragment The link fragment (after the "#")
508 * @param string $interwiki The interwiki prefix
509 * @return Title The new object
511 public static function makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
513 $t->mInterwiki
= $interwiki;
514 $t->mFragment
= $fragment;
515 $t->mNamespace
= $ns = intval( $ns );
516 $t->mDbkeyform
= strtr( $title, ' ', '_' );
517 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
518 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
519 $t->mTextform
= strtr( $title, '_', ' ' );
520 $t->mContentModel
= false; # initialized lazily in getContentModel()
525 * Create a new Title from a namespace index and a DB key.
526 * The parameters will be checked for validity, which is a bit slower
527 * than makeTitle() but safer for user-provided data.
529 * @param int $ns The namespace of the article
530 * @param string $title Database key form
531 * @param string $fragment The link fragment (after the "#")
532 * @param string $interwiki Interwiki prefix
533 * @return Title|null The new object, or null on an error
535 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
536 if ( !MWNamespace
::exists( $ns ) ) {
541 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki, true );
544 $t->secureAndSplit();
546 } catch ( MalformedTitleException
$ex ) {
552 * Create a new Title for the Main Page
554 * @return Title The new object
556 public static function newMainPage() {
557 $title = Title
::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
558 // Don't give fatal errors if the message is broken
560 $title = Title
::newFromText( 'Main Page' );
566 * Get the prefixed DB key associated with an ID
568 * @param int $id The page_id of the article
569 * @return Title|null An object representing the article, or null if no such article was found
571 public static function nameOf( $id ) {
572 $dbr = wfGetDB( DB_REPLICA
);
574 $s = $dbr->selectRow(
576 [ 'page_namespace', 'page_title' ],
577 [ 'page_id' => $id ],
580 if ( $s === false ) {
584 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
589 * Get a regex character class describing the legal characters in a link
591 * @return string The list of characters, not delimited
593 public static function legalChars() {
594 global $wgLegalTitleChars;
595 return $wgLegalTitleChars;
599 * Returns a simple regex that will match on characters and sequences invalid in titles.
600 * Note that this doesn't pick up many things that could be wrong with titles, but that
601 * replacing this regex with something valid will make many titles valid.
603 * @deprecated since 1.25, use MediaWikiTitleCodec::getTitleInvalidRegex() instead
605 * @return string Regex string
607 static function getTitleInvalidRegex() {
608 wfDeprecated( __METHOD__
, '1.25' );
609 return MediaWikiTitleCodec
::getTitleInvalidRegex();
613 * Utility method for converting a character sequence from bytes to Unicode.
615 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
616 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
618 * @param string $byteClass
621 public static function convertByteClassToUnicodeClass( $byteClass ) {
622 $length = strlen( $byteClass );
624 $x0 = $x1 = $x2 = '';
626 $d0 = $d1 = $d2 = '';
627 // Decoded integer codepoints
628 $ord0 = $ord1 = $ord2 = 0;
630 $r0 = $r1 = $r2 = '';
634 $allowUnicode = false;
635 for ( $pos = 0; $pos < $length; $pos++
) {
636 // Shift the queues down
645 // Load the current input token and decoded values
646 $inChar = $byteClass[$pos];
647 if ( $inChar == '\\' ) {
648 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
649 $x0 = $inChar . $m[0];
650 $d0 = chr( hexdec( $m[1] ) );
651 $pos +
= strlen( $m[0] );
652 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
653 $x0 = $inChar . $m[0];
654 $d0 = chr( octdec( $m[0] ) );
655 $pos +
= strlen( $m[0] );
656 } elseif ( $pos +
1 >= $length ) {
659 $d0 = $byteClass[$pos +
1];
667 // Load the current re-encoded value
668 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
669 $r0 = sprintf( '\x%02x', $ord0 );
670 } elseif ( $ord0 >= 0x80 ) {
671 // Allow unicode if a single high-bit character appears
672 $r0 = sprintf( '\x%02x', $ord0 );
673 $allowUnicode = true;
674 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
680 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
682 if ( $ord2 > $ord0 ) {
684 } elseif ( $ord0 >= 0x80 ) {
686 $allowUnicode = true;
687 if ( $ord2 < 0x80 ) {
688 // Keep the non-unicode section of the range
695 // Reset state to the initial value
696 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
697 } elseif ( $ord2 < 0x80 ) {
702 if ( $ord1 < 0x80 ) {
705 if ( $ord0 < 0x80 ) {
708 if ( $allowUnicode ) {
709 $out .= '\u0080-\uFFFF';
715 * Make a prefixed DB key from a DB key and a namespace index
717 * @param int $ns Numerical representation of the namespace
718 * @param string $title The DB key form the title
719 * @param string $fragment The link fragment (after the "#")
720 * @param string $interwiki The interwiki prefix
721 * @param bool $canonicalNamespace If true, use the canonical name for
722 * $ns instead of the localized version.
723 * @return string The prefixed form of the title
725 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
726 $canonicalNamespace = false
730 if ( $canonicalNamespace ) {
731 $namespace = MWNamespace
::getCanonicalName( $ns );
733 $namespace = $wgContLang->getNsText( $ns );
735 $name = $namespace == '' ?
$title : "$namespace:$title";
736 if ( strval( $interwiki ) != '' ) {
737 $name = "$interwiki:$name";
739 if ( strval( $fragment ) != '' ) {
740 $name .= '#' . $fragment;
746 * Escape a text fragment, say from a link, for a URL
748 * @param string $fragment Containing a URL or link fragment (after the "#")
749 * @return string Escaped string
751 static function escapeFragmentForURL( $fragment ) {
752 # Note that we don't urlencode the fragment. urlencoded Unicode
753 # fragments appear not to work in IE (at least up to 7) or in at least
754 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
755 # to care if they aren't encoded.
756 return Sanitizer
::escapeId( $fragment, 'noninitial' );
760 * Callback for usort() to do title sorts by (namespace, title)
762 * @param LinkTarget $a
763 * @param LinkTarget $b
765 * @return int Result of string comparison, or namespace comparison
767 public static function compare( LinkTarget
$a, LinkTarget
$b ) {
768 if ( $a->getNamespace() == $b->getNamespace() ) {
769 return strcmp( $a->getText(), $b->getText() );
771 return $a->getNamespace() - $b->getNamespace();
776 * Determine whether the object refers to a page within
777 * this project (either this wiki or a wiki with a local
778 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
780 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
782 public function isLocal() {
783 if ( $this->isExternal() ) {
784 $iw = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
786 return $iw->isLocal();
793 * Is this Title interwiki?
797 public function isExternal() {
798 return $this->mInterwiki
!== '';
802 * Get the interwiki prefix
804 * Use Title::isExternal to check if a interwiki is set
806 * @return string Interwiki prefix
808 public function getInterwiki() {
809 return $this->mInterwiki
;
813 * Was this a local interwiki link?
817 public function wasLocalInterwiki() {
818 return $this->mLocalInterwiki
;
822 * Determine whether the object refers to a page within
823 * this project and is transcludable.
825 * @return bool True if this is transcludable
827 public function isTrans() {
828 if ( !$this->isExternal() ) {
832 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->isTranscludable();
836 * Returns the DB name of the distant wiki which owns the object.
838 * @return string|false The DB name
840 public function getTransWikiID() {
841 if ( !$this->isExternal() ) {
845 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->getWikiID();
849 * Get a TitleValue object representing this Title.
851 * @note Not all valid Titles have a corresponding valid TitleValue
852 * (e.g. TitleValues cannot represent page-local links that have a
853 * fragment but no title text).
855 * @return TitleValue|null
857 public function getTitleValue() {
858 if ( $this->mTitleValue
=== null ) {
860 $this->mTitleValue
= new TitleValue(
861 $this->getNamespace(),
863 $this->getFragment(),
864 $this->getInterwiki()
866 } catch ( InvalidArgumentException
$ex ) {
867 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
868 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
872 return $this->mTitleValue
;
876 * Get the text form (spaces not underscores) of the main part
878 * @return string Main part of the title
880 public function getText() {
881 return $this->mTextform
;
885 * Get the URL-encoded form of the main part
887 * @return string Main part of the title, URL-encoded
889 public function getPartialURL() {
890 return $this->mUrlform
;
894 * Get the main part with underscores
896 * @return string Main part of the title, with underscores
898 public function getDBkey() {
899 return $this->mDbkeyform
;
903 * Get the DB key with the initial letter case as specified by the user
905 * @return string DB key
907 function getUserCaseDBKey() {
908 if ( !is_null( $this->mUserCaseDBKey
) ) {
909 return $this->mUserCaseDBKey
;
911 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
912 return $this->mDbkeyform
;
917 * Get the namespace index, i.e. one of the NS_xxxx constants.
919 * @return int Namespace index
921 public function getNamespace() {
922 return $this->mNamespace
;
926 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
928 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
929 * @return string Content model id
931 public function getContentModel( $flags = 0 ) {
932 if ( !$this->mForcedContentModel
933 && ( !$this->mContentModel ||
$flags === Title
::GAID_FOR_UPDATE
)
934 && $this->getArticleID( $flags )
936 $linkCache = LinkCache
::singleton();
937 $linkCache->addLinkObj( $this ); # in case we already had an article ID
938 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
941 if ( !$this->mContentModel
) {
942 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
945 return $this->mContentModel
;
949 * Convenience method for checking a title's content model name
951 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
952 * @return bool True if $this->getContentModel() == $id
954 public function hasContentModel( $id ) {
955 return $this->getContentModel() == $id;
959 * Set a proposed content model for the page for permissions
960 * checking. This does not actually change the content model
963 * Additionally, you should make sure you've checked
964 * ContentHandler::canBeUsedOn() first.
967 * @param string $model CONTENT_MODEL_XXX constant
969 public function setContentModel( $model ) {
970 $this->mContentModel
= $model;
971 $this->mForcedContentModel
= true;
975 * Get the namespace text
977 * @return string|false Namespace text
979 public function getNsText() {
980 if ( $this->isExternal() ) {
981 // This probably shouldn't even happen,
982 // but for interwiki transclusion it sometimes does.
983 // Use the canonical namespaces if possible to try to
984 // resolve a foreign namespace.
985 if ( MWNamespace
::exists( $this->mNamespace
) ) {
986 return MWNamespace
::getCanonicalName( $this->mNamespace
);
991 $formatter = self
::getTitleFormatter();
992 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
993 } catch ( InvalidArgumentException
$ex ) {
994 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
1000 * Get the namespace text of the subject (rather than talk) page
1002 * @return string Namespace text
1004 public function getSubjectNsText() {
1006 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
1010 * Get the namespace text of the talk page
1012 * @return string Namespace text
1014 public function getTalkNsText() {
1016 return $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) );
1020 * Could this title have a corresponding talk page?
1024 public function canTalk() {
1025 return MWNamespace
::canTalk( $this->mNamespace
);
1029 * Is this in a namespace that allows actual pages?
1033 public function canExist() {
1034 return $this->mNamespace
>= NS_MAIN
;
1038 * Can this title be added to a user's watchlist?
1042 public function isWatchable() {
1043 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
1047 * Returns true if this is a special page.
1051 public function isSpecialPage() {
1052 return $this->getNamespace() == NS_SPECIAL
;
1056 * Returns true if this title resolves to the named special page
1058 * @param string $name The special page name
1061 public function isSpecial( $name ) {
1062 if ( $this->isSpecialPage() ) {
1063 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
1064 if ( $name == $thisName ) {
1072 * If the Title refers to a special page alias which is not the local default, resolve
1073 * the alias, and localise the name as necessary. Otherwise, return $this
1077 public function fixSpecialName() {
1078 if ( $this->isSpecialPage() ) {
1079 list( $canonicalName, $par ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
1080 if ( $canonicalName ) {
1081 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName, $par );
1082 if ( $localName != $this->mDbkeyform
) {
1083 return Title
::makeTitle( NS_SPECIAL
, $localName );
1091 * Returns true if the title is inside the specified namespace.
1093 * Please make use of this instead of comparing to getNamespace()
1094 * This function is much more resistant to changes we may make
1095 * to namespaces than code that makes direct comparisons.
1096 * @param int $ns The namespace
1100 public function inNamespace( $ns ) {
1101 return MWNamespace
::equals( $this->getNamespace(), $ns );
1105 * Returns true if the title is inside one of the specified namespaces.
1107 * @param int|int[] $namespaces,... The namespaces to check for
1111 public function inNamespaces( /* ... */ ) {
1112 $namespaces = func_get_args();
1113 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1114 $namespaces = $namespaces[0];
1117 foreach ( $namespaces as $ns ) {
1118 if ( $this->inNamespace( $ns ) ) {
1127 * Returns true if the title has the same subject namespace as the
1128 * namespace specified.
1129 * For example this method will take NS_USER and return true if namespace
1130 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1131 * as their subject namespace.
1133 * This is MUCH simpler than individually testing for equivalence
1134 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1139 public function hasSubjectNamespace( $ns ) {
1140 return MWNamespace
::subjectEquals( $this->getNamespace(), $ns );
1144 * Is this Title in a namespace which contains content?
1145 * In other words, is this a content page, for the purposes of calculating
1150 public function isContentPage() {
1151 return MWNamespace
::isContent( $this->getNamespace() );
1155 * Would anybody with sufficient privileges be able to move this page?
1156 * Some pages just aren't movable.
1160 public function isMovable() {
1161 if ( !MWNamespace
::isMovable( $this->getNamespace() ) ||
$this->isExternal() ) {
1162 // Interwiki title or immovable namespace. Hooks don't get to override here
1167 Hooks
::run( 'TitleIsMovable', [ $this, &$result ] );
1172 * Is this the mainpage?
1173 * @note Title::newFromText seems to be sufficiently optimized by the title
1174 * cache that we don't need to over-optimize by doing direct comparisons and
1175 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1176 * ends up reporting something differently than $title->isMainPage();
1181 public function isMainPage() {
1182 return $this->equals( Title
::newMainPage() );
1186 * Is this a subpage?
1190 public function isSubpage() {
1191 return MWNamespace
::hasSubpages( $this->mNamespace
)
1192 ?
strpos( $this->getText(), '/' ) !== false
1197 * Is this a conversion table for the LanguageConverter?
1201 public function isConversionTable() {
1202 // @todo ConversionTable should become a separate content model.
1204 return $this->getNamespace() == NS_MEDIAWIKI
&&
1205 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1209 * Does that page contain wikitext, or it is JS, CSS or whatever?
1213 public function isWikitextPage() {
1214 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1218 * Could this page contain custom CSS or JavaScript for the global UI.
1219 * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
1220 * or CONTENT_MODEL_JAVASCRIPT.
1222 * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage()
1225 * Note that this method should not return true for pages that contain and
1226 * show "inactive" CSS or JS.
1229 * @todo FIXME: Rename to isSiteConfigPage() and remove deprecated hook
1231 public function isCssOrJsPage() {
1232 $isCssOrJsPage = NS_MEDIAWIKI
== $this->mNamespace
1233 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1234 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1236 # @note This hook is also called in ContentHandler::getDefaultModel.
1237 # It's called here again to make sure hook functions can force this
1238 # method to return true even outside the MediaWiki namespace.
1240 Hooks
::run( 'TitleIsCssOrJsPage', [ $this, &$isCssOrJsPage ], '1.25' );
1242 return $isCssOrJsPage;
1246 * Is this a .css or .js subpage of a user page?
1248 * @todo FIXME: Rename to isUserConfigPage()
1250 public function isCssJsSubpage() {
1251 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1252 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1253 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
1257 * Trim down a .css or .js subpage title to get the corresponding skin name
1259 * @return string Containing skin name from .css or .js subpage title
1261 public function getSkinFromCssJsSubpage() {
1262 $subpage = explode( '/', $this->mTextform
);
1263 $subpage = $subpage[count( $subpage ) - 1];
1264 $lastdot = strrpos( $subpage, '.' );
1265 if ( $lastdot === false ) {
1266 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
1268 return substr( $subpage, 0, $lastdot );
1272 * Is this a .css subpage of a user page?
1276 public function isCssSubpage() {
1277 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1278 && $this->hasContentModel( CONTENT_MODEL_CSS
) );
1282 * Is this a .js subpage of a user page?
1286 public function isJsSubpage() {
1287 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1288 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1292 * Is this a talk page of some sort?
1296 public function isTalkPage() {
1297 return MWNamespace
::isTalk( $this->getNamespace() );
1301 * Get a Title object associated with the talk page of this article
1303 * @return Title The object for the talk page
1305 public function getTalkPage() {
1306 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
1310 * Get a title object associated with the subject page of this
1313 * @return Title The object for the subject page
1315 public function getSubjectPage() {
1316 // Is this the same title?
1317 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
1318 if ( $this->getNamespace() == $subjectNS ) {
1321 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
1325 * Get the other title for this page, if this is a subject page
1326 * get the talk page, if it is a subject page get the talk page
1329 * @throws MWException
1332 public function getOtherPage() {
1333 if ( $this->isSpecialPage() ) {
1334 throw new MWException( 'Special pages cannot have other pages' );
1336 if ( $this->isTalkPage() ) {
1337 return $this->getSubjectPage();
1339 return $this->getTalkPage();
1344 * Get the default namespace index, for when there is no namespace
1346 * @return int Default namespace index
1348 public function getDefaultNamespace() {
1349 return $this->mDefaultNamespace
;
1353 * Get the Title fragment (i.e.\ the bit after the #) in text form
1355 * Use Title::hasFragment to check for a fragment
1357 * @return string Title fragment
1359 public function getFragment() {
1360 return $this->mFragment
;
1364 * Check if a Title fragment is set
1369 public function hasFragment() {
1370 return $this->mFragment
!== '';
1374 * Get the fragment in URL form, including the "#" character if there is one
1375 * @return string Fragment in URL form
1377 public function getFragmentForURL() {
1378 if ( !$this->hasFragment() ) {
1381 return '#' . Title
::escapeFragmentForURL( $this->getFragment() );
1386 * Set the fragment for this title. Removes the first character from the
1387 * specified fragment before setting, so it assumes you're passing it with
1390 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1391 * or Title::createFragmentTarget().
1392 * Still in active use privately.
1395 * @param string $fragment Text
1397 public function setFragment( $fragment ) {
1398 $this->mFragment
= strtr( substr( $fragment, 1 ), '_', ' ' );
1402 * Creates a new Title for a different fragment of the same page.
1405 * @param string $fragment
1408 public function createFragmentTarget( $fragment ) {
1409 return self
::makeTitle(
1410 $this->getNamespace(),
1413 $this->getInterwiki()
1418 * Prefix some arbitrary text with the namespace or interwiki prefix
1421 * @param string $name The text
1422 * @return string The prefixed text
1424 private function prefix( $name ) {
1426 if ( $this->isExternal() ) {
1427 $p = $this->mInterwiki
. ':';
1430 if ( 0 != $this->mNamespace
) {
1431 $p .= $this->getNsText() . ':';
1437 * Get the prefixed database key form
1439 * @return string The prefixed title, with underscores and
1440 * any interwiki and namespace prefixes
1442 public function getPrefixedDBkey() {
1443 $s = $this->prefix( $this->mDbkeyform
);
1444 $s = strtr( $s, ' ', '_' );
1449 * Get the prefixed title with spaces.
1450 * This is the form usually used for display
1452 * @return string The prefixed title, with spaces
1454 public function getPrefixedText() {
1455 if ( $this->mPrefixedText
=== null ) {
1456 $s = $this->prefix( $this->mTextform
);
1457 $s = strtr( $s, '_', ' ' );
1458 $this->mPrefixedText
= $s;
1460 return $this->mPrefixedText
;
1464 * Return a string representation of this title
1466 * @return string Representation of this title
1468 public function __toString() {
1469 return $this->getPrefixedText();
1473 * Get the prefixed title with spaces, plus any fragment
1474 * (part beginning with '#')
1476 * @return string The prefixed title, with spaces and the fragment, including '#'
1478 public function getFullText() {
1479 $text = $this->getPrefixedText();
1480 if ( $this->hasFragment() ) {
1481 $text .= '#' . $this->getFragment();
1487 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1491 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1495 * @return string Root name
1498 public function getRootText() {
1499 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1500 return $this->getText();
1503 return strtok( $this->getText(), '/' );
1507 * Get the root page name title, i.e. the leftmost part before any slashes
1511 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1512 * # returns: Title{User:Foo}
1515 * @return Title Root title
1518 public function getRootTitle() {
1519 return Title
::makeTitle( $this->getNamespace(), $this->getRootText() );
1523 * Get the base page name without a namespace, i.e. the part before the subpage name
1527 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1528 * # returns: 'Foo/Bar'
1531 * @return string Base name
1533 public function getBaseText() {
1534 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1535 return $this->getText();
1538 $parts = explode( '/', $this->getText() );
1539 # Don't discard the real title if there's no subpage involved
1540 if ( count( $parts ) > 1 ) {
1541 unset( $parts[count( $parts ) - 1] );
1543 return implode( '/', $parts );
1547 * Get the base page name title, i.e. the part before the subpage name
1551 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1552 * # returns: Title{User:Foo/Bar}
1555 * @return Title Base title
1558 public function getBaseTitle() {
1559 return Title
::makeTitle( $this->getNamespace(), $this->getBaseText() );
1563 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1567 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1571 * @return string Subpage name
1573 public function getSubpageText() {
1574 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1575 return $this->mTextform
;
1577 $parts = explode( '/', $this->mTextform
);
1578 return $parts[count( $parts ) - 1];
1582 * Get the title for a subpage of the current page
1586 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1587 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1590 * @param string $text The subpage name to add to the title
1591 * @return Title Subpage title
1594 public function getSubpage( $text ) {
1595 return Title
::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1599 * Get a URL-encoded form of the subpage text
1601 * @return string URL-encoded subpage name
1603 public function getSubpageUrlForm() {
1604 $text = $this->getSubpageText();
1605 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1610 * Get a URL-encoded title (not an actual URL) including interwiki
1612 * @return string The URL-encoded form
1614 public function getPrefixedURL() {
1615 $s = $this->prefix( $this->mDbkeyform
);
1616 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1621 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1622 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1623 * second argument named variant. This was deprecated in favor
1624 * of passing an array of option with a "variant" key
1625 * Once $query2 is removed for good, this helper can be dropped
1626 * and the wfArrayToCgi moved to getLocalURL();
1628 * @since 1.19 (r105919)
1629 * @param array|string $query
1630 * @param string|string[]|bool $query2
1633 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1634 if ( $query2 !== false ) {
1635 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1636 "method called with a second parameter is deprecated. Add your " .
1637 "parameter to an array passed as the first parameter.", "1.19" );
1639 if ( is_array( $query ) ) {
1640 $query = wfArrayToCgi( $query );
1643 if ( is_string( $query2 ) ) {
1644 // $query2 is a string, we will consider this to be
1645 // a deprecated $variant argument and add it to the query
1646 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1648 $query2 = wfArrayToCgi( $query2 );
1650 // If we have $query content add a & to it first
1654 // Now append the queries together
1661 * Get a real URL referring to this title, with interwiki link and
1664 * @see self::getLocalURL for the arguments.
1666 * @param string|string[] $query
1667 * @param string|string[]|bool $query2
1668 * @param string $proto Protocol type to use in URL
1669 * @return string The URL
1671 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1672 $query = self
::fixUrlQueryArgs( $query, $query2 );
1674 # Hand off all the decisions on urls to getLocalURL
1675 $url = $this->getLocalURL( $query );
1677 # Expand the url to make it a full url. Note that getLocalURL has the
1678 # potential to output full urls for a variety of reasons, so we use
1679 # wfExpandUrl instead of simply prepending $wgServer
1680 $url = wfExpandUrl( $url, $proto );
1682 # Finally, add the fragment.
1683 $url .= $this->getFragmentForURL();
1684 // Avoid PHP 7.1 warning from passing $this by reference
1686 Hooks
::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
1691 * Get a URL with no fragment or server name (relative URL) from a Title object.
1692 * If this page is generated with action=render, however,
1693 * $wgServer is prepended to make an absolute URL.
1695 * @see self::getFullURL to always get an absolute URL.
1696 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
1697 * valid to link, locally, to the current Title.
1698 * @see self::newFromText to produce a Title object.
1700 * @param string|string[] $query An optional query string,
1701 * not used for interwiki links. Can be specified as an associative array as well,
1702 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1703 * Some query patterns will trigger various shorturl path replacements.
1704 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
1705 * be an array. If a string is passed it will be interpreted as a deprecated
1706 * variant argument and urlencoded into a variant= argument.
1707 * This second query argument will be added to the $query
1708 * The second parameter is deprecated since 1.19. Pass it as a key,value
1709 * pair in the first parameter array instead.
1711 * @return string String of the URL.
1713 public function getLocalURL( $query = '', $query2 = false ) {
1714 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1716 $query = self
::fixUrlQueryArgs( $query, $query2 );
1718 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
1720 $namespace = $this->getNsText();
1721 if ( $namespace != '' ) {
1722 # Can this actually happen? Interwikis shouldn't be parsed.
1723 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1726 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1727 $url = wfAppendQuery( $url, $query );
1729 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1730 if ( $query == '' ) {
1731 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1732 // Avoid PHP 7.1 warning from passing $this by reference
1734 Hooks
::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
1736 global $wgVariantArticlePath, $wgActionPaths, $wgContLang;
1740 if ( !empty( $wgActionPaths )
1741 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1743 $action = urldecode( $matches[2] );
1744 if ( isset( $wgActionPaths[$action] ) ) {
1745 $query = $matches[1];
1746 if ( isset( $matches[4] ) ) {
1747 $query .= $matches[4];
1749 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1750 if ( $query != '' ) {
1751 $url = wfAppendQuery( $url, $query );
1757 && $wgVariantArticlePath
1758 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1759 && $this->getPageLanguage()->equals( $wgContLang )
1760 && $this->getPageLanguage()->hasVariants()
1762 $variant = urldecode( $matches[1] );
1763 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1764 // Only do the variant replacement if the given variant is a valid
1765 // variant for the page's language.
1766 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1767 $url = str_replace( '$1', $dbkey, $url );
1771 if ( $url === false ) {
1772 if ( $query == '-' ) {
1775 $url = "{$wgScript}?title={$dbkey}&{$query}";
1778 // Avoid PHP 7.1 warning from passing $this by reference
1780 Hooks
::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
1782 // @todo FIXME: This causes breakage in various places when we
1783 // actually expected a local URL and end up with dupe prefixes.
1784 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1785 $url = $wgServer . $url;
1788 // Avoid PHP 7.1 warning from passing $this by reference
1790 Hooks
::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
1795 * Get a URL that's the simplest URL that will be valid to link, locally,
1796 * to the current Title. It includes the fragment, but does not include
1797 * the server unless action=render is used (or the link is external). If
1798 * there's a fragment but the prefixed text is empty, we just return a link
1801 * The result obviously should not be URL-escaped, but does need to be
1802 * HTML-escaped if it's being output in HTML.
1804 * @param string|string[] $query
1805 * @param bool $query2
1806 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
1807 * or false (default) for no expansion
1808 * @see self::getLocalURL for the arguments.
1809 * @return string The URL
1811 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
1812 if ( $this->isExternal() ||
$proto !== false ) {
1813 $ret = $this->getFullURL( $query, $query2, $proto );
1814 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
1815 $ret = $this->getFragmentForURL();
1817 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1823 * Get the URL form for an internal link.
1824 * - Used in various CDN-related code, in case we have a different
1825 * internal hostname for the server from the exposed one.
1827 * This uses $wgInternalServer to qualify the path, or $wgServer
1828 * if $wgInternalServer is not set. If the server variable used is
1829 * protocol-relative, the URL will be expanded to http://
1831 * @see self::getLocalURL for the arguments.
1832 * @return string The URL
1834 public function getInternalURL( $query = '', $query2 = false ) {
1835 global $wgInternalServer, $wgServer;
1836 $query = self
::fixUrlQueryArgs( $query, $query2 );
1837 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1838 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
1839 // Avoid PHP 7.1 warning from passing $this by reference
1841 Hooks
::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
1846 * Get the URL for a canonical link, for use in things like IRC and
1847 * e-mail notifications. Uses $wgCanonicalServer and the
1848 * GetCanonicalURL hook.
1850 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1852 * @see self::getLocalURL for the arguments.
1853 * @return string The URL
1856 public function getCanonicalURL( $query = '', $query2 = false ) {
1857 $query = self
::fixUrlQueryArgs( $query, $query2 );
1858 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
1859 // Avoid PHP 7.1 warning from passing $this by reference
1861 Hooks
::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
1866 * Get the edit URL for this Title
1868 * @return string The URL, or a null string if this is an interwiki link
1870 public function getEditURL() {
1871 if ( $this->isExternal() ) {
1874 $s = $this->getLocalURL( 'action=edit' );
1880 * Can $user perform $action on this page?
1881 * This skips potentially expensive cascading permission checks
1882 * as well as avoids expensive error formatting
1884 * Suitable for use for nonessential UI controls in common cases, but
1885 * _not_ for functional access control.
1887 * May provide false positives, but should never provide a false negative.
1889 * @param string $action Action that permission needs to be checked for
1890 * @param User $user User to check (since 1.19); $wgUser will be used if not provided.
1893 public function quickUserCan( $action, $user = null ) {
1894 return $this->userCan( $action, $user, false );
1898 * Can $user perform $action on this page?
1900 * @param string $action Action that permission needs to be checked for
1901 * @param User $user User to check (since 1.19); $wgUser will be used if not
1903 * @param string $rigor Same format as Title::getUserPermissionsErrors()
1906 public function userCan( $action, $user = null, $rigor = 'secure' ) {
1907 if ( !$user instanceof User
) {
1912 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $rigor, true ) );
1916 * Can $user perform $action on this page?
1918 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1920 * @param string $action Action that permission needs to be checked for
1921 * @param User $user User to check
1922 * @param string $rigor One of (quick,full,secure)
1923 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
1924 * - full : does cheap and expensive checks possibly from a replica DB
1925 * - secure : does cheap and expensive checks, using the master as needed
1926 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
1927 * whose corresponding errors may be ignored.
1928 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
1930 public function getUserPermissionsErrors(
1931 $action, $user, $rigor = 'secure', $ignoreErrors = []
1933 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $rigor );
1935 // Remove the errors being ignored.
1936 foreach ( $errors as $index => $error ) {
1937 $errKey = is_array( $error ) ?
$error[0] : $error;
1939 if ( in_array( $errKey, $ignoreErrors ) ) {
1940 unset( $errors[$index] );
1942 if ( $errKey instanceof MessageSpecifier
&& in_array( $errKey->getKey(), $ignoreErrors ) ) {
1943 unset( $errors[$index] );
1951 * Permissions checks that fail most often, and which are easiest to test.
1953 * @param string $action The action to check
1954 * @param User $user User to check
1955 * @param array $errors List of current errors
1956 * @param string $rigor Same format as Title::getUserPermissionsErrors()
1957 * @param bool $short Short circuit on first error
1959 * @return array List of errors
1961 private function checkQuickPermissions( $action, $user, $errors, $rigor, $short ) {
1962 if ( !Hooks
::run( 'TitleQuickPermissions',
1963 [ $this, $user, $action, &$errors, ( $rigor !== 'quick' ), $short ] )
1968 if ( $action == 'create' ) {
1970 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1971 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
1973 $errors[] = $user->isAnon() ?
[ 'nocreatetext' ] : [ 'nocreate-loggedin' ];
1975 } elseif ( $action == 'move' ) {
1976 if ( !$user->isAllowed( 'move-rootuserpages' )
1977 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1978 // Show user page-specific message only if the user can move other pages
1979 $errors[] = [ 'cant-move-user-page' ];
1982 // Check if user is allowed to move files if it's a file
1983 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1984 $errors[] = [ 'movenotallowedfile' ];
1987 // Check if user is allowed to move category pages if it's a category page
1988 if ( $this->mNamespace
== NS_CATEGORY
&& !$user->isAllowed( 'move-categorypages' ) ) {
1989 $errors[] = [ 'cant-move-category-page' ];
1992 if ( !$user->isAllowed( 'move' ) ) {
1993 // User can't move anything
1994 $userCanMove = User
::groupHasPermission( 'user', 'move' );
1995 $autoconfirmedCanMove = User
::groupHasPermission( 'autoconfirmed', 'move' );
1996 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1997 // custom message if logged-in users without any special rights can move
1998 $errors[] = [ 'movenologintext' ];
2000 $errors[] = [ 'movenotallowed' ];
2003 } elseif ( $action == 'move-target' ) {
2004 if ( !$user->isAllowed( 'move' ) ) {
2005 // User can't move anything
2006 $errors[] = [ 'movenotallowed' ];
2007 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
2008 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
2009 // Show user page-specific message only if the user can move other pages
2010 $errors[] = [ 'cant-move-to-user-page' ];
2011 } elseif ( !$user->isAllowed( 'move-categorypages' )
2012 && $this->mNamespace
== NS_CATEGORY
) {
2013 // Show category page-specific message only if the user can move other pages
2014 $errors[] = [ 'cant-move-to-category-page' ];
2016 } elseif ( !$user->isAllowed( $action ) ) {
2017 $errors[] = $this->missingPermissionError( $action, $short );
2024 * Add the resulting error code to the errors array
2026 * @param array $errors List of current errors
2027 * @param array $result Result of errors
2029 * @return array List of errors
2031 private function resultToError( $errors, $result ) {
2032 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2033 // A single array representing an error
2034 $errors[] = $result;
2035 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2036 // A nested array representing multiple errors
2037 $errors = array_merge( $errors, $result );
2038 } elseif ( $result !== '' && is_string( $result ) ) {
2039 // A string representing a message-id
2040 $errors[] = [ $result ];
2041 } elseif ( $result instanceof MessageSpecifier
) {
2042 // A message specifier representing an error
2043 $errors[] = [ $result ];
2044 } elseif ( $result === false ) {
2045 // a generic "We don't want them to do that"
2046 $errors[] = [ 'badaccess-group0' ];
2052 * Check various permission hooks
2054 * @param string $action The action to check
2055 * @param User $user User to check
2056 * @param array $errors List of current errors
2057 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2058 * @param bool $short Short circuit on first error
2060 * @return array List of errors
2062 private function checkPermissionHooks( $action, $user, $errors, $rigor, $short ) {
2063 // Use getUserPermissionsErrors instead
2065 // Avoid PHP 7.1 warning from passing $this by reference
2067 if ( !Hooks
::run( 'userCan', [ &$titleRef, &$user, $action, &$result ] ) ) {
2068 return $result ?
[] : [ [ 'badaccess-group0' ] ];
2070 // Check getUserPermissionsErrors hook
2071 // Avoid PHP 7.1 warning from passing $this by reference
2073 if ( !Hooks
::run( 'getUserPermissionsErrors', [ &$titleRef, &$user, $action, &$result ] ) ) {
2074 $errors = $this->resultToError( $errors, $result );
2076 // Check getUserPermissionsErrorsExpensive hook
2079 && !( $short && count( $errors ) > 0 )
2080 && !Hooks
::run( 'getUserPermissionsErrorsExpensive', [ &$titleRef, &$user, $action, &$result ] )
2082 $errors = $this->resultToError( $errors, $result );
2089 * Check permissions on special pages & namespaces
2091 * @param string $action The action to check
2092 * @param User $user User to check
2093 * @param array $errors List of current errors
2094 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2095 * @param bool $short Short circuit on first error
2097 * @return array List of errors
2099 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $rigor, $short ) {
2100 # Only 'createaccount' can be performed on special pages,
2101 # which don't actually exist in the DB.
2102 if ( NS_SPECIAL
== $this->mNamespace
&& $action !== 'createaccount' ) {
2103 $errors[] = [ 'ns-specialprotected' ];
2106 # Check $wgNamespaceProtection for restricted namespaces
2107 if ( $this->isNamespaceProtected( $user ) ) {
2108 $ns = $this->mNamespace
== NS_MAIN ?
2109 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2110 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
2111 [ 'protectedinterface', $action ] : [ 'namespaceprotected', $ns, $action ];
2118 * Check CSS/JS sub-page permissions
2120 * @param string $action The action to check
2121 * @param User $user User to check
2122 * @param array $errors List of current errors
2123 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2124 * @param bool $short Short circuit on first error
2126 * @return array List of errors
2128 private function checkCSSandJSPermissions( $action, $user, $errors, $rigor, $short ) {
2129 # Protect css/js subpages of user pages
2130 # XXX: this might be better using restrictions
2131 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
2132 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' ) ) {
2133 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
2134 if ( $this->isCssSubpage() && !$user->isAllowedAny( 'editmyusercss', 'editusercss' ) ) {
2135 $errors[] = [ 'mycustomcssprotected', $action ];
2136 } elseif ( $this->isJsSubpage() && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' ) ) {
2137 $errors[] = [ 'mycustomjsprotected', $action ];
2140 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
2141 $errors[] = [ 'customcssprotected', $action ];
2142 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
2143 $errors[] = [ 'customjsprotected', $action ];
2152 * Check against page_restrictions table requirements on this
2153 * page. The user must possess all required rights for this
2156 * @param string $action The action to check
2157 * @param User $user User to check
2158 * @param array $errors List of current errors
2159 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2160 * @param bool $short Short circuit on first error
2162 * @return array List of errors
2164 private function checkPageRestrictions( $action, $user, $errors, $rigor, $short ) {
2165 foreach ( $this->getRestrictions( $action ) as $right ) {
2166 // Backwards compatibility, rewrite sysop -> editprotected
2167 if ( $right == 'sysop' ) {
2168 $right = 'editprotected';
2170 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2171 if ( $right == 'autoconfirmed' ) {
2172 $right = 'editsemiprotected';
2174 if ( $right == '' ) {
2177 if ( !$user->isAllowed( $right ) ) {
2178 $errors[] = [ 'protectedpagetext', $right, $action ];
2179 } elseif ( $this->mCascadeRestriction
&& !$user->isAllowed( 'protect' ) ) {
2180 $errors[] = [ 'protectedpagetext', 'protect', $action ];
2188 * Check restrictions on cascading pages.
2190 * @param string $action The action to check
2191 * @param User $user User to check
2192 * @param array $errors List of current errors
2193 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2194 * @param bool $short Short circuit on first error
2196 * @return array List of errors
2198 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $rigor, $short ) {
2199 if ( $rigor !== 'quick' && !$this->isCssJsSubpage() ) {
2200 # We /could/ use the protection level on the source page, but it's
2201 # fairly ugly as we have to establish a precedence hierarchy for pages
2202 # included by multiple cascade-protected pages. So just restrict
2203 # it to people with 'protect' permission, as they could remove the
2204 # protection anyway.
2205 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2206 # Cascading protection depends on more than this page...
2207 # Several cascading protected pages may include this page...
2208 # Check each cascading level
2209 # This is only for protection restrictions, not for all actions
2210 if ( isset( $restrictions[$action] ) ) {
2211 foreach ( $restrictions[$action] as $right ) {
2212 // Backwards compatibility, rewrite sysop -> editprotected
2213 if ( $right == 'sysop' ) {
2214 $right = 'editprotected';
2216 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2217 if ( $right == 'autoconfirmed' ) {
2218 $right = 'editsemiprotected';
2220 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2222 foreach ( $cascadingSources as $page ) {
2223 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2225 $errors[] = [ 'cascadeprotected', count( $cascadingSources ), $pages, $action ];
2235 * Check action permissions not already checked in checkQuickPermissions
2237 * @param string $action The action to check
2238 * @param User $user User to check
2239 * @param array $errors List of current errors
2240 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2241 * @param bool $short Short circuit on first error
2243 * @return array List of errors
2245 private function checkActionPermissions( $action, $user, $errors, $rigor, $short ) {
2246 global $wgDeleteRevisionsLimit, $wgLang;
2248 if ( $action == 'protect' ) {
2249 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2250 // If they can't edit, they shouldn't protect.
2251 $errors[] = [ 'protect-cantedit' ];
2253 } elseif ( $action == 'create' ) {
2254 $title_protection = $this->getTitleProtection();
2255 if ( $title_protection ) {
2256 if ( $title_protection['permission'] == ''
2257 ||
!$user->isAllowed( $title_protection['permission'] )
2261 User
::whoIs( $title_protection['user'] ),
2262 $title_protection['reason']
2266 } elseif ( $action == 'move' ) {
2267 // Check for immobile pages
2268 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2269 // Specific message for this case
2270 $errors[] = [ 'immobile-source-namespace', $this->getNsText() ];
2271 } elseif ( !$this->isMovable() ) {
2272 // Less specific message for rarer cases
2273 $errors[] = [ 'immobile-source-page' ];
2275 } elseif ( $action == 'move-target' ) {
2276 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2277 $errors[] = [ 'immobile-target-namespace', $this->getNsText() ];
2278 } elseif ( !$this->isMovable() ) {
2279 $errors[] = [ 'immobile-target-page' ];
2281 } elseif ( $action == 'delete' ) {
2282 $tempErrors = $this->checkPageRestrictions( 'edit', $user, [], $rigor, true );
2283 if ( !$tempErrors ) {
2284 $tempErrors = $this->checkCascadingSourcesRestrictions( 'edit',
2285 $user, $tempErrors, $rigor, true );
2287 if ( $tempErrors ) {
2288 // If protection keeps them from editing, they shouldn't be able to delete.
2289 $errors[] = [ 'deleteprotected' ];
2291 if ( $rigor !== 'quick' && $wgDeleteRevisionsLimit
2292 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2294 $errors[] = [ 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ];
2301 * Check that the user isn't blocked from editing.
2303 * @param string $action The action to check
2304 * @param User $user User to check
2305 * @param array $errors List of current errors
2306 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2307 * @param bool $short Short circuit on first error
2309 * @return array List of errors
2311 private function checkUserBlock( $action, $user, $errors, $rigor, $short ) {
2312 global $wgEmailConfirmToEdit, $wgBlockDisablesLogin;
2313 // Account creation blocks handled at userlogin.
2314 // Unblocking handled in SpecialUnblock
2315 if ( $rigor === 'quick' ||
in_array( $action, [ 'createaccount', 'unblock' ] ) ) {
2319 // Optimize for a very common case
2320 if ( $action === 'read' && !$wgBlockDisablesLogin ) {
2324 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2325 $errors[] = [ 'confirmedittext' ];
2328 $useSlave = ( $rigor !== 'secure' );
2329 if ( ( $action == 'edit' ||
$action == 'create' )
2330 && !$user->isBlockedFrom( $this, $useSlave )
2332 // Don't block the user from editing their own talk page unless they've been
2333 // explicitly blocked from that too.
2334 } elseif ( $user->isBlocked() && $user->getBlock()->prevents( $action ) !== false ) {
2335 // @todo FIXME: Pass the relevant context into this function.
2336 $errors[] = $user->getBlock()->getPermissionsError( RequestContext
::getMain() );
2343 * Check that the user is allowed to read this page.
2345 * @param string $action The action to check
2346 * @param User $user User to check
2347 * @param array $errors List of current errors
2348 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2349 * @param bool $short Short circuit on first error
2351 * @return array List of errors
2353 private function checkReadPermissions( $action, $user, $errors, $rigor, $short ) {
2354 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2356 $whitelisted = false;
2357 if ( User
::isEveryoneAllowed( 'read' ) ) {
2358 # Shortcut for public wikis, allows skipping quite a bit of code
2359 $whitelisted = true;
2360 } elseif ( $user->isAllowed( 'read' ) ) {
2361 # If the user is allowed to read pages, he is allowed to read all pages
2362 $whitelisted = true;
2363 } elseif ( $this->isSpecial( 'Userlogin' )
2364 ||
$this->isSpecial( 'PasswordReset' )
2365 ||
$this->isSpecial( 'Userlogout' )
2367 # Always grant access to the login page.
2368 # Even anons need to be able to log in.
2369 $whitelisted = true;
2370 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2371 # Time to check the whitelist
2372 # Only do these checks is there's something to check against
2373 $name = $this->getPrefixedText();
2374 $dbName = $this->getPrefixedDBkey();
2376 // Check for explicit whitelisting with and without underscores
2377 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2378 $whitelisted = true;
2379 } elseif ( $this->getNamespace() == NS_MAIN
) {
2380 # Old settings might have the title prefixed with
2381 # a colon for main-namespace pages
2382 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2383 $whitelisted = true;
2385 } elseif ( $this->isSpecialPage() ) {
2386 # If it's a special page, ditch the subpage bit and check again
2387 $name = $this->getDBkey();
2388 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
2390 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2391 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2392 $whitelisted = true;
2398 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2399 $name = $this->getPrefixedText();
2400 // Check for regex whitelisting
2401 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2402 if ( preg_match( $listItem, $name ) ) {
2403 $whitelisted = true;
2409 if ( !$whitelisted ) {
2410 # If the title is not whitelisted, give extensions a chance to do so...
2411 Hooks
::run( 'TitleReadWhitelist', [ $this, $user, &$whitelisted ] );
2412 if ( !$whitelisted ) {
2413 $errors[] = $this->missingPermissionError( $action, $short );
2421 * Get a description array when the user doesn't have the right to perform
2422 * $action (i.e. when User::isAllowed() returns false)
2424 * @param string $action The action to check
2425 * @param bool $short Short circuit on first error
2426 * @return array List of errors
2428 private function missingPermissionError( $action, $short ) {
2429 // We avoid expensive display logic for quickUserCan's and such
2431 return [ 'badaccess-group0' ];
2434 $groups = array_map( [ 'User', 'makeGroupLinkWiki' ],
2435 User
::getGroupsWithPermission( $action ) );
2437 if ( count( $groups ) ) {
2441 $wgLang->commaList( $groups ),
2445 return [ 'badaccess-group0' ];
2450 * Can $user perform $action on this page? This is an internal function,
2451 * with multiple levels of checks depending on performance needs; see $rigor below.
2452 * It does not check wfReadOnly().
2454 * @param string $action Action that permission needs to be checked for
2455 * @param User $user User to check
2456 * @param string $rigor One of (quick,full,secure)
2457 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2458 * - full : does cheap and expensive checks possibly from a replica DB
2459 * - secure : does cheap and expensive checks, using the master as needed
2460 * @param bool $short Set this to true to stop after the first permission error.
2461 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2463 protected function getUserPermissionsErrorsInternal(
2464 $action, $user, $rigor = 'secure', $short = false
2466 if ( $rigor === true ) {
2467 $rigor = 'secure'; // b/c
2468 } elseif ( $rigor === false ) {
2469 $rigor = 'quick'; // b/c
2470 } elseif ( !in_array( $rigor, [ 'quick', 'full', 'secure' ] ) ) {
2471 throw new Exception( "Invalid rigor parameter '$rigor'." );
2474 # Read has special handling
2475 if ( $action == 'read' ) {
2477 'checkPermissionHooks',
2478 'checkReadPermissions',
2479 'checkUserBlock', // for wgBlockDisablesLogin
2481 # Don't call checkSpecialsAndNSPermissions or checkCSSandJSPermissions
2482 # here as it will lead to duplicate error messages. This is okay to do
2483 # since anywhere that checks for create will also check for edit, and
2484 # those checks are called for edit.
2485 } elseif ( $action == 'create' ) {
2487 'checkQuickPermissions',
2488 'checkPermissionHooks',
2489 'checkPageRestrictions',
2490 'checkCascadingSourcesRestrictions',
2491 'checkActionPermissions',
2496 'checkQuickPermissions',
2497 'checkPermissionHooks',
2498 'checkSpecialsAndNSPermissions',
2499 'checkCSSandJSPermissions',
2500 'checkPageRestrictions',
2501 'checkCascadingSourcesRestrictions',
2502 'checkActionPermissions',
2508 while ( count( $checks ) > 0 &&
2509 !( $short && count( $errors ) > 0 ) ) {
2510 $method = array_shift( $checks );
2511 $errors = $this->$method( $action, $user, $errors, $rigor, $short );
2518 * Get a filtered list of all restriction types supported by this wiki.
2519 * @param bool $exists True to get all restriction types that apply to
2520 * titles that do exist, False for all restriction types that apply to
2521 * titles that do not exist
2524 public static function getFilteredRestrictionTypes( $exists = true ) {
2525 global $wgRestrictionTypes;
2526 $types = $wgRestrictionTypes;
2528 # Remove the create restriction for existing titles
2529 $types = array_diff( $types, [ 'create' ] );
2531 # Only the create and upload restrictions apply to non-existing titles
2532 $types = array_intersect( $types, [ 'create', 'upload' ] );
2538 * Returns restriction types for the current Title
2540 * @return array Applicable restriction types
2542 public function getRestrictionTypes() {
2543 if ( $this->isSpecialPage() ) {
2547 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2549 if ( $this->getNamespace() != NS_FILE
) {
2550 # Remove the upload restriction for non-file titles
2551 $types = array_diff( $types, [ 'upload' ] );
2554 Hooks
::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2556 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2557 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2563 * Is this title subject to title protection?
2564 * Title protection is the one applied against creation of such title.
2566 * @return array|bool An associative array representing any existent title
2567 * protection, or false if there's none.
2569 public function getTitleProtection() {
2570 // Can't protect pages in special namespaces
2571 if ( $this->getNamespace() < 0 ) {
2575 // Can't protect pages that exist.
2576 if ( $this->exists() ) {
2580 if ( $this->mTitleProtection
=== null ) {
2581 $dbr = wfGetDB( DB_REPLICA
);
2582 $res = $dbr->select(
2585 'user' => 'pt_user',
2586 'reason' => 'pt_reason',
2587 'expiry' => 'pt_expiry',
2588 'permission' => 'pt_create_perm'
2590 [ 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ],
2594 // fetchRow returns false if there are no rows.
2595 $row = $dbr->fetchRow( $res );
2597 if ( $row['permission'] == 'sysop' ) {
2598 $row['permission'] = 'editprotected'; // B/C
2600 if ( $row['permission'] == 'autoconfirmed' ) {
2601 $row['permission'] = 'editsemiprotected'; // B/C
2603 $row['expiry'] = $dbr->decodeExpiry( $row['expiry'] );
2605 $this->mTitleProtection
= $row;
2607 return $this->mTitleProtection
;
2611 * Remove any title protection due to page existing
2613 public function deleteTitleProtection() {
2614 $dbw = wfGetDB( DB_MASTER
);
2618 [ 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ],
2621 $this->mTitleProtection
= false;
2625 * Is this page "semi-protected" - the *only* protection levels are listed
2626 * in $wgSemiprotectedRestrictionLevels?
2628 * @param string $action Action to check (default: edit)
2631 public function isSemiProtected( $action = 'edit' ) {
2632 global $wgSemiprotectedRestrictionLevels;
2634 $restrictions = $this->getRestrictions( $action );
2635 $semi = $wgSemiprotectedRestrictionLevels;
2636 if ( !$restrictions ||
!$semi ) {
2637 // Not protected, or all protection is full protection
2641 // Remap autoconfirmed to editsemiprotected for BC
2642 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2643 $semi[$key] = 'editsemiprotected';
2645 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2646 $restrictions[$key] = 'editsemiprotected';
2649 return !array_diff( $restrictions, $semi );
2653 * Does the title correspond to a protected article?
2655 * @param string $action The action the page is protected from,
2656 * by default checks all actions.
2659 public function isProtected( $action = '' ) {
2660 global $wgRestrictionLevels;
2662 $restrictionTypes = $this->getRestrictionTypes();
2664 # Special pages have inherent protection
2665 if ( $this->isSpecialPage() ) {
2669 # Check regular protection levels
2670 foreach ( $restrictionTypes as $type ) {
2671 if ( $action == $type ||
$action == '' ) {
2672 $r = $this->getRestrictions( $type );
2673 foreach ( $wgRestrictionLevels as $level ) {
2674 if ( in_array( $level, $r ) && $level != '' ) {
2685 * Determines if $user is unable to edit this page because it has been protected
2686 * by $wgNamespaceProtection.
2688 * @param User $user User object to check permissions
2691 public function isNamespaceProtected( User
$user ) {
2692 global $wgNamespaceProtection;
2694 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2695 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2696 if ( $right != '' && !$user->isAllowed( $right ) ) {
2705 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2707 * @return bool If the page is subject to cascading restrictions.
2709 public function isCascadeProtected() {
2710 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2711 return ( $sources > 0 );
2715 * Determines whether cascading protection sources have already been loaded from
2718 * @param bool $getPages True to check if the pages are loaded, or false to check
2719 * if the status is loaded.
2720 * @return bool Whether or not the specified information has been loaded
2723 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2724 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
2728 * Cascading protection: Get the source of any cascading restrictions on this page.
2730 * @param bool $getPages Whether or not to retrieve the actual pages
2731 * that the restrictions have come from and the actual restrictions
2733 * @return array Two elements: First is an array of Title objects of the
2734 * pages from which cascading restrictions have come, false for
2735 * none, or true if such restrictions exist but $getPages was not
2736 * set. Second is an array like that returned by
2737 * Title::getAllRestrictions(), or an empty array if $getPages is
2740 public function getCascadeProtectionSources( $getPages = true ) {
2741 $pagerestrictions = [];
2743 if ( $this->mCascadeSources
!== null && $getPages ) {
2744 return [ $this->mCascadeSources
, $this->mCascadingRestrictions
];
2745 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
2746 return [ $this->mHasCascadingRestrictions
, $pagerestrictions ];
2749 $dbr = wfGetDB( DB_REPLICA
);
2751 if ( $this->getNamespace() == NS_FILE
) {
2752 $tables = [ 'imagelinks', 'page_restrictions' ];
2754 'il_to' => $this->getDBkey(),
2759 $tables = [ 'templatelinks', 'page_restrictions' ];
2761 'tl_namespace' => $this->getNamespace(),
2762 'tl_title' => $this->getDBkey(),
2769 $cols = [ 'pr_page', 'page_namespace', 'page_title',
2770 'pr_expiry', 'pr_type', 'pr_level' ];
2771 $where_clauses[] = 'page_id=pr_page';
2774 $cols = [ 'pr_expiry' ];
2777 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2779 $sources = $getPages ?
[] : false;
2780 $now = wfTimestampNow();
2782 foreach ( $res as $row ) {
2783 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
2784 if ( $expiry > $now ) {
2786 $page_id = $row->pr_page
;
2787 $page_ns = $row->page_namespace
;
2788 $page_title = $row->page_title
;
2789 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2790 # Add groups needed for each restriction type if its not already there
2791 # Make sure this restriction type still exists
2793 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2794 $pagerestrictions[$row->pr_type
] = [];
2798 isset( $pagerestrictions[$row->pr_type
] )
2799 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
2801 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2810 $this->mCascadeSources
= $sources;
2811 $this->mCascadingRestrictions
= $pagerestrictions;
2813 $this->mHasCascadingRestrictions
= $sources;
2816 return [ $sources, $pagerestrictions ];
2820 * Accessor for mRestrictionsLoaded
2822 * @return bool Whether or not the page's restrictions have already been
2823 * loaded from the database
2826 public function areRestrictionsLoaded() {
2827 return $this->mRestrictionsLoaded
;
2831 * Accessor/initialisation for mRestrictions
2833 * @param string $action Action that permission needs to be checked for
2834 * @return array Restriction levels needed to take the action. All levels are
2835 * required. Note that restriction levels are normally user rights, but 'sysop'
2836 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
2837 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
2839 public function getRestrictions( $action ) {
2840 if ( !$this->mRestrictionsLoaded
) {
2841 $this->loadRestrictions();
2843 return isset( $this->mRestrictions
[$action] )
2844 ?
$this->mRestrictions
[$action]
2849 * Accessor/initialisation for mRestrictions
2851 * @return array Keys are actions, values are arrays as returned by
2852 * Title::getRestrictions()
2855 public function getAllRestrictions() {
2856 if ( !$this->mRestrictionsLoaded
) {
2857 $this->loadRestrictions();
2859 return $this->mRestrictions
;
2863 * Get the expiry time for the restriction against a given action
2865 * @param string $action
2866 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2867 * or not protected at all, or false if the action is not recognised.
2869 public function getRestrictionExpiry( $action ) {
2870 if ( !$this->mRestrictionsLoaded
) {
2871 $this->loadRestrictions();
2873 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2877 * Returns cascading restrictions for the current article
2881 function areRestrictionsCascading() {
2882 if ( !$this->mRestrictionsLoaded
) {
2883 $this->loadRestrictions();
2886 return $this->mCascadeRestriction
;
2890 * Compiles list of active page restrictions from both page table (pre 1.10)
2891 * and page_restrictions table for this existing page.
2892 * Public for usage by LiquidThreads.
2894 * @param array $rows Array of db result objects
2895 * @param string $oldFashionedRestrictions Comma-separated list of page
2896 * restrictions from page table (pre 1.10)
2898 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2899 $dbr = wfGetDB( DB_REPLICA
);
2901 $restrictionTypes = $this->getRestrictionTypes();
2903 foreach ( $restrictionTypes as $type ) {
2904 $this->mRestrictions
[$type] = [];
2905 $this->mRestrictionsExpiry
[$type] = 'infinity';
2908 $this->mCascadeRestriction
= false;
2910 # Backwards-compatibility: also load the restrictions from the page record (old format).
2911 if ( $oldFashionedRestrictions !== null ) {
2912 $this->mOldRestrictions
= $oldFashionedRestrictions;
2915 if ( $this->mOldRestrictions
=== false ) {
2916 $this->mOldRestrictions
= $dbr->selectField( 'page', 'page_restrictions',
2917 [ 'page_id' => $this->getArticleID() ], __METHOD__
);
2920 if ( $this->mOldRestrictions
!= '' ) {
2921 foreach ( explode( ':', trim( $this->mOldRestrictions
) ) as $restrict ) {
2922 $temp = explode( '=', trim( $restrict ) );
2923 if ( count( $temp ) == 1 ) {
2924 // old old format should be treated as edit/move restriction
2925 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2926 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2928 $restriction = trim( $temp[1] );
2929 if ( $restriction != '' ) { // some old entries are empty
2930 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
2936 if ( count( $rows ) ) {
2937 # Current system - load second to make them override.
2938 $now = wfTimestampNow();
2940 # Cycle through all the restrictions.
2941 foreach ( $rows as $row ) {
2942 // Don't take care of restrictions types that aren't allowed
2943 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
2947 // This code should be refactored, now that it's being used more generally,
2948 // But I don't really see any harm in leaving it in Block for now -werdna
2949 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
2951 // Only apply the restrictions if they haven't expired!
2952 if ( !$expiry ||
$expiry > $now ) {
2953 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2954 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2956 $this->mCascadeRestriction |
= $row->pr_cascade
;
2961 $this->mRestrictionsLoaded
= true;
2965 * Load restrictions from the page_restrictions table
2967 * @param string $oldFashionedRestrictions Comma-separated list of page
2968 * restrictions from page table (pre 1.10)
2970 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2971 if ( $this->mRestrictionsLoaded
) {
2975 $id = $this->getArticleID();
2977 $cache = ObjectCache
::getMainWANInstance();
2978 $rows = $cache->getWithSetCallback(
2979 // Page protections always leave a new null revision
2980 $cache->makeKey( 'page-restrictions', $id, $this->getLatestRevID() ),
2982 function ( $curValue, &$ttl, array &$setOpts ) {
2983 $dbr = wfGetDB( DB_REPLICA
);
2985 $setOpts +
= Database
::getCacheSetOptions( $dbr );
2987 return iterator_to_array(
2989 'page_restrictions',
2990 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
2991 [ 'pr_page' => $this->getArticleID() ],
2998 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
3000 $title_protection = $this->getTitleProtection();
3002 if ( $title_protection ) {
3003 $now = wfTimestampNow();
3004 $expiry = wfGetDB( DB_REPLICA
)->decodeExpiry( $title_protection['expiry'] );
3006 if ( !$expiry ||
$expiry > $now ) {
3007 // Apply the restrictions
3008 $this->mRestrictionsExpiry
['create'] = $expiry;
3009 $this->mRestrictions
['create'] =
3010 explode( ',', trim( $title_protection['permission'] ) );
3011 } else { // Get rid of the old restrictions
3012 $this->mTitleProtection
= false;
3015 $this->mRestrictionsExpiry
['create'] = 'infinity';
3017 $this->mRestrictionsLoaded
= true;
3022 * Flush the protection cache in this object and force reload from the database.
3023 * This is used when updating protection from WikiPage::doUpdateRestrictions().
3025 public function flushRestrictions() {
3026 $this->mRestrictionsLoaded
= false;
3027 $this->mTitleProtection
= null;
3031 * Purge expired restrictions from the page_restrictions table
3033 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
3035 static function purgeExpiredRestrictions() {
3036 if ( wfReadOnly() ) {
3040 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
3041 wfGetDB( DB_MASTER
),
3043 function ( IDatabase
$dbw, $fname ) {
3044 $config = MediaWikiServices
::getInstance()->getMainConfig();
3045 $ids = $dbw->selectFieldValues(
3046 'page_restrictions',
3048 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3050 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
3053 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
3058 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
3059 wfGetDB( DB_MASTER
),
3061 function ( IDatabase
$dbw, $fname ) {
3064 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3072 * Does this have subpages? (Warning, usually requires an extra DB query.)
3076 public function hasSubpages() {
3077 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3082 # We dynamically add a member variable for the purpose of this method
3083 # alone to cache the result. There's no point in having it hanging
3084 # around uninitialized in every Title object; therefore we only add it
3085 # if needed and don't declare it statically.
3086 if ( $this->mHasSubpages
=== null ) {
3087 $this->mHasSubpages
= false;
3088 $subpages = $this->getSubpages( 1 );
3089 if ( $subpages instanceof TitleArray
) {
3090 $this->mHasSubpages
= (bool)$subpages->count();
3094 return $this->mHasSubpages
;
3098 * Get all subpages of this page.
3100 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3101 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3102 * doesn't allow subpages
3104 public function getSubpages( $limit = -1 ) {
3105 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3109 $dbr = wfGetDB( DB_REPLICA
);
3110 $conds['page_namespace'] = $this->getNamespace();
3111 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
3113 if ( $limit > -1 ) {
3114 $options['LIMIT'] = $limit;
3116 $this->mSubpages
= TitleArray
::newFromResult(
3117 $dbr->select( 'page',
3118 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
3124 return $this->mSubpages
;
3128 * Is there a version of this page in the deletion archive?
3130 * @return int The number of archived revisions
3132 public function isDeleted() {
3133 if ( $this->getNamespace() < 0 ) {
3136 $dbr = wfGetDB( DB_REPLICA
);
3138 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3139 [ 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ],
3142 if ( $this->getNamespace() == NS_FILE
) {
3143 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
3144 [ 'fa_name' => $this->getDBkey() ],
3153 * Is there a version of this page in the deletion archive?
3157 public function isDeletedQuick() {
3158 if ( $this->getNamespace() < 0 ) {
3161 $dbr = wfGetDB( DB_REPLICA
);
3162 $deleted = (bool)$dbr->selectField( 'archive', '1',
3163 [ 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ],
3166 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
3167 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3168 [ 'fa_name' => $this->getDBkey() ],
3176 * Get the article ID for this Title from the link cache,
3177 * adding it if necessary
3179 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3181 * @return int The ID
3183 public function getArticleID( $flags = 0 ) {
3184 if ( $this->getNamespace() < 0 ) {
3185 $this->mArticleID
= 0;
3186 return $this->mArticleID
;
3188 $linkCache = LinkCache
::singleton();
3189 if ( $flags & self
::GAID_FOR_UPDATE
) {
3190 $oldUpdate = $linkCache->forUpdate( true );
3191 $linkCache->clearLink( $this );
3192 $this->mArticleID
= $linkCache->addLinkObj( $this );
3193 $linkCache->forUpdate( $oldUpdate );
3195 if ( -1 == $this->mArticleID
) {
3196 $this->mArticleID
= $linkCache->addLinkObj( $this );
3199 return $this->mArticleID
;
3203 * Is this an article that is a redirect page?
3204 * Uses link cache, adding it if necessary
3206 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3209 public function isRedirect( $flags = 0 ) {
3210 if ( !is_null( $this->mRedirect
) ) {
3211 return $this->mRedirect
;
3213 if ( !$this->getArticleID( $flags ) ) {
3214 $this->mRedirect
= false;
3215 return $this->mRedirect
;
3218 $linkCache = LinkCache
::singleton();
3219 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3220 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3221 if ( $cached === null ) {
3222 # Trust LinkCache's state over our own
3223 # LinkCache is telling us that the page doesn't exist, despite there being cached
3224 # data relating to an existing page in $this->mArticleID. Updaters should clear
3225 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3226 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3227 # LinkCache to refresh its data from the master.
3228 $this->mRedirect
= false;
3229 return $this->mRedirect
;
3232 $this->mRedirect
= (bool)$cached;
3234 return $this->mRedirect
;
3238 * What is the length of this page?
3239 * Uses link cache, adding it if necessary
3241 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3244 public function getLength( $flags = 0 ) {
3245 if ( $this->mLength
!= -1 ) {
3246 return $this->mLength
;
3248 if ( !$this->getArticleID( $flags ) ) {
3250 return $this->mLength
;
3252 $linkCache = LinkCache
::singleton();
3253 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3254 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3255 if ( $cached === null ) {
3256 # Trust LinkCache's state over our own, as for isRedirect()
3258 return $this->mLength
;
3261 $this->mLength
= intval( $cached );
3263 return $this->mLength
;
3267 * What is the page_latest field for this page?
3269 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3270 * @return int Int or 0 if the page doesn't exist
3272 public function getLatestRevID( $flags = 0 ) {
3273 if ( !( $flags & Title
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
3274 return intval( $this->mLatestID
);
3276 if ( !$this->getArticleID( $flags ) ) {
3277 $this->mLatestID
= 0;
3278 return $this->mLatestID
;
3280 $linkCache = LinkCache
::singleton();
3281 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3282 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3283 if ( $cached === null ) {
3284 # Trust LinkCache's state over our own, as for isRedirect()
3285 $this->mLatestID
= 0;
3286 return $this->mLatestID
;
3289 $this->mLatestID
= intval( $cached );
3291 return $this->mLatestID
;
3295 * This clears some fields in this object, and clears any associated
3296 * keys in the "bad links" section of the link cache.
3298 * - This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow
3299 * loading of the new page_id. It's also called from
3300 * WikiPage::doDeleteArticleReal()
3302 * @param int $newid The new Article ID
3304 public function resetArticleID( $newid ) {
3305 $linkCache = LinkCache
::singleton();
3306 $linkCache->clearLink( $this );
3308 if ( $newid === false ) {
3309 $this->mArticleID
= -1;
3311 $this->mArticleID
= intval( $newid );
3313 $this->mRestrictionsLoaded
= false;
3314 $this->mRestrictions
= [];
3315 $this->mOldRestrictions
= false;
3316 $this->mRedirect
= null;
3317 $this->mLength
= -1;
3318 $this->mLatestID
= false;
3319 $this->mContentModel
= false;
3320 $this->mEstimateRevisions
= null;
3321 $this->mPageLanguage
= false;
3322 $this->mDbPageLanguage
= false;
3323 $this->mIsBigDeletion
= null;
3326 public static function clearCaches() {
3327 $linkCache = LinkCache
::singleton();
3328 $linkCache->clear();
3330 $titleCache = self
::getTitleCache();
3331 $titleCache->clear();
3335 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3337 * @param string $text Containing title to capitalize
3338 * @param int $ns Namespace index, defaults to NS_MAIN
3339 * @return string Containing capitalized title
3341 public static function capitalize( $text, $ns = NS_MAIN
) {
3344 if ( MWNamespace
::isCapitalized( $ns ) ) {
3345 return $wgContLang->ucfirst( $text );
3352 * Secure and split - main initialisation function for this object
3354 * Assumes that mDbkeyform has been set, and is urldecoded
3355 * and uses underscores, but not otherwise munged. This function
3356 * removes illegal characters, splits off the interwiki and
3357 * namespace prefixes, sets the other forms, and canonicalizes
3360 * @throws MalformedTitleException On invalid titles
3361 * @return bool True on success
3363 private function secureAndSplit() {
3365 $this->mInterwiki
= '';
3366 $this->mFragment
= '';
3367 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
3369 $dbkey = $this->mDbkeyform
;
3371 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3372 // the parsing code with Title, while avoiding massive refactoring.
3373 // @todo: get rid of secureAndSplit, refactor parsing code.
3374 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3375 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3376 $titleCodec = MediaWikiServices
::getInstance()->getTitleParser();
3377 // MalformedTitleException can be thrown here
3378 $parts = $titleCodec->splitTitleString( $dbkey, $this->getDefaultNamespace() );
3381 $this->setFragment( '#' . $parts['fragment'] );
3382 $this->mInterwiki
= $parts['interwiki'];
3383 $this->mLocalInterwiki
= $parts['local_interwiki'];
3384 $this->mNamespace
= $parts['namespace'];
3385 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3387 $this->mDbkeyform
= $parts['dbkey'];
3388 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3389 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );
3391 # We already know that some pages won't be in the database!
3392 if ( $this->isExternal() ||
$this->mNamespace
== NS_SPECIAL
) {
3393 $this->mArticleID
= 0;
3400 * Get an array of Title objects linking to this Title
3401 * Also stores the IDs in the link cache.
3403 * WARNING: do not use this function on arbitrary user-supplied titles!
3404 * On heavily-used templates it will max out the memory.
3406 * @param array $options May be FOR UPDATE
3407 * @param string $table Table name
3408 * @param string $prefix Fields prefix
3409 * @return Title[] Array of Title objects linking here
3411 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3412 if ( count( $options ) > 0 ) {
3413 $db = wfGetDB( DB_MASTER
);
3415 $db = wfGetDB( DB_REPLICA
);
3420 self
::getSelectFields(),
3422 "{$prefix}_from=page_id",
3423 "{$prefix}_namespace" => $this->getNamespace(),
3424 "{$prefix}_title" => $this->getDBkey() ],
3430 if ( $res->numRows() ) {
3431 $linkCache = LinkCache
::singleton();
3432 foreach ( $res as $row ) {
3433 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
3435 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3436 $retVal[] = $titleObj;
3444 * Get an array of Title objects using this Title as a template
3445 * Also stores the IDs in the link cache.
3447 * WARNING: do not use this function on arbitrary user-supplied titles!
3448 * On heavily-used templates it will max out the memory.
3450 * @param array $options Query option to Database::select()
3451 * @return Title[] Array of Title the Title objects linking here
3453 public function getTemplateLinksTo( $options = [] ) {
3454 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3458 * Get an array of Title objects linked from this Title
3459 * Also stores the IDs in the link cache.
3461 * WARNING: do not use this function on arbitrary user-supplied titles!
3462 * On heavily-used templates it will max out the memory.
3464 * @param array $options Query option to Database::select()
3465 * @param string $table Table name
3466 * @param string $prefix Fields prefix
3467 * @return array Array of Title objects linking here
3469 public function getLinksFrom( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3470 $id = $this->getArticleID();
3472 # If the page doesn't exist; there can't be any link from this page
3477 $db = wfGetDB( DB_REPLICA
);
3479 $blNamespace = "{$prefix}_namespace";
3480 $blTitle = "{$prefix}_title";
3485 [ $blNamespace, $blTitle ],
3486 WikiPage
::selectFields()
3488 [ "{$prefix}_from" => $id ],
3493 [ "page_namespace=$blNamespace", "page_title=$blTitle" ]
3498 $linkCache = LinkCache
::singleton();
3499 foreach ( $res as $row ) {
3500 if ( $row->page_id
) {
3501 $titleObj = Title
::newFromRow( $row );
3503 $titleObj = Title
::makeTitle( $row->$blNamespace, $row->$blTitle );
3504 $linkCache->addBadLinkObj( $titleObj );
3506 $retVal[] = $titleObj;
3513 * Get an array of Title objects used on this Title as a template
3514 * Also stores the IDs in the link cache.
3516 * WARNING: do not use this function on arbitrary user-supplied titles!
3517 * On heavily-used templates it will max out the memory.
3519 * @param array $options May be FOR UPDATE
3520 * @return Title[] Array of Title the Title objects used here
3522 public function getTemplateLinksFrom( $options = [] ) {
3523 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3527 * Get an array of Title objects referring to non-existent articles linked
3530 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3531 * should use redirect table in this case).
3532 * @return Title[] Array of Title the Title objects
3534 public function getBrokenLinksFrom() {
3535 if ( $this->getArticleID() == 0 ) {
3536 # All links from article ID 0 are false positives
3540 $dbr = wfGetDB( DB_REPLICA
);
3541 $res = $dbr->select(
3542 [ 'page', 'pagelinks' ],
3543 [ 'pl_namespace', 'pl_title' ],
3545 'pl_from' => $this->getArticleID(),
3546 'page_namespace IS NULL'
3552 [ 'pl_namespace=page_namespace', 'pl_title=page_title' ]
3558 foreach ( $res as $row ) {
3559 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3565 * Get a list of URLs to purge from the CDN cache when this
3568 * @return string[] Array of String the URLs
3570 public function getCdnUrls() {
3572 $this->getInternalURL(),
3573 $this->getInternalURL( 'action=history' )
3576 $pageLang = $this->getPageLanguage();
3577 if ( $pageLang->hasVariants() ) {
3578 $variants = $pageLang->getVariants();
3579 foreach ( $variants as $vCode ) {
3580 $urls[] = $this->getInternalURL( $vCode );
3584 // If we are looking at a css/js user subpage, purge the action=raw.
3585 if ( $this->isJsSubpage() ) {
3586 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/javascript' );
3587 } elseif ( $this->isCssSubpage() ) {
3588 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/css' );
3591 Hooks
::run( 'TitleSquidURLs', [ $this, &$urls ] );
3596 * @deprecated since 1.27 use getCdnUrls()
3598 public function getSquidURLs() {
3599 return $this->getCdnUrls();
3603 * Purge all applicable CDN URLs
3605 public function purgeSquid() {
3606 DeferredUpdates
::addUpdate(
3607 new CdnCacheUpdate( $this->getCdnUrls() ),
3608 DeferredUpdates
::PRESEND
3613 * Check whether a given move operation would be valid.
3614 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3616 * @deprecated since 1.25, use MovePage's methods instead
3617 * @param Title $nt The new title
3618 * @param bool $auth Whether to check user permissions (uses $wgUser)
3619 * @param string $reason Is the log summary of the move, used for spam checking
3620 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3622 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3625 if ( !( $nt instanceof Title
) ) {
3626 // Normally we'd add this to $errors, but we'll get
3627 // lots of syntax errors if $nt is not an object
3628 return [ [ 'badtitletext' ] ];
3631 $mp = new MovePage( $this, $nt );
3632 $errors = $mp->isValidMove()->getErrorsArray();
3634 $errors = wfMergeErrorArrays(
3636 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
3640 return $errors ?
: true;
3644 * Check if the requested move target is a valid file move target
3645 * @todo move this to MovePage
3646 * @param Title $nt Target title
3647 * @return array List of errors
3649 protected function validateFileMoveOperation( $nt ) {
3654 $destFile = wfLocalFile( $nt );
3655 $destFile->load( File
::READ_LATEST
);
3656 if ( !$wgUser->isAllowed( 'reupload-shared' )
3657 && !$destFile->exists() && wfFindFile( $nt )
3659 $errors[] = [ 'file-exists-sharedrepo' ];
3666 * Move a title to a new location
3668 * @deprecated since 1.25, use the MovePage class instead
3669 * @param Title $nt The new title
3670 * @param bool $auth Indicates whether $wgUser's permissions
3672 * @param string $reason The reason for the move
3673 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3674 * Ignored if the user doesn't have the suppressredirect right.
3675 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3676 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3678 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true,
3679 array $changeTags = [] ) {
3682 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3683 if ( is_array( $err ) ) {
3684 // Auto-block user's IP if the account was "hard" blocked
3685 $wgUser->spreadAnyEditBlock();
3688 // Check suppressredirect permission
3689 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3690 $createRedirect = true;
3693 $mp = new MovePage( $this, $nt );
3694 $status = $mp->move( $wgUser, $reason, $createRedirect, $changeTags );
3695 if ( $status->isOK() ) {
3698 return $status->getErrorsArray();
3703 * Move this page's subpages to be subpages of $nt
3705 * @param Title $nt Move target
3706 * @param bool $auth Whether $wgUser's permissions should be checked
3707 * @param string $reason The reason for the move
3708 * @param bool $createRedirect Whether to create redirects from the old subpages to
3709 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3710 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3711 * @return array Array with old page titles as keys, and strings (new page titles) or
3712 * getUserPermissionsErrors()-like arrays (errors) as values, or a
3713 * getUserPermissionsErrors()-like error array with numeric indices if
3714 * no pages were moved
3716 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true,
3717 array $changeTags = [] ) {
3719 global $wgMaximumMovedPages;
3720 // Check permissions
3721 if ( !$this->userCan( 'move-subpages' ) ) {
3723 [ 'cant-move-subpages' ],
3726 // Do the source and target namespaces support subpages?
3727 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3729 [ 'namespace-nosubpages', MWNamespace
::getCanonicalName( $this->getNamespace() ) ],
3732 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3734 [ 'namespace-nosubpages', MWNamespace
::getCanonicalName( $nt->getNamespace() ) ],
3738 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3741 foreach ( $subpages as $oldSubpage ) {
3743 if ( $count > $wgMaximumMovedPages ) {
3744 $retval[$oldSubpage->getPrefixedText()] = [
3745 [ 'movepage-max-pages', $wgMaximumMovedPages ],
3750 // We don't know whether this function was called before
3751 // or after moving the root page, so check both
3753 if ( $oldSubpage->getArticleID() == $this->getArticleID()
3754 ||
$oldSubpage->getArticleID() == $nt->getArticleID()
3756 // When moving a page to a subpage of itself,
3757 // don't move it twice
3760 $newPageName = preg_replace(
3761 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3762 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3763 $oldSubpage->getDBkey() );
3764 if ( $oldSubpage->isTalkPage() ) {
3765 $newNs = $nt->getTalkPage()->getNamespace();
3767 $newNs = $nt->getSubjectPage()->getNamespace();
3769 # Bug 14385: we need makeTitleSafe because the new page names may
3770 # be longer than 255 characters.
3771 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3773 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect, $changeTags );
3774 if ( $success === true ) {
3775 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3777 $retval[$oldSubpage->getPrefixedText()] = $success;
3784 * Checks if this page is just a one-rev redirect.
3785 * Adds lock, so don't use just for light purposes.
3789 public function isSingleRevRedirect() {
3790 global $wgContentHandlerUseDB;
3792 $dbw = wfGetDB( DB_MASTER
);
3795 $fields = [ 'page_is_redirect', 'page_latest', 'page_id' ];
3796 if ( $wgContentHandlerUseDB ) {
3797 $fields[] = 'page_content_model';
3800 $row = $dbw->selectRow( 'page',
3806 # Cache some fields we may want
3807 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3808 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3809 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3810 $this->mContentModel
= $row && isset( $row->page_content_model
)
3811 ?
strval( $row->page_content_model
)
3814 if ( !$this->mRedirect
) {
3817 # Does the article have a history?
3818 $row = $dbw->selectField( [ 'page', 'revision' ],
3820 [ 'page_namespace' => $this->getNamespace(),
3821 'page_title' => $this->getDBkey(),
3823 'page_latest != rev_id'
3828 # Return true if there was no history
3829 return ( $row === false );
3833 * Checks if $this can be moved to a given Title
3834 * - Selects for update, so don't call it unless you mean business
3836 * @deprecated since 1.25, use MovePage's methods instead
3837 * @param Title $nt The new title to check
3840 public function isValidMoveTarget( $nt ) {
3841 # Is it an existing file?
3842 if ( $nt->getNamespace() == NS_FILE
) {
3843 $file = wfLocalFile( $nt );
3844 $file->load( File
::READ_LATEST
);
3845 if ( $file->exists() ) {
3846 wfDebug( __METHOD__
. ": file exists\n" );
3850 # Is it a redirect with no history?
3851 if ( !$nt->isSingleRevRedirect() ) {
3852 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3855 # Get the article text
3856 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
3857 if ( !is_object( $rev ) ) {
3860 $content = $rev->getContent();
3861 # Does the redirect point to the source?
3862 # Or is it a broken self-redirect, usually caused by namespace collisions?
3863 $redirTitle = $content ?
$content->getRedirectTarget() : null;
3865 if ( $redirTitle ) {
3866 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3867 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3868 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3874 # Fail safe (not a redirect after all. strange.)
3875 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
3876 " is a redirect, but it doesn't contain a valid redirect.\n" );
3882 * Get categories to which this Title belongs and return an array of
3883 * categories' names.
3885 * @return array Array of parents in the form:
3886 * $parent => $currentarticle
3888 public function getParentCategories() {
3893 $titleKey = $this->getArticleID();
3895 if ( $titleKey === 0 ) {
3899 $dbr = wfGetDB( DB_REPLICA
);
3901 $res = $dbr->select(
3904 [ 'cl_from' => $titleKey ],
3908 if ( $res->numRows() > 0 ) {
3909 foreach ( $res as $row ) {
3910 // $data[] = Title::newFromText($wgContLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
3911 $data[$wgContLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3918 * Get a tree of parent categories
3920 * @param array $children Array with the children in the keys, to check for circular refs
3921 * @return array Tree of parent categories
3923 public function getParentCategoryTree( $children = [] ) {
3925 $parents = $this->getParentCategories();
3928 foreach ( $parents as $parent => $current ) {
3929 if ( array_key_exists( $parent, $children ) ) {
3930 # Circular reference
3931 $stack[$parent] = [];
3933 $nt = Title
::newFromText( $parent );
3935 $stack[$parent] = $nt->getParentCategoryTree( $children +
[ $parent => 1 ] );
3945 * Get an associative array for selecting this title from
3948 * @return array Array suitable for the $where parameter of DB::select()
3950 public function pageCond() {
3951 if ( $this->mArticleID
> 0 ) {
3952 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3953 return [ 'page_id' => $this->mArticleID
];
3955 return [ 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
];
3960 * Get the revision ID of the previous revision
3962 * @param int $revId Revision ID. Get the revision that was before this one.
3963 * @param int $flags Title::GAID_FOR_UPDATE
3964 * @return int|bool Old revision ID, or false if none exists
3966 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3967 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
3968 $revId = $db->selectField( 'revision', 'rev_id',
3970 'rev_page' => $this->getArticleID( $flags ),
3971 'rev_id < ' . intval( $revId )
3974 [ 'ORDER BY' => 'rev_id DESC' ]
3977 if ( $revId === false ) {
3980 return intval( $revId );
3985 * Get the revision ID of the next revision
3987 * @param int $revId Revision ID. Get the revision that was after this one.
3988 * @param int $flags Title::GAID_FOR_UPDATE
3989 * @return int|bool Next revision ID, or false if none exists
3991 public function getNextRevisionID( $revId, $flags = 0 ) {
3992 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
3993 $revId = $db->selectField( 'revision', 'rev_id',
3995 'rev_page' => $this->getArticleID( $flags ),
3996 'rev_id > ' . intval( $revId )
3999 [ 'ORDER BY' => 'rev_id' ]
4002 if ( $revId === false ) {
4005 return intval( $revId );
4010 * Get the first revision of the page
4012 * @param int $flags Title::GAID_FOR_UPDATE
4013 * @return Revision|null If page doesn't exist
4015 public function getFirstRevision( $flags = 0 ) {
4016 $pageId = $this->getArticleID( $flags );
4018 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
4019 $row = $db->selectRow( 'revision', Revision
::selectFields(),
4020 [ 'rev_page' => $pageId ],
4022 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 ]
4025 return new Revision( $row );
4032 * Get the oldest revision timestamp of this page
4034 * @param int $flags Title::GAID_FOR_UPDATE
4035 * @return string MW timestamp
4037 public function getEarliestRevTime( $flags = 0 ) {
4038 $rev = $this->getFirstRevision( $flags );
4039 return $rev ?
$rev->getTimestamp() : null;
4043 * Check if this is a new page
4047 public function isNewPage() {
4048 $dbr = wfGetDB( DB_REPLICA
);
4049 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4053 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4057 public function isBigDeletion() {
4058 global $wgDeleteRevisionsLimit;
4060 if ( !$wgDeleteRevisionsLimit ) {
4064 if ( $this->mIsBigDeletion
=== null ) {
4065 $dbr = wfGetDB( DB_REPLICA
);
4067 $revCount = $dbr->selectRowCount(
4070 [ 'rev_page' => $this->getArticleID() ],
4072 [ 'LIMIT' => $wgDeleteRevisionsLimit +
1 ]
4075 $this->mIsBigDeletion
= $revCount > $wgDeleteRevisionsLimit;
4078 return $this->mIsBigDeletion
;
4082 * Get the approximate revision count of this page.
4086 public function estimateRevisionCount() {
4087 if ( !$this->exists() ) {
4091 if ( $this->mEstimateRevisions
=== null ) {
4092 $dbr = wfGetDB( DB_REPLICA
);
4093 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4094 [ 'rev_page' => $this->getArticleID() ], __METHOD__
);
4097 return $this->mEstimateRevisions
;
4101 * Get the number of revisions between the given revision.
4102 * Used for diffs and other things that really need it.
4104 * @param int|Revision $old Old revision or rev ID (first before range)
4105 * @param int|Revision $new New revision or rev ID (first after range)
4106 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4107 * @return int Number of revisions between these revisions.
4109 public function countRevisionsBetween( $old, $new, $max = null ) {
4110 if ( !( $old instanceof Revision
) ) {
4111 $old = Revision
::newFromTitle( $this, (int)$old );
4113 if ( !( $new instanceof Revision
) ) {
4114 $new = Revision
::newFromTitle( $this, (int)$new );
4116 if ( !$old ||
!$new ) {
4117 return 0; // nothing to compare
4119 $dbr = wfGetDB( DB_REPLICA
);
4121 'rev_page' => $this->getArticleID(),
4122 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4123 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4125 if ( $max !== null ) {
4126 return $dbr->selectRowCount( 'revision', '1',
4129 [ 'LIMIT' => $max +
1 ] // extra to detect truncation
4132 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
4137 * Get the authors between the given revisions or revision IDs.
4138 * Used for diffs and other things that really need it.
4142 * @param int|Revision $old Old revision or rev ID (first before range by default)
4143 * @param int|Revision $new New revision or rev ID (first after range by default)
4144 * @param int $limit Maximum number of authors
4145 * @param string|array $options (Optional): Single option, or an array of options:
4146 * 'include_old' Include $old in the range; $new is excluded.
4147 * 'include_new' Include $new in the range; $old is excluded.
4148 * 'include_both' Include both $old and $new in the range.
4149 * Unknown option values are ignored.
4150 * @return array|null Names of revision authors in the range; null if not both revisions exist
4152 public function getAuthorsBetween( $old, $new, $limit, $options = [] ) {
4153 if ( !( $old instanceof Revision
) ) {
4154 $old = Revision
::newFromTitle( $this, (int)$old );
4156 if ( !( $new instanceof Revision
) ) {
4157 $new = Revision
::newFromTitle( $this, (int)$new );
4159 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4160 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4161 // in the sanity check below?
4162 if ( !$old ||
!$new ) {
4163 return null; // nothing to compare
4168 $options = (array)$options;
4169 if ( in_array( 'include_old', $options ) ) {
4172 if ( in_array( 'include_new', $options ) ) {
4175 if ( in_array( 'include_both', $options ) ) {
4179 // No DB query needed if $old and $new are the same or successive revisions:
4180 if ( $old->getId() === $new->getId() ) {
4181 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
4183 [ $old->getUserText( Revision
::RAW
) ];
4184 } elseif ( $old->getId() === $new->getParentId() ) {
4185 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4186 $authors[] = $old->getUserText( Revision
::RAW
);
4187 if ( $old->getUserText( Revision
::RAW
) != $new->getUserText( Revision
::RAW
) ) {
4188 $authors[] = $new->getUserText( Revision
::RAW
);
4190 } elseif ( $old_cmp === '>=' ) {
4191 $authors[] = $old->getUserText( Revision
::RAW
);
4192 } elseif ( $new_cmp === '<=' ) {
4193 $authors[] = $new->getUserText( Revision
::RAW
);
4197 $dbr = wfGetDB( DB_REPLICA
);
4198 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4200 'rev_page' => $this->getArticleID(),
4201 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4202 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4204 [ 'LIMIT' => $limit +
1 ] // add one so caller knows it was truncated
4206 foreach ( $res as $row ) {
4207 $authors[] = $row->rev_user_text
;
4213 * Get the number of authors between the given revisions or revision IDs.
4214 * Used for diffs and other things that really need it.
4216 * @param int|Revision $old Old revision or rev ID (first before range by default)
4217 * @param int|Revision $new New revision or rev ID (first after range by default)
4218 * @param int $limit Maximum number of authors
4219 * @param string|array $options (Optional): Single option, or an array of options:
4220 * 'include_old' Include $old in the range; $new is excluded.
4221 * 'include_new' Include $new in the range; $old is excluded.
4222 * 'include_both' Include both $old and $new in the range.
4223 * Unknown option values are ignored.
4224 * @return int Number of revision authors in the range; zero if not both revisions exist
4226 public function countAuthorsBetween( $old, $new, $limit, $options = [] ) {
4227 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4228 return $authors ?
count( $authors ) : 0;
4232 * Compare with another title.
4234 * @param Title $title
4237 public function equals( Title
$title ) {
4238 // Note: === is necessary for proper matching of number-like titles.
4239 return $this->getInterwiki() === $title->getInterwiki()
4240 && $this->getNamespace() == $title->getNamespace()
4241 && $this->getDBkey() === $title->getDBkey();
4245 * Check if this title is a subpage of another title
4247 * @param Title $title
4250 public function isSubpageOf( Title
$title ) {
4251 return $this->getInterwiki() === $title->getInterwiki()
4252 && $this->getNamespace() == $title->getNamespace()
4253 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4257 * Check if page exists. For historical reasons, this function simply
4258 * checks for the existence of the title in the page table, and will
4259 * thus return false for interwiki links, special pages and the like.
4260 * If you want to know if a title can be meaningfully viewed, you should
4261 * probably call the isKnown() method instead.
4263 * @param int $flags An optional bit field; may be Title::GAID_FOR_UPDATE to check
4264 * from master/for update
4267 public function exists( $flags = 0 ) {
4268 $exists = $this->getArticleID( $flags ) != 0;
4269 Hooks
::run( 'TitleExists', [ $this, &$exists ] );
4274 * Should links to this title be shown as potentially viewable (i.e. as
4275 * "bluelinks"), even if there's no record by this title in the page
4278 * This function is semi-deprecated for public use, as well as somewhat
4279 * misleadingly named. You probably just want to call isKnown(), which
4280 * calls this function internally.
4282 * (ISSUE: Most of these checks are cheap, but the file existence check
4283 * can potentially be quite expensive. Including it here fixes a lot of
4284 * existing code, but we might want to add an optional parameter to skip
4285 * it and any other expensive checks.)
4289 public function isAlwaysKnown() {
4293 * Allows overriding default behavior for determining if a page exists.
4294 * If $isKnown is kept as null, regular checks happen. If it's
4295 * a boolean, this value is returned by the isKnown method.
4299 * @param Title $title
4300 * @param bool|null $isKnown
4302 Hooks
::run( 'TitleIsAlwaysKnown', [ $this, &$isKnown ] );
4304 if ( !is_null( $isKnown ) ) {
4308 if ( $this->isExternal() ) {
4309 return true; // any interwiki link might be viewable, for all we know
4312 switch ( $this->mNamespace
) {
4315 // file exists, possibly in a foreign repo
4316 return (bool)wfFindFile( $this );
4318 // valid special page
4319 return SpecialPageFactory
::exists( $this->getDBkey() );
4321 // selflink, possibly with fragment
4322 return $this->mDbkeyform
== '';
4324 // known system message
4325 return $this->hasSourceText() !== false;
4332 * Does this title refer to a page that can (or might) be meaningfully
4333 * viewed? In particular, this function may be used to determine if
4334 * links to the title should be rendered as "bluelinks" (as opposed to
4335 * "redlinks" to non-existent pages).
4336 * Adding something else to this function will cause inconsistency
4337 * since LinkHolderArray calls isAlwaysKnown() and does its own
4338 * page existence check.
4342 public function isKnown() {
4343 return $this->isAlwaysKnown() ||
$this->exists();
4347 * Does this page have source text?
4351 public function hasSourceText() {
4352 if ( $this->exists() ) {
4356 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4357 // If the page doesn't exist but is a known system message, default
4358 // message content will be displayed, same for language subpages-
4359 // Use always content language to avoid loading hundreds of languages
4360 // to get the link color.
4362 list( $name, ) = MessageCache
::singleton()->figureMessage(
4363 $wgContLang->lcfirst( $this->getText() )
4365 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4366 return $message->exists();
4373 * Get the default message text or false if the message doesn't exist
4375 * @return string|bool
4377 public function getDefaultMessageText() {
4380 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
4384 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4385 $wgContLang->lcfirst( $this->getText() )
4387 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4389 if ( $message->exists() ) {
4390 return $message->plain();
4397 * Updates page_touched for this page; called from LinksUpdate.php
4399 * @param string $purgeTime [optional] TS_MW timestamp
4400 * @return bool True if the update succeeded
4402 public function invalidateCache( $purgeTime = null ) {
4403 if ( wfReadOnly() ) {
4405 } elseif ( $this->mArticleID
=== 0 ) {
4406 return true; // avoid gap locking if we know it's not there
4409 $dbw = wfGetDB( DB_MASTER
);
4410 $dbw->onTransactionPreCommitOrIdle( function () {
4411 ResourceLoaderWikiModule
::invalidateModuleCache( $this, null, null, wfWikiID() );
4414 $conds = $this->pageCond();
4415 DeferredUpdates
::addUpdate(
4416 new AutoCommitUpdate(
4419 function ( IDatabase
$dbw, $fname ) use ( $conds, $purgeTime ) {
4420 $dbTimestamp = $dbw->timestamp( $purgeTime ?
: time() );
4423 [ 'page_touched' => $dbTimestamp ],
4424 $conds +
[ 'page_touched < ' . $dbw->addQuotes( $dbTimestamp ) ],
4427 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $this );
4430 DeferredUpdates
::PRESEND
4437 * Update page_touched timestamps and send CDN purge messages for
4438 * pages linking to this title. May be sent to the job queue depending
4439 * on the number of links. Typically called on create and delete.
4441 public function touchLinks() {
4442 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this, 'pagelinks' ) );
4443 if ( $this->getNamespace() == NS_CATEGORY
) {
4444 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this, 'categorylinks' ) );
4449 * Get the last touched timestamp
4451 * @param IDatabase $db Optional db
4452 * @return string|false Last-touched timestamp
4454 public function getTouched( $db = null ) {
4455 if ( $db === null ) {
4456 $db = wfGetDB( DB_REPLICA
);
4458 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4463 * Get the timestamp when this page was updated since the user last saw it.
4466 * @return string|null
4468 public function getNotificationTimestamp( $user = null ) {
4471 // Assume current user if none given
4475 // Check cache first
4476 $uid = $user->getId();
4480 // avoid isset here, as it'll return false for null entries
4481 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4482 return $this->mNotificationTimestamp
[$uid];
4484 // Don't cache too much!
4485 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4486 $this->mNotificationTimestamp
= [];
4489 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
4490 $watchedItem = $store->getWatchedItem( $user, $this );
4491 if ( $watchedItem ) {
4492 $this->mNotificationTimestamp
[$uid] = $watchedItem->getNotificationTimestamp();
4494 $this->mNotificationTimestamp
[$uid] = false;
4497 return $this->mNotificationTimestamp
[$uid];
4501 * Generate strings used for xml 'id' names in monobook tabs
4503 * @param string $prepend Defaults to 'nstab-'
4504 * @return string XML 'id' name
4506 public function getNamespaceKey( $prepend = 'nstab-' ) {
4508 // Gets the subject namespace if this title
4509 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4510 // Checks if canonical namespace name exists for namespace
4511 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4512 // Uses canonical namespace name
4513 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4515 // Uses text of namespace
4516 $namespaceKey = $this->getSubjectNsText();
4518 // Makes namespace key lowercase
4519 $namespaceKey = $wgContLang->lc( $namespaceKey );
4521 if ( $namespaceKey == '' ) {
4522 $namespaceKey = 'main';
4524 // Changes file to image for backwards compatibility
4525 if ( $namespaceKey == 'file' ) {
4526 $namespaceKey = 'image';
4528 return $prepend . $namespaceKey;
4532 * Get all extant redirects to this Title
4534 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4535 * @return Title[] Array of Title redirects to this title
4537 public function getRedirectsHere( $ns = null ) {
4540 $dbr = wfGetDB( DB_REPLICA
);
4542 'rd_namespace' => $this->getNamespace(),
4543 'rd_title' => $this->getDBkey(),
4546 if ( $this->isExternal() ) {
4547 $where['rd_interwiki'] = $this->getInterwiki();
4549 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4551 if ( !is_null( $ns ) ) {
4552 $where['page_namespace'] = $ns;
4555 $res = $dbr->select(
4556 [ 'redirect', 'page' ],
4557 [ 'page_namespace', 'page_title' ],
4562 foreach ( $res as $row ) {
4563 $redirs[] = self
::newFromRow( $row );
4569 * Check if this Title is a valid redirect target
4573 public function isValidRedirectTarget() {
4574 global $wgInvalidRedirectTargets;
4576 if ( $this->isSpecialPage() ) {
4577 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4578 if ( $this->isSpecial( 'Userlogout' ) ) {
4582 foreach ( $wgInvalidRedirectTargets as $target ) {
4583 if ( $this->isSpecial( $target ) ) {
4593 * Get a backlink cache object
4595 * @return BacklinkCache
4597 public function getBacklinkCache() {
4598 return BacklinkCache
::get( $this );
4602 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4606 public function canUseNoindex() {
4607 global $wgExemptFromUserRobotsControl;
4609 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4610 ? MWNamespace
::getContentNamespaces()
4611 : $wgExemptFromUserRobotsControl;
4613 return !in_array( $this->mNamespace
, $bannedNamespaces );
4617 * Returns the raw sort key to be used for categories, with the specified
4618 * prefix. This will be fed to Collation::getSortKey() to get a
4619 * binary sortkey that can be used for actual sorting.
4621 * @param string $prefix The prefix to be used, specified using
4622 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4626 public function getCategorySortkey( $prefix = '' ) {
4627 $unprefixed = $this->getText();
4629 // Anything that uses this hook should only depend
4630 // on the Title object passed in, and should probably
4631 // tell the users to run updateCollations.php --force
4632 // in order to re-sort existing category relations.
4633 Hooks
::run( 'GetDefaultSortkey', [ $this, &$unprefixed ] );
4634 if ( $prefix !== '' ) {
4635 # Separate with a line feed, so the unprefixed part is only used as
4636 # a tiebreaker when two pages have the exact same prefix.
4637 # In UCA, tab is the only character that can sort above LF
4638 # so we strip both of them from the original prefix.
4639 $prefix = strtr( $prefix, "\n\t", ' ' );
4640 return "$prefix\n$unprefixed";
4646 * Returns the page language code saved in the database, if $wgPageLanguageUseDB is set
4647 * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
4648 * the db, it will return NULL.
4650 * @return string|null|bool
4652 private function getDbPageLanguageCode() {
4653 global $wgPageLanguageUseDB;
4655 // check, if the page language could be saved in the database, and if so and
4656 // the value is not requested already, lookup the page language using LinkCache
4657 if ( $wgPageLanguageUseDB && $this->mDbPageLanguage
=== false ) {
4658 $linkCache = LinkCache
::singleton();
4659 $linkCache->addLinkObj( $this );
4660 $this->mDbPageLanguage
= $linkCache->getGoodLinkFieldObj( $this, 'lang' );
4663 return $this->mDbPageLanguage
;
4667 * Get the language in which the content of this page is written in
4668 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4669 * e.g. $wgLang (such as special pages, which are in the user language).
4674 public function getPageLanguage() {
4675 global $wgLang, $wgLanguageCode;
4676 if ( $this->isSpecialPage() ) {
4677 // special pages are in the user language
4681 // Checking if DB language is set
4682 $dbPageLanguage = $this->getDbPageLanguageCode();
4683 if ( $dbPageLanguage ) {
4684 return wfGetLangObj( $dbPageLanguage );
4687 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
4688 // Note that this may depend on user settings, so the cache should
4689 // be only per-request.
4690 // NOTE: ContentHandler::getPageLanguage() may need to load the
4691 // content to determine the page language!
4692 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4694 $contentHandler = ContentHandler
::getForTitle( $this );
4695 $langObj = $contentHandler->getPageLanguage( $this );
4696 $this->mPageLanguage
= [ $langObj->getCode(), $wgLanguageCode ];
4698 $langObj = wfGetLangObj( $this->mPageLanguage
[0] );
4705 * Get the language in which the content of this page is written when
4706 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4707 * e.g. $wgLang (such as special pages, which are in the user language).
4712 public function getPageViewLanguage() {
4715 if ( $this->isSpecialPage() ) {
4716 // If the user chooses a variant, the content is actually
4717 // in a language whose code is the variant code.
4718 $variant = $wgLang->getPreferredVariant();
4719 if ( $wgLang->getCode() !== $variant ) {
4720 return Language
::factory( $variant );
4726 // Checking if DB language is set
4727 $dbPageLanguage = $this->getDbPageLanguageCode();
4728 if ( $dbPageLanguage ) {
4729 $pageLang = wfGetLangObj( $dbPageLanguage );
4730 $variant = $pageLang->getPreferredVariant();
4731 if ( $pageLang->getCode() !== $variant ) {
4732 $pageLang = Language
::factory( $variant );
4738 // @note Can't be cached persistently, depends on user settings.
4739 // @note ContentHandler::getPageViewLanguage() may need to load the
4740 // content to determine the page language!
4741 $contentHandler = ContentHandler
::getForTitle( $this );
4742 $pageLang = $contentHandler->getPageViewLanguage( $this );
4747 * Get a list of rendered edit notices for this page.
4749 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4750 * they will already be wrapped in paragraphs.
4753 * @param int $oldid Revision ID that's being edited
4756 public function getEditNotices( $oldid = 0 ) {
4759 // Optional notice for the entire namespace
4760 $editnotice_ns = 'editnotice-' . $this->getNamespace();
4761 $msg = wfMessage( $editnotice_ns );
4762 if ( $msg->exists() ) {
4763 $html = $msg->parseAsBlock();
4764 // Edit notices may have complex logic, but output nothing (T91715)
4765 if ( trim( $html ) !== '' ) {
4766 $notices[$editnotice_ns] = Html
::rawElement(
4770 'mw-editnotice-namespace',
4771 Sanitizer
::escapeClass( "mw-$editnotice_ns" )
4778 if ( MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
4779 // Optional notice for page itself and any parent page
4780 $parts = explode( '/', $this->getDBkey() );
4781 $editnotice_base = $editnotice_ns;
4782 while ( count( $parts ) > 0 ) {
4783 $editnotice_base .= '-' . array_shift( $parts );
4784 $msg = wfMessage( $editnotice_base );
4785 if ( $msg->exists() ) {
4786 $html = $msg->parseAsBlock();
4787 if ( trim( $html ) !== '' ) {
4788 $notices[$editnotice_base] = Html
::rawElement(
4792 'mw-editnotice-base',
4793 Sanitizer
::escapeClass( "mw-$editnotice_base" )
4801 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
4802 $editnoticeText = $editnotice_ns . '-' . strtr( $this->getDBkey(), '/', '-' );
4803 $msg = wfMessage( $editnoticeText );
4804 if ( $msg->exists() ) {
4805 $html = $msg->parseAsBlock();
4806 if ( trim( $html ) !== '' ) {
4807 $notices[$editnoticeText] = Html
::rawElement(
4811 'mw-editnotice-page',
4812 Sanitizer
::escapeClass( "mw-$editnoticeText" )
4820 Hooks
::run( 'TitleGetEditNotices', [ $this, $oldid, &$notices ] );
4827 public function __sleep() {
4835 'mDefaultNamespace',
4839 public function __wakeup() {
4840 $this->mArticleID
= ( $this->mNamespace
>= 0 ) ?
-1 : 0;
4841 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
4842 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );