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
25 use Wikimedia\Rdbms\Database
;
26 use Wikimedia\Rdbms\IDatabase
;
27 use MediaWiki\Linker\LinkTarget
;
28 use MediaWiki\Interwiki\InterwikiLookup
;
29 use MediaWiki\MediaWikiServices
;
32 * Represents a title within MediaWiki.
33 * Optionally may contain an interwiki designation or namespace.
34 * @note This class can fetch various kinds of data from the database;
35 * however, it does so inefficiently.
36 * @note Consider using a TitleValue object instead. TitleValue is more lightweight
37 * and does not rely on global state or the database.
39 class Title
implements LinkTarget
, IDBAccessObject
{
40 /** @var MapCacheLRU|null */
41 private static $titleCache = null;
44 * Title::newFromText maintains a cache to avoid expensive re-normalization of
45 * commonly used titles. On a batch operation this can become a memory leak
46 * if not bounded. After hitting this many titles reset the cache.
48 const CACHE_MAX
= 1000;
51 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
52 * to use the master DB
54 const GAID_FOR_UPDATE
= 1;
57 * @name Private member variables
58 * Please use the accessor functions instead.
63 /** @var string Text form (spaces not underscores) of the main part */
64 public $mTextform = '';
66 /** @var string URL-encoded form of the main part */
67 public $mUrlform = '';
69 /** @var string Main part with underscores */
70 public $mDbkeyform = '';
72 /** @var string Database key with the initial letter in the case specified by the user */
73 protected $mUserCaseDBKey;
75 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
76 public $mNamespace = NS_MAIN
;
78 /** @var string Interwiki prefix */
79 public $mInterwiki = '';
81 /** @var bool Was this Title created from a string with a local interwiki prefix? */
82 private $mLocalInterwiki = false;
84 /** @var string Title fragment (i.e. the bit after the #) */
85 public $mFragment = '';
87 /** @var int Article ID, fetched from the link cache on demand */
88 public $mArticleID = -1;
90 /** @var bool|int ID of most recent revision */
91 protected $mLatestID = false;
94 * @var bool|string ID of the page's content model, i.e. one of the
95 * CONTENT_MODEL_XXX constants
97 private $mContentModel = false;
100 * @var bool If a content model was forced via setContentModel()
101 * this will be true to avoid having other code paths reset it
103 private $mForcedContentModel = false;
105 /** @var int Estimated number of revisions; null of not loaded */
106 private $mEstimateRevisions;
108 /** @var array Array of groups allowed to edit this article */
109 public $mRestrictions = [];
112 * @var string|bool Comma-separated set of permission keys
113 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
114 * Edit and move sections are separated by a colon
115 * Example: "edit=autoconfirmed,sysop:move=sysop"
117 protected $mOldRestrictions = false;
119 /** @var bool Cascade restrictions on this page to included templates and images? */
120 public $mCascadeRestriction;
122 /** Caching the results of getCascadeProtectionSources */
123 public $mCascadingRestrictions;
125 /** @var array When do the restrictions on this page expire? */
126 protected $mRestrictionsExpiry = [];
128 /** @var bool Are cascading restrictions in effect on this page? */
129 protected $mHasCascadingRestrictions;
131 /** @var array Where are the cascading restrictions coming from on this page? */
132 public $mCascadeSources;
134 /** @var bool Boolean for initialisation on demand */
135 public $mRestrictionsLoaded = false;
138 * Text form including namespace/interwiki, initialised on demand
140 * Only public to share cache with TitleFormatter
145 public $prefixedText = null;
147 /** @var mixed Cached value for getTitleProtection (create protection) */
148 public $mTitleProtection;
151 * @var int Namespace index when there is no namespace. Don't change the
152 * following default, NS_MAIN is hardcoded in several places. See T2696.
153 * Zero except in {{transclusion}} tags.
155 public $mDefaultNamespace = NS_MAIN
;
157 /** @var int The page length, 0 for special pages */
158 protected $mLength = -1;
160 /** @var null Is the article at this title a redirect? */
161 public $mRedirect = null;
163 /** @var array Associative array of user ID -> timestamp/false */
164 private $mNotificationTimestamp = [];
166 /** @var bool Whether a page has any subpages */
167 private $mHasSubpages;
169 /** @var bool The (string) language code of the page's language and content code. */
170 private $mPageLanguage = false;
172 /** @var string|bool|null The page language code from the database, null if not saved in
173 * the database or false if not loaded, yet. */
174 private $mDbPageLanguage = false;
176 /** @var TitleValue|null A corresponding TitleValue object */
177 private $mTitleValue = null;
179 /** @var bool|null Would deleting this page be a big deletion? */
180 private $mIsBigDeletion = null;
184 * B/C kludge: provide a TitleParser for use by Title.
185 * Ideally, Title would have no methods that need this.
186 * Avoid usage of this singleton by using TitleValue
187 * and the associated services when possible.
189 * @return TitleFormatter
191 private static function getTitleFormatter() {
192 return MediaWikiServices
::getInstance()->getTitleFormatter();
196 * B/C kludge: provide an InterwikiLookup for use by Title.
197 * Ideally, Title would have no methods that need this.
198 * Avoid usage of this singleton by using TitleValue
199 * and the associated services when possible.
201 * @return InterwikiLookup
203 private static function getInterwikiLookup() {
204 return MediaWikiServices
::getInstance()->getInterwikiLookup();
210 function __construct() {
214 * Create a new Title from a prefixed DB key
216 * @param string $key The database key, which has underscores
217 * instead of spaces, possibly including namespace and
219 * @return Title|null Title, or null on an error
221 public static function newFromDBkey( $key ) {
223 $t->mDbkeyform
= $key;
226 $t->secureAndSplit();
228 } catch ( MalformedTitleException
$ex ) {
234 * Create a new Title from a TitleValue
236 * @param TitleValue $titleValue Assumed to be safe.
240 public static function newFromTitleValue( TitleValue
$titleValue ) {
241 return self
::newFromLinkTarget( $titleValue );
245 * Create a new Title from a LinkTarget
247 * @param LinkTarget $linkTarget Assumed to be safe.
251 public static function newFromLinkTarget( LinkTarget
$linkTarget ) {
252 if ( $linkTarget instanceof Title
) {
253 // Special case if it's already a Title object
256 return self
::makeTitle(
257 $linkTarget->getNamespace(),
258 $linkTarget->getText(),
259 $linkTarget->getFragment(),
260 $linkTarget->getInterwiki()
265 * Create a new Title from text, such as what one would find in a link. De-
266 * codes any HTML entities in the text.
268 * Title objects returned by this method are guaranteed to be valid, and
269 * thus return true from the isValid() method.
271 * @param string|int|null $text The link text; spaces, prefixes, and an
272 * initial ':' indicating the main namespace are accepted.
273 * @param int $defaultNamespace The namespace to use if none is specified
274 * by a prefix. If you want to force a specific namespace even if
275 * $text might begin with a namespace prefix, use makeTitle() or
277 * @throws InvalidArgumentException
278 * @return Title|null Title or null on an error.
280 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
281 // DWIM: Integers can be passed in here when page titles are used as array keys.
282 if ( $text !== null && !is_string( $text ) && !is_int( $text ) ) {
283 throw new InvalidArgumentException( '$text must be a string.' );
285 if ( $text === null ) {
290 return self
::newFromTextThrow( (string)$text, $defaultNamespace );
291 } catch ( MalformedTitleException
$ex ) {
297 * Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,
298 * rather than returning null.
300 * The exception subclasses encode detailed information about why the title is invalid.
302 * Title objects returned by this method are guaranteed to be valid, and
303 * thus return true from the isValid() method.
305 * @see Title::newFromText
308 * @param string $text Title text to check
309 * @param int $defaultNamespace
310 * @throws MalformedTitleException If the title is invalid
313 public static function newFromTextThrow( $text, $defaultNamespace = NS_MAIN
) {
314 if ( is_object( $text ) ) {
315 throw new MWException( '$text must be a string, given an object' );
316 } elseif ( $text === null ) {
317 // Legacy code relies on MalformedTitleException being thrown in this case
318 // (happens when URL with no title in it is parsed). TODO fix
319 throw new MalformedTitleException( 'title-invalid-empty' );
322 $titleCache = self
::getTitleCache();
324 // Wiki pages often contain multiple links to the same page.
325 // Title normalization and parsing can become expensive on pages with many
326 // links, so we can save a little time by caching them.
327 // In theory these are value objects and won't get changed...
328 if ( $defaultNamespace == NS_MAIN
) {
329 $t = $titleCache->get( $text );
335 // Convert things like é ā or 〗 into normalized (T16952) text
336 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
339 $t->mDbkeyform
= strtr( $filteredText, ' ', '_' );
340 $t->mDefaultNamespace
= (int)$defaultNamespace;
342 $t->secureAndSplit();
343 if ( $defaultNamespace == NS_MAIN
) {
344 $titleCache->set( $text, $t );
350 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
352 * Example of wrong and broken code:
353 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
355 * Example of right code:
356 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
358 * Create a new Title from URL-encoded text. Ensures that
359 * the given title's length does not exceed the maximum.
361 * @param string $url The title, as might be taken from a URL
362 * @return Title|null The new object, or null on an error
364 public static function newFromURL( $url ) {
367 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
368 # but some URLs used it as a space replacement and they still come
369 # from some external search tools.
370 if ( strpos( self
::legalChars(), '+' ) === false ) {
371 $url = strtr( $url, '+', ' ' );
374 $t->mDbkeyform
= strtr( $url, ' ', '_' );
377 $t->secureAndSplit();
379 } catch ( MalformedTitleException
$ex ) {
385 * @return MapCacheLRU
387 private static function getTitleCache() {
388 if ( self
::$titleCache === null ) {
389 self
::$titleCache = new MapCacheLRU( self
::CACHE_MAX
);
391 return self
::$titleCache;
395 * Returns a list of fields that are to be selected for initializing Title
396 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
397 * whether to include page_content_model.
401 protected static function getSelectFields() {
402 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
405 'page_namespace', 'page_title', 'page_id',
406 'page_len', 'page_is_redirect', 'page_latest',
409 if ( $wgContentHandlerUseDB ) {
410 $fields[] = 'page_content_model';
413 if ( $wgPageLanguageUseDB ) {
414 $fields[] = 'page_lang';
421 * Create a new Title from an article ID
423 * @param int $id The page_id corresponding to the Title to create
424 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
425 * @return Title|null The new object, or null on an error
427 public static function newFromID( $id, $flags = 0 ) {
428 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
429 $row = $db->selectRow(
431 self
::getSelectFields(),
432 [ 'page_id' => $id ],
435 if ( $row !== false ) {
436 $title = self
::newFromRow( $row );
444 * Make an array of titles from an array of IDs
446 * @param int[] $ids Array of IDs
447 * @return Title[] Array of Titles
449 public static function newFromIDs( $ids ) {
450 if ( !count( $ids ) ) {
453 $dbr = wfGetDB( DB_REPLICA
);
457 self
::getSelectFields(),
458 [ 'page_id' => $ids ],
463 foreach ( $res as $row ) {
464 $titles[] = self
::newFromRow( $row );
470 * Make a Title object from a DB row
472 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
473 * @return Title Corresponding Title
475 public static function newFromRow( $row ) {
476 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
477 $t->loadFromRow( $row );
482 * Load Title object fields from a DB row.
483 * If false is given, the title will be treated as non-existing.
485 * @param stdClass|bool $row Database row
487 public function loadFromRow( $row ) {
488 if ( $row ) { // page found
489 if ( isset( $row->page_id
) ) {
490 $this->mArticleID
= (int)$row->page_id
;
492 if ( isset( $row->page_len
) ) {
493 $this->mLength
= (int)$row->page_len
;
495 if ( isset( $row->page_is_redirect
) ) {
496 $this->mRedirect
= (bool)$row->page_is_redirect
;
498 if ( isset( $row->page_latest
) ) {
499 $this->mLatestID
= (int)$row->page_latest
;
501 if ( !$this->mForcedContentModel
&& isset( $row->page_content_model
) ) {
502 $this->mContentModel
= (string)$row->page_content_model
;
503 } elseif ( !$this->mForcedContentModel
) {
504 $this->mContentModel
= false; # initialized lazily in getContentModel()
506 if ( isset( $row->page_lang
) ) {
507 $this->mDbPageLanguage
= (string)$row->page_lang
;
509 if ( isset( $row->page_restrictions
) ) {
510 $this->mOldRestrictions
= $row->page_restrictions
;
512 } else { // page not found
513 $this->mArticleID
= 0;
515 $this->mRedirect
= false;
516 $this->mLatestID
= 0;
517 if ( !$this->mForcedContentModel
) {
518 $this->mContentModel
= false; # initialized lazily in getContentModel()
524 * Create a new Title from a namespace index and a DB key.
526 * It's assumed that $ns and $title are safe, for instance when
527 * they came directly from the database or a special page name,
528 * not from user input.
530 * No validation is applied. For convenience, spaces are normalized
531 * to underscores, so that e.g. user_text fields can be used directly.
533 * @note This method may return Title objects that are "invalid"
534 * according to the isValid() method. This is usually caused by
535 * configuration changes: e.g. a namespace that was once defined is
536 * no longer configured, or a character that was once allowed in
537 * titles is now forbidden.
539 * @param int $ns The namespace of the article
540 * @param string $title The unprefixed database key form
541 * @param string $fragment The link fragment (after the "#")
542 * @param string $interwiki The interwiki prefix
543 * @return Title The new object
545 public static function makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
547 $t->mInterwiki
= $interwiki;
548 $t->mFragment
= $fragment;
549 $t->mNamespace
= $ns = (int)$ns;
550 $t->mDbkeyform
= strtr( $title, ' ', '_' );
551 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
552 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
553 $t->mTextform
= strtr( $title, '_', ' ' );
554 $t->mContentModel
= false; # initialized lazily in getContentModel()
559 * Create a new Title from a namespace index and a DB key.
560 * The parameters will be checked for validity, which is a bit slower
561 * than makeTitle() but safer for user-provided data.
563 * Title objects returned by makeTitleSafe() are guaranteed to be valid,
564 * that is, they return true from the isValid() method. If no valid Title
565 * can be constructed from the input, this method returns null.
567 * @param int $ns The namespace of the article
568 * @param string $title Database key form
569 * @param string $fragment The link fragment (after the "#")
570 * @param string $interwiki Interwiki prefix
571 * @return Title|null The new object, or null on an error
573 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
574 // NOTE: ideally, this would just call makeTitle() and then isValid(),
575 // but presently, that means more overhead on a potential performance hotspot.
577 if ( !MWNamespace
::exists( $ns ) ) {
582 $t->mDbkeyform
= self
::makeName( $ns, $title, $fragment, $interwiki, true );
585 $t->secureAndSplit();
587 } catch ( MalformedTitleException
$ex ) {
593 * Create a new Title for the Main Page
595 * @return Title The new object
597 public static function newMainPage() {
598 $title = self
::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
599 // Don't give fatal errors if the message is broken
601 $title = self
::newFromText( 'Main Page' );
607 * Get the prefixed DB key associated with an ID
609 * @param int $id The page_id of the article
610 * @return Title|null An object representing the article, or null if no such article was found
612 public static function nameOf( $id ) {
613 $dbr = wfGetDB( DB_REPLICA
);
615 $s = $dbr->selectRow(
617 [ 'page_namespace', 'page_title' ],
618 [ 'page_id' => $id ],
621 if ( $s === false ) {
625 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
630 * Get a regex character class describing the legal characters in a link
632 * @return string The list of characters, not delimited
634 public static function legalChars() {
635 global $wgLegalTitleChars;
636 return $wgLegalTitleChars;
640 * Utility method for converting a character sequence from bytes to Unicode.
642 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
643 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
645 * @param string $byteClass
648 public static function convertByteClassToUnicodeClass( $byteClass ) {
649 $length = strlen( $byteClass );
651 $x0 = $x1 = $x2 = '';
653 $d0 = $d1 = $d2 = '';
654 // Decoded integer codepoints
655 $ord0 = $ord1 = $ord2 = 0;
657 $r0 = $r1 = $r2 = '';
661 $allowUnicode = false;
662 for ( $pos = 0; $pos < $length; $pos++
) {
663 // Shift the queues down
672 // Load the current input token and decoded values
673 $inChar = $byteClass[$pos];
674 if ( $inChar == '\\' ) {
675 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
676 $x0 = $inChar . $m[0];
677 $d0 = chr( hexdec( $m[1] ) );
678 $pos +
= strlen( $m[0] );
679 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
680 $x0 = $inChar . $m[0];
681 $d0 = chr( octdec( $m[0] ) );
682 $pos +
= strlen( $m[0] );
683 } elseif ( $pos +
1 >= $length ) {
686 $d0 = $byteClass[$pos +
1];
694 // Load the current re-encoded value
695 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
696 $r0 = sprintf( '\x%02x', $ord0 );
697 } elseif ( $ord0 >= 0x80 ) {
698 // Allow unicode if a single high-bit character appears
699 $r0 = sprintf( '\x%02x', $ord0 );
700 $allowUnicode = true;
701 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
707 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
709 if ( $ord2 > $ord0 ) {
711 } elseif ( $ord0 >= 0x80 ) {
713 $allowUnicode = true;
714 if ( $ord2 < 0x80 ) {
715 // Keep the non-unicode section of the range
722 // Reset state to the initial value
723 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
724 } elseif ( $ord2 < 0x80 ) {
729 if ( $ord1 < 0x80 ) {
732 if ( $ord0 < 0x80 ) {
735 if ( $allowUnicode ) {
736 $out .= '\u0080-\uFFFF';
742 * Make a prefixed DB key from a DB key and a namespace index
744 * @param int $ns Numerical representation of the namespace
745 * @param string $title The DB key form the title
746 * @param string $fragment The link fragment (after the "#")
747 * @param string $interwiki The interwiki prefix
748 * @param bool $canonicalNamespace If true, use the canonical name for
749 * $ns instead of the localized version.
750 * @return string The prefixed form of the title
752 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
753 $canonicalNamespace = false
755 if ( $canonicalNamespace ) {
756 $namespace = MWNamespace
::getCanonicalName( $ns );
758 $namespace = MediaWikiServices
::getInstance()->getContentLanguage()->getNsText( $ns );
760 $name = $namespace == '' ?
$title : "$namespace:$title";
761 if ( strval( $interwiki ) != '' ) {
762 $name = "$interwiki:$name";
764 if ( strval( $fragment ) != '' ) {
765 $name .= '#' . $fragment;
771 * Callback for usort() to do title sorts by (namespace, title)
773 * @param LinkTarget $a
774 * @param LinkTarget $b
776 * @return int Result of string comparison, or namespace comparison
778 public static function compare( LinkTarget
$a, LinkTarget
$b ) {
779 return $a->getNamespace() <=> $b->getNamespace()
780 ?
: strcmp( $a->getText(), $b->getText() );
784 * Returns true if the title is valid, false if it is invalid.
786 * Valid titles can be round-tripped via makeTitleSafe() and newFromText().
787 * Invalid titles may get returned from makeTitle(), and it may be useful to
788 * allow them to exist, e.g. in order to process log entries about pages in
789 * namespaces that belong to extensions that are no longer installed.
791 * @note This method is relatively expensive. When constructing Title
792 * objects that need to be valid, use an instantiator method that is guaranteed
793 * to return valid titles, such as makeTitleSafe() or newFromText().
797 public function isValid() {
798 if ( !MWNamespace
::exists( $this->mNamespace
) ) {
803 $parser = MediaWikiServices
::getInstance()->getTitleParser();
804 $parser->parseTitle( $this->mDbkeyform
, $this->mNamespace
);
806 } catch ( MalformedTitleException
$ex ) {
812 * Determine whether the object refers to a page within
813 * this project (either this wiki or a wiki with a local
814 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
816 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
818 public function isLocal() {
819 if ( $this->isExternal() ) {
820 $iw = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
822 return $iw->isLocal();
829 * Is this Title interwiki?
833 public function isExternal() {
834 return $this->mInterwiki
!== '';
838 * Get the interwiki prefix
840 * Use Title::isExternal to check if a interwiki is set
842 * @return string Interwiki prefix
844 public function getInterwiki() {
845 return $this->mInterwiki
;
849 * Was this a local interwiki link?
853 public function wasLocalInterwiki() {
854 return $this->mLocalInterwiki
;
858 * Determine whether the object refers to a page within
859 * this project and is transcludable.
861 * @return bool True if this is transcludable
863 public function isTrans() {
864 if ( !$this->isExternal() ) {
868 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->isTranscludable();
872 * Returns the DB name of the distant wiki which owns the object.
874 * @return string|false The DB name
876 public function getTransWikiID() {
877 if ( !$this->isExternal() ) {
881 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->getWikiID();
885 * Get a TitleValue object representing this Title.
887 * @note Not all valid Titles have a corresponding valid TitleValue
888 * (e.g. TitleValues cannot represent page-local links that have a
889 * fragment but no title text).
891 * @return TitleValue|null
893 public function getTitleValue() {
894 if ( $this->mTitleValue
=== null ) {
896 $this->mTitleValue
= new TitleValue(
902 } catch ( InvalidArgumentException
$ex ) {
903 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
904 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
908 return $this->mTitleValue
;
912 * Get the text form (spaces not underscores) of the main part
914 * @return string Main part of the title
916 public function getText() {
917 return $this->mTextform
;
921 * Get the URL-encoded form of the main part
923 * @return string Main part of the title, URL-encoded
925 public function getPartialURL() {
926 return $this->mUrlform
;
930 * Get the main part with underscores
932 * @return string Main part of the title, with underscores
934 public function getDBkey() {
935 return $this->mDbkeyform
;
939 * Get the DB key with the initial letter case as specified by the user
940 * @deprecated since 1.33; please use Title::getDBKey() instead
942 * @return string DB key
944 function getUserCaseDBKey() {
945 if ( !is_null( $this->mUserCaseDBKey
) ) {
946 return $this->mUserCaseDBKey
;
948 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
949 return $this->mDbkeyform
;
954 * Get the namespace index, i.e. one of the NS_xxxx constants.
956 * @return int Namespace index
958 public function getNamespace() {
959 return $this->mNamespace
;
963 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
965 * @todo Deprecate this in favor of SlotRecord::getModel()
967 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
968 * @return string Content model id
970 public function getContentModel( $flags = 0 ) {
971 if ( !$this->mForcedContentModel
972 && ( !$this->mContentModel ||
$flags === self
::GAID_FOR_UPDATE
)
973 && $this->getArticleID( $flags )
975 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
976 $linkCache->addLinkObj( $this ); # in case we already had an article ID
977 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
980 if ( !$this->mContentModel
) {
981 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
984 return $this->mContentModel
;
988 * Convenience method for checking a title's content model name
990 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
991 * @return bool True if $this->getContentModel() == $id
993 public function hasContentModel( $id ) {
994 return $this->getContentModel() == $id;
998 * Set a proposed content model for the page for permissions
999 * checking. This does not actually change the content model
1002 * Additionally, you should make sure you've checked
1003 * ContentHandler::canBeUsedOn() first.
1006 * @param string $model CONTENT_MODEL_XXX constant
1008 public function setContentModel( $model ) {
1009 $this->mContentModel
= $model;
1010 $this->mForcedContentModel
= true;
1014 * Get the namespace text
1016 * @return string|false Namespace text
1018 public function getNsText() {
1019 if ( $this->isExternal() ) {
1020 // This probably shouldn't even happen, except for interwiki transclusion.
1021 // If possible, use the canonical name for the foreign namespace.
1022 $nsText = MWNamespace
::getCanonicalName( $this->mNamespace
);
1023 if ( $nsText !== false ) {
1029 $formatter = self
::getTitleFormatter();
1030 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
1031 } catch ( InvalidArgumentException
$ex ) {
1032 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
1038 * Get the namespace text of the subject (rather than talk) page
1040 * @return string Namespace text
1042 public function getSubjectNsText() {
1043 return MediaWikiServices
::getInstance()->getContentLanguage()->
1044 getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
1048 * Get the namespace text of the talk page
1050 * @return string Namespace text
1052 public function getTalkNsText() {
1053 return MediaWikiServices
::getInstance()->getContentLanguage()->
1054 getNsText( MWNamespace
::getTalk( $this->mNamespace
) );
1058 * Can this title have a corresponding talk page?
1060 * @see MWNamespace::hasTalkNamespace
1063 * @return bool True if this title either is a talk page or can have a talk page associated.
1065 public function canHaveTalkPage() {
1066 return MWNamespace
::hasTalkNamespace( $this->mNamespace
);
1070 * Is this in a namespace that allows actual pages?
1074 public function canExist() {
1075 return $this->mNamespace
>= NS_MAIN
;
1079 * Can this title be added to a user's watchlist?
1083 public function isWatchable() {
1084 return !$this->isExternal() && MWNamespace
::isWatchable( $this->mNamespace
);
1088 * Returns true if this is a special page.
1092 public function isSpecialPage() {
1093 return $this->mNamespace
== NS_SPECIAL
;
1097 * Returns true if this title resolves to the named special page
1099 * @param string $name The special page name
1102 public function isSpecial( $name ) {
1103 if ( $this->isSpecialPage() ) {
1104 list( $thisName, /* $subpage */ ) =
1105 MediaWikiServices
::getInstance()->getSpecialPageFactory()->
1106 resolveAlias( $this->mDbkeyform
);
1107 if ( $name == $thisName ) {
1115 * If the Title refers to a special page alias which is not the local default, resolve
1116 * the alias, and localise the name as necessary. Otherwise, return $this
1120 public function fixSpecialName() {
1121 if ( $this->isSpecialPage() ) {
1122 $spFactory = MediaWikiServices
::getInstance()->getSpecialPageFactory();
1123 list( $canonicalName, $par ) = $spFactory->resolveAlias( $this->mDbkeyform
);
1124 if ( $canonicalName ) {
1125 $localName = $spFactory->getLocalNameFor( $canonicalName, $par );
1126 if ( $localName != $this->mDbkeyform
) {
1127 return self
::makeTitle( NS_SPECIAL
, $localName );
1135 * Returns true if the title is inside the specified namespace.
1137 * Please make use of this instead of comparing to getNamespace()
1138 * This function is much more resistant to changes we may make
1139 * to namespaces than code that makes direct comparisons.
1140 * @param int $ns The namespace
1144 public function inNamespace( $ns ) {
1145 return MWNamespace
::equals( $this->mNamespace
, $ns );
1149 * Returns true if the title is inside one of the specified namespaces.
1151 * @param int|int[] $namespaces,... The namespaces to check for
1155 public function inNamespaces( /* ... */ ) {
1156 $namespaces = func_get_args();
1157 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1158 $namespaces = $namespaces[0];
1161 foreach ( $namespaces as $ns ) {
1162 if ( $this->inNamespace( $ns ) ) {
1171 * Returns true if the title has the same subject namespace as the
1172 * namespace specified.
1173 * For example this method will take NS_USER and return true if namespace
1174 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1175 * as their subject namespace.
1177 * This is MUCH simpler than individually testing for equivalence
1178 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1183 public function hasSubjectNamespace( $ns ) {
1184 return MWNamespace
::subjectEquals( $this->mNamespace
, $ns );
1188 * Is this Title in a namespace which contains content?
1189 * In other words, is this a content page, for the purposes of calculating
1194 public function isContentPage() {
1195 return MWNamespace
::isContent( $this->mNamespace
);
1199 * Would anybody with sufficient privileges be able to move this page?
1200 * Some pages just aren't movable.
1204 public function isMovable() {
1205 if ( !MWNamespace
::isMovable( $this->mNamespace
) ||
$this->isExternal() ) {
1206 // Interwiki title or immovable namespace. Hooks don't get to override here
1211 Hooks
::run( 'TitleIsMovable', [ $this, &$result ] );
1216 * Is this the mainpage?
1217 * @note Title::newFromText seems to be sufficiently optimized by the title
1218 * cache that we don't need to over-optimize by doing direct comparisons and
1219 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1220 * ends up reporting something differently than $title->isMainPage();
1225 public function isMainPage() {
1226 return $this->equals( self
::newMainPage() );
1230 * Is this a subpage?
1234 public function isSubpage() {
1235 return MWNamespace
::hasSubpages( $this->mNamespace
)
1236 ?
strpos( $this->getText(), '/' ) !== false
1241 * Is this a conversion table for the LanguageConverter?
1245 public function isConversionTable() {
1246 // @todo ConversionTable should become a separate content model.
1248 return $this->mNamespace
== NS_MEDIAWIKI
&&
1249 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1253 * Does that page contain wikitext, or it is JS, CSS or whatever?
1257 public function isWikitextPage() {
1258 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1262 * Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the
1263 * global UI. This is generally true for pages in the MediaWiki namespace having
1264 * CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
1266 * This method does *not* return true for per-user JS/JSON/CSS. Use isUserConfigPage()
1269 * Note that this method should not return true for pages that contain and show
1270 * "inactive" CSS, JSON, or JS.
1275 public function isSiteConfigPage() {
1277 $this->isSiteCssConfigPage()
1278 ||
$this->isSiteJsonConfigPage()
1279 ||
$this->isSiteJsConfigPage()
1284 * Is this a "config" (.css, .json, or .js) sub-page of a user page?
1289 public function isUserConfigPage() {
1291 $this->isUserCssConfigPage()
1292 ||
$this->isUserJsonConfigPage()
1293 ||
$this->isUserJsConfigPage()
1298 * Trim down a .css, .json, or .js subpage title to get the corresponding skin name
1300 * @return string Containing skin name from .css, .json, or .js subpage title
1303 public function getSkinFromConfigSubpage() {
1304 $subpage = explode( '/', $this->mTextform
);
1305 $subpage = $subpage[count( $subpage ) - 1];
1306 $lastdot = strrpos( $subpage, '.' );
1307 if ( $lastdot === false ) {
1308 return $subpage; # Never happens: only called for names ending in '.css'/'.json'/'.js'
1310 return substr( $subpage, 0, $lastdot );
1314 * Is this a CSS "config" sub-page of a user page?
1319 public function isUserCssConfigPage() {
1321 NS_USER
== $this->mNamespace
1322 && $this->isSubpage()
1323 && $this->hasContentModel( CONTENT_MODEL_CSS
)
1328 * Is this a JSON "config" sub-page of a user page?
1333 public function isUserJsonConfigPage() {
1335 NS_USER
== $this->mNamespace
1336 && $this->isSubpage()
1337 && $this->hasContentModel( CONTENT_MODEL_JSON
)
1342 * Is this a JS "config" sub-page of a user page?
1347 public function isUserJsConfigPage() {
1349 NS_USER
== $this->mNamespace
1350 && $this->isSubpage()
1351 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1356 * Is this a sitewide CSS "config" page?
1361 public function isSiteCssConfigPage() {
1363 NS_MEDIAWIKI
== $this->mNamespace
1365 $this->hasContentModel( CONTENT_MODEL_CSS
)
1366 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1367 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1368 ||
substr( $this->mDbkeyform
, -4 ) === '.css'
1374 * Is this a sitewide JSON "config" page?
1379 public function isSiteJsonConfigPage() {
1381 NS_MEDIAWIKI
== $this->mNamespace
1383 $this->hasContentModel( CONTENT_MODEL_JSON
)
1384 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1385 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1386 ||
substr( $this->mDbkeyform
, -5 ) === '.json'
1392 * Is this a sitewide JS "config" page?
1397 public function isSiteJsConfigPage() {
1399 NS_MEDIAWIKI
== $this->mNamespace
1401 $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1402 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1403 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1404 ||
substr( $this->mDbkeyform
, -3 ) === '.js'
1410 * Is this a message which can contain raw HTML?
1415 public function isRawHtmlMessage() {
1416 global $wgRawHtmlMessages;
1418 if ( !$this->inNamespace( NS_MEDIAWIKI
) ) {
1421 $message = lcfirst( $this->getRootTitle()->getDBkey() );
1422 return in_array( $message, $wgRawHtmlMessages, true );
1426 * Is this a talk page of some sort?
1430 public function isTalkPage() {
1431 return MWNamespace
::isTalk( $this->mNamespace
);
1435 * Get a Title object associated with the talk page of this article
1437 * @return Title The object for the talk page
1439 public function getTalkPage() {
1440 return self
::makeTitle( MWNamespace
::getTalk( $this->mNamespace
), $this->mDbkeyform
);
1444 * Get a Title object associated with the talk page of this article,
1445 * if such a talk page can exist.
1449 * @return Title|null The object for the talk page,
1450 * or null if no associated talk page can exist, according to canHaveTalkPage().
1452 public function getTalkPageIfDefined() {
1453 if ( !$this->canHaveTalkPage() ) {
1457 return $this->getTalkPage();
1461 * Get a title object associated with the subject page of this
1464 * @return Title The object for the subject page
1466 public function getSubjectPage() {
1467 // Is this the same title?
1468 $subjectNS = MWNamespace
::getSubject( $this->mNamespace
);
1469 if ( $this->mNamespace
== $subjectNS ) {
1472 return self
::makeTitle( $subjectNS, $this->mDbkeyform
);
1476 * Get the other title for this page, if this is a subject page
1477 * get the talk page, if it is a subject page get the talk page
1480 * @throws MWException If the page doesn't have an other page
1483 public function getOtherPage() {
1484 if ( $this->isSpecialPage() ) {
1485 throw new MWException( 'Special pages cannot have other pages' );
1487 if ( $this->isTalkPage() ) {
1488 return $this->getSubjectPage();
1490 if ( !$this->canHaveTalkPage() ) {
1491 throw new MWException( "{$this->getPrefixedText()} does not have an other page" );
1493 return $this->getTalkPage();
1498 * Get the default namespace index, for when there is no namespace
1500 * @return int Default namespace index
1502 public function getDefaultNamespace() {
1503 return $this->mDefaultNamespace
;
1507 * Get the Title fragment (i.e.\ the bit after the #) in text form
1509 * Use Title::hasFragment to check for a fragment
1511 * @return string Title fragment
1513 public function getFragment() {
1514 return $this->mFragment
;
1518 * Check if a Title fragment is set
1523 public function hasFragment() {
1524 return $this->mFragment
!== '';
1528 * Get the fragment in URL form, including the "#" character if there is one
1530 * @return string Fragment in URL form
1532 public function getFragmentForURL() {
1533 if ( !$this->hasFragment() ) {
1535 } elseif ( $this->isExternal() ) {
1536 // Note: If the interwiki is unknown, it's treated as a namespace on the local wiki,
1537 // so we treat it like a local interwiki.
1538 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
1539 if ( $interwiki && !$interwiki->isLocal() ) {
1540 return '#' . Sanitizer
::escapeIdForExternalInterwiki( $this->mFragment
);
1544 return '#' . Sanitizer
::escapeIdForLink( $this->mFragment
);
1548 * Set the fragment for this title. Removes the first character from the
1549 * specified fragment before setting, so it assumes you're passing it with
1552 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1553 * or Title::createFragmentTarget().
1554 * Still in active use privately.
1557 * @param string $fragment Text
1559 public function setFragment( $fragment ) {
1560 $this->mFragment
= strtr( substr( $fragment, 1 ), '_', ' ' );
1564 * Creates a new Title for a different fragment of the same page.
1567 * @param string $fragment
1570 public function createFragmentTarget( $fragment ) {
1571 return self
::makeTitle(
1580 * Prefix some arbitrary text with the namespace or interwiki prefix
1583 * @param string $name The text
1584 * @return string The prefixed text
1586 private function prefix( $name ) {
1588 if ( $this->isExternal() ) {
1589 $p = $this->mInterwiki
. ':';
1592 if ( $this->mNamespace
!= 0 ) {
1593 $nsText = $this->getNsText();
1595 if ( $nsText === false ) {
1596 // See T165149. Awkward, but better than erroneously linking to the main namespace.
1597 $nsText = MediaWikiServices
::getInstance()->getContentLanguage()->
1598 getNsText( NS_SPECIAL
) . ":Badtitle/NS{$this->mNamespace}";
1601 $p .= $nsText . ':';
1607 * Get the prefixed database key form
1609 * @return string The prefixed title, with underscores and
1610 * any interwiki and namespace prefixes
1612 public function getPrefixedDBkey() {
1613 $s = $this->prefix( $this->mDbkeyform
);
1614 $s = strtr( $s, ' ', '_' );
1619 * Get the prefixed title with spaces.
1620 * This is the form usually used for display
1622 * @return string The prefixed title, with spaces
1624 public function getPrefixedText() {
1625 if ( $this->prefixedText
=== null ) {
1626 $s = $this->prefix( $this->mTextform
);
1627 $s = strtr( $s, '_', ' ' );
1628 $this->prefixedText
= $s;
1630 return $this->prefixedText
;
1634 * Return a string representation of this title
1636 * @return string Representation of this title
1638 public function __toString() {
1639 return $this->getPrefixedText();
1643 * Get the prefixed title with spaces, plus any fragment
1644 * (part beginning with '#')
1646 * @return string The prefixed title, with spaces and the fragment, including '#'
1648 public function getFullText() {
1649 $text = $this->getPrefixedText();
1650 if ( $this->hasFragment() ) {
1651 $text .= '#' . $this->mFragment
;
1657 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1661 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1665 * @return string Root name
1668 public function getRootText() {
1669 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1670 return $this->getText();
1673 return strtok( $this->getText(), '/' );
1677 * Get the root page name title, i.e. the leftmost part before any slashes
1681 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1682 * # returns: Title{User:Foo}
1685 * @return Title Root title
1688 public function getRootTitle() {
1689 return self
::makeTitle( $this->mNamespace
, $this->getRootText() );
1693 * Get the base page name without a namespace, i.e. the part before the subpage name
1697 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1698 * # returns: 'Foo/Bar'
1701 * @return string Base name
1703 public function getBaseText() {
1704 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1705 return $this->getText();
1708 $parts = explode( '/', $this->getText() );
1709 # Don't discard the real title if there's no subpage involved
1710 if ( count( $parts ) > 1 ) {
1711 unset( $parts[count( $parts ) - 1] );
1713 return implode( '/', $parts );
1717 * Get the base page name title, i.e. the part before the subpage name
1721 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1722 * # returns: Title{User:Foo/Bar}
1725 * @return Title Base title
1728 public function getBaseTitle() {
1729 return self
::makeTitle( $this->mNamespace
, $this->getBaseText() );
1733 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1737 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1741 * @return string Subpage name
1743 public function getSubpageText() {
1744 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1745 return $this->mTextform
;
1747 $parts = explode( '/', $this->mTextform
);
1748 return $parts[count( $parts ) - 1];
1752 * Get the title for a subpage of the current page
1756 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1757 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1760 * @param string $text The subpage name to add to the title
1761 * @return Title|null Subpage title, or null on an error
1764 public function getSubpage( $text ) {
1765 return self
::makeTitleSafe( $this->mNamespace
, $this->getText() . '/' . $text );
1769 * Get a URL-encoded form of the subpage text
1771 * @return string URL-encoded subpage name
1773 public function getSubpageUrlForm() {
1774 $text = $this->getSubpageText();
1775 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1780 * Get a URL-encoded title (not an actual URL) including interwiki
1782 * @return string The URL-encoded form
1784 public function getPrefixedURL() {
1785 $s = $this->prefix( $this->mDbkeyform
);
1786 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1791 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1792 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1793 * second argument named variant. This was deprecated in favor
1794 * of passing an array of option with a "variant" key
1795 * Once $query2 is removed for good, this helper can be dropped
1796 * and the wfArrayToCgi moved to getLocalURL();
1798 * @since 1.19 (r105919)
1799 * @param array|string $query
1800 * @param string|string[]|bool $query2
1803 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1804 if ( $query2 !== false ) {
1805 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1806 "method called with a second parameter is deprecated. Add your " .
1807 "parameter to an array passed as the first parameter.", "1.19" );
1809 if ( is_array( $query ) ) {
1810 $query = wfArrayToCgi( $query );
1813 if ( is_string( $query2 ) ) {
1814 // $query2 is a string, we will consider this to be
1815 // a deprecated $variant argument and add it to the query
1816 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1818 $query2 = wfArrayToCgi( $query2 );
1820 // If we have $query content add a & to it first
1824 // Now append the queries together
1831 * Get a real URL referring to this title, with interwiki link and
1834 * @see self::getLocalURL for the arguments.
1836 * @param string|string[] $query
1837 * @param string|string[]|bool $query2
1838 * @param string|int|null $proto Protocol type to use in URL
1839 * @return string The URL
1841 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1842 $query = self
::fixUrlQueryArgs( $query, $query2 );
1844 # Hand off all the decisions on urls to getLocalURL
1845 $url = $this->getLocalURL( $query );
1847 # Expand the url to make it a full url. Note that getLocalURL has the
1848 # potential to output full urls for a variety of reasons, so we use
1849 # wfExpandUrl instead of simply prepending $wgServer
1850 $url = wfExpandUrl( $url, $proto );
1852 # Finally, add the fragment.
1853 $url .= $this->getFragmentForURL();
1854 // Avoid PHP 7.1 warning from passing $this by reference
1856 Hooks
::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
1861 * Get a url appropriate for making redirects based on an untrusted url arg
1863 * This is basically the same as getFullUrl(), but in the case of external
1864 * interwikis, we send the user to a landing page, to prevent possible
1865 * phishing attacks and the like.
1867 * @note Uses current protocol by default, since technically relative urls
1868 * aren't allowed in redirects per HTTP spec, so this is not suitable for
1869 * places where the url gets cached, as might pollute between
1870 * https and non-https users.
1871 * @see self::getLocalURL for the arguments.
1872 * @param array|string $query
1873 * @param string $proto Protocol type to use in URL
1874 * @return string A url suitable to use in an HTTP location header.
1876 public function getFullUrlForRedirect( $query = '', $proto = PROTO_CURRENT
) {
1878 if ( $this->isExternal() ) {
1879 $target = SpecialPage
::getTitleFor(
1881 $this->getPrefixedDBkey()
1884 return $target->getFullURL( $query, false, $proto );
1888 * Get a URL with no fragment or server name (relative URL) from a Title object.
1889 * If this page is generated with action=render, however,
1890 * $wgServer is prepended to make an absolute URL.
1892 * @see self::getFullURL to always get an absolute URL.
1893 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
1894 * valid to link, locally, to the current Title.
1895 * @see self::newFromText to produce a Title object.
1897 * @param string|string[] $query An optional query string,
1898 * not used for interwiki links. Can be specified as an associative array as well,
1899 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1900 * Some query patterns will trigger various shorturl path replacements.
1901 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
1902 * be an array. If a string is passed it will be interpreted as a deprecated
1903 * variant argument and urlencoded into a variant= argument.
1904 * This second query argument will be added to the $query
1905 * The second parameter is deprecated since 1.19. Pass it as a key,value
1906 * pair in the first parameter array instead.
1908 * @return string String of the URL.
1910 public function getLocalURL( $query = '', $query2 = false ) {
1911 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1913 $query = self
::fixUrlQueryArgs( $query, $query2 );
1915 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
1917 $namespace = $this->getNsText();
1918 if ( $namespace != '' ) {
1919 # Can this actually happen? Interwikis shouldn't be parsed.
1920 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1923 $url = $interwiki->getURL( $namespace . $this->mDbkeyform
);
1924 $url = wfAppendQuery( $url, $query );
1926 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1927 if ( $query == '' ) {
1928 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1929 // Avoid PHP 7.1 warning from passing $this by reference
1931 Hooks
::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
1933 global $wgVariantArticlePath, $wgActionPaths;
1937 if ( !empty( $wgActionPaths )
1938 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1940 $action = urldecode( $matches[2] );
1941 if ( isset( $wgActionPaths[$action] ) ) {
1942 $query = $matches[1];
1943 if ( isset( $matches[4] ) ) {
1944 $query .= $matches[4];
1946 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1947 if ( $query != '' ) {
1948 $url = wfAppendQuery( $url, $query );
1954 && $wgVariantArticlePath
1955 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1956 && $this->getPageLanguage()->equals(
1957 MediaWikiServices
::getInstance()->getContentLanguage() )
1958 && $this->getPageLanguage()->hasVariants()
1960 $variant = urldecode( $matches[1] );
1961 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1962 // Only do the variant replacement if the given variant is a valid
1963 // variant for the page's language.
1964 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1965 $url = str_replace( '$1', $dbkey, $url );
1969 if ( $url === false ) {
1970 if ( $query == '-' ) {
1973 $url = "{$wgScript}?title={$dbkey}&{$query}";
1976 // Avoid PHP 7.1 warning from passing $this by reference
1978 Hooks
::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
1980 // @todo FIXME: This causes breakage in various places when we
1981 // actually expected a local URL and end up with dupe prefixes.
1982 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1983 $url = $wgServer . $url;
1986 // Avoid PHP 7.1 warning from passing $this by reference
1988 Hooks
::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
1993 * Get a URL that's the simplest URL that will be valid to link, locally,
1994 * to the current Title. It includes the fragment, but does not include
1995 * the server unless action=render is used (or the link is external). If
1996 * there's a fragment but the prefixed text is empty, we just return a link
1999 * The result obviously should not be URL-escaped, but does need to be
2000 * HTML-escaped if it's being output in HTML.
2002 * @param string|string[] $query
2003 * @param bool $query2
2004 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
2005 * or false (default) for no expansion
2006 * @see self::getLocalURL for the arguments.
2007 * @return string The URL
2009 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
2010 if ( $this->isExternal() ||
$proto !== false ) {
2011 $ret = $this->getFullURL( $query, $query2, $proto );
2012 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
2013 $ret = $this->getFragmentForURL();
2015 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
2021 * Get the URL form for an internal link.
2022 * - Used in various CDN-related code, in case we have a different
2023 * internal hostname for the server from the exposed one.
2025 * This uses $wgInternalServer to qualify the path, or $wgServer
2026 * if $wgInternalServer is not set. If the server variable used is
2027 * protocol-relative, the URL will be expanded to http://
2029 * @see self::getLocalURL for the arguments.
2030 * @param string $query
2031 * @param string|bool $query2
2032 * @return string The URL
2034 public function getInternalURL( $query = '', $query2 = false ) {
2035 global $wgInternalServer, $wgServer;
2036 $query = self
::fixUrlQueryArgs( $query, $query2 );
2037 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
2038 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
2039 // Avoid PHP 7.1 warning from passing $this by reference
2041 Hooks
::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
2046 * Get the URL for a canonical link, for use in things like IRC and
2047 * e-mail notifications. Uses $wgCanonicalServer and the
2048 * GetCanonicalURL hook.
2050 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
2052 * @see self::getLocalURL for the arguments.
2053 * @param string $query
2054 * @param string|bool $query2
2055 * @return string The URL
2058 public function getCanonicalURL( $query = '', $query2 = false ) {
2059 $query = self
::fixUrlQueryArgs( $query, $query2 );
2060 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
2061 // Avoid PHP 7.1 warning from passing $this by reference
2063 Hooks
::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
2068 * Get the edit URL for this Title
2070 * @return string The URL, or a null string if this is an interwiki link
2072 public function getEditURL() {
2073 if ( $this->isExternal() ) {
2076 $s = $this->getLocalURL( 'action=edit' );
2082 * Can $user perform $action on this page?
2083 * This skips potentially expensive cascading permission checks
2084 * as well as avoids expensive error formatting
2086 * Suitable for use for nonessential UI controls in common cases, but
2087 * _not_ for functional access control.
2089 * May provide false positives, but should never provide a false negative.
2091 * @param string $action Action that permission needs to be checked for
2092 * @param User|null $user User to check (since 1.19); $wgUser will be used if not provided.
2095 public function quickUserCan( $action, $user = null ) {
2096 return $this->userCan( $action, $user, false );
2100 * Can $user perform $action on this page?
2102 * @param string $action Action that permission needs to be checked for
2103 * @param User|null $user User to check (since 1.19); $wgUser will be used if not
2105 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2108 public function userCan( $action, $user = null, $rigor = 'secure' ) {
2109 if ( !$user instanceof User
) {
2114 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $rigor, true ) );
2118 * Can $user perform $action on this page?
2120 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
2122 * @param string $action Action that permission needs to be checked for
2123 * @param User $user User to check
2124 * @param string $rigor One of (quick,full,secure)
2125 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2126 * - full : does cheap and expensive checks possibly from a replica DB
2127 * - secure : does cheap and expensive checks, using the master as needed
2128 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
2129 * whose corresponding errors may be ignored.
2130 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2132 public function getUserPermissionsErrors(
2133 $action, $user, $rigor = 'secure', $ignoreErrors = []
2135 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $rigor );
2137 // Remove the errors being ignored.
2138 foreach ( $errors as $index => $error ) {
2139 $errKey = is_array( $error ) ?
$error[0] : $error;
2141 if ( in_array( $errKey, $ignoreErrors ) ) {
2142 unset( $errors[$index] );
2144 if ( $errKey instanceof MessageSpecifier
&& in_array( $errKey->getKey(), $ignoreErrors ) ) {
2145 unset( $errors[$index] );
2153 * Permissions checks that fail most often, and which are easiest to test.
2155 * @param string $action The action to check
2156 * @param User $user User to check
2157 * @param array $errors List of current errors
2158 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2159 * @param bool $short Short circuit on first error
2161 * @return array List of errors
2163 private function checkQuickPermissions( $action, $user, $errors, $rigor, $short ) {
2164 if ( !Hooks
::run( 'TitleQuickPermissions',
2165 [ $this, $user, $action, &$errors, ( $rigor !== 'quick' ), $short ] )
2170 if ( $action == 'create' ) {
2172 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
2173 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
2175 $errors[] = $user->isAnon() ?
[ 'nocreatetext' ] : [ 'nocreate-loggedin' ];
2177 } elseif ( $action == 'move' ) {
2178 if ( !$user->isAllowed( 'move-rootuserpages' )
2179 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
2180 // Show user page-specific message only if the user can move other pages
2181 $errors[] = [ 'cant-move-user-page' ];
2184 // Check if user is allowed to move files if it's a file
2185 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
2186 $errors[] = [ 'movenotallowedfile' ];
2189 // Check if user is allowed to move category pages if it's a category page
2190 if ( $this->mNamespace
== NS_CATEGORY
&& !$user->isAllowed( 'move-categorypages' ) ) {
2191 $errors[] = [ 'cant-move-category-page' ];
2194 if ( !$user->isAllowed( 'move' ) ) {
2195 // User can't move anything
2196 $userCanMove = User
::groupHasPermission( 'user', 'move' );
2197 $autoconfirmedCanMove = User
::groupHasPermission( 'autoconfirmed', 'move' );
2198 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
2199 // custom message if logged-in users without any special rights can move
2200 $errors[] = [ 'movenologintext' ];
2202 $errors[] = [ 'movenotallowed' ];
2205 } elseif ( $action == 'move-target' ) {
2206 if ( !$user->isAllowed( 'move' ) ) {
2207 // User can't move anything
2208 $errors[] = [ 'movenotallowed' ];
2209 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
2210 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
2211 // Show user page-specific message only if the user can move other pages
2212 $errors[] = [ 'cant-move-to-user-page' ];
2213 } elseif ( !$user->isAllowed( 'move-categorypages' )
2214 && $this->mNamespace
== NS_CATEGORY
) {
2215 // Show category page-specific message only if the user can move other pages
2216 $errors[] = [ 'cant-move-to-category-page' ];
2218 } elseif ( !$user->isAllowed( $action ) ) {
2219 $errors[] = $this->missingPermissionError( $action, $short );
2226 * Add the resulting error code to the errors array
2228 * @param array $errors List of current errors
2229 * @param array $result Result of errors
2231 * @return array List of errors
2233 private function resultToError( $errors, $result ) {
2234 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2235 // A single array representing an error
2236 $errors[] = $result;
2237 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2238 // A nested array representing multiple errors
2239 $errors = array_merge( $errors, $result );
2240 } elseif ( $result !== '' && is_string( $result ) ) {
2241 // A string representing a message-id
2242 $errors[] = [ $result ];
2243 } elseif ( $result instanceof MessageSpecifier
) {
2244 // A message specifier representing an error
2245 $errors[] = [ $result ];
2246 } elseif ( $result === false ) {
2247 // a generic "We don't want them to do that"
2248 $errors[] = [ 'badaccess-group0' ];
2254 * Check various permission hooks
2256 * @param string $action The action to check
2257 * @param User $user User to check
2258 * @param array $errors List of current errors
2259 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2260 * @param bool $short Short circuit on first error
2262 * @return array List of errors
2264 private function checkPermissionHooks( $action, $user, $errors, $rigor, $short ) {
2265 // Use getUserPermissionsErrors instead
2267 // Avoid PHP 7.1 warning from passing $this by reference
2269 if ( !Hooks
::run( 'userCan', [ &$titleRef, &$user, $action, &$result ] ) ) {
2270 return $result ?
[] : [ [ 'badaccess-group0' ] ];
2272 // Check getUserPermissionsErrors hook
2273 // Avoid PHP 7.1 warning from passing $this by reference
2275 if ( !Hooks
::run( 'getUserPermissionsErrors', [ &$titleRef, &$user, $action, &$result ] ) ) {
2276 $errors = $this->resultToError( $errors, $result );
2278 // Check getUserPermissionsErrorsExpensive hook
2281 && !( $short && count( $errors ) > 0 )
2282 && !Hooks
::run( 'getUserPermissionsErrorsExpensive', [ &$titleRef, &$user, $action, &$result ] )
2284 $errors = $this->resultToError( $errors, $result );
2291 * Check permissions on special pages & namespaces
2293 * @param string $action The action to check
2294 * @param User $user User to check
2295 * @param array $errors List of current errors
2296 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2297 * @param bool $short Short circuit on first error
2299 * @return array List of errors
2301 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $rigor, $short ) {
2302 # Only 'createaccount' can be performed on special pages,
2303 # which don't actually exist in the DB.
2304 if ( $this->isSpecialPage() && $action !== 'createaccount' ) {
2305 $errors[] = [ 'ns-specialprotected' ];
2308 # Check $wgNamespaceProtection for restricted namespaces
2309 if ( $this->isNamespaceProtected( $user ) ) {
2310 $ns = $this->mNamespace
== NS_MAIN ?
2311 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2312 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
2313 [ 'protectedinterface', $action ] : [ 'namespaceprotected', $ns, $action ];
2320 * Check sitewide CSS/JSON/JS permissions
2322 * @param string $action The action to check
2323 * @param User $user User to check
2324 * @param array $errors List of current errors
2325 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2326 * @param bool $short Short circuit on first error
2328 * @return array List of errors
2330 private function checkSiteConfigPermissions( $action, $user, $errors, $rigor, $short ) {
2331 if ( $action != 'patrol' ) {
2333 // Sitewide CSS/JSON/JS changes, like all NS_MEDIAWIKI changes, also require the
2334 // editinterface right. That's implemented as a restriction so no check needed here.
2335 if ( $this->isSiteCssConfigPage() && !$user->isAllowed( 'editsitecss' ) ) {
2336 $error = [ 'sitecssprotected', $action ];
2337 } elseif ( $this->isSiteJsonConfigPage() && !$user->isAllowed( 'editsitejson' ) ) {
2338 $error = [ 'sitejsonprotected', $action ];
2339 } elseif ( $this->isSiteJsConfigPage() && !$user->isAllowed( 'editsitejs' ) ) {
2340 $error = [ 'sitejsprotected', $action ];
2341 } elseif ( $this->isRawHtmlMessage() ) {
2342 // Raw HTML can be used to deploy CSS or JS so require rights for both.
2343 if ( !$user->isAllowed( 'editsitejs' ) ) {
2344 $error = [ 'sitejsprotected', $action ];
2345 } elseif ( !$user->isAllowed( 'editsitecss' ) ) {
2346 $error = [ 'sitecssprotected', $action ];
2351 if ( $user->isAllowed( 'editinterface' ) ) {
2352 // Most users / site admins will probably find out about the new, more restrictive
2353 // permissions by failing to edit something. Give them more info.
2354 // TODO remove this a few release cycles after 1.32
2355 $error = [ 'interfaceadmin-info', wfMessage( $error[0], $error[1] ) ];
2365 * Check CSS/JSON/JS sub-page permissions
2367 * @param string $action The action to check
2368 * @param User $user User to check
2369 * @param array $errors List of current errors
2370 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2371 * @param bool $short Short circuit on first error
2373 * @return array List of errors
2375 private function checkUserConfigPermissions( $action, $user, $errors, $rigor, $short ) {
2376 # Protect css/json/js subpages of user pages
2377 # XXX: this might be better using restrictions
2379 if ( $action === 'patrol' ) {
2383 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
2384 // Users need editmyuser* to edit their own CSS/JSON/JS subpages.
2386 $this->isUserCssConfigPage()
2387 && !$user->isAllowedAny( 'editmyusercss', 'editusercss' )
2389 $errors[] = [ 'mycustomcssprotected', $action ];
2391 $this->isUserJsonConfigPage()
2392 && !$user->isAllowedAny( 'editmyuserjson', 'edituserjson' )
2394 $errors[] = [ 'mycustomjsonprotected', $action ];
2396 $this->isUserJsConfigPage()
2397 && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' )
2399 $errors[] = [ 'mycustomjsprotected', $action ];
2402 // Users need editmyuser* to edit their own CSS/JSON/JS subpages, except for
2403 // deletion/suppression which cannot be used for attacks and we want to avoid the
2404 // situation where an unprivileged user can post abusive content on their subpages
2405 // and only very highly privileged users could remove it.
2406 if ( !in_array( $action, [ 'delete', 'deleterevision', 'suppressrevision' ], true ) ) {
2408 $this->isUserCssConfigPage()
2409 && !$user->isAllowed( 'editusercss' )
2411 $errors[] = [ 'customcssprotected', $action ];
2413 $this->isUserJsonConfigPage()
2414 && !$user->isAllowed( 'edituserjson' )
2416 $errors[] = [ 'customjsonprotected', $action ];
2418 $this->isUserJsConfigPage()
2419 && !$user->isAllowed( 'edituserjs' )
2421 $errors[] = [ 'customjsprotected', $action ];
2430 * Check against page_restrictions table requirements on this
2431 * page. The user must possess all required rights for this
2434 * @param string $action The action to check
2435 * @param User $user User to check
2436 * @param array $errors List of current errors
2437 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2438 * @param bool $short Short circuit on first error
2440 * @return array List of errors
2442 private function checkPageRestrictions( $action, $user, $errors, $rigor, $short ) {
2443 foreach ( $this->getRestrictions( $action ) as $right ) {
2444 // Backwards compatibility, rewrite sysop -> editprotected
2445 if ( $right == 'sysop' ) {
2446 $right = 'editprotected';
2448 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2449 if ( $right == 'autoconfirmed' ) {
2450 $right = 'editsemiprotected';
2452 if ( $right == '' ) {
2455 if ( !$user->isAllowed( $right ) ) {
2456 $errors[] = [ 'protectedpagetext', $right, $action ];
2457 } elseif ( $this->mCascadeRestriction
&& !$user->isAllowed( 'protect' ) ) {
2458 $errors[] = [ 'protectedpagetext', 'protect', $action ];
2466 * Check restrictions on cascading pages.
2468 * @param string $action The action to check
2469 * @param User $user User to check
2470 * @param array $errors List of current errors
2471 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2472 * @param bool $short Short circuit on first error
2474 * @return array List of errors
2476 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $rigor, $short ) {
2477 if ( $rigor !== 'quick' && !$this->isUserConfigPage() ) {
2478 # We /could/ use the protection level on the source page, but it's
2479 # fairly ugly as we have to establish a precedence hierarchy for pages
2480 # included by multiple cascade-protected pages. So just restrict
2481 # it to people with 'protect' permission, as they could remove the
2482 # protection anyway.
2483 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2484 # Cascading protection depends on more than this page...
2485 # Several cascading protected pages may include this page...
2486 # Check each cascading level
2487 # This is only for protection restrictions, not for all actions
2488 if ( isset( $restrictions[$action] ) ) {
2489 foreach ( $restrictions[$action] as $right ) {
2490 // Backwards compatibility, rewrite sysop -> editprotected
2491 if ( $right == 'sysop' ) {
2492 $right = 'editprotected';
2494 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2495 if ( $right == 'autoconfirmed' ) {
2496 $right = 'editsemiprotected';
2498 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2500 foreach ( $cascadingSources as $page ) {
2501 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2503 $errors[] = [ 'cascadeprotected', count( $cascadingSources ), $pages, $action ];
2513 * Check action permissions not already checked in checkQuickPermissions
2515 * @param string $action The action to check
2516 * @param User $user User to check
2517 * @param array $errors List of current errors
2518 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2519 * @param bool $short Short circuit on first error
2521 * @return array List of errors
2523 private function checkActionPermissions( $action, $user, $errors, $rigor, $short ) {
2524 global $wgDeleteRevisionsLimit, $wgLang;
2526 if ( $action == 'protect' ) {
2527 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2528 // If they can't edit, they shouldn't protect.
2529 $errors[] = [ 'protect-cantedit' ];
2531 } elseif ( $action == 'create' ) {
2532 $title_protection = $this->getTitleProtection();
2533 if ( $title_protection ) {
2534 if ( $title_protection['permission'] == ''
2535 ||
!$user->isAllowed( $title_protection['permission'] )
2539 User
::whoIs( $title_protection['user'] ),
2540 $title_protection['reason']
2544 } elseif ( $action == 'move' ) {
2545 // Check for immobile pages
2546 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2547 // Specific message for this case
2548 $errors[] = [ 'immobile-source-namespace', $this->getNsText() ];
2549 } elseif ( !$this->isMovable() ) {
2550 // Less specific message for rarer cases
2551 $errors[] = [ 'immobile-source-page' ];
2553 } elseif ( $action == 'move-target' ) {
2554 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2555 $errors[] = [ 'immobile-target-namespace', $this->getNsText() ];
2556 } elseif ( !$this->isMovable() ) {
2557 $errors[] = [ 'immobile-target-page' ];
2559 } elseif ( $action == 'delete' ) {
2560 $tempErrors = $this->checkPageRestrictions( 'edit', $user, [], $rigor, true );
2561 if ( !$tempErrors ) {
2562 $tempErrors = $this->checkCascadingSourcesRestrictions( 'edit',
2563 $user, $tempErrors, $rigor, true );
2565 if ( $tempErrors ) {
2566 // If protection keeps them from editing, they shouldn't be able to delete.
2567 $errors[] = [ 'deleteprotected' ];
2569 if ( $rigor !== 'quick' && $wgDeleteRevisionsLimit
2570 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2572 $errors[] = [ 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ];
2574 } elseif ( $action === 'undelete' ) {
2575 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2576 // Undeleting implies editing
2577 $errors[] = [ 'undelete-cantedit' ];
2579 if ( !$this->exists()
2580 && count( $this->getUserPermissionsErrorsInternal( 'create', $user, $rigor, true ) )
2582 // Undeleting where nothing currently exists implies creating
2583 $errors[] = [ 'undelete-cantcreate' ];
2590 * Check that the user isn't blocked from editing.
2592 * @param string $action The action to check
2593 * @param User $user User to check
2594 * @param array $errors List of current errors
2595 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2596 * @param bool $short Short circuit on first error
2598 * @return array List of errors
2600 private function checkUserBlock( $action, $user, $errors, $rigor, $short ) {
2601 global $wgEmailConfirmToEdit, $wgBlockDisablesLogin;
2602 // Account creation blocks handled at userlogin.
2603 // Unblocking handled in SpecialUnblock
2604 if ( $rigor === 'quick' ||
in_array( $action, [ 'createaccount', 'unblock' ] ) ) {
2608 // Optimize for a very common case
2609 if ( $action === 'read' && !$wgBlockDisablesLogin ) {
2613 if ( $wgEmailConfirmToEdit
2614 && !$user->isEmailConfirmed()
2615 && $action === 'edit'
2617 $errors[] = [ 'confirmedittext' ];
2620 $useReplica = ( $rigor !== 'secure' );
2621 $block = $user->getBlock( $useReplica );
2623 // If the user does not have a block, or the block they do have explicitly
2624 // allows the action (like "read" or "upload").
2625 if ( !$block ||
$block->appliesToRight( $action ) === false ) {
2629 // Determine if the user is blocked from this action on this page.
2630 // What gets passed into this method is a user right, not an action name.
2631 // There is no way to instantiate an action by restriction. However, this
2632 // will get the action where the restriction is the same. This may result
2633 // in actions being blocked that shouldn't be.
2635 if ( Action
::exists( $action ) ) {
2636 // Clone the title to prevent mutations to this object which is done
2637 // by Title::loadFromRow() in WikiPage::loadFromRow().
2638 $page = WikiPage
::factory( clone $this );
2639 // Creating an action will perform several database queries to ensure that
2640 // the action has not been overridden by the content type.
2641 // @todo FIXME: Pass the relevant context into this function.
2642 $actionObj = Action
::factory( $action, $page, RequestContext
::getMain() );
2643 // Ensure that the retrieved action matches the restriction.
2644 if ( $actionObj && $actionObj->getRestriction() !== $action ) {
2649 // If no action object is returned, assume that the action requires unblock
2650 // which is the default.
2651 if ( !$actionObj ||
$actionObj->requiresUnblock() ) {
2652 if ( $user->isBlockedFrom( $this, $useReplica ) ) {
2653 // @todo FIXME: Pass the relevant context into this function.
2654 $errors[] = $block->getPermissionsError( RequestContext
::getMain() );
2662 * Check that the user is allowed to read this page.
2664 * @param string $action The action to check
2665 * @param User $user User to check
2666 * @param array $errors List of current errors
2667 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2668 * @param bool $short Short circuit on first error
2670 * @return array List of errors
2672 private function checkReadPermissions( $action, $user, $errors, $rigor, $short ) {
2673 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2675 $whitelisted = false;
2676 if ( User
::isEveryoneAllowed( 'read' ) ) {
2677 # Shortcut for public wikis, allows skipping quite a bit of code
2678 $whitelisted = true;
2679 } elseif ( $user->isAllowed( 'read' ) ) {
2680 # If the user is allowed to read pages, he is allowed to read all pages
2681 $whitelisted = true;
2682 } elseif ( $this->isSpecial( 'Userlogin' )
2683 ||
$this->isSpecial( 'PasswordReset' )
2684 ||
$this->isSpecial( 'Userlogout' )
2686 # Always grant access to the login page.
2687 # Even anons need to be able to log in.
2688 $whitelisted = true;
2689 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2690 # Time to check the whitelist
2691 # Only do these checks is there's something to check against
2692 $name = $this->getPrefixedText();
2693 $dbName = $this->getPrefixedDBkey();
2695 // Check for explicit whitelisting with and without underscores
2696 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2697 $whitelisted = true;
2698 } elseif ( $this->mNamespace
== NS_MAIN
) {
2699 # Old settings might have the title prefixed with
2700 # a colon for main-namespace pages
2701 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2702 $whitelisted = true;
2704 } elseif ( $this->isSpecialPage() ) {
2705 # If it's a special page, ditch the subpage bit and check again
2706 $name = $this->mDbkeyform
;
2707 list( $name, /* $subpage */ ) =
2708 MediaWikiServices
::getInstance()->getSpecialPageFactory()->
2709 resolveAlias( $name );
2711 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2712 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2713 $whitelisted = true;
2719 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2720 $name = $this->getPrefixedText();
2721 // Check for regex whitelisting
2722 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2723 if ( preg_match( $listItem, $name ) ) {
2724 $whitelisted = true;
2730 if ( !$whitelisted ) {
2731 # If the title is not whitelisted, give extensions a chance to do so...
2732 Hooks
::run( 'TitleReadWhitelist', [ $this, $user, &$whitelisted ] );
2733 if ( !$whitelisted ) {
2734 $errors[] = $this->missingPermissionError( $action, $short );
2742 * Get a description array when the user doesn't have the right to perform
2743 * $action (i.e. when User::isAllowed() returns false)
2745 * @param string $action The action to check
2746 * @param bool $short Short circuit on first error
2747 * @return array Array containing an error message key and any parameters
2749 private function missingPermissionError( $action, $short ) {
2750 // We avoid expensive display logic for quickUserCan's and such
2752 return [ 'badaccess-group0' ];
2755 return User
::newFatalPermissionDeniedStatus( $action )->getErrorsArray()[0];
2759 * Can $user perform $action on this page? This is an internal function,
2760 * with multiple levels of checks depending on performance needs; see $rigor below.
2761 * It does not check wfReadOnly().
2763 * @param string $action Action that permission needs to be checked for
2764 * @param User $user User to check
2765 * @param string $rigor One of (quick,full,secure)
2766 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2767 * - full : does cheap and expensive checks possibly from a replica DB
2768 * - secure : does cheap and expensive checks, using the master as needed
2769 * @param bool $short Set this to true to stop after the first permission error.
2770 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2772 protected function getUserPermissionsErrorsInternal(
2773 $action, $user, $rigor = 'secure', $short = false
2775 if ( $rigor === true ) {
2776 $rigor = 'secure'; // b/c
2777 } elseif ( $rigor === false ) {
2778 $rigor = 'quick'; // b/c
2779 } elseif ( !in_array( $rigor, [ 'quick', 'full', 'secure' ] ) ) {
2780 throw new Exception( "Invalid rigor parameter '$rigor'." );
2783 # Read has special handling
2784 if ( $action == 'read' ) {
2786 'checkPermissionHooks',
2787 'checkReadPermissions',
2788 'checkUserBlock', // for wgBlockDisablesLogin
2790 # Don't call checkSpecialsAndNSPermissions, checkSiteConfigPermissions
2791 # or checkUserConfigPermissions here as it will lead to duplicate
2792 # error messages. This is okay to do since anywhere that checks for
2793 # create will also check for edit, and those checks are called for edit.
2794 } elseif ( $action == 'create' ) {
2796 'checkQuickPermissions',
2797 'checkPermissionHooks',
2798 'checkPageRestrictions',
2799 'checkCascadingSourcesRestrictions',
2800 'checkActionPermissions',
2805 'checkQuickPermissions',
2806 'checkPermissionHooks',
2807 'checkSpecialsAndNSPermissions',
2808 'checkSiteConfigPermissions',
2809 'checkUserConfigPermissions',
2810 'checkPageRestrictions',
2811 'checkCascadingSourcesRestrictions',
2812 'checkActionPermissions',
2818 foreach ( $checks as $method ) {
2819 $errors = $this->$method( $action, $user, $errors, $rigor, $short );
2821 if ( $short && $errors !== [] ) {
2830 * Get a filtered list of all restriction types supported by this wiki.
2831 * @param bool $exists True to get all restriction types that apply to
2832 * titles that do exist, False for all restriction types that apply to
2833 * titles that do not exist
2836 public static function getFilteredRestrictionTypes( $exists = true ) {
2837 global $wgRestrictionTypes;
2838 $types = $wgRestrictionTypes;
2840 # Remove the create restriction for existing titles
2841 $types = array_diff( $types, [ 'create' ] );
2843 # Only the create and upload restrictions apply to non-existing titles
2844 $types = array_intersect( $types, [ 'create', 'upload' ] );
2850 * Returns restriction types for the current Title
2852 * @return array Applicable restriction types
2854 public function getRestrictionTypes() {
2855 if ( $this->isSpecialPage() ) {
2859 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2861 if ( $this->mNamespace
!= NS_FILE
) {
2862 # Remove the upload restriction for non-file titles
2863 $types = array_diff( $types, [ 'upload' ] );
2866 Hooks
::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2868 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2869 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2875 * Is this title subject to title protection?
2876 * Title protection is the one applied against creation of such title.
2878 * @return array|bool An associative array representing any existent title
2879 * protection, or false if there's none.
2881 public function getTitleProtection() {
2882 $protection = $this->getTitleProtectionInternal();
2883 if ( $protection ) {
2884 if ( $protection['permission'] == 'sysop' ) {
2885 $protection['permission'] = 'editprotected'; // B/C
2887 if ( $protection['permission'] == 'autoconfirmed' ) {
2888 $protection['permission'] = 'editsemiprotected'; // B/C
2895 * Fetch title protection settings
2897 * To work correctly, $this->loadRestrictions() needs to have access to the
2898 * actual protections in the database without munging 'sysop' =>
2899 * 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other
2900 * callers probably want $this->getTitleProtection() instead.
2902 * @return array|bool
2904 protected function getTitleProtectionInternal() {
2905 // Can't protect pages in special namespaces
2906 if ( $this->mNamespace
< 0 ) {
2910 // Can't protect pages that exist.
2911 if ( $this->exists() ) {
2915 if ( $this->mTitleProtection
=== null ) {
2916 $dbr = wfGetDB( DB_REPLICA
);
2917 $commentStore = CommentStore
::getStore();
2918 $commentQuery = $commentStore->getJoin( 'pt_reason' );
2919 $res = $dbr->select(
2920 [ 'protected_titles' ] +
$commentQuery['tables'],
2922 'user' => 'pt_user',
2923 'expiry' => 'pt_expiry',
2924 'permission' => 'pt_create_perm'
2925 ] +
$commentQuery['fields'],
2926 [ 'pt_namespace' => $this->mNamespace
, 'pt_title' => $this->mDbkeyform
],
2929 $commentQuery['joins']
2932 // fetchRow returns false if there are no rows.
2933 $row = $dbr->fetchRow( $res );
2935 $this->mTitleProtection
= [
2936 'user' => $row['user'],
2937 'expiry' => $dbr->decodeExpiry( $row['expiry'] ),
2938 'permission' => $row['permission'],
2939 'reason' => $commentStore->getComment( 'pt_reason', $row )->text
,
2942 $this->mTitleProtection
= false;
2945 return $this->mTitleProtection
;
2949 * Remove any title protection due to page existing
2951 public function deleteTitleProtection() {
2952 $dbw = wfGetDB( DB_MASTER
);
2956 [ 'pt_namespace' => $this->mNamespace
, 'pt_title' => $this->mDbkeyform
],
2959 $this->mTitleProtection
= false;
2963 * Is this page "semi-protected" - the *only* protection levels are listed
2964 * in $wgSemiprotectedRestrictionLevels?
2966 * @param string $action Action to check (default: edit)
2969 public function isSemiProtected( $action = 'edit' ) {
2970 global $wgSemiprotectedRestrictionLevels;
2972 $restrictions = $this->getRestrictions( $action );
2973 $semi = $wgSemiprotectedRestrictionLevels;
2974 if ( !$restrictions ||
!$semi ) {
2975 // Not protected, or all protection is full protection
2979 // Remap autoconfirmed to editsemiprotected for BC
2980 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2981 $semi[$key] = 'editsemiprotected';
2983 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2984 $restrictions[$key] = 'editsemiprotected';
2987 return !array_diff( $restrictions, $semi );
2991 * Does the title correspond to a protected article?
2993 * @param string $action The action the page is protected from,
2994 * by default checks all actions.
2997 public function isProtected( $action = '' ) {
2998 global $wgRestrictionLevels;
3000 $restrictionTypes = $this->getRestrictionTypes();
3002 # Special pages have inherent protection
3003 if ( $this->isSpecialPage() ) {
3007 # Check regular protection levels
3008 foreach ( $restrictionTypes as $type ) {
3009 if ( $action == $type ||
$action == '' ) {
3010 $r = $this->getRestrictions( $type );
3011 foreach ( $wgRestrictionLevels as $level ) {
3012 if ( in_array( $level, $r ) && $level != '' ) {
3023 * Determines if $user is unable to edit this page because it has been protected
3024 * by $wgNamespaceProtection.
3026 * @param User $user User object to check permissions
3029 public function isNamespaceProtected( User
$user ) {
3030 global $wgNamespaceProtection;
3032 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
3033 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
3034 if ( $right != '' && !$user->isAllowed( $right ) ) {
3043 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
3045 * @return bool If the page is subject to cascading restrictions.
3047 public function isCascadeProtected() {
3048 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
3049 return ( $sources > 0 );
3053 * Determines whether cascading protection sources have already been loaded from
3056 * @param bool $getPages True to check if the pages are loaded, or false to check
3057 * if the status is loaded.
3058 * @return bool Whether or not the specified information has been loaded
3061 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
3062 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
3066 * Cascading protection: Get the source of any cascading restrictions on this page.
3068 * @param bool $getPages Whether or not to retrieve the actual pages
3069 * that the restrictions have come from and the actual restrictions
3071 * @return array Two elements: First is an array of Title objects of the
3072 * pages from which cascading restrictions have come, false for
3073 * none, or true if such restrictions exist but $getPages was not
3074 * set. Second is an array like that returned by
3075 * Title::getAllRestrictions(), or an empty array if $getPages is
3078 public function getCascadeProtectionSources( $getPages = true ) {
3079 $pagerestrictions = [];
3081 if ( $this->mCascadeSources
!== null && $getPages ) {
3082 return [ $this->mCascadeSources
, $this->mCascadingRestrictions
];
3083 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
3084 return [ $this->mHasCascadingRestrictions
, $pagerestrictions ];
3087 $dbr = wfGetDB( DB_REPLICA
);
3089 if ( $this->mNamespace
== NS_FILE
) {
3090 $tables = [ 'imagelinks', 'page_restrictions' ];
3092 'il_to' => $this->mDbkeyform
,
3097 $tables = [ 'templatelinks', 'page_restrictions' ];
3099 'tl_namespace' => $this->mNamespace
,
3100 'tl_title' => $this->mDbkeyform
,
3107 $cols = [ 'pr_page', 'page_namespace', 'page_title',
3108 'pr_expiry', 'pr_type', 'pr_level' ];
3109 $where_clauses[] = 'page_id=pr_page';
3112 $cols = [ 'pr_expiry' ];
3115 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
3117 $sources = $getPages ?
[] : false;
3118 $now = wfTimestampNow();
3120 foreach ( $res as $row ) {
3121 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
3122 if ( $expiry > $now ) {
3124 $page_id = $row->pr_page
;
3125 $page_ns = $row->page_namespace
;
3126 $page_title = $row->page_title
;
3127 $sources[$page_id] = self
::makeTitle( $page_ns, $page_title );
3128 # Add groups needed for each restriction type if its not already there
3129 # Make sure this restriction type still exists
3131 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
3132 $pagerestrictions[$row->pr_type
] = [];
3136 isset( $pagerestrictions[$row->pr_type
] )
3137 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
3139 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
3148 $this->mCascadeSources
= $sources;
3149 $this->mCascadingRestrictions
= $pagerestrictions;
3151 $this->mHasCascadingRestrictions
= $sources;
3154 return [ $sources, $pagerestrictions ];
3158 * Accessor for mRestrictionsLoaded
3160 * @return bool Whether or not the page's restrictions have already been
3161 * loaded from the database
3164 public function areRestrictionsLoaded() {
3165 return $this->mRestrictionsLoaded
;
3169 * Accessor/initialisation for mRestrictions
3171 * @param string $action Action that permission needs to be checked for
3172 * @return array Restriction levels needed to take the action. All levels are
3173 * required. Note that restriction levels are normally user rights, but 'sysop'
3174 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
3175 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
3177 public function getRestrictions( $action ) {
3178 if ( !$this->mRestrictionsLoaded
) {
3179 $this->loadRestrictions();
3181 return $this->mRestrictions
[$action] ??
[];
3185 * Accessor/initialisation for mRestrictions
3187 * @return array Keys are actions, values are arrays as returned by
3188 * Title::getRestrictions()
3191 public function getAllRestrictions() {
3192 if ( !$this->mRestrictionsLoaded
) {
3193 $this->loadRestrictions();
3195 return $this->mRestrictions
;
3199 * Get the expiry time for the restriction against a given action
3201 * @param string $action
3202 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
3203 * or not protected at all, or false if the action is not recognised.
3205 public function getRestrictionExpiry( $action ) {
3206 if ( !$this->mRestrictionsLoaded
) {
3207 $this->loadRestrictions();
3209 return $this->mRestrictionsExpiry
[$action] ??
false;
3213 * Returns cascading restrictions for the current article
3217 function areRestrictionsCascading() {
3218 if ( !$this->mRestrictionsLoaded
) {
3219 $this->loadRestrictions();
3222 return $this->mCascadeRestriction
;
3226 * Compiles list of active page restrictions from both page table (pre 1.10)
3227 * and page_restrictions table for this existing page.
3228 * Public for usage by LiquidThreads.
3230 * @param array $rows Array of db result objects
3231 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
3232 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
3233 * Edit and move sections are separated by a colon
3234 * Example: "edit=autoconfirmed,sysop:move=sysop"
3236 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
3237 // This function will only read rows from a table that we migrated away
3238 // from before adding READ_LATEST support to loadRestrictions, so we
3239 // don't need to support reading from DB_MASTER here.
3240 $dbr = wfGetDB( DB_REPLICA
);
3242 $restrictionTypes = $this->getRestrictionTypes();
3244 foreach ( $restrictionTypes as $type ) {
3245 $this->mRestrictions
[$type] = [];
3246 $this->mRestrictionsExpiry
[$type] = 'infinity';
3249 $this->mCascadeRestriction
= false;
3251 # Backwards-compatibility: also load the restrictions from the page record (old format).
3252 if ( $oldFashionedRestrictions !== null ) {
3253 $this->mOldRestrictions
= $oldFashionedRestrictions;
3256 if ( $this->mOldRestrictions
=== false ) {
3257 $this->mOldRestrictions
= $dbr->selectField( 'page', 'page_restrictions',
3258 [ 'page_id' => $this->getArticleID() ], __METHOD__
);
3261 if ( $this->mOldRestrictions
!= '' ) {
3262 foreach ( explode( ':', trim( $this->mOldRestrictions
) ) as $restrict ) {
3263 $temp = explode( '=', trim( $restrict ) );
3264 if ( count( $temp ) == 1 ) {
3265 // old old format should be treated as edit/move restriction
3266 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
3267 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
3269 $restriction = trim( $temp[1] );
3270 if ( $restriction != '' ) { // some old entries are empty
3271 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
3277 if ( count( $rows ) ) {
3278 # Current system - load second to make them override.
3279 $now = wfTimestampNow();
3281 # Cycle through all the restrictions.
3282 foreach ( $rows as $row ) {
3283 // Don't take care of restrictions types that aren't allowed
3284 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
3288 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
3290 // Only apply the restrictions if they haven't expired!
3291 if ( !$expiry ||
$expiry > $now ) {
3292 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
3293 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
3295 $this->mCascadeRestriction |
= $row->pr_cascade
;
3300 $this->mRestrictionsLoaded
= true;
3304 * Load restrictions from the page_restrictions table
3306 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
3307 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
3308 * Edit and move sections are separated by a colon
3309 * Example: "edit=autoconfirmed,sysop:move=sysop"
3310 * @param int $flags A bit field. If self::READ_LATEST is set, skip replicas and read
3311 * from the master DB.
3313 public function loadRestrictions( $oldFashionedRestrictions = null, $flags = 0 ) {
3314 $readLatest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
3315 if ( $this->mRestrictionsLoaded
&& !$readLatest ) {
3319 // TODO: should probably pass $flags into getArticleID, but it seems hacky
3320 // to mix READ_LATEST and GAID_FOR_UPDATE, even if they have the same value.
3321 // Maybe deprecate GAID_FOR_UPDATE now that we implement IDBAccessObject?
3322 $id = $this->getArticleID();
3324 $fname = __METHOD__
;
3325 $loadRestrictionsFromDb = function ( Database
$dbr ) use ( $fname, $id ) {
3326 return iterator_to_array(
3328 'page_restrictions',
3329 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
3330 [ 'pr_page' => $id ],
3336 if ( $readLatest ) {
3337 $dbr = wfGetDB( DB_MASTER
);
3338 $rows = $loadRestrictionsFromDb( $dbr );
3340 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
3341 $rows = $cache->getWithSetCallback(
3342 // Page protections always leave a new null revision
3343 $cache->makeKey( 'page-restrictions', $id, $this->getLatestRevID() ),
3345 function ( $curValue, &$ttl, array &$setOpts ) use ( $loadRestrictionsFromDb ) {
3346 $dbr = wfGetDB( DB_REPLICA
);
3348 $setOpts +
= Database
::getCacheSetOptions( $dbr );
3350 return $loadRestrictionsFromDb( $dbr );
3355 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
3357 $title_protection = $this->getTitleProtectionInternal();
3359 if ( $title_protection ) {
3360 $now = wfTimestampNow();
3361 $expiry = wfGetDB( DB_REPLICA
)->decodeExpiry( $title_protection['expiry'] );
3363 if ( !$expiry ||
$expiry > $now ) {
3364 // Apply the restrictions
3365 $this->mRestrictionsExpiry
['create'] = $expiry;
3366 $this->mRestrictions
['create'] =
3367 explode( ',', trim( $title_protection['permission'] ) );
3368 } else { // Get rid of the old restrictions
3369 $this->mTitleProtection
= false;
3372 $this->mRestrictionsExpiry
['create'] = 'infinity';
3374 $this->mRestrictionsLoaded
= true;
3379 * Flush the protection cache in this object and force reload from the database.
3380 * This is used when updating protection from WikiPage::doUpdateRestrictions().
3382 public function flushRestrictions() {
3383 $this->mRestrictionsLoaded
= false;
3384 $this->mTitleProtection
= null;
3388 * Purge expired restrictions from the page_restrictions table
3390 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
3392 static function purgeExpiredRestrictions() {
3393 if ( wfReadOnly() ) {
3397 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
3398 wfGetDB( DB_MASTER
),
3400 function ( IDatabase
$dbw, $fname ) {
3401 $config = MediaWikiServices
::getInstance()->getMainConfig();
3402 $ids = $dbw->selectFieldValues(
3403 'page_restrictions',
3405 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3407 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
3410 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
3415 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
3416 wfGetDB( DB_MASTER
),
3418 function ( IDatabase
$dbw, $fname ) {
3421 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3429 * Does this have subpages? (Warning, usually requires an extra DB query.)
3433 public function hasSubpages() {
3434 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3439 # We dynamically add a member variable for the purpose of this method
3440 # alone to cache the result. There's no point in having it hanging
3441 # around uninitialized in every Title object; therefore we only add it
3442 # if needed and don't declare it statically.
3443 if ( $this->mHasSubpages
=== null ) {
3444 $this->mHasSubpages
= false;
3445 $subpages = $this->getSubpages( 1 );
3446 if ( $subpages instanceof TitleArray
) {
3447 $this->mHasSubpages
= (bool)$subpages->count();
3451 return $this->mHasSubpages
;
3455 * Get all subpages of this page.
3457 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3458 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3459 * doesn't allow subpages
3461 public function getSubpages( $limit = -1 ) {
3462 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3466 $dbr = wfGetDB( DB_REPLICA
);
3467 $conds['page_namespace'] = $this->mNamespace
;
3468 $conds[] = 'page_title ' . $dbr->buildLike( $this->mDbkeyform
. '/', $dbr->anyString() );
3470 if ( $limit > -1 ) {
3471 $options['LIMIT'] = $limit;
3473 return TitleArray
::newFromResult(
3474 $dbr->select( 'page',
3475 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
3484 * Is there a version of this page in the deletion archive?
3486 * @return int The number of archived revisions
3488 public function isDeleted() {
3489 if ( $this->mNamespace
< 0 ) {
3492 $dbr = wfGetDB( DB_REPLICA
);
3494 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3495 [ 'ar_namespace' => $this->mNamespace
, 'ar_title' => $this->mDbkeyform
],
3498 if ( $this->mNamespace
== NS_FILE
) {
3499 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
3500 [ 'fa_name' => $this->mDbkeyform
],
3509 * Is there a version of this page in the deletion archive?
3513 public function isDeletedQuick() {
3514 if ( $this->mNamespace
< 0 ) {
3517 $dbr = wfGetDB( DB_REPLICA
);
3518 $deleted = (bool)$dbr->selectField( 'archive', '1',
3519 [ 'ar_namespace' => $this->mNamespace
, 'ar_title' => $this->mDbkeyform
],
3522 if ( !$deleted && $this->mNamespace
== NS_FILE
) {
3523 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3524 [ 'fa_name' => $this->mDbkeyform
],
3532 * Get the article ID for this Title from the link cache,
3533 * adding it if necessary
3535 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3537 * @return int The ID
3539 public function getArticleID( $flags = 0 ) {
3540 if ( $this->mNamespace
< 0 ) {
3541 $this->mArticleID
= 0;
3542 return $this->mArticleID
;
3544 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3545 if ( $flags & self
::GAID_FOR_UPDATE
) {
3546 $oldUpdate = $linkCache->forUpdate( true );
3547 $linkCache->clearLink( $this );
3548 $this->mArticleID
= $linkCache->addLinkObj( $this );
3549 $linkCache->forUpdate( $oldUpdate );
3551 if ( $this->mArticleID
== -1 ) {
3552 $this->mArticleID
= $linkCache->addLinkObj( $this );
3555 return $this->mArticleID
;
3559 * Is this an article that is a redirect page?
3560 * Uses link cache, adding it if necessary
3562 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3565 public function isRedirect( $flags = 0 ) {
3566 if ( !is_null( $this->mRedirect
) ) {
3567 return $this->mRedirect
;
3569 if ( !$this->getArticleID( $flags ) ) {
3570 $this->mRedirect
= false;
3571 return $this->mRedirect
;
3574 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3575 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3576 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3577 if ( $cached === null ) {
3578 # Trust LinkCache's state over our own
3579 # LinkCache is telling us that the page doesn't exist, despite there being cached
3580 # data relating to an existing page in $this->mArticleID. Updaters should clear
3581 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3582 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3583 # LinkCache to refresh its data from the master.
3584 $this->mRedirect
= false;
3585 return $this->mRedirect
;
3588 $this->mRedirect
= (bool)$cached;
3590 return $this->mRedirect
;
3594 * What is the length of this page?
3595 * Uses link cache, adding it if necessary
3597 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3600 public function getLength( $flags = 0 ) {
3601 if ( $this->mLength
!= -1 ) {
3602 return $this->mLength
;
3604 if ( !$this->getArticleID( $flags ) ) {
3606 return $this->mLength
;
3608 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3609 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3610 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3611 if ( $cached === null ) {
3612 # Trust LinkCache's state over our own, as for isRedirect()
3614 return $this->mLength
;
3617 $this->mLength
= intval( $cached );
3619 return $this->mLength
;
3623 * What is the page_latest field for this page?
3625 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3626 * @return int Int or 0 if the page doesn't exist
3628 public function getLatestRevID( $flags = 0 ) {
3629 if ( !( $flags & self
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
3630 return intval( $this->mLatestID
);
3632 if ( !$this->getArticleID( $flags ) ) {
3633 $this->mLatestID
= 0;
3634 return $this->mLatestID
;
3636 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3637 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3638 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3639 if ( $cached === null ) {
3640 # Trust LinkCache's state over our own, as for isRedirect()
3641 $this->mLatestID
= 0;
3642 return $this->mLatestID
;
3645 $this->mLatestID
= intval( $cached );
3647 return $this->mLatestID
;
3651 * This clears some fields in this object, and clears any associated
3652 * keys in the "bad links" section of the link cache.
3654 * - This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow
3655 * loading of the new page_id. It's also called from
3656 * WikiPage::doDeleteArticleReal()
3658 * @param int $newid The new Article ID
3660 public function resetArticleID( $newid ) {
3661 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3662 $linkCache->clearLink( $this );
3664 if ( $newid === false ) {
3665 $this->mArticleID
= -1;
3667 $this->mArticleID
= intval( $newid );
3669 $this->mRestrictionsLoaded
= false;
3670 $this->mRestrictions
= [];
3671 $this->mOldRestrictions
= false;
3672 $this->mRedirect
= null;
3673 $this->mLength
= -1;
3674 $this->mLatestID
= false;
3675 $this->mContentModel
= false;
3676 $this->mEstimateRevisions
= null;
3677 $this->mPageLanguage
= false;
3678 $this->mDbPageLanguage
= false;
3679 $this->mIsBigDeletion
= null;
3682 public static function clearCaches() {
3683 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3684 $linkCache->clear();
3686 $titleCache = self
::getTitleCache();
3687 $titleCache->clear();
3691 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3693 * @param string $text Containing title to capitalize
3694 * @param int $ns Namespace index, defaults to NS_MAIN
3695 * @return string Containing capitalized title
3697 public static function capitalize( $text, $ns = NS_MAIN
) {
3698 if ( MWNamespace
::isCapitalized( $ns ) ) {
3699 return MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $text );
3706 * Secure and split - main initialisation function for this object
3708 * Assumes that mDbkeyform has been set, and is urldecoded
3709 * and uses underscores, but not otherwise munged. This function
3710 * removes illegal characters, splits off the interwiki and
3711 * namespace prefixes, sets the other forms, and canonicalizes
3714 * @throws MalformedTitleException On invalid titles
3715 * @return bool True on success
3717 private function secureAndSplit() {
3718 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3719 // the parsing code with Title, while avoiding massive refactoring.
3720 // @todo: get rid of secureAndSplit, refactor parsing code.
3721 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3722 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3723 $titleCodec = MediaWikiServices
::getInstance()->getTitleParser();
3724 // MalformedTitleException can be thrown here
3725 $parts = $titleCodec->splitTitleString( $this->mDbkeyform
, $this->mDefaultNamespace
);
3728 $this->setFragment( '#' . $parts['fragment'] );
3729 $this->mInterwiki
= $parts['interwiki'];
3730 $this->mLocalInterwiki
= $parts['local_interwiki'];
3731 $this->mNamespace
= $parts['namespace'];
3732 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3734 $this->mDbkeyform
= $parts['dbkey'];
3735 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3736 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );
3738 # We already know that some pages won't be in the database!
3739 if ( $this->isExternal() ||
$this->isSpecialPage() ) {
3740 $this->mArticleID
= 0;
3747 * Get an array of Title objects linking to this Title
3748 * Also stores the IDs in the link cache.
3750 * WARNING: do not use this function on arbitrary user-supplied titles!
3751 * On heavily-used templates it will max out the memory.
3753 * @param array $options May be FOR UPDATE
3754 * @param string $table Table name
3755 * @param string $prefix Fields prefix
3756 * @return Title[] Array of Title objects linking here
3758 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3759 if ( count( $options ) > 0 ) {
3760 $db = wfGetDB( DB_MASTER
);
3762 $db = wfGetDB( DB_REPLICA
);
3767 self
::getSelectFields(),
3769 "{$prefix}_from=page_id",
3770 "{$prefix}_namespace" => $this->mNamespace
,
3771 "{$prefix}_title" => $this->mDbkeyform
],
3777 if ( $res->numRows() ) {
3778 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3779 foreach ( $res as $row ) {
3780 $titleObj = self
::makeTitle( $row->page_namespace
, $row->page_title
);
3782 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3783 $retVal[] = $titleObj;
3791 * Get an array of Title objects using this Title as a template
3792 * Also stores the IDs in the link cache.
3794 * WARNING: do not use this function on arbitrary user-supplied titles!
3795 * On heavily-used templates it will max out the memory.
3797 * @param array $options Query option to Database::select()
3798 * @return Title[] Array of Title the Title objects linking here
3800 public function getTemplateLinksTo( $options = [] ) {
3801 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3805 * Get an array of Title objects linked from this Title
3806 * Also stores the IDs in the link cache.
3808 * WARNING: do not use this function on arbitrary user-supplied titles!
3809 * On heavily-used templates it will max out the memory.
3811 * @param array $options Query option to Database::select()
3812 * @param string $table Table name
3813 * @param string $prefix Fields prefix
3814 * @return array Array of Title objects linking here
3816 public function getLinksFrom( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3817 $id = $this->getArticleID();
3819 # If the page doesn't exist; there can't be any link from this page
3824 $db = wfGetDB( DB_REPLICA
);
3826 $blNamespace = "{$prefix}_namespace";
3827 $blTitle = "{$prefix}_title";
3829 $pageQuery = WikiPage
::getQueryInfo();
3831 [ $table, 'nestpage' => $pageQuery['tables'] ],
3833 [ $blNamespace, $blTitle ],
3834 $pageQuery['fields']
3836 [ "{$prefix}_from" => $id ],
3841 [ "page_namespace=$blNamespace", "page_title=$blTitle" ]
3842 ] ] +
$pageQuery['joins']
3846 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3847 foreach ( $res as $row ) {
3848 if ( $row->page_id
) {
3849 $titleObj = self
::newFromRow( $row );
3851 $titleObj = self
::makeTitle( $row->$blNamespace, $row->$blTitle );
3852 $linkCache->addBadLinkObj( $titleObj );
3854 $retVal[] = $titleObj;
3861 * Get an array of Title objects used on this Title as a template
3862 * Also stores the IDs in the link cache.
3864 * WARNING: do not use this function on arbitrary user-supplied titles!
3865 * On heavily-used templates it will max out the memory.
3867 * @param array $options May be FOR UPDATE
3868 * @return Title[] Array of Title the Title objects used here
3870 public function getTemplateLinksFrom( $options = [] ) {
3871 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3875 * Get an array of Title objects referring to non-existent articles linked
3878 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3879 * should use redirect table in this case).
3880 * @return Title[] Array of Title the Title objects
3882 public function getBrokenLinksFrom() {
3883 if ( $this->getArticleID() == 0 ) {
3884 # All links from article ID 0 are false positives
3888 $dbr = wfGetDB( DB_REPLICA
);
3889 $res = $dbr->select(
3890 [ 'page', 'pagelinks' ],
3891 [ 'pl_namespace', 'pl_title' ],
3893 'pl_from' => $this->getArticleID(),
3894 'page_namespace IS NULL'
3900 [ 'pl_namespace=page_namespace', 'pl_title=page_title' ]
3906 foreach ( $res as $row ) {
3907 $retVal[] = self
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3913 * Get a list of URLs to purge from the CDN cache when this
3916 * @return string[] Array of String the URLs
3918 public function getCdnUrls() {
3920 $this->getInternalURL(),
3921 $this->getInternalURL( 'action=history' )
3924 $pageLang = $this->getPageLanguage();
3925 if ( $pageLang->hasVariants() ) {
3926 $variants = $pageLang->getVariants();
3927 foreach ( $variants as $vCode ) {
3928 $urls[] = $this->getInternalURL( $vCode );
3932 // If we are looking at a css/js user subpage, purge the action=raw.
3933 if ( $this->isUserJsConfigPage() ) {
3934 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/javascript' );
3935 } elseif ( $this->isUserJsonConfigPage() ) {
3936 $urls[] = $this->getInternalURL( 'action=raw&ctype=application/json' );
3937 } elseif ( $this->isUserCssConfigPage() ) {
3938 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/css' );
3941 Hooks
::run( 'TitleSquidURLs', [ $this, &$urls ] );
3946 * Purge all applicable CDN URLs
3948 public function purgeSquid() {
3949 DeferredUpdates
::addUpdate(
3950 new CdnCacheUpdate( $this->getCdnUrls() ),
3951 DeferredUpdates
::PRESEND
3956 * Check whether a given move operation would be valid.
3957 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3959 * @deprecated since 1.25, use MovePage's methods instead
3960 * @param Title &$nt The new title
3961 * @param bool $auth Whether to check user permissions (uses $wgUser)
3962 * @param string $reason Is the log summary of the move, used for spam checking
3963 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3965 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3968 if ( !( $nt instanceof Title
) ) {
3969 // Normally we'd add this to $errors, but we'll get
3970 // lots of syntax errors if $nt is not an object
3971 return [ [ 'badtitletext' ] ];
3974 $mp = new MovePage( $this, $nt );
3975 $errors = $mp->isValidMove()->getErrorsArray();
3977 $errors = wfMergeErrorArrays(
3979 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
3983 return $errors ?
: true;
3987 * Move a title to a new location
3989 * @deprecated since 1.25, use the MovePage class instead
3990 * @param Title &$nt The new title
3991 * @param bool $auth Indicates whether $wgUser's permissions
3993 * @param string $reason The reason for the move
3994 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3995 * Ignored if the user doesn't have the suppressredirect right.
3996 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3997 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3999 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true,
4000 array $changeTags = []
4003 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
4004 if ( is_array( $err ) ) {
4005 // Auto-block user's IP if the account was "hard" blocked
4006 $wgUser->spreadAnyEditBlock();
4009 // Check suppressredirect permission
4010 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
4011 $createRedirect = true;
4014 $mp = new MovePage( $this, $nt );
4015 $status = $mp->move( $wgUser, $reason, $createRedirect, $changeTags );
4016 if ( $status->isOK() ) {
4019 return $status->getErrorsArray();
4024 * Move this page's subpages to be subpages of $nt
4026 * @param Title $nt Move target
4027 * @param bool $auth Whether $wgUser's permissions should be checked
4028 * @param string $reason The reason for the move
4029 * @param bool $createRedirect Whether to create redirects from the old subpages to
4030 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
4031 * @param array $changeTags Applied to the entry in the move log and redirect page revision
4032 * @return array Array with old page titles as keys, and strings (new page titles) or
4033 * getUserPermissionsErrors()-like arrays (errors) as values, or a
4034 * getUserPermissionsErrors()-like error array with numeric indices if
4035 * no pages were moved
4037 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true,
4038 array $changeTags = []
4040 global $wgMaximumMovedPages;
4041 // Check permissions
4042 if ( !$this->userCan( 'move-subpages' ) ) {
4044 [ 'cant-move-subpages' ],
4047 // Do the source and target namespaces support subpages?
4048 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
4050 [ 'namespace-nosubpages', MWNamespace
::getCanonicalName( $this->mNamespace
) ],
4053 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
4055 [ 'namespace-nosubpages', MWNamespace
::getCanonicalName( $nt->getNamespace() ) ],
4059 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
4062 foreach ( $subpages as $oldSubpage ) {
4064 if ( $count > $wgMaximumMovedPages ) {
4065 $retval[$oldSubpage->getPrefixedText()] = [
4066 [ 'movepage-max-pages', $wgMaximumMovedPages ],
4071 // We don't know whether this function was called before
4072 // or after moving the root page, so check both
4074 if ( $oldSubpage->getArticleID() == $this->getArticleID()
4075 ||
$oldSubpage->getArticleID() == $nt->getArticleID()
4077 // When moving a page to a subpage of itself,
4078 // don't move it twice
4081 $newPageName = preg_replace(
4082 '#^' . preg_quote( $this->mDbkeyform
, '#' ) . '#',
4083 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # T23234
4084 $oldSubpage->getDBkey() );
4085 if ( $oldSubpage->isTalkPage() ) {
4086 $newNs = $nt->getTalkPage()->getNamespace();
4088 $newNs = $nt->getSubjectPage()->getNamespace();
4090 # T16385: we need makeTitleSafe because the new page names may
4091 # be longer than 255 characters.
4092 $newSubpage = self
::makeTitleSafe( $newNs, $newPageName );
4094 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect, $changeTags );
4095 if ( $success === true ) {
4096 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
4098 $retval[$oldSubpage->getPrefixedText()] = $success;
4105 * Checks if this page is just a one-rev redirect.
4106 * Adds lock, so don't use just for light purposes.
4110 public function isSingleRevRedirect() {
4111 global $wgContentHandlerUseDB;
4113 $dbw = wfGetDB( DB_MASTER
);
4116 $fields = [ 'page_is_redirect', 'page_latest', 'page_id' ];
4117 if ( $wgContentHandlerUseDB ) {
4118 $fields[] = 'page_content_model';
4121 $row = $dbw->selectRow( 'page',
4127 # Cache some fields we may want
4128 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
4129 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
4130 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
4131 $this->mContentModel
= $row && isset( $row->page_content_model
)
4132 ?
strval( $row->page_content_model
)
4135 if ( !$this->mRedirect
) {
4138 # Does the article have a history?
4139 $row = $dbw->selectField( [ 'page', 'revision' ],
4141 [ 'page_namespace' => $this->mNamespace
,
4142 'page_title' => $this->mDbkeyform
,
4144 'page_latest != rev_id'
4149 # Return true if there was no history
4150 return ( $row === false );
4154 * Checks if $this can be moved to a given Title
4155 * - Selects for update, so don't call it unless you mean business
4157 * @deprecated since 1.25, use MovePage's methods instead
4158 * @param Title $nt The new title to check
4161 public function isValidMoveTarget( $nt ) {
4162 # Is it an existing file?
4163 if ( $nt->getNamespace() == NS_FILE
) {
4164 $file = wfLocalFile( $nt );
4165 $file->load( File
::READ_LATEST
);
4166 if ( $file->exists() ) {
4167 wfDebug( __METHOD__
. ": file exists\n" );
4171 # Is it a redirect with no history?
4172 if ( !$nt->isSingleRevRedirect() ) {
4173 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
4176 # Get the article text
4177 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
4178 if ( !is_object( $rev ) ) {
4181 $content = $rev->getContent();
4182 # Does the redirect point to the source?
4183 # Or is it a broken self-redirect, usually caused by namespace collisions?
4184 $redirTitle = $content ?
$content->getRedirectTarget() : null;
4186 if ( $redirTitle ) {
4187 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
4188 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
4189 wfDebug( __METHOD__
. ": redirect points to other page\n" );
4195 # Fail safe (not a redirect after all. strange.)
4196 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4197 " is a redirect, but it doesn't contain a valid redirect.\n" );
4203 * Get categories to which this Title belongs and return an array of
4204 * categories' names.
4206 * @return array Array of parents in the form:
4207 * $parent => $currentarticle
4209 public function getParentCategories() {
4212 $titleKey = $this->getArticleID();
4214 if ( $titleKey === 0 ) {
4218 $dbr = wfGetDB( DB_REPLICA
);
4220 $res = $dbr->select(
4223 [ 'cl_from' => $titleKey ],
4227 if ( $res->numRows() > 0 ) {
4228 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
4229 foreach ( $res as $row ) {
4230 // $data[] = Title::newFromText( $contLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
4231 $data[$contLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] =
4232 $this->getFullText();
4239 * Get a tree of parent categories
4241 * @param array $children Array with the children in the keys, to check for circular refs
4242 * @return array Tree of parent categories
4244 public function getParentCategoryTree( $children = [] ) {
4246 $parents = $this->getParentCategories();
4249 foreach ( $parents as $parent => $current ) {
4250 if ( array_key_exists( $parent, $children ) ) {
4251 # Circular reference
4252 $stack[$parent] = [];
4254 $nt = self
::newFromText( $parent );
4256 $stack[$parent] = $nt->getParentCategoryTree( $children +
[ $parent => 1 ] );
4266 * Get an associative array for selecting this title from
4269 * @return array Array suitable for the $where parameter of DB::select()
4271 public function pageCond() {
4272 if ( $this->mArticleID
> 0 ) {
4273 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4274 return [ 'page_id' => $this->mArticleID
];
4276 return [ 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
];
4281 * Get next/previous revision ID relative to another revision ID
4282 * @param int $revId Revision ID. Get the revision that was before this one.
4283 * @param int $flags Title::GAID_FOR_UPDATE
4284 * @param string $dir 'next' or 'prev'
4285 * @return int|bool New revision ID, or false if none exists
4287 private function getRelativeRevisionID( $revId, $flags, $dir ) {
4288 $revId = (int)$revId;
4289 if ( $dir === 'next' ) {
4292 } elseif ( $dir === 'prev' ) {
4296 throw new InvalidArgumentException( '$dir must be "next" or "prev"' );
4299 if ( $flags & self
::GAID_FOR_UPDATE
) {
4300 $db = wfGetDB( DB_MASTER
);
4302 $db = wfGetDB( DB_REPLICA
, 'contributions' );
4305 // Intentionally not caring if the specified revision belongs to this
4306 // page. We only care about the timestamp.
4307 $ts = $db->selectField( 'revision', 'rev_timestamp', [ 'rev_id' => $revId ], __METHOD__
);
4308 if ( $ts === false ) {
4309 $ts = $db->selectField( 'archive', 'ar_timestamp', [ 'ar_rev_id' => $revId ], __METHOD__
);
4310 if ( $ts === false ) {
4311 // Or should this throw an InvalidArgumentException or something?
4315 $ts = $db->addQuotes( $ts );
4317 $revId = $db->selectField( 'revision', 'rev_id',
4319 'rev_page' => $this->getArticleID( $flags ),
4320 "rev_timestamp $op $ts OR (rev_timestamp = $ts AND rev_id $op $revId)"
4324 'ORDER BY' => "rev_timestamp $sort, rev_id $sort",
4325 'IGNORE INDEX' => 'rev_timestamp', // Probably needed for T159319
4329 if ( $revId === false ) {
4332 return intval( $revId );
4337 * Get the revision ID of the previous revision
4339 * @param int $revId Revision ID. Get the revision that was before this one.
4340 * @param int $flags Title::GAID_FOR_UPDATE
4341 * @return int|bool Old revision ID, or false if none exists
4343 public function getPreviousRevisionID( $revId, $flags = 0 ) {
4344 return $this->getRelativeRevisionID( $revId, $flags, 'prev' );
4348 * Get the revision ID of the next revision
4350 * @param int $revId Revision ID. Get the revision that was after this one.
4351 * @param int $flags Title::GAID_FOR_UPDATE
4352 * @return int|bool Next revision ID, or false if none exists
4354 public function getNextRevisionID( $revId, $flags = 0 ) {
4355 return $this->getRelativeRevisionID( $revId, $flags, 'next' );
4359 * Get the first revision of the page
4361 * @param int $flags Title::GAID_FOR_UPDATE
4362 * @return Revision|null If page doesn't exist
4364 public function getFirstRevision( $flags = 0 ) {
4365 $pageId = $this->getArticleID( $flags );
4367 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
4368 $revQuery = Revision
::getQueryInfo();
4369 $row = $db->selectRow( $revQuery['tables'], $revQuery['fields'],
4370 [ 'rev_page' => $pageId ],
4373 'ORDER BY' => 'rev_timestamp ASC, rev_id ASC',
4374 'IGNORE INDEX' => [ 'revision' => 'rev_timestamp' ], // See T159319
4379 return new Revision( $row, 0, $this );
4386 * Get the oldest revision timestamp of this page
4388 * @param int $flags Title::GAID_FOR_UPDATE
4389 * @return string|null MW timestamp
4391 public function getEarliestRevTime( $flags = 0 ) {
4392 $rev = $this->getFirstRevision( $flags );
4393 return $rev ?
$rev->getTimestamp() : null;
4397 * Check if this is a new page
4401 public function isNewPage() {
4402 $dbr = wfGetDB( DB_REPLICA
);
4403 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4407 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4411 public function isBigDeletion() {
4412 global $wgDeleteRevisionsLimit;
4414 if ( !$wgDeleteRevisionsLimit ) {
4418 if ( $this->mIsBigDeletion
=== null ) {
4419 $dbr = wfGetDB( DB_REPLICA
);
4421 $revCount = $dbr->selectRowCount(
4424 [ 'rev_page' => $this->getArticleID() ],
4426 [ 'LIMIT' => $wgDeleteRevisionsLimit +
1 ]
4429 $this->mIsBigDeletion
= $revCount > $wgDeleteRevisionsLimit;
4432 return $this->mIsBigDeletion
;
4436 * Get the approximate revision count of this page.
4440 public function estimateRevisionCount() {
4441 if ( !$this->exists() ) {
4445 if ( $this->mEstimateRevisions
=== null ) {
4446 $dbr = wfGetDB( DB_REPLICA
);
4447 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4448 [ 'rev_page' => $this->getArticleID() ], __METHOD__
);
4451 return $this->mEstimateRevisions
;
4455 * Get the number of revisions between the given revision.
4456 * Used for diffs and other things that really need it.
4458 * @param int|Revision $old Old revision or rev ID (first before range)
4459 * @param int|Revision $new New revision or rev ID (first after range)
4460 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4461 * @return int Number of revisions between these revisions.
4463 public function countRevisionsBetween( $old, $new, $max = null ) {
4464 if ( !( $old instanceof Revision
) ) {
4465 $old = Revision
::newFromTitle( $this, (int)$old );
4467 if ( !( $new instanceof Revision
) ) {
4468 $new = Revision
::newFromTitle( $this, (int)$new );
4470 if ( !$old ||
!$new ) {
4471 return 0; // nothing to compare
4473 $dbr = wfGetDB( DB_REPLICA
);
4475 'rev_page' => $this->getArticleID(),
4476 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4477 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4479 if ( $max !== null ) {
4480 return $dbr->selectRowCount( 'revision', '1',
4483 [ 'LIMIT' => $max +
1 ] // extra to detect truncation
4486 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
4491 * Get the authors between the given revisions or revision IDs.
4492 * Used for diffs and other things that really need it.
4496 * @param int|Revision $old Old revision or rev ID (first before range by default)
4497 * @param int|Revision $new New revision or rev ID (first after range by default)
4498 * @param int $limit Maximum number of authors
4499 * @param string|array $options (Optional): Single option, or an array of options:
4500 * 'include_old' Include $old in the range; $new is excluded.
4501 * 'include_new' Include $new in the range; $old is excluded.
4502 * 'include_both' Include both $old and $new in the range.
4503 * Unknown option values are ignored.
4504 * @return array|null Names of revision authors in the range; null if not both revisions exist
4506 public function getAuthorsBetween( $old, $new, $limit, $options = [] ) {
4507 if ( !( $old instanceof Revision
) ) {
4508 $old = Revision
::newFromTitle( $this, (int)$old );
4510 if ( !( $new instanceof Revision
) ) {
4511 $new = Revision
::newFromTitle( $this, (int)$new );
4513 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4514 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4515 // in the sanity check below?
4516 if ( !$old ||
!$new ) {
4517 return null; // nothing to compare
4522 $options = (array)$options;
4523 if ( in_array( 'include_old', $options ) ) {
4526 if ( in_array( 'include_new', $options ) ) {
4529 if ( in_array( 'include_both', $options ) ) {
4533 // No DB query needed if $old and $new are the same or successive revisions:
4534 if ( $old->getId() === $new->getId() ) {
4535 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
4537 [ $old->getUserText( Revision
::RAW
) ];
4538 } elseif ( $old->getId() === $new->getParentId() ) {
4539 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4540 $authors[] = $old->getUserText( Revision
::RAW
);
4541 if ( $old->getUserText( Revision
::RAW
) != $new->getUserText( Revision
::RAW
) ) {
4542 $authors[] = $new->getUserText( Revision
::RAW
);
4544 } elseif ( $old_cmp === '>=' ) {
4545 $authors[] = $old->getUserText( Revision
::RAW
);
4546 } elseif ( $new_cmp === '<=' ) {
4547 $authors[] = $new->getUserText( Revision
::RAW
);
4551 $dbr = wfGetDB( DB_REPLICA
);
4552 $revQuery = Revision
::getQueryInfo();
4553 $authors = $dbr->selectFieldValues(
4554 $revQuery['tables'],
4555 $revQuery['fields']['rev_user_text'],
4557 'rev_page' => $this->getArticleID(),
4558 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4559 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4561 [ 'DISTINCT', 'LIMIT' => $limit +
1 ], // add one so caller knows it was truncated
4568 * Get the number of authors between the given revisions or revision IDs.
4569 * Used for diffs and other things that really need it.
4571 * @param int|Revision $old Old revision or rev ID (first before range by default)
4572 * @param int|Revision $new New revision or rev ID (first after range by default)
4573 * @param int $limit Maximum number of authors
4574 * @param string|array $options (Optional): Single option, or an array of options:
4575 * 'include_old' Include $old in the range; $new is excluded.
4576 * 'include_new' Include $new in the range; $old is excluded.
4577 * 'include_both' Include both $old and $new in the range.
4578 * Unknown option values are ignored.
4579 * @return int Number of revision authors in the range; zero if not both revisions exist
4581 public function countAuthorsBetween( $old, $new, $limit, $options = [] ) {
4582 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4583 return $authors ?
count( $authors ) : 0;
4587 * Compare with another title.
4589 * @param Title $title
4592 public function equals( Title
$title ) {
4593 // Note: === is necessary for proper matching of number-like titles.
4594 return $this->mInterwiki
=== $title->mInterwiki
4595 && $this->mNamespace
== $title->mNamespace
4596 && $this->mDbkeyform
=== $title->mDbkeyform
;
4600 * Check if this title is a subpage of another title
4602 * @param Title $title
4605 public function isSubpageOf( Title
$title ) {
4606 return $this->mInterwiki
=== $title->mInterwiki
4607 && $this->mNamespace
== $title->mNamespace
4608 && strpos( $this->mDbkeyform
, $title->mDbkeyform
. '/' ) === 0;
4612 * Check if page exists. For historical reasons, this function simply
4613 * checks for the existence of the title in the page table, and will
4614 * thus return false for interwiki links, special pages and the like.
4615 * If you want to know if a title can be meaningfully viewed, you should
4616 * probably call the isKnown() method instead.
4618 * @param int $flags An optional bit field; may be Title::GAID_FOR_UPDATE to check
4619 * from master/for update
4622 public function exists( $flags = 0 ) {
4623 $exists = $this->getArticleID( $flags ) != 0;
4624 Hooks
::run( 'TitleExists', [ $this, &$exists ] );
4629 * Should links to this title be shown as potentially viewable (i.e. as
4630 * "bluelinks"), even if there's no record by this title in the page
4633 * This function is semi-deprecated for public use, as well as somewhat
4634 * misleadingly named. You probably just want to call isKnown(), which
4635 * calls this function internally.
4637 * (ISSUE: Most of these checks are cheap, but the file existence check
4638 * can potentially be quite expensive. Including it here fixes a lot of
4639 * existing code, but we might want to add an optional parameter to skip
4640 * it and any other expensive checks.)
4644 public function isAlwaysKnown() {
4648 * Allows overriding default behavior for determining if a page exists.
4649 * If $isKnown is kept as null, regular checks happen. If it's
4650 * a boolean, this value is returned by the isKnown method.
4654 * @param Title $title
4655 * @param bool|null $isKnown
4657 Hooks
::run( 'TitleIsAlwaysKnown', [ $this, &$isKnown ] );
4659 if ( !is_null( $isKnown ) ) {
4663 if ( $this->isExternal() ) {
4664 return true; // any interwiki link might be viewable, for all we know
4667 switch ( $this->mNamespace
) {
4670 // file exists, possibly in a foreign repo
4671 return (bool)wfFindFile( $this );
4673 // valid special page
4674 return MediaWikiServices
::getInstance()->getSpecialPageFactory()->
4675 exists( $this->mDbkeyform
);
4677 // selflink, possibly with fragment
4678 return $this->mDbkeyform
== '';
4680 // known system message
4681 return $this->hasSourceText() !== false;
4688 * Does this title refer to a page that can (or might) be meaningfully
4689 * viewed? In particular, this function may be used to determine if
4690 * links to the title should be rendered as "bluelinks" (as opposed to
4691 * "redlinks" to non-existent pages).
4692 * Adding something else to this function will cause inconsistency
4693 * since LinkHolderArray calls isAlwaysKnown() and does its own
4694 * page existence check.
4698 public function isKnown() {
4699 return $this->isAlwaysKnown() ||
$this->exists();
4703 * Does this page have source text?
4707 public function hasSourceText() {
4708 if ( $this->exists() ) {
4712 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4713 // If the page doesn't exist but is a known system message, default
4714 // message content will be displayed, same for language subpages-
4715 // Use always content language to avoid loading hundreds of languages
4716 // to get the link color.
4717 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
4718 list( $name, ) = MessageCache
::singleton()->figureMessage(
4719 $contLang->lcfirst( $this->getText() )
4721 $message = wfMessage( $name )->inLanguage( $contLang )->useDatabase( false );
4722 return $message->exists();
4729 * Get the default (plain) message contents for an page that overrides an
4730 * interface message key.
4732 * Primary use cases:
4735 * - Show default when viewing the page. The Article::getSubstituteContent
4736 * method displays the default message content, instead of the
4737 * 'noarticletext' placeholder message normally used.
4740 * - Title of edit page. When creating an interface message override,
4741 * the editor is told they are "Editing the page", instead of
4742 * "Creating the page". (EditPage::setHeaders)
4743 * - Edit notice. The 'translateinterface' edit notice is shown when creating
4744 * or editing a an interface message override. (EditPage::showIntro)
4745 * - Opening the editor. The contents of the localisation message are used
4746 * as contents of the editor when creating a new page in the MediaWiki
4747 * namespace. This simplifies the process for editors when "changing"
4748 * an interface message by creating an override. (EditPage::getContentObject)
4749 * - Showing a diff. The left-hand side of a diff when an editor is
4750 * previewing their changes before saving the creation of a page in the
4751 * MediaWiki namespace. (EditPage::showDiff)
4752 * - Disallowing a save. When attempting to create a a MediaWiki-namespace
4753 * page with the proposed content matching the interface message default,
4754 * the save is rejected, the same way we disallow blank pages from being
4755 * created. (EditPage::internalAttemptSave)
4758 * - Default content, when using the 'prepend' or 'append' feature.
4761 * - Label the create action as "Edit", if the page can be an override.
4763 * @return string|bool
4765 public function getDefaultMessageText() {
4766 if ( $this->mNamespace
!= NS_MEDIAWIKI
) { // Just in case
4770 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4771 MediaWikiServices
::getInstance()->getContentLanguage()->lcfirst( $this->getText() )
4773 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4775 if ( $message->exists() ) {
4776 return $message->plain();
4783 * Updates page_touched for this page; called from LinksUpdate.php
4785 * @param string|null $purgeTime [optional] TS_MW timestamp
4786 * @return bool True if the update succeeded
4788 public function invalidateCache( $purgeTime = null ) {
4789 if ( wfReadOnly() ) {
4791 } elseif ( $this->mArticleID
=== 0 ) {
4792 return true; // avoid gap locking if we know it's not there
4795 $dbw = wfGetDB( DB_MASTER
);
4796 $dbw->onTransactionPreCommitOrIdle(
4797 function () use ( $dbw ) {
4798 ResourceLoaderWikiModule
::invalidateModuleCache(
4799 $this, null, null, $dbw->getDomainId() );
4804 $conds = $this->pageCond();
4805 DeferredUpdates
::addUpdate(
4806 new AutoCommitUpdate(
4809 function ( IDatabase
$dbw, $fname ) use ( $conds, $purgeTime ) {
4810 $dbTimestamp = $dbw->timestamp( $purgeTime ?
: time() );
4813 [ 'page_touched' => $dbTimestamp ],
4814 $conds +
[ 'page_touched < ' . $dbw->addQuotes( $dbTimestamp ) ],
4817 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $this );
4820 DeferredUpdates
::PRESEND
4827 * Update page_touched timestamps and send CDN purge messages for
4828 * pages linking to this title. May be sent to the job queue depending
4829 * on the number of links. Typically called on create and delete.
4831 public function touchLinks() {
4832 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this, 'pagelinks', 'page-touch' ) );
4833 if ( $this->mNamespace
== NS_CATEGORY
) {
4834 DeferredUpdates
::addUpdate(
4835 new HTMLCacheUpdate( $this, 'categorylinks', 'category-touch' )
4841 * Get the last touched timestamp
4843 * @param IDatabase|null $db
4844 * @return string|false Last-touched timestamp
4846 public function getTouched( $db = null ) {
4847 if ( $db === null ) {
4848 $db = wfGetDB( DB_REPLICA
);
4850 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4855 * Get the timestamp when this page was updated since the user last saw it.
4857 * @param User|null $user
4858 * @return string|null
4860 public function getNotificationTimestamp( $user = null ) {
4863 // Assume current user if none given
4867 // Check cache first
4868 $uid = $user->getId();
4872 // avoid isset here, as it'll return false for null entries
4873 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4874 return $this->mNotificationTimestamp
[$uid];
4876 // Don't cache too much!
4877 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4878 $this->mNotificationTimestamp
= [];
4881 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
4882 $watchedItem = $store->getWatchedItem( $user, $this );
4883 if ( $watchedItem ) {
4884 $this->mNotificationTimestamp
[$uid] = $watchedItem->getNotificationTimestamp();
4886 $this->mNotificationTimestamp
[$uid] = false;
4889 return $this->mNotificationTimestamp
[$uid];
4893 * Generate strings used for xml 'id' names in monobook tabs
4895 * @param string $prepend Defaults to 'nstab-'
4896 * @return string XML 'id' name
4898 public function getNamespaceKey( $prepend = 'nstab-' ) {
4899 // Gets the subject namespace of this title
4900 $subjectNS = MWNamespace
::getSubject( $this->mNamespace
);
4901 // Prefer canonical namespace name for HTML IDs
4902 $namespaceKey = MWNamespace
::getCanonicalName( $subjectNS );
4903 if ( $namespaceKey === false ) {
4904 // Fallback to localised text
4905 $namespaceKey = $this->getSubjectNsText();
4907 // Makes namespace key lowercase
4908 $namespaceKey = MediaWikiServices
::getInstance()->getContentLanguage()->lc( $namespaceKey );
4910 if ( $namespaceKey == '' ) {
4911 $namespaceKey = 'main';
4913 // Changes file to image for backwards compatibility
4914 if ( $namespaceKey == 'file' ) {
4915 $namespaceKey = 'image';
4917 return $prepend . $namespaceKey;
4921 * Get all extant redirects to this Title
4923 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4924 * @return Title[] Array of Title redirects to this title
4926 public function getRedirectsHere( $ns = null ) {
4929 $dbr = wfGetDB( DB_REPLICA
);
4931 'rd_namespace' => $this->mNamespace
,
4932 'rd_title' => $this->mDbkeyform
,
4935 if ( $this->isExternal() ) {
4936 $where['rd_interwiki'] = $this->mInterwiki
;
4938 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4940 if ( !is_null( $ns ) ) {
4941 $where['page_namespace'] = $ns;
4944 $res = $dbr->select(
4945 [ 'redirect', 'page' ],
4946 [ 'page_namespace', 'page_title' ],
4951 foreach ( $res as $row ) {
4952 $redirs[] = self
::newFromRow( $row );
4958 * Check if this Title is a valid redirect target
4962 public function isValidRedirectTarget() {
4963 global $wgInvalidRedirectTargets;
4965 if ( $this->isSpecialPage() ) {
4966 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4967 if ( $this->isSpecial( 'Userlogout' ) ) {
4971 foreach ( $wgInvalidRedirectTargets as $target ) {
4972 if ( $this->isSpecial( $target ) ) {
4982 * Get a backlink cache object
4984 * @return BacklinkCache
4986 public function getBacklinkCache() {
4987 return BacklinkCache
::get( $this );
4991 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4995 public function canUseNoindex() {
4996 global $wgExemptFromUserRobotsControl;
4998 $bannedNamespaces = $wgExemptFromUserRobotsControl ?? MWNamespace
::getContentNamespaces();
5000 return !in_array( $this->mNamespace
, $bannedNamespaces );
5004 * Returns the raw sort key to be used for categories, with the specified
5005 * prefix. This will be fed to Collation::getSortKey() to get a
5006 * binary sortkey that can be used for actual sorting.
5008 * @param string $prefix The prefix to be used, specified using
5009 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
5013 public function getCategorySortkey( $prefix = '' ) {
5014 $unprefixed = $this->getText();
5016 // Anything that uses this hook should only depend
5017 // on the Title object passed in, and should probably
5018 // tell the users to run updateCollations.php --force
5019 // in order to re-sort existing category relations.
5020 Hooks
::run( 'GetDefaultSortkey', [ $this, &$unprefixed ] );
5021 if ( $prefix !== '' ) {
5022 # Separate with a line feed, so the unprefixed part is only used as
5023 # a tiebreaker when two pages have the exact same prefix.
5024 # In UCA, tab is the only character that can sort above LF
5025 # so we strip both of them from the original prefix.
5026 $prefix = strtr( $prefix, "\n\t", ' ' );
5027 return "$prefix\n$unprefixed";
5033 * Returns the page language code saved in the database, if $wgPageLanguageUseDB is set
5034 * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
5035 * the db, it will return NULL.
5037 * @return string|null|bool
5039 private function getDbPageLanguageCode() {
5040 global $wgPageLanguageUseDB;
5042 // check, if the page language could be saved in the database, and if so and
5043 // the value is not requested already, lookup the page language using LinkCache
5044 if ( $wgPageLanguageUseDB && $this->mDbPageLanguage
=== false ) {
5045 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
5046 $linkCache->addLinkObj( $this );
5047 $this->mDbPageLanguage
= $linkCache->getGoodLinkFieldObj( $this, 'lang' );
5050 return $this->mDbPageLanguage
;
5054 * Get the language in which the content of this page is written in
5055 * wikitext. Defaults to content language, but in certain cases it can be
5056 * e.g. $wgLang (such as special pages, which are in the user language).
5061 public function getPageLanguage() {
5062 global $wgLang, $wgLanguageCode;
5063 if ( $this->isSpecialPage() ) {
5064 // special pages are in the user language
5068 // Checking if DB language is set
5069 $dbPageLanguage = $this->getDbPageLanguageCode();
5070 if ( $dbPageLanguage ) {
5071 return wfGetLangObj( $dbPageLanguage );
5074 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
5075 // Note that this may depend on user settings, so the cache should
5076 // be only per-request.
5077 // NOTE: ContentHandler::getPageLanguage() may need to load the
5078 // content to determine the page language!
5079 // Checking $wgLanguageCode hasn't changed for the benefit of unit
5081 $contentHandler = ContentHandler
::getForTitle( $this );
5082 $langObj = $contentHandler->getPageLanguage( $this );
5083 $this->mPageLanguage
= [ $langObj->getCode(), $wgLanguageCode ];
5085 $langObj = Language
::factory( $this->mPageLanguage
[0] );
5092 * Get the language in which the content of this page is written when
5093 * viewed by user. Defaults to content language, but in certain cases it can be
5094 * e.g. $wgLang (such as special pages, which are in the user language).
5099 public function getPageViewLanguage() {
5102 if ( $this->isSpecialPage() ) {
5103 // If the user chooses a variant, the content is actually
5104 // in a language whose code is the variant code.
5105 $variant = $wgLang->getPreferredVariant();
5106 if ( $wgLang->getCode() !== $variant ) {
5107 return Language
::factory( $variant );
5113 // Checking if DB language is set
5114 $dbPageLanguage = $this->getDbPageLanguageCode();
5115 if ( $dbPageLanguage ) {
5116 $pageLang = wfGetLangObj( $dbPageLanguage );
5117 $variant = $pageLang->getPreferredVariant();
5118 if ( $pageLang->getCode() !== $variant ) {
5119 $pageLang = Language
::factory( $variant );
5125 // @note Can't be cached persistently, depends on user settings.
5126 // @note ContentHandler::getPageViewLanguage() may need to load the
5127 // content to determine the page language!
5128 $contentHandler = ContentHandler
::getForTitle( $this );
5129 $pageLang = $contentHandler->getPageViewLanguage( $this );
5134 * Get a list of rendered edit notices for this page.
5136 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
5137 * they will already be wrapped in paragraphs.
5140 * @param int $oldid Revision ID that's being edited
5143 public function getEditNotices( $oldid = 0 ) {
5146 // Optional notice for the entire namespace
5147 $editnotice_ns = 'editnotice-' . $this->mNamespace
;
5148 $msg = wfMessage( $editnotice_ns );
5149 if ( $msg->exists() ) {
5150 $html = $msg->parseAsBlock();
5151 // Edit notices may have complex logic, but output nothing (T91715)
5152 if ( trim( $html ) !== '' ) {
5153 $notices[$editnotice_ns] = Html
::rawElement(
5157 'mw-editnotice-namespace',
5158 Sanitizer
::escapeClass( "mw-$editnotice_ns" )
5165 if ( MWNamespace
::hasSubpages( $this->mNamespace
) ) {
5166 // Optional notice for page itself and any parent page
5167 $editnotice_base = $editnotice_ns;
5168 foreach ( explode( '/', $this->mDbkeyform
) as $part ) {
5169 $editnotice_base .= '-' . $part;
5170 $msg = wfMessage( $editnotice_base );
5171 if ( $msg->exists() ) {
5172 $html = $msg->parseAsBlock();
5173 if ( trim( $html ) !== '' ) {
5174 $notices[$editnotice_base] = Html
::rawElement(
5178 'mw-editnotice-base',
5179 Sanitizer
::escapeClass( "mw-$editnotice_base" )
5187 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
5188 $editnoticeText = $editnotice_ns . '-' . strtr( $this->mDbkeyform
, '/', '-' );
5189 $msg = wfMessage( $editnoticeText );
5190 if ( $msg->exists() ) {
5191 $html = $msg->parseAsBlock();
5192 if ( trim( $html ) !== '' ) {
5193 $notices[$editnoticeText] = Html
::rawElement(
5197 'mw-editnotice-page',
5198 Sanitizer
::escapeClass( "mw-$editnoticeText" )
5206 Hooks
::run( 'TitleGetEditNotices', [ $this, $oldid, &$notices ] );
5213 public function __sleep() {
5221 'mDefaultNamespace',
5225 public function __wakeup() {
5226 $this->mArticleID
= ( $this->mNamespace
>= 0 ) ?
-1 : 0;
5227 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
5228 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );