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 MediaWiki\Permissions\PermissionManager
;
26 use MediaWiki\Storage\RevisionRecord
;
27 use Wikimedia\Assert\Assert
;
28 use Wikimedia\Rdbms\Database
;
29 use Wikimedia\Rdbms\IDatabase
;
30 use MediaWiki\Linker\LinkTarget
;
31 use MediaWiki\Interwiki\InterwikiLookup
;
32 use MediaWiki\MediaWikiServices
;
35 * Represents a title within MediaWiki.
36 * Optionally may contain an interwiki designation or namespace.
37 * @note This class can fetch various kinds of data from the database;
38 * however, it does so inefficiently.
39 * @note Consider using a TitleValue object instead. TitleValue is more lightweight
40 * and does not rely on global state or the database.
42 class Title
implements LinkTarget
, IDBAccessObject
{
43 /** @var MapCacheLRU|null */
44 private static $titleCache = null;
47 * Title::newFromText maintains a cache to avoid expensive re-normalization of
48 * commonly used titles. On a batch operation this can become a memory leak
49 * if not bounded. After hitting this many titles reset the cache.
51 const CACHE_MAX
= 1000;
54 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
55 * to use the master DB
57 const GAID_FOR_UPDATE
= 1;
60 * Flag for use with factory methods like newFromLinkTarget() that have
61 * a $forceClone parameter. If set, the method must return a new instance.
62 * Without this flag, some factory methods may return existing instances.
66 const NEW_CLONE
= 'clone';
69 * @name Private member variables
70 * Please use the accessor functions instead.
75 /** @var string Text form (spaces not underscores) of the main part */
76 public $mTextform = '';
78 /** @var string URL-encoded form of the main part */
79 public $mUrlform = '';
81 /** @var string Main part with underscores */
82 public $mDbkeyform = '';
84 /** @var string Database key with the initial letter in the case specified by the user */
85 protected $mUserCaseDBKey;
87 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
88 public $mNamespace = NS_MAIN
;
90 /** @var string Interwiki prefix */
91 public $mInterwiki = '';
93 /** @var bool Was this Title created from a string with a local interwiki prefix? */
94 private $mLocalInterwiki = false;
96 /** @var string Title fragment (i.e. the bit after the #) */
97 public $mFragment = '';
99 /** @var int Article ID, fetched from the link cache on demand */
100 public $mArticleID = -1;
102 /** @var bool|int ID of most recent revision */
103 protected $mLatestID = false;
106 * @var bool|string ID of the page's content model, i.e. one of the
107 * CONTENT_MODEL_XXX constants
109 private $mContentModel = false;
112 * @var bool If a content model was forced via setContentModel()
113 * this will be true to avoid having other code paths reset it
115 private $mForcedContentModel = false;
117 /** @var int Estimated number of revisions; null of not loaded */
118 private $mEstimateRevisions;
120 /** @var array Array of groups allowed to edit this article */
121 public $mRestrictions = [];
124 * @var string|bool Comma-separated set of permission keys
125 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
126 * Edit and move sections are separated by a colon
127 * Example: "edit=autoconfirmed,sysop:move=sysop"
129 protected $mOldRestrictions = false;
131 /** @var bool Cascade restrictions on this page to included templates and images? */
132 public $mCascadeRestriction;
134 /** Caching the results of getCascadeProtectionSources */
135 public $mCascadingRestrictions;
137 /** @var array When do the restrictions on this page expire? */
138 protected $mRestrictionsExpiry = [];
140 /** @var bool Are cascading restrictions in effect on this page? */
141 protected $mHasCascadingRestrictions;
143 /** @var array Where are the cascading restrictions coming from on this page? */
144 public $mCascadeSources;
146 /** @var bool Boolean for initialisation on demand */
147 public $mRestrictionsLoaded = false;
150 * Text form including namespace/interwiki, initialised on demand
152 * Only public to share cache with TitleFormatter
157 public $prefixedText = null;
159 /** @var mixed Cached value for getTitleProtection (create protection) */
160 public $mTitleProtection;
163 * @var int Namespace index when there is no namespace. Don't change the
164 * following default, NS_MAIN is hardcoded in several places. See T2696.
165 * Zero except in {{transclusion}} tags.
167 public $mDefaultNamespace = NS_MAIN
;
169 /** @var int The page length, 0 for special pages */
170 protected $mLength = -1;
172 /** @var null Is the article at this title a redirect? */
173 public $mRedirect = null;
175 /** @var array Associative array of user ID -> timestamp/false */
176 private $mNotificationTimestamp = [];
178 /** @var bool Whether a page has any subpages */
179 private $mHasSubpages;
181 /** @var array|null The (string) language code of the page's language and content code. */
182 private $mPageLanguage;
184 /** @var string|bool|null The page language code from the database, null if not saved in
185 * the database or false if not loaded, yet.
187 private $mDbPageLanguage = false;
189 /** @var TitleValue|null A corresponding TitleValue object */
190 private $mTitleValue = null;
192 /** @var bool|null Would deleting this page be a big deletion? */
193 private $mIsBigDeletion = null;
197 * B/C kludge: provide a TitleParser for use by Title.
198 * Ideally, Title would have no methods that need this.
199 * Avoid usage of this singleton by using TitleValue
200 * and the associated services when possible.
202 * @return TitleFormatter
204 private static function getTitleFormatter() {
205 return MediaWikiServices
::getInstance()->getTitleFormatter();
209 * B/C kludge: provide an InterwikiLookup for use by Title.
210 * Ideally, Title would have no methods that need this.
211 * Avoid usage of this singleton by using TitleValue
212 * and the associated services when possible.
214 * @return InterwikiLookup
216 private static function getInterwikiLookup() {
217 return MediaWikiServices
::getInstance()->getInterwikiLookup();
223 function __construct() {
227 * Create a new Title from a prefixed DB key
229 * @param string $key The database key, which has underscores
230 * instead of spaces, possibly including namespace and
232 * @return Title|null Title, or null on an error
234 public static function newFromDBkey( $key ) {
236 $t->mDbkeyform
= $key;
239 $t->secureAndSplit();
241 } catch ( MalformedTitleException
$ex ) {
247 * Returns a Title given a TitleValue.
248 * If the given TitleValue is already a Title instance, that instance is returned,
249 * unless $forceClone is "clone". If $forceClone is "clone" and the given TitleValue
250 * is already a Title instance, that instance is copied using the clone operator.
252 * @deprecated since 1.34, use newFromLinkTarget or castFromLinkTarget
254 * @param TitleValue $titleValue Assumed to be safe.
255 * @param string $forceClone set to NEW_CLONE to ensure a fresh instance is returned.
259 public static function newFromTitleValue( TitleValue
$titleValue, $forceClone = '' ) {
260 return self
::newFromLinkTarget( $titleValue, $forceClone );
264 * Returns a Title given a LinkTarget.
265 * If the given LinkTarget is already a Title instance, that instance is returned,
266 * unless $forceClone is "clone". If $forceClone is "clone" and the given LinkTarget
267 * is already a Title instance, that instance is copied using the clone operator.
269 * @param LinkTarget $linkTarget Assumed to be safe.
270 * @param string $forceClone set to NEW_CLONE to ensure a fresh instance is returned.
274 public static function newFromLinkTarget( LinkTarget
$linkTarget, $forceClone = '' ) {
275 if ( $linkTarget instanceof Title
) {
276 // Special case if it's already a Title object
277 if ( $forceClone === self
::NEW_CLONE
) {
278 return clone $linkTarget;
283 return self
::makeTitle(
284 $linkTarget->getNamespace(),
285 $linkTarget->getText(),
286 $linkTarget->getFragment(),
287 $linkTarget->getInterwiki()
292 * Same as newFromLinkTarget, but if passed null, returns null.
294 * @param LinkTarget|null $linkTarget Assumed to be safe (if not null).
298 public static function castFromLinkTarget( $linkTarget ) {
299 return $linkTarget ? self
::newFromLinkTarget( $linkTarget ) : null;
303 * Create a new Title from text, such as what one would find in a link. De-
304 * codes any HTML entities in the text.
306 * Title objects returned by this method are guaranteed to be valid, and
307 * thus return true from the isValid() method.
309 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
310 * It may instead be a cached instance created previously, with references to it remaining
313 * @param string|int|null $text The link text; spaces, prefixes, and an
314 * initial ':' indicating the main namespace are accepted.
315 * @param int $defaultNamespace The namespace to use if none is specified
316 * by a prefix. If you want to force a specific namespace even if
317 * $text might begin with a namespace prefix, use makeTitle() or
319 * @throws InvalidArgumentException
320 * @return Title|null Title or null on an error.
322 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
323 // DWIM: Integers can be passed in here when page titles are used as array keys.
324 if ( $text !== null && !is_string( $text ) && !is_int( $text ) ) {
325 throw new InvalidArgumentException( '$text must be a string.' );
327 if ( $text === null ) {
332 return self
::newFromTextThrow( (string)$text, $defaultNamespace );
333 } catch ( MalformedTitleException
$ex ) {
339 * Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,
340 * rather than returning null.
342 * The exception subclasses encode detailed information about why the title is invalid.
344 * Title objects returned by this method are guaranteed to be valid, and
345 * thus return true from the isValid() method.
347 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
348 * It may instead be a cached instance created previously, with references to it remaining
351 * @see Title::newFromText
354 * @param string $text Title text to check
355 * @param int $defaultNamespace
356 * @throws MalformedTitleException If the title is invalid
359 public static function newFromTextThrow( $text, $defaultNamespace = NS_MAIN
) {
360 if ( is_object( $text ) ) {
361 throw new MWException( '$text must be a string, given an object' );
362 } elseif ( $text === null ) {
363 // Legacy code relies on MalformedTitleException being thrown in this case
364 // (happens when URL with no title in it is parsed). TODO fix
365 throw new MalformedTitleException( 'title-invalid-empty' );
368 $titleCache = self
::getTitleCache();
370 // Wiki pages often contain multiple links to the same page.
371 // Title normalization and parsing can become expensive on pages with many
372 // links, so we can save a little time by caching them.
373 // In theory these are value objects and won't get changed...
374 if ( $defaultNamespace == NS_MAIN
) {
375 $t = $titleCache->get( $text );
381 // Convert things like é ā or 〗 into normalized (T16952) text
382 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
385 $t->mDbkeyform
= strtr( $filteredText, ' ', '_' );
386 $t->mDefaultNamespace
= (int)$defaultNamespace;
388 $t->secureAndSplit();
389 if ( $defaultNamespace == NS_MAIN
) {
390 $titleCache->set( $text, $t );
396 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
398 * Example of wrong and broken code:
399 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
401 * Example of right code:
402 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
404 * Create a new Title from URL-encoded text. Ensures that
405 * the given title's length does not exceed the maximum.
407 * @param string $url The title, as might be taken from a URL
408 * @return Title|null The new object, or null on an error
410 public static function newFromURL( $url ) {
413 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
414 # but some URLs used it as a space replacement and they still come
415 # from some external search tools.
416 if ( strpos( self
::legalChars(), '+' ) === false ) {
417 $url = strtr( $url, '+', ' ' );
420 $t->mDbkeyform
= strtr( $url, ' ', '_' );
423 $t->secureAndSplit();
425 } catch ( MalformedTitleException
$ex ) {
431 * @return MapCacheLRU
433 private static function getTitleCache() {
434 if ( self
::$titleCache === null ) {
435 self
::$titleCache = new MapCacheLRU( self
::CACHE_MAX
);
437 return self
::$titleCache;
441 * Returns a list of fields that are to be selected for initializing Title
442 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
443 * whether to include page_content_model.
447 protected static function getSelectFields() {
448 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
451 'page_namespace', 'page_title', 'page_id',
452 'page_len', 'page_is_redirect', 'page_latest',
455 if ( $wgContentHandlerUseDB ) {
456 $fields[] = 'page_content_model';
459 if ( $wgPageLanguageUseDB ) {
460 $fields[] = 'page_lang';
467 * Create a new Title from an article ID
469 * @param int $id The page_id corresponding to the Title to create
470 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
471 * @return Title|null The new object, or null on an error
473 public static function newFromID( $id, $flags = 0 ) {
474 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
475 $row = $db->selectRow(
477 self
::getSelectFields(),
478 [ 'page_id' => $id ],
481 if ( $row !== false ) {
482 $title = self
::newFromRow( $row );
491 * Make an array of titles from an array of IDs
493 * @param int[] $ids Array of IDs
494 * @return Title[] Array of Titles
496 public static function newFromIDs( $ids ) {
497 if ( !count( $ids ) ) {
500 $dbr = wfGetDB( DB_REPLICA
);
504 self
::getSelectFields(),
505 [ 'page_id' => $ids ],
510 foreach ( $res as $row ) {
511 $titles[] = self
::newFromRow( $row );
517 * Make a Title object from a DB row
519 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
520 * @return Title Corresponding Title
522 public static function newFromRow( $row ) {
523 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
524 $t->loadFromRow( $row );
529 * Load Title object fields from a DB row.
530 * If false is given, the title will be treated as non-existing.
532 * @param stdClass|bool $row Database row
534 public function loadFromRow( $row ) {
535 if ( $row ) { // page found
536 if ( isset( $row->page_id
) ) {
537 $this->mArticleID
= (int)$row->page_id
;
539 if ( isset( $row->page_len
) ) {
540 $this->mLength
= (int)$row->page_len
;
542 if ( isset( $row->page_is_redirect
) ) {
543 $this->mRedirect
= (bool)$row->page_is_redirect
;
545 if ( isset( $row->page_latest
) ) {
546 $this->mLatestID
= (int)$row->page_latest
;
548 if ( !$this->mForcedContentModel
&& isset( $row->page_content_model
) ) {
549 $this->mContentModel
= (string)$row->page_content_model
;
550 } elseif ( !$this->mForcedContentModel
) {
551 $this->mContentModel
= false; # initialized lazily in getContentModel()
553 if ( isset( $row->page_lang
) ) {
554 $this->mDbPageLanguage
= (string)$row->page_lang
;
556 if ( isset( $row->page_restrictions
) ) {
557 $this->mOldRestrictions
= $row->page_restrictions
;
559 } else { // page not found
560 $this->mArticleID
= 0;
562 $this->mRedirect
= false;
563 $this->mLatestID
= 0;
564 if ( !$this->mForcedContentModel
) {
565 $this->mContentModel
= false; # initialized lazily in getContentModel()
571 * Create a new Title from a namespace index and a DB key.
573 * It's assumed that $ns and $title are safe, for instance when
574 * they came directly from the database or a special page name,
575 * not from user input.
577 * No validation is applied. For convenience, spaces are normalized
578 * to underscores, so that e.g. user_text fields can be used directly.
580 * @note This method may return Title objects that are "invalid"
581 * according to the isValid() method. This is usually caused by
582 * configuration changes: e.g. a namespace that was once defined is
583 * no longer configured, or a character that was once allowed in
584 * titles is now forbidden.
586 * @param int $ns The namespace of the article
587 * @param string $title The unprefixed database key form
588 * @param string $fragment The link fragment (after the "#")
589 * @param string $interwiki The interwiki prefix
590 * @return Title The new object
592 public static function makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
594 $t->mInterwiki
= $interwiki;
595 $t->mFragment
= $fragment;
596 $t->mNamespace
= $ns = (int)$ns;
597 $t->mDbkeyform
= strtr( $title, ' ', '_' );
598 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
599 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
600 $t->mTextform
= strtr( $title, '_', ' ' );
601 $t->mContentModel
= false; # initialized lazily in getContentModel()
606 * Create a new Title from a namespace index and a DB key.
607 * The parameters will be checked for validity, which is a bit slower
608 * than makeTitle() but safer for user-provided data.
610 * Title objects returned by makeTitleSafe() are guaranteed to be valid,
611 * that is, they return true from the isValid() method. If no valid Title
612 * can be constructed from the input, this method returns null.
614 * @param int $ns The namespace of the article
615 * @param string $title Database key form
616 * @param string $fragment The link fragment (after the "#")
617 * @param string $interwiki Interwiki prefix
618 * @return Title|null The new object, or null on an error
620 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
621 // NOTE: ideally, this would just call makeTitle() and then isValid(),
622 // but presently, that means more overhead on a potential performance hotspot.
624 if ( !MediaWikiServices
::getInstance()->getNamespaceInfo()->exists( $ns ) ) {
629 $t->mDbkeyform
= self
::makeName( $ns, $title, $fragment, $interwiki, true );
632 $t->secureAndSplit();
634 } catch ( MalformedTitleException
$ex ) {
640 * Create a new Title for the Main Page
642 * This uses the 'mainpage' interface message, which could be specified in
643 * `$wgForceUIMsgAsContentMsg`. If that is the case, then calling this method
644 * will use the user language, which would involve initialising the session
645 * via `RequestContext::getMain()->getLanguage()`. For session-less endpoints,
646 * be sure to pass in a MessageLocalizer (such as your own RequestContext,
647 * or ResourceloaderContext) to prevent an error.
649 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
650 * It may instead be a cached instance created previously, with references to it remaining
653 * @param MessageLocalizer|null $localizer An optional context to use (since 1.34)
656 public static function newMainPage( MessageLocalizer
$localizer = null ) {
658 $msg = $localizer->msg( 'mainpage' );
660 $msg = wfMessage( 'mainpage' );
663 $title = self
::newFromText( $msg->inContentLanguage()->text() );
665 // Every page renders at least one link to the Main Page (e.g. sidebar).
666 // If the localised value is invalid, don't produce fatal errors that
667 // would make the wiki inaccessible (and hard to fix the invalid message).
668 // Gracefully fallback...
670 $title = self
::newFromText( 'Main Page' );
676 * Get the prefixed DB key associated with an ID
678 * @param int $id The page_id of the article
679 * @return Title|null An object representing the article, or null if no such article was found
681 public static function nameOf( $id ) {
682 $dbr = wfGetDB( DB_REPLICA
);
684 $s = $dbr->selectRow(
686 [ 'page_namespace', 'page_title' ],
687 [ 'page_id' => $id ],
690 if ( $s === false ) {
694 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
699 * Get a regex character class describing the legal characters in a link
701 * @return string The list of characters, not delimited
703 public static function legalChars() {
704 global $wgLegalTitleChars;
705 return $wgLegalTitleChars;
709 * Utility method for converting a character sequence from bytes to Unicode.
711 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
712 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
714 * @param string $byteClass
717 public static function convertByteClassToUnicodeClass( $byteClass ) {
718 $length = strlen( $byteClass );
720 $x0 = $x1 = $x2 = '';
722 $d0 = $d1 = $d2 = '';
723 // Decoded integer codepoints
724 $ord0 = $ord1 = $ord2 = 0;
726 $r0 = $r1 = $r2 = '';
730 $allowUnicode = false;
731 for ( $pos = 0; $pos < $length; $pos++
) {
732 // Shift the queues down
741 // Load the current input token and decoded values
742 $inChar = $byteClass[$pos];
743 if ( $inChar == '\\' ) {
744 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
745 $x0 = $inChar . $m[0];
746 $d0 = chr( hexdec( $m[1] ) );
747 $pos +
= strlen( $m[0] );
748 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
749 $x0 = $inChar . $m[0];
750 $d0 = chr( octdec( $m[0] ) );
751 $pos +
= strlen( $m[0] );
752 } elseif ( $pos +
1 >= $length ) {
755 $d0 = $byteClass[$pos +
1];
763 // Load the current re-encoded value
764 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
765 $r0 = sprintf( '\x%02x', $ord0 );
766 } elseif ( $ord0 >= 0x80 ) {
767 // Allow unicode if a single high-bit character appears
768 $r0 = sprintf( '\x%02x', $ord0 );
769 $allowUnicode = true;
770 // @phan-suppress-next-line PhanParamSuspiciousOrder false positive
771 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
777 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
779 if ( $ord2 > $ord0 ) {
781 } elseif ( $ord0 >= 0x80 ) {
783 $allowUnicode = true;
784 if ( $ord2 < 0x80 ) {
785 // Keep the non-unicode section of the range
792 // Reset state to the initial value
793 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
794 } elseif ( $ord2 < 0x80 ) {
799 if ( $ord1 < 0x80 ) {
802 if ( $ord0 < 0x80 ) {
805 if ( $allowUnicode ) {
806 $out .= '\u0080-\uFFFF';
812 * Make a prefixed DB key from a DB key and a namespace index
814 * @param int $ns Numerical representation of the namespace
815 * @param string $title The DB key form the title
816 * @param string $fragment The link fragment (after the "#")
817 * @param string $interwiki The interwiki prefix
818 * @param bool $canonicalNamespace If true, use the canonical name for
819 * $ns instead of the localized version.
820 * @return string The prefixed form of the title
822 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
823 $canonicalNamespace = false
825 if ( $canonicalNamespace ) {
826 $namespace = MediaWikiServices
::getInstance()->getNamespaceInfo()->
827 getCanonicalName( $ns );
829 $namespace = MediaWikiServices
::getInstance()->getContentLanguage()->getNsText( $ns );
831 $name = $namespace == '' ?
$title : "$namespace:$title";
832 if ( strval( $interwiki ) != '' ) {
833 $name = "$interwiki:$name";
835 if ( strval( $fragment ) != '' ) {
836 $name .= '#' . $fragment;
842 * Callback for usort() to do title sorts by (namespace, title)
844 * @param LinkTarget $a
845 * @param LinkTarget $b
847 * @return int Result of string comparison, or namespace comparison
849 public static function compare( LinkTarget
$a, LinkTarget
$b ) {
850 return $a->getNamespace() <=> $b->getNamespace()
851 ?
: strcmp( $a->getText(), $b->getText() );
855 * Returns true if the title is valid, false if it is invalid.
857 * Valid titles can be round-tripped via makeTitle() and newFromText().
858 * Their DB key can be used in the database, though it may not have the correct
861 * Invalid titles may get returned from makeTitle(), and it may be useful to
862 * allow them to exist, e.g. in order to process log entries about pages in
863 * namespaces that belong to extensions that are no longer installed.
865 * @note This method is relatively expensive. When constructing Title
866 * objects that need to be valid, use an instantiator method that is guaranteed
867 * to return valid titles, such as makeTitleSafe() or newFromText().
871 public function isValid() {
872 $services = MediaWikiServices
::getInstance();
873 if ( !$services->getNamespaceInfo()->exists( $this->mNamespace
) ) {
878 $services->getTitleParser()->parseTitle( $this->mDbkeyform
, $this->mNamespace
);
879 } catch ( MalformedTitleException
$ex ) {
884 // Title value applies basic syntax checks. Should perhaps be moved elsewhere.
891 } catch ( InvalidArgumentException
$ex ) {
899 * Determine whether the object refers to a page within
900 * this project (either this wiki or a wiki with a local
901 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
903 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
905 public function isLocal() {
906 if ( $this->isExternal() ) {
907 $iw = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
909 return $iw->isLocal();
916 * Is this Title interwiki?
920 public function isExternal() {
921 return $this->mInterwiki
!== '';
925 * Get the interwiki prefix
927 * Use Title::isExternal to check if a interwiki is set
929 * @return string Interwiki prefix
931 public function getInterwiki() {
932 return $this->mInterwiki
;
936 * Was this a local interwiki link?
940 public function wasLocalInterwiki() {
941 return $this->mLocalInterwiki
;
945 * Determine whether the object refers to a page within
946 * this project and is transcludable.
948 * @return bool True if this is transcludable
950 public function isTrans() {
951 if ( !$this->isExternal() ) {
955 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->isTranscludable();
959 * Returns the DB name of the distant wiki which owns the object.
961 * @return string|false The DB name
963 public function getTransWikiID() {
964 if ( !$this->isExternal() ) {
968 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->getWikiID();
972 * Get a TitleValue object representing this Title.
974 * @note Not all valid Titles have a corresponding valid TitleValue
975 * (e.g. TitleValues cannot represent page-local links that have a
976 * fragment but no title text).
978 * @return TitleValue|null
980 public function getTitleValue() {
981 if ( $this->mTitleValue
=== null ) {
983 $this->mTitleValue
= new TitleValue(
989 } catch ( InvalidArgumentException
$ex ) {
990 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
991 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
995 return $this->mTitleValue
;
999 * Get the text form (spaces not underscores) of the main part
1001 * @return string Main part of the title
1003 public function getText() {
1004 return $this->mTextform
;
1008 * Get the URL-encoded form of the main part
1010 * @return string Main part of the title, URL-encoded
1012 public function getPartialURL() {
1013 return $this->mUrlform
;
1017 * Get the main part with underscores
1019 * @return string Main part of the title, with underscores
1021 public function getDBkey() {
1022 return $this->mDbkeyform
;
1026 * Get the DB key with the initial letter case as specified by the user
1027 * @deprecated since 1.33; please use Title::getDBKey() instead
1029 * @return string DB key
1031 function getUserCaseDBKey() {
1032 if ( !is_null( $this->mUserCaseDBKey
) ) {
1033 return $this->mUserCaseDBKey
;
1035 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
1036 return $this->mDbkeyform
;
1041 * Get the namespace index, i.e. one of the NS_xxxx constants.
1043 * @return int Namespace index
1045 public function getNamespace() {
1046 return $this->mNamespace
;
1050 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
1052 * @todo Deprecate this in favor of SlotRecord::getModel()
1054 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
1055 * @return string Content model id
1057 public function getContentModel( $flags = 0 ) {
1058 if ( !$this->mForcedContentModel
1059 && ( !$this->mContentModel ||
$flags === self
::GAID_FOR_UPDATE
)
1060 && $this->getArticleID( $flags )
1062 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
1063 $linkCache->addLinkObj( $this ); # in case we already had an article ID
1064 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
1067 if ( !$this->mContentModel
) {
1068 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
1071 return $this->mContentModel
;
1075 * Convenience method for checking a title's content model name
1077 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
1078 * @return bool True if $this->getContentModel() == $id
1080 public function hasContentModel( $id ) {
1081 return $this->getContentModel() == $id;
1085 * Set a proposed content model for the page for permissions
1086 * checking. This does not actually change the content model
1089 * Additionally, you should make sure you've checked
1090 * ContentHandler::canBeUsedOn() first.
1093 * @param string $model CONTENT_MODEL_XXX constant
1095 public function setContentModel( $model ) {
1096 $this->mContentModel
= $model;
1097 $this->mForcedContentModel
= true;
1101 * Get the namespace text
1103 * @return string|false Namespace text
1105 public function getNsText() {
1106 if ( $this->isExternal() ) {
1107 // This probably shouldn't even happen, except for interwiki transclusion.
1108 // If possible, use the canonical name for the foreign namespace.
1109 $nsText = MediaWikiServices
::getInstance()->getNamespaceInfo()->
1110 getCanonicalName( $this->mNamespace
);
1111 if ( $nsText !== false ) {
1117 $formatter = self
::getTitleFormatter();
1118 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
1119 } catch ( InvalidArgumentException
$ex ) {
1120 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
1126 * Get the namespace text of the subject (rather than talk) page
1128 * @return string Namespace text
1130 public function getSubjectNsText() {
1131 $services = MediaWikiServices
::getInstance();
1132 return $services->getContentLanguage()->
1133 getNsText( $services->getNamespaceInfo()->getSubject( $this->mNamespace
) );
1137 * Get the namespace text of the talk page
1139 * @return string Namespace text
1141 public function getTalkNsText() {
1142 $services = MediaWikiServices
::getInstance();
1143 return $services->getContentLanguage()->
1144 getNsText( $services->getNamespaceInfo()->getTalk( $this->mNamespace
) );
1148 * Can this title have a corresponding talk page?
1150 * False for relative section links (with getText() === ''),
1151 * interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.
1153 * @see NamespaceInfo::canHaveTalkPage
1156 * @return bool True if this title either is a talk page or can have a talk page associated.
1158 public function canHaveTalkPage() {
1159 return MediaWikiServices
::getInstance()->getNamespaceInfo()->canHaveTalkPage( $this );
1163 * Is this in a namespace that allows actual pages?
1167 public function canExist() {
1168 return $this->mNamespace
>= NS_MAIN
;
1172 * Can this title be added to a user's watchlist?
1174 * False for relative section links (with getText() === ''),
1175 * interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.
1179 public function isWatchable() {
1180 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
1181 return $this->getText() !== '' && !$this->isExternal() &&
1182 $nsInfo->isWatchable( $this->mNamespace
);
1186 * Returns true if this is a special page.
1190 public function isSpecialPage() {
1191 return $this->mNamespace
== NS_SPECIAL
;
1195 * Returns true if this title resolves to the named special page
1197 * @param string $name The special page name
1200 public function isSpecial( $name ) {
1201 if ( $this->isSpecialPage() ) {
1202 list( $thisName, /* $subpage */ ) =
1203 MediaWikiServices
::getInstance()->getSpecialPageFactory()->
1204 resolveAlias( $this->mDbkeyform
);
1205 if ( $name == $thisName ) {
1213 * If the Title refers to a special page alias which is not the local default, resolve
1214 * the alias, and localise the name as necessary. Otherwise, return $this
1218 public function fixSpecialName() {
1219 if ( $this->isSpecialPage() ) {
1220 $spFactory = MediaWikiServices
::getInstance()->getSpecialPageFactory();
1221 list( $canonicalName, $par ) = $spFactory->resolveAlias( $this->mDbkeyform
);
1222 if ( $canonicalName ) {
1223 $localName = $spFactory->getLocalNameFor( $canonicalName, $par );
1224 if ( $localName != $this->mDbkeyform
) {
1225 return self
::makeTitle( NS_SPECIAL
, $localName );
1233 * Returns true if the title is inside the specified namespace.
1235 * Please make use of this instead of comparing to getNamespace()
1236 * This function is much more resistant to changes we may make
1237 * to namespaces than code that makes direct comparisons.
1238 * @param int $ns The namespace
1242 public function inNamespace( $ns ) {
1243 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1244 equals( $this->mNamespace
, $ns );
1248 * Returns true if the title is inside one of the specified namespaces.
1250 * @param int|int[] $namespaces,... The namespaces to check for
1253 * @suppress PhanCommentParamOnEmptyParamList Cannot make variadic due to HHVM bug, T191668#5263929
1255 public function inNamespaces( /* ... */ ) {
1256 $namespaces = func_get_args();
1257 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1258 $namespaces = $namespaces[0];
1261 foreach ( $namespaces as $ns ) {
1262 if ( $this->inNamespace( $ns ) ) {
1271 * Returns true if the title has the same subject namespace as the
1272 * namespace specified.
1273 * For example this method will take NS_USER and return true if namespace
1274 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1275 * as their subject namespace.
1277 * This is MUCH simpler than individually testing for equivalence
1278 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1283 public function hasSubjectNamespace( $ns ) {
1284 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1285 subjectEquals( $this->mNamespace
, $ns );
1289 * Is this Title in a namespace which contains content?
1290 * In other words, is this a content page, for the purposes of calculating
1295 public function isContentPage() {
1296 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1297 isContent( $this->mNamespace
);
1301 * Would anybody with sufficient privileges be able to move this page?
1302 * Some pages just aren't movable.
1306 public function isMovable() {
1308 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
1309 isMovable( $this->mNamespace
) ||
$this->isExternal()
1311 // Interwiki title or immovable namespace. Hooks don't get to override here
1316 Hooks
::run( 'TitleIsMovable', [ $this, &$result ] );
1321 * Is this the mainpage?
1322 * @note Title::newFromText seems to be sufficiently optimized by the title
1323 * cache that we don't need to over-optimize by doing direct comparisons and
1324 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1325 * ends up reporting something differently than $title->isMainPage();
1330 public function isMainPage() {
1331 return $this->equals( self
::newMainPage() );
1335 * Is this a subpage?
1339 public function isSubpage() {
1340 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1341 hasSubpages( $this->mNamespace
)
1342 ?
strpos( $this->getText(), '/' ) !== false
1347 * Is this a conversion table for the LanguageConverter?
1351 public function isConversionTable() {
1352 // @todo ConversionTable should become a separate content model.
1354 return $this->mNamespace
== NS_MEDIAWIKI
&&
1355 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1359 * Does that page contain wikitext, or it is JS, CSS or whatever?
1363 public function isWikitextPage() {
1364 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1368 * Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the
1369 * global UI. This is generally true for pages in the MediaWiki namespace having
1370 * CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
1372 * This method does *not* return true for per-user JS/JSON/CSS. Use isUserConfigPage()
1375 * Note that this method should not return true for pages that contain and show
1376 * "inactive" CSS, JSON, or JS.
1381 public function isSiteConfigPage() {
1383 $this->isSiteCssConfigPage()
1384 ||
$this->isSiteJsonConfigPage()
1385 ||
$this->isSiteJsConfigPage()
1390 * Is this a "config" (.css, .json, or .js) sub-page of a user page?
1395 public function isUserConfigPage() {
1397 $this->isUserCssConfigPage()
1398 ||
$this->isUserJsonConfigPage()
1399 ||
$this->isUserJsConfigPage()
1404 * Trim down a .css, .json, or .js subpage title to get the corresponding skin name
1406 * @return string Containing skin name from .css, .json, or .js subpage title
1409 public function getSkinFromConfigSubpage() {
1410 $subpage = explode( '/', $this->mTextform
);
1411 $subpage = $subpage[count( $subpage ) - 1];
1412 $lastdot = strrpos( $subpage, '.' );
1413 if ( $lastdot === false ) {
1414 return $subpage; # Never happens: only called for names ending in '.css'/'.json'/'.js'
1416 return substr( $subpage, 0, $lastdot );
1420 * Is this a CSS "config" sub-page of a user page?
1425 public function isUserCssConfigPage() {
1427 NS_USER
== $this->mNamespace
1428 && $this->isSubpage()
1429 && $this->hasContentModel( CONTENT_MODEL_CSS
)
1434 * Is this a JSON "config" sub-page of a user page?
1439 public function isUserJsonConfigPage() {
1441 NS_USER
== $this->mNamespace
1442 && $this->isSubpage()
1443 && $this->hasContentModel( CONTENT_MODEL_JSON
)
1448 * Is this a JS "config" sub-page of a user page?
1453 public function isUserJsConfigPage() {
1455 NS_USER
== $this->mNamespace
1456 && $this->isSubpage()
1457 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1462 * Is this a sitewide CSS "config" page?
1467 public function isSiteCssConfigPage() {
1469 NS_MEDIAWIKI
== $this->mNamespace
1471 $this->hasContentModel( CONTENT_MODEL_CSS
)
1472 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1473 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1474 ||
substr( $this->mDbkeyform
, -4 ) === '.css'
1480 * Is this a sitewide JSON "config" page?
1485 public function isSiteJsonConfigPage() {
1487 NS_MEDIAWIKI
== $this->mNamespace
1489 $this->hasContentModel( CONTENT_MODEL_JSON
)
1490 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1491 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1492 ||
substr( $this->mDbkeyform
, -5 ) === '.json'
1498 * Is this a sitewide JS "config" page?
1503 public function isSiteJsConfigPage() {
1505 NS_MEDIAWIKI
== $this->mNamespace
1507 $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1508 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1509 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1510 ||
substr( $this->mDbkeyform
, -3 ) === '.js'
1516 * Is this a message which can contain raw HTML?
1521 public function isRawHtmlMessage() {
1522 global $wgRawHtmlMessages;
1524 if ( !$this->inNamespace( NS_MEDIAWIKI
) ) {
1527 $message = lcfirst( $this->getRootTitle()->getDBkey() );
1528 return in_array( $message, $wgRawHtmlMessages, true );
1532 * Is this a talk page of some sort?
1536 public function isTalkPage() {
1537 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1538 isTalk( $this->mNamespace
);
1542 * Get a Title object associated with the talk page of this article
1544 * @deprecated since 1.34, use getTalkPageIfDefined() or NamespaceInfo::getTalkPage()
1545 * with NamespaceInfo::canHaveTalkPage().
1546 * @return Title The object for the talk page
1547 * @throws MWException if $target doesn't have talk pages, e.g. because it's in NS_SPECIAL
1548 * or because it's a relative link, or an interwiki link.
1550 public function getTalkPage() {
1551 return self
::castFromLinkTarget(
1552 MediaWikiServices
::getInstance()->getNamespaceInfo()->getTalkPage( $this ) );
1556 * Get a Title object associated with the talk page of this article,
1557 * if such a talk page can exist.
1561 * @return Title|null The object for the talk page,
1562 * or null if no associated talk page can exist, according to canHaveTalkPage().
1564 public function getTalkPageIfDefined() {
1565 if ( !$this->canHaveTalkPage() ) {
1569 return $this->getTalkPage();
1573 * Get a title object associated with the subject page of this
1576 * @deprecated since 1.34, use NamespaceInfo::getSubjectPage
1577 * @return Title The object for the subject page
1579 public function getSubjectPage() {
1580 return self
::castFromLinkTarget(
1581 MediaWikiServices
::getInstance()->getNamespaceInfo()->getSubjectPage( $this ) );
1585 * Get the other title for this page, if this is a subject page
1586 * get the talk page, if it is a subject page get the talk page
1588 * @deprecated since 1.34, use NamespaceInfo::getAssociatedPage
1590 * @throws MWException If the page doesn't have an other page
1593 public function getOtherPage() {
1594 return self
::castFromLinkTarget(
1595 MediaWikiServices
::getInstance()->getNamespaceInfo()->getAssociatedPage( $this ) );
1599 * Get the default namespace index, for when there is no namespace
1601 * @return int Default namespace index
1603 public function getDefaultNamespace() {
1604 return $this->mDefaultNamespace
;
1608 * Get the Title fragment (i.e.\ the bit after the #) in text form
1610 * Use Title::hasFragment to check for a fragment
1612 * @return string Title fragment
1614 public function getFragment() {
1615 return $this->mFragment
;
1619 * Check if a Title fragment is set
1624 public function hasFragment() {
1625 return $this->mFragment
!== '';
1629 * Get the fragment in URL form, including the "#" character if there is one
1631 * @return string Fragment in URL form
1633 public function getFragmentForURL() {
1634 if ( !$this->hasFragment() ) {
1636 } elseif ( $this->isExternal() ) {
1637 // Note: If the interwiki is unknown, it's treated as a namespace on the local wiki,
1638 // so we treat it like a local interwiki.
1639 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
1640 if ( $interwiki && !$interwiki->isLocal() ) {
1641 return '#' . Sanitizer
::escapeIdForExternalInterwiki( $this->mFragment
);
1645 return '#' . Sanitizer
::escapeIdForLink( $this->mFragment
);
1649 * Set the fragment for this title. Removes the first character from the
1650 * specified fragment before setting, so it assumes you're passing it with
1653 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1654 * or Title::createFragmentTarget().
1655 * Still in active use privately.
1658 * @param string $fragment Text
1660 public function setFragment( $fragment ) {
1661 $this->mFragment
= strtr( substr( $fragment, 1 ), '_', ' ' );
1665 * Creates a new Title for a different fragment of the same page.
1668 * @param string $fragment
1671 public function createFragmentTarget( $fragment ) {
1672 return self
::makeTitle(
1681 * Prefix some arbitrary text with the namespace or interwiki prefix
1684 * @param string $name The text
1685 * @return string The prefixed text
1687 private function prefix( $name ) {
1689 if ( $this->isExternal() ) {
1690 $p = $this->mInterwiki
. ':';
1693 if ( $this->mNamespace
!= 0 ) {
1694 $nsText = $this->getNsText();
1696 if ( $nsText === false ) {
1697 // See T165149. Awkward, but better than erroneously linking to the main namespace.
1698 $nsText = MediaWikiServices
::getInstance()->getContentLanguage()->
1699 getNsText( NS_SPECIAL
) . ":Badtitle/NS{$this->mNamespace}";
1702 $p .= $nsText . ':';
1708 * Get the prefixed database key form
1710 * @return string The prefixed title, with underscores and
1711 * any interwiki and namespace prefixes
1713 public function getPrefixedDBkey() {
1714 $s = $this->prefix( $this->mDbkeyform
);
1715 $s = strtr( $s, ' ', '_' );
1720 * Get the prefixed title with spaces.
1721 * This is the form usually used for display
1723 * @return string The prefixed title, with spaces
1725 public function getPrefixedText() {
1726 if ( $this->prefixedText
=== null ) {
1727 $s = $this->prefix( $this->mTextform
);
1728 $s = strtr( $s, '_', ' ' );
1729 $this->prefixedText
= $s;
1731 return $this->prefixedText
;
1735 * Return a string representation of this title
1737 * @return string Representation of this title
1739 public function __toString() {
1740 return $this->getPrefixedText();
1744 * Get the prefixed title with spaces, plus any fragment
1745 * (part beginning with '#')
1747 * @return string The prefixed title, with spaces and the fragment, including '#'
1749 public function getFullText() {
1750 $text = $this->getPrefixedText();
1751 if ( $this->hasFragment() ) {
1752 $text .= '#' . $this->mFragment
;
1758 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1760 * @note the return value may contain trailing whitespace and is thus
1761 * not safe for use with makeTitle or TitleValue.
1765 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1769 * @return string Root name
1772 public function getRootText() {
1774 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
1775 hasSubpages( $this->mNamespace
)
1776 ||
strtok( $this->getText(), '/' ) === false
1778 return $this->getText();
1781 return strtok( $this->getText(), '/' );
1785 * Get the root page name title, i.e. the leftmost part before any slashes
1789 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1790 * # returns: Title{User:Foo}
1793 * @return Title Root title
1796 public function getRootTitle() {
1797 $title = self
::makeTitleSafe( $this->mNamespace
, $this->getRootText() );
1798 Assert
::postcondition(
1800 'makeTitleSafe() should always return a Title for the text returned by getRootText().'
1806 * Get the base page name without a namespace, i.e. the part before the subpage name
1808 * @note the return value may contain trailing whitespace and is thus
1809 * not safe for use with makeTitle or TitleValue.
1813 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1814 * # returns: 'Foo/Bar'
1817 * @return string Base name
1819 public function getBaseText() {
1820 $text = $this->getText();
1822 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
1823 hasSubpages( $this->mNamespace
)
1828 $lastSlashPos = strrpos( $text, '/' );
1829 // Don't discard the real title if there's no subpage involved
1830 if ( $lastSlashPos === false ) {
1834 return substr( $text, 0, $lastSlashPos );
1838 * Get the base page name title, i.e. the part before the subpage name.
1842 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1843 * # returns: Title{User:Foo/Bar}
1846 * @return Title Base title
1849 public function getBaseTitle() {
1850 $title = self
::makeTitleSafe( $this->mNamespace
, $this->getBaseText() );
1851 Assert
::postcondition(
1853 'makeTitleSafe() should always return a Title for the text returned by getBaseText().'
1859 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1863 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1867 * @return string Subpage name
1869 public function getSubpageText() {
1871 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
1872 hasSubpages( $this->mNamespace
)
1874 return $this->mTextform
;
1876 $parts = explode( '/', $this->mTextform
);
1877 return $parts[count( $parts ) - 1];
1881 * Get the title for a subpage of the current page
1885 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1886 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1889 * @param string $text The subpage name to add to the title
1890 * @return Title|null Subpage title, or null on an error
1893 public function getSubpage( $text ) {
1894 return self
::makeTitleSafe(
1896 $this->getText() . '/' . $text,
1903 * Get a URL-encoded form of the subpage text
1905 * @return string URL-encoded subpage name
1907 public function getSubpageUrlForm() {
1908 $text = $this->getSubpageText();
1909 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1914 * Get a URL-encoded title (not an actual URL) including interwiki
1916 * @return string The URL-encoded form
1918 public function getPrefixedURL() {
1919 $s = $this->prefix( $this->mDbkeyform
);
1920 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1925 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1926 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1927 * second argument named variant. This was deprecated in favor
1928 * of passing an array of option with a "variant" key
1929 * Once $query2 is removed for good, this helper can be dropped
1930 * and the wfArrayToCgi moved to getLocalURL();
1932 * @since 1.19 (r105919)
1933 * @param array|string $query
1934 * @param string|string[]|bool $query2
1937 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1938 if ( $query2 !== false ) {
1939 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1940 "method called with a second parameter is deprecated. Add your " .
1941 "parameter to an array passed as the first parameter.", "1.19" );
1943 if ( is_array( $query ) ) {
1944 $query = wfArrayToCgi( $query );
1947 if ( is_string( $query2 ) ) {
1948 // $query2 is a string, we will consider this to be
1949 // a deprecated $variant argument and add it to the query
1950 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1952 $query2 = wfArrayToCgi( $query2 );
1954 // If we have $query content add a & to it first
1958 // Now append the queries together
1965 * Get a real URL referring to this title, with interwiki link and
1968 * @see self::getLocalURL for the arguments.
1970 * @param string|string[] $query
1971 * @param string|string[]|bool $query2
1972 * @param string|int|null $proto Protocol type to use in URL
1973 * @return string The URL
1975 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1976 $query = self
::fixUrlQueryArgs( $query, $query2 );
1978 # Hand off all the decisions on urls to getLocalURL
1979 $url = $this->getLocalURL( $query );
1981 # Expand the url to make it a full url. Note that getLocalURL has the
1982 # potential to output full urls for a variety of reasons, so we use
1983 # wfExpandUrl instead of simply prepending $wgServer
1984 $url = wfExpandUrl( $url, $proto );
1986 # Finally, add the fragment.
1987 $url .= $this->getFragmentForURL();
1988 // Avoid PHP 7.1 warning from passing $this by reference
1990 Hooks
::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
1995 * Get a url appropriate for making redirects based on an untrusted url arg
1997 * This is basically the same as getFullUrl(), but in the case of external
1998 * interwikis, we send the user to a landing page, to prevent possible
1999 * phishing attacks and the like.
2001 * @note Uses current protocol by default, since technically relative urls
2002 * aren't allowed in redirects per HTTP spec, so this is not suitable for
2003 * places where the url gets cached, as might pollute between
2004 * https and non-https users.
2005 * @see self::getLocalURL for the arguments.
2006 * @param array|string $query
2007 * @param string $proto Protocol type to use in URL
2008 * @return string A url suitable to use in an HTTP location header.
2010 public function getFullUrlForRedirect( $query = '', $proto = PROTO_CURRENT
) {
2012 if ( $this->isExternal() ) {
2013 $target = SpecialPage
::getTitleFor(
2015 $this->getPrefixedDBkey()
2018 return $target->getFullURL( $query, false, $proto );
2022 * Get a URL with no fragment or server name (relative URL) from a Title object.
2023 * If this page is generated with action=render, however,
2024 * $wgServer is prepended to make an absolute URL.
2026 * @see self::getFullURL to always get an absolute URL.
2027 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
2028 * valid to link, locally, to the current Title.
2029 * @see self::newFromText to produce a Title object.
2031 * @param string|string[] $query An optional query string,
2032 * not used for interwiki links. Can be specified as an associative array as well,
2033 * e.g., [ 'action' => 'edit' ] (keys and values will be URL-escaped).
2034 * Some query patterns will trigger various shorturl path replacements.
2035 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
2036 * be an array. If a string is passed it will be interpreted as a deprecated
2037 * variant argument and urlencoded into a variant= argument.
2038 * This second query argument will be added to the $query
2039 * The second parameter is deprecated since 1.19. Pass it as a key,value
2040 * pair in the first parameter array instead.
2042 * @return string String of the URL.
2044 public function getLocalURL( $query = '', $query2 = false ) {
2045 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
2047 $query = self
::fixUrlQueryArgs( $query, $query2 );
2049 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
2051 $namespace = $this->getNsText();
2052 if ( $namespace != '' ) {
2053 # Can this actually happen? Interwikis shouldn't be parsed.
2054 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
2057 $url = $interwiki->getURL( $namespace . $this->mDbkeyform
);
2058 $url = wfAppendQuery( $url, $query );
2060 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
2061 if ( $query == '' ) {
2062 $url = str_replace( '$1', $dbkey, $wgArticlePath );
2063 // Avoid PHP 7.1 warning from passing $this by reference
2065 Hooks
::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
2067 global $wgVariantArticlePath, $wgActionPaths;
2071 if ( !empty( $wgActionPaths )
2072 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
2074 $action = urldecode( $matches[2] );
2075 if ( isset( $wgActionPaths[$action] ) ) {
2076 $query = $matches[1];
2077 if ( isset( $matches[4] ) ) {
2078 $query .= $matches[4];
2080 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
2081 if ( $query != '' ) {
2082 $url = wfAppendQuery( $url, $query );
2088 && $wgVariantArticlePath
2089 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
2090 && $this->getPageLanguage()->equals(
2091 MediaWikiServices
::getInstance()->getContentLanguage() )
2092 && $this->getPageLanguage()->hasVariants()
2094 $variant = urldecode( $matches[1] );
2095 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
2096 // Only do the variant replacement if the given variant is a valid
2097 // variant for the page's language.
2098 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
2099 $url = str_replace( '$1', $dbkey, $url );
2103 if ( $url === false ) {
2104 if ( $query == '-' ) {
2107 $url = "{$wgScript}?title={$dbkey}&{$query}";
2110 // Avoid PHP 7.1 warning from passing $this by reference
2112 Hooks
::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
2114 // @todo FIXME: This causes breakage in various places when we
2115 // actually expected a local URL and end up with dupe prefixes.
2116 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
2117 $url = $wgServer . $url;
2120 // Avoid PHP 7.1 warning from passing $this by reference
2122 Hooks
::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
2127 * Get a URL that's the simplest URL that will be valid to link, locally,
2128 * to the current Title. It includes the fragment, but does not include
2129 * the server unless action=render is used (or the link is external). If
2130 * there's a fragment but the prefixed text is empty, we just return a link
2133 * The result obviously should not be URL-escaped, but does need to be
2134 * HTML-escaped if it's being output in HTML.
2136 * @param string|string[] $query
2137 * @param bool $query2
2138 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
2139 * or false (default) for no expansion
2140 * @see self::getLocalURL for the arguments.
2141 * @return string The URL
2143 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
2144 if ( $this->isExternal() ||
$proto !== false ) {
2145 $ret = $this->getFullURL( $query, $query2, $proto );
2146 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
2147 $ret = $this->getFragmentForURL();
2149 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
2155 * Get the URL form for an internal link.
2156 * - Used in various CDN-related code, in case we have a different
2157 * internal hostname for the server from the exposed one.
2159 * This uses $wgInternalServer to qualify the path, or $wgServer
2160 * if $wgInternalServer is not set. If the server variable used is
2161 * protocol-relative, the URL will be expanded to http://
2163 * @see self::getLocalURL for the arguments.
2164 * @param string|string[] $query
2165 * @param string|bool $query2 Deprecated
2166 * @return string The URL
2168 public function getInternalURL( $query = '', $query2 = false ) {
2169 global $wgInternalServer, $wgServer;
2170 $query = self
::fixUrlQueryArgs( $query, $query2 );
2171 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
2172 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
2173 // Avoid PHP 7.1 warning from passing $this by reference
2175 Hooks
::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
2180 * Get the URL for a canonical link, for use in things like IRC and
2181 * e-mail notifications. Uses $wgCanonicalServer and the
2182 * GetCanonicalURL hook.
2184 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
2186 * @see self::getLocalURL for the arguments.
2187 * @param string|string[] $query
2188 * @param string|bool $query2 Deprecated
2189 * @return string The URL
2192 public function getCanonicalURL( $query = '', $query2 = false ) {
2193 $query = self
::fixUrlQueryArgs( $query, $query2 );
2194 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
2195 // Avoid PHP 7.1 warning from passing $this by reference
2197 Hooks
::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
2202 * Get the edit URL for this Title
2204 * @return string The URL, or a null string if this is an interwiki link
2206 public function getEditURL() {
2207 if ( $this->isExternal() ) {
2210 $s = $this->getLocalURL( 'action=edit' );
2216 * Can $user perform $action on this page?
2217 * This skips potentially expensive cascading permission checks
2218 * as well as avoids expensive error formatting
2220 * Suitable for use for nonessential UI controls in common cases, but
2221 * _not_ for functional access control.
2223 * May provide false positives, but should never provide a false negative.
2225 * @param string $action Action that permission needs to be checked for
2226 * @param User|null $user User to check (since 1.19); $wgUser will be used if not provided.
2231 * @deprecated since 1.33,
2232 * use MediaWikiServices::getInstance()->getPermissionManager()->quickUserCan(..) instead
2235 public function quickUserCan( $action, $user = null ) {
2236 return $this->userCan( $action, $user, false );
2240 * Can $user perform $action on this page?
2242 * @param string $action Action that permission needs to be checked for
2243 * @param User|null $user User to check (since 1.19); $wgUser will be used if not
2245 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2250 * @deprecated since 1.33,
2251 * use MediaWikiServices::getInstance()->getPermissionManager()->userCan(..) instead
2254 public function userCan( $action, $user = null, $rigor = PermissionManager
::RIGOR_SECURE
) {
2255 if ( !$user instanceof User
) {
2260 // TODO: this is for b/c, eventually will be removed
2261 if ( $rigor === true ) {
2262 $rigor = PermissionManager
::RIGOR_SECURE
; // b/c
2263 } elseif ( $rigor === false ) {
2264 $rigor = PermissionManager
::RIGOR_QUICK
; // b/c
2267 return MediaWikiServices
::getInstance()->getPermissionManager()
2268 ->userCan( $action, $user, $this, $rigor );
2272 * Can $user perform $action on this page?
2274 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
2276 * @param string $action Action that permission needs to be checked for
2277 * @param User $user User to check
2278 * @param string $rigor One of (quick,full,secure)
2279 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2280 * - full : does cheap and expensive checks possibly from a replica DB
2281 * - secure : does cheap and expensive checks, using the master as needed
2282 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
2283 * whose corresponding errors may be ignored.
2285 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2288 * @deprecated since 1.33,
2289 * use MediaWikiServices::getInstance()->getPermissionManager()->getPermissionErrors()
2292 public function getUserPermissionsErrors(
2293 $action, $user, $rigor = PermissionManager
::RIGOR_SECURE
, $ignoreErrors = []
2295 // TODO: this is for b/c, eventually will be removed
2296 if ( $rigor === true ) {
2297 $rigor = PermissionManager
::RIGOR_SECURE
; // b/c
2298 } elseif ( $rigor === false ) {
2299 $rigor = PermissionManager
::RIGOR_QUICK
; // b/c
2302 return MediaWikiServices
::getInstance()->getPermissionManager()
2303 ->getPermissionErrors( $action, $user, $this, $rigor, $ignoreErrors );
2307 * Get a filtered list of all restriction types supported by this wiki.
2308 * @param bool $exists True to get all restriction types that apply to
2309 * titles that do exist, False for all restriction types that apply to
2310 * titles that do not exist
2313 public static function getFilteredRestrictionTypes( $exists = true ) {
2314 global $wgRestrictionTypes;
2315 $types = $wgRestrictionTypes;
2317 # Remove the create restriction for existing titles
2318 $types = array_diff( $types, [ 'create' ] );
2320 # Only the create and upload restrictions apply to non-existing titles
2321 $types = array_intersect( $types, [ 'create', 'upload' ] );
2327 * Returns restriction types for the current Title
2329 * @return array Applicable restriction types
2331 public function getRestrictionTypes() {
2332 if ( $this->isSpecialPage() ) {
2336 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2338 if ( $this->mNamespace
!= NS_FILE
) {
2339 # Remove the upload restriction for non-file titles
2340 $types = array_diff( $types, [ 'upload' ] );
2343 Hooks
::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2345 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2346 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2352 * Is this title subject to title protection?
2353 * Title protection is the one applied against creation of such title.
2355 * @return array|bool An associative array representing any existent title
2356 * protection, or false if there's none.
2358 public function getTitleProtection() {
2359 $protection = $this->getTitleProtectionInternal();
2360 if ( $protection ) {
2361 if ( $protection['permission'] == 'sysop' ) {
2362 $protection['permission'] = 'editprotected'; // B/C
2364 if ( $protection['permission'] == 'autoconfirmed' ) {
2365 $protection['permission'] = 'editsemiprotected'; // B/C
2372 * Fetch title protection settings
2374 * To work correctly, $this->loadRestrictions() needs to have access to the
2375 * actual protections in the database without munging 'sysop' =>
2376 * 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other
2377 * callers probably want $this->getTitleProtection() instead.
2379 * @return array|bool
2381 protected function getTitleProtectionInternal() {
2382 // Can't protect pages in special namespaces
2383 if ( $this->mNamespace
< 0 ) {
2387 // Can't protect pages that exist.
2388 if ( $this->exists() ) {
2392 if ( $this->mTitleProtection
=== null ) {
2393 $dbr = wfGetDB( DB_REPLICA
);
2394 $commentStore = CommentStore
::getStore();
2395 $commentQuery = $commentStore->getJoin( 'pt_reason' );
2396 $res = $dbr->select(
2397 [ 'protected_titles' ] +
$commentQuery['tables'],
2399 'user' => 'pt_user',
2400 'expiry' => 'pt_expiry',
2401 'permission' => 'pt_create_perm'
2402 ] +
$commentQuery['fields'],
2403 [ 'pt_namespace' => $this->mNamespace
, 'pt_title' => $this->mDbkeyform
],
2406 $commentQuery['joins']
2409 // fetchRow returns false if there are no rows.
2410 $row = $dbr->fetchRow( $res );
2412 $this->mTitleProtection
= [
2413 'user' => $row['user'],
2414 'expiry' => $dbr->decodeExpiry( $row['expiry'] ),
2415 'permission' => $row['permission'],
2416 'reason' => $commentStore->getComment( 'pt_reason', $row )->text
,
2419 $this->mTitleProtection
= false;
2422 return $this->mTitleProtection
;
2426 * Remove any title protection due to page existing
2428 public function deleteTitleProtection() {
2429 $dbw = wfGetDB( DB_MASTER
);
2433 [ 'pt_namespace' => $this->mNamespace
, 'pt_title' => $this->mDbkeyform
],
2436 $this->mTitleProtection
= false;
2440 * Is this page "semi-protected" - the *only* protection levels are listed
2441 * in $wgSemiprotectedRestrictionLevels?
2443 * @param string $action Action to check (default: edit)
2446 public function isSemiProtected( $action = 'edit' ) {
2447 global $wgSemiprotectedRestrictionLevels;
2449 $restrictions = $this->getRestrictions( $action );
2450 $semi = $wgSemiprotectedRestrictionLevels;
2451 if ( !$restrictions ||
!$semi ) {
2452 // Not protected, or all protection is full protection
2456 // Remap autoconfirmed to editsemiprotected for BC
2457 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2458 $semi[$key] = 'editsemiprotected';
2460 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2461 $restrictions[$key] = 'editsemiprotected';
2464 return !array_diff( $restrictions, $semi );
2468 * Does the title correspond to a protected article?
2470 * @param string $action The action the page is protected from,
2471 * by default checks all actions.
2474 public function isProtected( $action = '' ) {
2475 global $wgRestrictionLevels;
2477 $restrictionTypes = $this->getRestrictionTypes();
2479 # Special pages have inherent protection
2480 if ( $this->isSpecialPage() ) {
2484 # Check regular protection levels
2485 foreach ( $restrictionTypes as $type ) {
2486 if ( $action == $type ||
$action == '' ) {
2487 $r = $this->getRestrictions( $type );
2488 foreach ( $wgRestrictionLevels as $level ) {
2489 if ( in_array( $level, $r ) && $level != '' ) {
2500 * Determines if $user is unable to edit this page because it has been protected
2501 * by $wgNamespaceProtection.
2503 * @deprecated since 1.34 Don't use this function in new code.
2504 * @param User $user User object to check permissions
2507 public function isNamespaceProtected( User
$user ) {
2508 global $wgNamespaceProtection;
2510 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2511 $permissionManager = MediaWikiServices
::getInstance()->getPermissionManager();
2512 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2513 if ( !$permissionManager->userHasRight( $user, $right ) ) {
2522 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2524 * @return bool If the page is subject to cascading restrictions.
2526 public function isCascadeProtected() {
2527 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2528 return ( $sources > 0 );
2532 * Determines whether cascading protection sources have already been loaded from
2535 * @param bool $getPages True to check if the pages are loaded, or false to check
2536 * if the status is loaded.
2537 * @return bool Whether or not the specified information has been loaded
2540 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2541 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
2545 * Cascading protection: Get the source of any cascading restrictions on this page.
2547 * @param bool $getPages Whether or not to retrieve the actual pages
2548 * that the restrictions have come from and the actual restrictions
2550 * @return array Two elements: First is an array of Title objects of the
2551 * pages from which cascading restrictions have come, false for
2552 * none, or true if such restrictions exist but $getPages was not
2553 * set. Second is an array like that returned by
2554 * Title::getAllRestrictions(), or an empty array if $getPages is
2557 public function getCascadeProtectionSources( $getPages = true ) {
2558 $pagerestrictions = [];
2560 if ( $this->mCascadeSources
!== null && $getPages ) {
2561 return [ $this->mCascadeSources
, $this->mCascadingRestrictions
];
2562 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
2563 return [ $this->mHasCascadingRestrictions
, $pagerestrictions ];
2566 $dbr = wfGetDB( DB_REPLICA
);
2568 if ( $this->mNamespace
== NS_FILE
) {
2569 $tables = [ 'imagelinks', 'page_restrictions' ];
2571 'il_to' => $this->mDbkeyform
,
2576 $tables = [ 'templatelinks', 'page_restrictions' ];
2578 'tl_namespace' => $this->mNamespace
,
2579 'tl_title' => $this->mDbkeyform
,
2586 $cols = [ 'pr_page', 'page_namespace', 'page_title',
2587 'pr_expiry', 'pr_type', 'pr_level' ];
2588 $where_clauses[] = 'page_id=pr_page';
2591 $cols = [ 'pr_expiry' ];
2594 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2596 $sources = $getPages ?
[] : false;
2597 $now = wfTimestampNow();
2599 foreach ( $res as $row ) {
2600 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
2601 if ( $expiry > $now ) {
2603 $page_id = $row->pr_page
;
2604 $page_ns = $row->page_namespace
;
2605 $page_title = $row->page_title
;
2606 $sources[$page_id] = self
::makeTitle( $page_ns, $page_title );
2607 # Add groups needed for each restriction type if its not already there
2608 # Make sure this restriction type still exists
2610 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2611 $pagerestrictions[$row->pr_type
] = [];
2615 isset( $pagerestrictions[$row->pr_type
] )
2616 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
2618 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2627 $this->mCascadeSources
= $sources;
2628 $this->mCascadingRestrictions
= $pagerestrictions;
2630 $this->mHasCascadingRestrictions
= $sources;
2633 return [ $sources, $pagerestrictions ];
2637 * Accessor for mRestrictionsLoaded
2639 * @return bool Whether or not the page's restrictions have already been
2640 * loaded from the database
2643 public function areRestrictionsLoaded() {
2644 return $this->mRestrictionsLoaded
;
2648 * Accessor/initialisation for mRestrictions
2650 * @param string $action Action that permission needs to be checked for
2651 * @return array Restriction levels needed to take the action. All levels are
2652 * required. Note that restriction levels are normally user rights, but 'sysop'
2653 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
2654 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
2656 public function getRestrictions( $action ) {
2657 if ( !$this->mRestrictionsLoaded
) {
2658 $this->loadRestrictions();
2660 return $this->mRestrictions
[$action] ??
[];
2664 * Accessor/initialisation for mRestrictions
2666 * @return array Keys are actions, values are arrays as returned by
2667 * Title::getRestrictions()
2670 public function getAllRestrictions() {
2671 if ( !$this->mRestrictionsLoaded
) {
2672 $this->loadRestrictions();
2674 return $this->mRestrictions
;
2678 * Get the expiry time for the restriction against a given action
2680 * @param string $action
2681 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2682 * or not protected at all, or false if the action is not recognised.
2684 public function getRestrictionExpiry( $action ) {
2685 if ( !$this->mRestrictionsLoaded
) {
2686 $this->loadRestrictions();
2688 return $this->mRestrictionsExpiry
[$action] ??
false;
2692 * Returns cascading restrictions for the current article
2696 function areRestrictionsCascading() {
2697 if ( !$this->mRestrictionsLoaded
) {
2698 $this->loadRestrictions();
2701 return $this->mCascadeRestriction
;
2705 * Compiles list of active page restrictions from both page table (pre 1.10)
2706 * and page_restrictions table for this existing page.
2707 * Public for usage by LiquidThreads.
2709 * @param array $rows Array of db result objects
2710 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
2711 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
2712 * Edit and move sections are separated by a colon
2713 * Example: "edit=autoconfirmed,sysop:move=sysop"
2715 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2716 // This function will only read rows from a table that we migrated away
2717 // from before adding READ_LATEST support to loadRestrictions, so we
2718 // don't need to support reading from DB_MASTER here.
2719 $dbr = wfGetDB( DB_REPLICA
);
2721 $restrictionTypes = $this->getRestrictionTypes();
2723 foreach ( $restrictionTypes as $type ) {
2724 $this->mRestrictions
[$type] = [];
2725 $this->mRestrictionsExpiry
[$type] = 'infinity';
2728 $this->mCascadeRestriction
= false;
2730 # Backwards-compatibility: also load the restrictions from the page record (old format).
2731 if ( $oldFashionedRestrictions !== null ) {
2732 $this->mOldRestrictions
= $oldFashionedRestrictions;
2735 if ( $this->mOldRestrictions
=== false ) {
2736 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
2737 $linkCache->addLinkObj( $this ); # in case we already had an article ID
2738 $this->mOldRestrictions
= $linkCache->getGoodLinkFieldObj( $this, 'restrictions' );
2741 if ( $this->mOldRestrictions
!= '' ) {
2742 foreach ( explode( ':', trim( $this->mOldRestrictions
) ) as $restrict ) {
2743 $temp = explode( '=', trim( $restrict ) );
2744 if ( count( $temp ) == 1 ) {
2745 // old old format should be treated as edit/move restriction
2746 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2747 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2749 $restriction = trim( $temp[1] );
2750 if ( $restriction != '' ) { // some old entries are empty
2751 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
2757 if ( count( $rows ) ) {
2758 # Current system - load second to make them override.
2759 $now = wfTimestampNow();
2761 # Cycle through all the restrictions.
2762 foreach ( $rows as $row ) {
2763 // Don't take care of restrictions types that aren't allowed
2764 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
2768 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
2770 // Only apply the restrictions if they haven't expired!
2771 if ( !$expiry ||
$expiry > $now ) {
2772 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2773 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2775 $this->mCascadeRestriction |
= $row->pr_cascade
;
2780 $this->mRestrictionsLoaded
= true;
2784 * Load restrictions from the page_restrictions table
2786 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
2787 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
2788 * Edit and move sections are separated by a colon
2789 * Example: "edit=autoconfirmed,sysop:move=sysop"
2790 * @param int $flags A bit field. If self::READ_LATEST is set, skip replicas and read
2791 * from the master DB.
2793 public function loadRestrictions( $oldFashionedRestrictions = null, $flags = 0 ) {
2794 $readLatest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
2795 if ( $this->mRestrictionsLoaded
&& !$readLatest ) {
2799 // TODO: should probably pass $flags into getArticleID, but it seems hacky
2800 // to mix READ_LATEST and GAID_FOR_UPDATE, even if they have the same value.
2801 // Maybe deprecate GAID_FOR_UPDATE now that we implement IDBAccessObject?
2802 $id = $this->getArticleID();
2804 $fname = __METHOD__
;
2805 $loadRestrictionsFromDb = function ( IDatabase
$dbr ) use ( $fname, $id ) {
2806 return iterator_to_array(
2808 'page_restrictions',
2809 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
2810 [ 'pr_page' => $id ],
2816 if ( $readLatest ) {
2817 $dbr = wfGetDB( DB_MASTER
);
2818 $rows = $loadRestrictionsFromDb( $dbr );
2820 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2821 $rows = $cache->getWithSetCallback(
2822 // Page protections always leave a new null revision
2823 $cache->makeKey( 'page-restrictions', 'v1', $id, $this->getLatestRevID() ),
2825 function ( $curValue, &$ttl, array &$setOpts ) use ( $loadRestrictionsFromDb ) {
2826 $dbr = wfGetDB( DB_REPLICA
);
2828 $setOpts +
= Database
::getCacheSetOptions( $dbr );
2829 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2830 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2831 // @TODO: cleanup Title cache and caller assumption mess in general
2832 $ttl = WANObjectCache
::TTL_UNCACHEABLE
;
2835 return $loadRestrictionsFromDb( $dbr );
2840 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2842 $title_protection = $this->getTitleProtectionInternal();
2844 if ( $title_protection ) {
2845 $now = wfTimestampNow();
2846 $expiry = wfGetDB( DB_REPLICA
)->decodeExpiry( $title_protection['expiry'] );
2848 if ( !$expiry ||
$expiry > $now ) {
2849 // Apply the restrictions
2850 $this->mRestrictionsExpiry
['create'] = $expiry;
2851 $this->mRestrictions
['create'] =
2852 explode( ',', trim( $title_protection['permission'] ) );
2853 } else { // Get rid of the old restrictions
2854 $this->mTitleProtection
= false;
2857 $this->mRestrictionsExpiry
['create'] = 'infinity';
2859 $this->mRestrictionsLoaded
= true;
2864 * Flush the protection cache in this object and force reload from the database.
2865 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2867 public function flushRestrictions() {
2868 $this->mRestrictionsLoaded
= false;
2869 $this->mTitleProtection
= null;
2873 * Purge expired restrictions from the page_restrictions table
2875 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
2877 static function purgeExpiredRestrictions() {
2878 if ( wfReadOnly() ) {
2882 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
2883 wfGetDB( DB_MASTER
),
2885 function ( IDatabase
$dbw, $fname ) {
2886 $config = MediaWikiServices
::getInstance()->getMainConfig();
2887 $ids = $dbw->selectFieldValues(
2888 'page_restrictions',
2890 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
2892 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
2895 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
2900 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
2901 wfGetDB( DB_MASTER
),
2903 function ( IDatabase
$dbw, $fname ) {
2906 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
2914 * Does this have subpages? (Warning, usually requires an extra DB query.)
2918 public function hasSubpages() {
2920 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
2921 hasSubpages( $this->mNamespace
)
2927 # We dynamically add a member variable for the purpose of this method
2928 # alone to cache the result. There's no point in having it hanging
2929 # around uninitialized in every Title object; therefore we only add it
2930 # if needed and don't declare it statically.
2931 if ( $this->mHasSubpages
=== null ) {
2932 $this->mHasSubpages
= false;
2933 $subpages = $this->getSubpages( 1 );
2934 if ( $subpages instanceof TitleArray
) {
2935 $this->mHasSubpages
= (bool)$subpages->current();
2939 return $this->mHasSubpages
;
2943 * Get all subpages of this page.
2945 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
2946 * @return TitleArray|array TitleArray, or empty array if this page's namespace
2947 * doesn't allow subpages
2949 public function getSubpages( $limit = -1 ) {
2951 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
2952 hasSubpages( $this->mNamespace
)
2957 $dbr = wfGetDB( DB_REPLICA
);
2958 $conds = [ 'page_namespace' => $this->mNamespace
];
2959 $conds[] = 'page_title ' . $dbr->buildLike( $this->mDbkeyform
. '/', $dbr->anyString() );
2961 if ( $limit > -1 ) {
2962 $options['LIMIT'] = $limit;
2964 return TitleArray
::newFromResult(
2965 $dbr->select( 'page',
2966 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
2975 * Is there a version of this page in the deletion archive?
2977 * @return int The number of archived revisions
2979 public function isDeleted() {
2980 if ( $this->mNamespace
< 0 ) {
2983 $dbr = wfGetDB( DB_REPLICA
);
2985 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2986 [ 'ar_namespace' => $this->mNamespace
, 'ar_title' => $this->mDbkeyform
],
2989 if ( $this->mNamespace
== NS_FILE
) {
2990 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
2991 [ 'fa_name' => $this->mDbkeyform
],
3000 * Is there a version of this page in the deletion archive?
3004 public function isDeletedQuick() {
3005 if ( $this->mNamespace
< 0 ) {
3008 $dbr = wfGetDB( DB_REPLICA
);
3009 $deleted = (bool)$dbr->selectField( 'archive', '1',
3010 [ 'ar_namespace' => $this->mNamespace
, 'ar_title' => $this->mDbkeyform
],
3013 if ( !$deleted && $this->mNamespace
== NS_FILE
) {
3014 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3015 [ 'fa_name' => $this->mDbkeyform
],
3023 * Get the article ID for this Title from the link cache,
3024 * adding it if necessary
3026 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3028 * @return int The ID
3030 public function getArticleID( $flags = 0 ) {
3031 if ( $this->mNamespace
< 0 ) {
3032 $this->mArticleID
= 0;
3033 return $this->mArticleID
;
3035 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3036 if ( $flags & self
::GAID_FOR_UPDATE
) {
3037 $oldUpdate = $linkCache->forUpdate( true );
3038 $linkCache->clearLink( $this );
3039 $this->mArticleID
= $linkCache->addLinkObj( $this );
3040 $linkCache->forUpdate( $oldUpdate );
3041 } elseif ( $this->mArticleID
== -1 ) {
3042 $this->mArticleID
= $linkCache->addLinkObj( $this );
3044 return $this->mArticleID
;
3048 * Is this an article that is a redirect page?
3049 * Uses link cache, adding it if necessary
3051 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3054 public function isRedirect( $flags = 0 ) {
3055 if ( !is_null( $this->mRedirect
) ) {
3056 return $this->mRedirect
;
3058 if ( !$this->getArticleID( $flags ) ) {
3059 $this->mRedirect
= false;
3060 return $this->mRedirect
;
3063 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3064 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3065 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3066 if ( $cached === null ) {
3067 # Trust LinkCache's state over our own
3068 # LinkCache is telling us that the page doesn't exist, despite there being cached
3069 # data relating to an existing page in $this->mArticleID. Updaters should clear
3070 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3071 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3072 # LinkCache to refresh its data from the master.
3073 $this->mRedirect
= false;
3074 return $this->mRedirect
;
3077 $this->mRedirect
= (bool)$cached;
3079 return $this->mRedirect
;
3083 * What is the length of this page?
3084 * Uses link cache, adding it if necessary
3086 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3089 public function getLength( $flags = 0 ) {
3090 if ( $this->mLength
!= -1 ) {
3091 return $this->mLength
;
3093 if ( !$this->getArticleID( $flags ) ) {
3095 return $this->mLength
;
3097 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3098 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3099 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3100 if ( $cached === null ) {
3101 # Trust LinkCache's state over our own, as for isRedirect()
3103 return $this->mLength
;
3106 $this->mLength
= intval( $cached );
3108 return $this->mLength
;
3112 * What is the page_latest field for this page?
3114 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3115 * @return int Int or 0 if the page doesn't exist
3117 public function getLatestRevID( $flags = 0 ) {
3118 if ( !( $flags & self
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
3119 return intval( $this->mLatestID
);
3121 if ( !$this->getArticleID( $flags ) ) {
3122 $this->mLatestID
= 0;
3123 return $this->mLatestID
;
3125 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3126 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3127 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3128 if ( $cached === null ) {
3129 # Trust LinkCache's state over our own, as for isRedirect()
3130 $this->mLatestID
= 0;
3131 return $this->mLatestID
;
3134 $this->mLatestID
= intval( $cached );
3136 return $this->mLatestID
;
3140 * This clears some fields in this object, and clears any associated
3141 * keys in the "bad links" section of the link cache.
3143 * - This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow
3144 * loading of the new page_id. It's also called from
3145 * WikiPage::doDeleteArticleReal()
3147 * @param int $newid The new Article ID
3149 public function resetArticleID( $newid ) {
3150 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3151 $linkCache->clearLink( $this );
3153 if ( $newid === false ) {
3154 $this->mArticleID
= -1;
3156 $this->mArticleID
= intval( $newid );
3158 $this->mRestrictionsLoaded
= false;
3159 $this->mRestrictions
= [];
3160 $this->mOldRestrictions
= false;
3161 $this->mRedirect
= null;
3162 $this->mLength
= -1;
3163 $this->mLatestID
= false;
3164 $this->mContentModel
= false;
3165 $this->mEstimateRevisions
= null;
3166 $this->mPageLanguage
= null;
3167 $this->mDbPageLanguage
= false;
3168 $this->mIsBigDeletion
= null;
3171 public static function clearCaches() {
3172 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3173 $linkCache->clear();
3175 $titleCache = self
::getTitleCache();
3176 $titleCache->clear();
3180 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3182 * @param string $text Containing title to capitalize
3183 * @param int $ns Namespace index, defaults to NS_MAIN
3184 * @return string Containing capitalized title
3186 public static function capitalize( $text, $ns = NS_MAIN
) {
3187 $services = MediaWikiServices
::getInstance();
3188 if ( $services->getNamespaceInfo()->isCapitalized( $ns ) ) {
3189 return $services->getContentLanguage()->ucfirst( $text );
3196 * Secure and split - main initialisation function for this object
3198 * Assumes that mDbkeyform has been set, and is urldecoded
3199 * and uses underscores, but not otherwise munged. This function
3200 * removes illegal characters, splits off the interwiki and
3201 * namespace prefixes, sets the other forms, and canonicalizes
3204 * @throws MalformedTitleException On invalid titles
3205 * @return bool True on success
3207 private function secureAndSplit() {
3208 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3209 // the parsing code with Title, while avoiding massive refactoring.
3210 // @todo: get rid of secureAndSplit, refactor parsing code.
3211 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3212 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3213 /** @var MediaWikiTitleCodec $titleCodec */
3214 $titleCodec = MediaWikiServices
::getInstance()->getTitleParser();
3215 // MalformedTitleException can be thrown here
3216 $parts = $titleCodec->splitTitleString( $this->mDbkeyform
, $this->mDefaultNamespace
);
3219 $this->setFragment( '#' . $parts['fragment'] );
3220 $this->mInterwiki
= $parts['interwiki'];
3221 $this->mLocalInterwiki
= $parts['local_interwiki'];
3222 $this->mNamespace
= $parts['namespace'];
3223 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3225 $this->mDbkeyform
= $parts['dbkey'];
3226 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3227 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );
3229 # We already know that some pages won't be in the database!
3230 if ( $this->isExternal() ||
$this->isSpecialPage() ) {
3231 $this->mArticleID
= 0;
3238 * Get an array of Title objects linking to this Title
3239 * Also stores the IDs in the link cache.
3241 * WARNING: do not use this function on arbitrary user-supplied titles!
3242 * On heavily-used templates it will max out the memory.
3244 * @param array $options May be FOR UPDATE
3245 * @param string $table Table name
3246 * @param string $prefix Fields prefix
3247 * @return Title[] Array of Title objects linking here
3249 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3250 if ( count( $options ) > 0 ) {
3251 $db = wfGetDB( DB_MASTER
);
3253 $db = wfGetDB( DB_REPLICA
);
3258 self
::getSelectFields(),
3260 "{$prefix}_from=page_id",
3261 "{$prefix}_namespace" => $this->mNamespace
,
3262 "{$prefix}_title" => $this->mDbkeyform
],
3268 if ( $res->numRows() ) {
3269 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3270 foreach ( $res as $row ) {
3271 $titleObj = self
::makeTitle( $row->page_namespace
, $row->page_title
);
3273 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3274 $retVal[] = $titleObj;
3282 * Get an array of Title objects using this Title as a template
3283 * Also stores the IDs in the link cache.
3285 * WARNING: do not use this function on arbitrary user-supplied titles!
3286 * On heavily-used templates it will max out the memory.
3288 * @param array $options Query option to Database::select()
3289 * @return Title[] Array of Title the Title objects linking here
3291 public function getTemplateLinksTo( $options = [] ) {
3292 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3296 * Get an array of Title objects linked from this Title
3297 * Also stores the IDs in the link cache.
3299 * WARNING: do not use this function on arbitrary user-supplied titles!
3300 * On heavily-used templates it will max out the memory.
3302 * @param array $options Query option to Database::select()
3303 * @param string $table Table name
3304 * @param string $prefix Fields prefix
3305 * @return array Array of Title objects linking here
3307 public function getLinksFrom( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3308 $id = $this->getArticleID();
3310 # If the page doesn't exist; there can't be any link from this page
3315 $db = wfGetDB( DB_REPLICA
);
3317 $blNamespace = "{$prefix}_namespace";
3318 $blTitle = "{$prefix}_title";
3320 $pageQuery = WikiPage
::getQueryInfo();
3322 [ $table, 'nestpage' => $pageQuery['tables'] ],
3324 [ $blNamespace, $blTitle ],
3325 $pageQuery['fields']
3327 [ "{$prefix}_from" => $id ],
3332 [ "page_namespace=$blNamespace", "page_title=$blTitle" ]
3333 ] ] +
$pageQuery['joins']
3337 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3338 foreach ( $res as $row ) {
3339 if ( $row->page_id
) {
3340 $titleObj = self
::newFromRow( $row );
3342 $titleObj = self
::makeTitle( $row->$blNamespace, $row->$blTitle );
3343 $linkCache->addBadLinkObj( $titleObj );
3345 $retVal[] = $titleObj;
3352 * Get an array of Title objects used on this Title as a template
3353 * Also stores the IDs in the link cache.
3355 * WARNING: do not use this function on arbitrary user-supplied titles!
3356 * On heavily-used templates it will max out the memory.
3358 * @param array $options May be FOR UPDATE
3359 * @return Title[] Array of Title the Title objects used here
3361 public function getTemplateLinksFrom( $options = [] ) {
3362 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3366 * Get an array of Title objects referring to non-existent articles linked
3369 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3370 * should use redirect table in this case).
3371 * @return Title[] Array of Title the Title objects
3373 public function getBrokenLinksFrom() {
3374 if ( $this->getArticleID() == 0 ) {
3375 # All links from article ID 0 are false positives
3379 $dbr = wfGetDB( DB_REPLICA
);
3380 $res = $dbr->select(
3381 [ 'page', 'pagelinks' ],
3382 [ 'pl_namespace', 'pl_title' ],
3384 'pl_from' => $this->getArticleID(),
3385 'page_namespace IS NULL'
3391 [ 'pl_namespace=page_namespace', 'pl_title=page_title' ]
3397 foreach ( $res as $row ) {
3398 $retVal[] = self
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3404 * Get a list of URLs to purge from the CDN cache when this
3407 * @return string[] Array of String the URLs
3409 public function getCdnUrls() {
3411 $this->getInternalURL(),
3412 $this->getInternalURL( 'action=history' )
3415 $pageLang = $this->getPageLanguage();
3416 if ( $pageLang->hasVariants() ) {
3417 $variants = $pageLang->getVariants();
3418 foreach ( $variants as $vCode ) {
3419 $urls[] = $this->getInternalURL( $vCode );
3423 // If we are looking at a css/js user subpage, purge the action=raw.
3424 if ( $this->isUserJsConfigPage() ) {
3425 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/javascript' );
3426 } elseif ( $this->isUserJsonConfigPage() ) {
3427 $urls[] = $this->getInternalURL( 'action=raw&ctype=application/json' );
3428 } elseif ( $this->isUserCssConfigPage() ) {
3429 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/css' );
3432 Hooks
::run( 'TitleSquidURLs', [ $this, &$urls ] );
3437 * Purge all applicable CDN URLs
3439 public function purgeSquid() {
3440 DeferredUpdates
::addUpdate(
3441 new CdnCacheUpdate( $this->getCdnUrls() ),
3442 DeferredUpdates
::PRESEND
3447 * Check whether a given move operation would be valid.
3448 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3450 * @deprecated since 1.25, use MovePage's methods instead
3451 * @param Title &$nt The new title
3452 * @param bool $auth Whether to check user permissions (uses $wgUser)
3453 * @param string $reason Is the log summary of the move, used for spam checking
3454 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3456 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3457 wfDeprecated( __METHOD__
, '1.25' );
3461 if ( !( $nt instanceof Title
) ) {
3462 // Normally we'd add this to $errors, but we'll get
3463 // lots of syntax errors if $nt is not an object
3464 return [ [ 'badtitletext' ] ];
3467 $mp = MediaWikiServices
::getInstance()->getMovePageFactory()->newMovePage( $this, $nt );
3468 $errors = $mp->isValidMove()->getErrorsArray();
3470 $errors = wfMergeErrorArrays(
3472 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
3476 return $errors ?
: true;
3480 * Move a title to a new location
3482 * @deprecated since 1.25, use the MovePage class instead
3483 * @param Title &$nt The new title
3484 * @param bool $auth Indicates whether $wgUser's permissions
3486 * @param string $reason The reason for the move
3487 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3488 * Ignored if the user doesn't have the suppressredirect right.
3489 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3490 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3492 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true,
3493 array $changeTags = []
3495 wfDeprecated( __METHOD__
, '1.25' );
3499 $mp = MediaWikiServices
::getInstance()->getMovePageFactory()->newMovePage( $this, $nt );
3500 $method = $auth ?
'moveIfAllowed' : 'move';
3501 $status = $mp->$method( $wgUser, $reason, $createRedirect, $changeTags );
3502 if ( $status->isOK() ) {
3505 return $status->getErrorsArray();
3510 * Move this page's subpages to be subpages of $nt
3512 * @deprecated since 1.34, use MovePage instead
3513 * @param Title $nt Move target
3514 * @param bool $auth Whether $wgUser's permissions should be checked
3515 * @param string $reason The reason for the move
3516 * @param bool $createRedirect Whether to create redirects from the old subpages to
3517 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3518 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3519 * @return array Array with old page titles as keys, and strings (new page titles) or
3520 * getUserPermissionsErrors()-like arrays (errors) as values, or a
3521 * getUserPermissionsErrors()-like error array with numeric indices if
3522 * no pages were moved
3524 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true,
3525 array $changeTags = []
3527 wfDeprecated( __METHOD__
, '1.34' );
3531 $mp = new MovePage( $this, $nt );
3532 $method = $auth ?
'moveSubpagesIfAllowed' : 'moveSubpages';
3533 $result = $mp->$method( $wgUser, $reason, $createRedirect, $changeTags );
3535 if ( !$result->isOK() ) {
3536 return $result->getErrorsArray();
3540 foreach ( $result->getValue() as $key => $status ) {
3541 if ( $status->isOK() ) {
3542 $retval[$key] = $status->getValue();
3544 $retval[$key] = $status->getErrorsArray();
3551 * Checks if this page is just a one-rev redirect.
3552 * Adds lock, so don't use just for light purposes.
3556 public function isSingleRevRedirect() {
3557 global $wgContentHandlerUseDB;
3559 $dbw = wfGetDB( DB_MASTER
);
3562 $fields = [ 'page_is_redirect', 'page_latest', 'page_id' ];
3563 if ( $wgContentHandlerUseDB ) {
3564 $fields[] = 'page_content_model';
3567 $row = $dbw->selectRow( 'page',
3573 # Cache some fields we may want
3574 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3575 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3576 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3577 $this->mContentModel
= $row && isset( $row->page_content_model
)
3578 ?
strval( $row->page_content_model
)
3581 if ( !$this->mRedirect
) {
3584 # Does the article have a history?
3585 $row = $dbw->selectField( [ 'page', 'revision' ],
3587 [ 'page_namespace' => $this->mNamespace
,
3588 'page_title' => $this->mDbkeyform
,
3590 'page_latest != rev_id'
3595 # Return true if there was no history
3596 return ( $row === false );
3600 * Checks if $this can be moved to a given Title
3601 * - Selects for update, so don't call it unless you mean business
3603 * @deprecated since 1.25, use MovePage's methods instead
3604 * @param Title $nt The new title to check
3607 public function isValidMoveTarget( $nt ) {
3608 wfDeprecated( __METHOD__
, '1.25' );
3610 # Is it an existing file?
3611 if ( $nt->getNamespace() == NS_FILE
) {
3612 $file = MediaWikiServices
::getInstance()->getRepoGroup()->getLocalRepo()
3614 $file->load( File
::READ_LATEST
);
3615 if ( $file->exists() ) {
3616 wfDebug( __METHOD__
. ": file exists\n" );
3620 # Is it a redirect with no history?
3621 if ( !$nt->isSingleRevRedirect() ) {
3622 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3625 # Get the article text
3626 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
3627 if ( !is_object( $rev ) ) {
3630 $content = $rev->getContent();
3631 # Does the redirect point to the source?
3632 # Or is it a broken self-redirect, usually caused by namespace collisions?
3633 $redirTitle = $content ?
$content->getRedirectTarget() : null;
3635 if ( $redirTitle ) {
3636 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3637 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3638 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3644 # Fail safe (not a redirect after all. strange.)
3645 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
3646 " is a redirect, but it doesn't contain a valid redirect.\n" );
3652 * Get categories to which this Title belongs and return an array of
3653 * categories' names.
3655 * @return array Array of parents in the form:
3656 * $parent => $currentarticle
3658 public function getParentCategories() {
3661 $titleKey = $this->getArticleID();
3663 if ( $titleKey === 0 ) {
3667 $dbr = wfGetDB( DB_REPLICA
);
3669 $res = $dbr->select(
3672 [ 'cl_from' => $titleKey ],
3676 if ( $res->numRows() > 0 ) {
3677 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
3678 foreach ( $res as $row ) {
3679 // $data[] = Title::newFromText( $contLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
3680 $data[$contLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] =
3681 $this->getFullText();
3688 * Get a tree of parent categories
3690 * @param array $children Array with the children in the keys, to check for circular refs
3691 * @return array Tree of parent categories
3693 public function getParentCategoryTree( $children = [] ) {
3695 $parents = $this->getParentCategories();
3698 foreach ( $parents as $parent => $current ) {
3699 if ( array_key_exists( $parent, $children ) ) {
3700 # Circular reference
3701 $stack[$parent] = [];
3703 $nt = self
::newFromText( $parent );
3705 $stack[$parent] = $nt->getParentCategoryTree( $children +
[ $parent => 1 ] );
3715 * Get an associative array for selecting this title from
3718 * @return array Array suitable for the $where parameter of DB::select()
3720 public function pageCond() {
3721 if ( $this->mArticleID
> 0 ) {
3722 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3723 return [ 'page_id' => $this->mArticleID
];
3725 return [ 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
];
3730 * Get next/previous revision ID relative to another revision ID
3731 * @param int $revId Revision ID. Get the revision that was before this one.
3732 * @param int $flags Title::GAID_FOR_UPDATE
3733 * @param string $dir 'next' or 'prev'
3734 * @return int|bool New revision ID, or false if none exists
3736 private function getRelativeRevisionID( $revId, $flags, $dir ) {
3737 $rl = MediaWikiServices
::getInstance()->getRevisionLookup();
3738 $rlFlags = $flags === self
::GAID_FOR_UPDATE ? IDBAccessObject
::READ_LATEST
: 0;
3739 $rev = $rl->getRevisionById( $revId, $rlFlags );
3743 $oldRev = $dir === 'next'
3744 ?
$rl->getNextRevision( $rev, $rlFlags )
3745 : $rl->getPreviousRevision( $rev, $rlFlags );
3749 return $oldRev->getId();
3753 * Get the revision ID of the previous revision
3755 * @deprecated since 1.34, use RevisionLookup::getPreviousRevision
3756 * @param int $revId Revision ID. Get the revision that was before this one.
3757 * @param int $flags Title::GAID_FOR_UPDATE
3758 * @return int|bool Old revision ID, or false if none exists
3760 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3761 return $this->getRelativeRevisionID( $revId, $flags, 'prev' );
3765 * Get the revision ID of the next revision
3767 * @deprecated since 1.34, use RevisionLookup::getNextRevision
3768 * @param int $revId Revision ID. Get the revision that was after this one.
3769 * @param int $flags Title::GAID_FOR_UPDATE
3770 * @return int|bool Next revision ID, or false if none exists
3772 public function getNextRevisionID( $revId, $flags = 0 ) {
3773 return $this->getRelativeRevisionID( $revId, $flags, 'next' );
3777 * Get the first revision of the page
3779 * @param int $flags Title::GAID_FOR_UPDATE
3780 * @return Revision|null If page doesn't exist
3782 public function getFirstRevision( $flags = 0 ) {
3783 $pageId = $this->getArticleID( $flags );
3785 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
3786 $revQuery = Revision
::getQueryInfo();
3787 $row = $db->selectRow( $revQuery['tables'], $revQuery['fields'],
3788 [ 'rev_page' => $pageId ],
3791 'ORDER BY' => 'rev_timestamp ASC, rev_id ASC',
3792 'IGNORE INDEX' => [ 'revision' => 'rev_timestamp' ], // See T159319
3797 return new Revision( $row, 0, $this );
3804 * Get the oldest revision timestamp of this page
3806 * @param int $flags Title::GAID_FOR_UPDATE
3807 * @return string|null MW timestamp
3809 public function getEarliestRevTime( $flags = 0 ) {
3810 $rev = $this->getFirstRevision( $flags );
3811 return $rev ?
$rev->getTimestamp() : null;
3815 * Check if this is a new page
3819 public function isNewPage() {
3820 $dbr = wfGetDB( DB_REPLICA
);
3821 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3825 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
3829 public function isBigDeletion() {
3830 global $wgDeleteRevisionsLimit;
3832 if ( !$wgDeleteRevisionsLimit ) {
3836 if ( $this->mIsBigDeletion
=== null ) {
3837 $dbr = wfGetDB( DB_REPLICA
);
3839 $revCount = $dbr->selectRowCount(
3842 [ 'rev_page' => $this->getArticleID() ],
3844 [ 'LIMIT' => $wgDeleteRevisionsLimit +
1 ]
3847 $this->mIsBigDeletion
= $revCount > $wgDeleteRevisionsLimit;
3850 return $this->mIsBigDeletion
;
3854 * Get the approximate revision count of this page.
3858 public function estimateRevisionCount() {
3859 if ( !$this->exists() ) {
3863 if ( $this->mEstimateRevisions
=== null ) {
3864 $dbr = wfGetDB( DB_REPLICA
);
3865 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
3866 [ 'rev_page' => $this->getArticleID() ], __METHOD__
);
3869 return $this->mEstimateRevisions
;
3873 * Get the number of revisions between the given revision.
3874 * Used for diffs and other things that really need it.
3876 * @param int|Revision $old Old revision or rev ID (first before range)
3877 * @param int|Revision $new New revision or rev ID (first after range)
3878 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
3879 * @return int Number of revisions between these revisions.
3881 public function countRevisionsBetween( $old, $new, $max = null ) {
3882 if ( !( $old instanceof Revision
) ) {
3883 $old = Revision
::newFromTitle( $this, (int)$old );
3885 if ( !( $new instanceof Revision
) ) {
3886 $new = Revision
::newFromTitle( $this, (int)$new );
3888 if ( !$old ||
!$new ) {
3889 return 0; // nothing to compare
3891 $dbr = wfGetDB( DB_REPLICA
);
3893 'rev_page' => $this->getArticleID(),
3894 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3895 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3897 if ( $max !== null ) {
3898 return $dbr->selectRowCount( 'revision', '1',
3901 [ 'LIMIT' => $max +
1 ] // extra to detect truncation
3904 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
3909 * Get the authors between the given revisions or revision IDs.
3910 * Used for diffs and other things that really need it.
3914 * @param int|Revision $old Old revision or rev ID (first before range by default)
3915 * @param int|Revision $new New revision or rev ID (first after range by default)
3916 * @param int $limit Maximum number of authors
3917 * @param string|array $options (Optional): Single option, or an array of options:
3918 * 'include_old' Include $old in the range; $new is excluded.
3919 * 'include_new' Include $new in the range; $old is excluded.
3920 * 'include_both' Include both $old and $new in the range.
3921 * Unknown option values are ignored.
3922 * @return array|null Names of revision authors in the range; null if not both revisions exist
3924 public function getAuthorsBetween( $old, $new, $limit, $options = [] ) {
3925 if ( !( $old instanceof Revision
) ) {
3926 $old = Revision
::newFromTitle( $this, (int)$old );
3928 if ( !( $new instanceof Revision
) ) {
3929 $new = Revision
::newFromTitle( $this, (int)$new );
3931 // XXX: what if Revision objects are passed in, but they don't refer to this title?
3932 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
3933 // in the sanity check below?
3934 if ( !$old ||
!$new ) {
3935 return null; // nothing to compare
3940 $options = (array)$options;
3941 if ( in_array( 'include_old', $options ) ) {
3944 if ( in_array( 'include_new', $options ) ) {
3947 if ( in_array( 'include_both', $options ) ) {
3951 // No DB query needed if $old and $new are the same or successive revisions:
3952 if ( $old->getId() === $new->getId() ) {
3953 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
3955 [ $old->getUserText( RevisionRecord
::RAW
) ];
3956 } elseif ( $old->getId() === $new->getParentId() ) {
3957 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
3958 $authors[] = $oldUserText = $old->getUserText( RevisionRecord
::RAW
);
3959 $newUserText = $new->getUserText( RevisionRecord
::RAW
);
3960 if ( $oldUserText != $newUserText ) {
3961 $authors[] = $newUserText;
3963 } elseif ( $old_cmp === '>=' ) {
3964 $authors[] = $old->getUserText( RevisionRecord
::RAW
);
3965 } elseif ( $new_cmp === '<=' ) {
3966 $authors[] = $new->getUserText( RevisionRecord
::RAW
);
3970 $dbr = wfGetDB( DB_REPLICA
);
3971 $revQuery = Revision
::getQueryInfo();
3972 $authors = $dbr->selectFieldValues(
3973 $revQuery['tables'],
3974 $revQuery['fields']['rev_user_text'],
3976 'rev_page' => $this->getArticleID(),
3977 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3978 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3980 [ 'DISTINCT', 'LIMIT' => $limit +
1 ], // add one so caller knows it was truncated
3987 * Get the number of authors between the given revisions or revision IDs.
3988 * Used for diffs and other things that really need it.
3990 * @param int|Revision $old Old revision or rev ID (first before range by default)
3991 * @param int|Revision $new New revision or rev ID (first after range by default)
3992 * @param int $limit Maximum number of authors
3993 * @param string|array $options (Optional): Single option, or an array of options:
3994 * 'include_old' Include $old in the range; $new is excluded.
3995 * 'include_new' Include $new in the range; $old is excluded.
3996 * 'include_both' Include both $old and $new in the range.
3997 * Unknown option values are ignored.
3998 * @return int Number of revision authors in the range; zero if not both revisions exist
4000 public function countAuthorsBetween( $old, $new, $limit, $options = [] ) {
4001 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4002 return $authors ?
count( $authors ) : 0;
4006 * Compare with another title.
4008 * @param LinkTarget $title
4011 public function equals( LinkTarget
$title ) {
4012 // Note: === is necessary for proper matching of number-like titles.
4013 return $this->mInterwiki
=== $title->getInterwiki()
4014 && $this->mNamespace
== $title->getNamespace()
4015 && $this->mDbkeyform
=== $title->getDBkey();
4019 * Check if this title is a subpage of another title
4021 * @param Title $title
4024 public function isSubpageOf( Title
$title ) {
4025 return $this->mInterwiki
=== $title->mInterwiki
4026 && $this->mNamespace
== $title->mNamespace
4027 && strpos( $this->mDbkeyform
, $title->mDbkeyform
. '/' ) === 0;
4031 * Check if page exists. For historical reasons, this function simply
4032 * checks for the existence of the title in the page table, and will
4033 * thus return false for interwiki links, special pages and the like.
4034 * If you want to know if a title can be meaningfully viewed, you should
4035 * probably call the isKnown() method instead.
4037 * @param int $flags An optional bit field; may be Title::GAID_FOR_UPDATE to check
4038 * from master/for update
4041 public function exists( $flags = 0 ) {
4042 $exists = $this->getArticleID( $flags ) != 0;
4043 Hooks
::run( 'TitleExists', [ $this, &$exists ] );
4048 * Should links to this title be shown as potentially viewable (i.e. as
4049 * "bluelinks"), even if there's no record by this title in the page
4052 * This function is semi-deprecated for public use, as well as somewhat
4053 * misleadingly named. You probably just want to call isKnown(), which
4054 * calls this function internally.
4056 * (ISSUE: Most of these checks are cheap, but the file existence check
4057 * can potentially be quite expensive. Including it here fixes a lot of
4058 * existing code, but we might want to add an optional parameter to skip
4059 * it and any other expensive checks.)
4063 public function isAlwaysKnown() {
4067 * Allows overriding default behavior for determining if a page exists.
4068 * If $isKnown is kept as null, regular checks happen. If it's
4069 * a boolean, this value is returned by the isKnown method.
4073 * @param Title $title
4074 * @param bool|null $isKnown
4076 Hooks
::run( 'TitleIsAlwaysKnown', [ $this, &$isKnown ] );
4078 if ( !is_null( $isKnown ) ) {
4082 if ( $this->isExternal() ) {
4083 return true; // any interwiki link might be viewable, for all we know
4086 $services = MediaWikiServices
::getInstance();
4087 switch ( $this->mNamespace
) {
4090 // file exists, possibly in a foreign repo
4091 return (bool)$services->getRepoGroup()->findFile( $this );
4093 // valid special page
4094 return $services->getSpecialPageFactory()->exists( $this->mDbkeyform
);
4096 // selflink, possibly with fragment
4097 return $this->mDbkeyform
== '';
4099 // known system message
4100 return $this->hasSourceText() !== false;
4107 * Does this title refer to a page that can (or might) be meaningfully
4108 * viewed? In particular, this function may be used to determine if
4109 * links to the title should be rendered as "bluelinks" (as opposed to
4110 * "redlinks" to non-existent pages).
4111 * Adding something else to this function will cause inconsistency
4112 * since LinkHolderArray calls isAlwaysKnown() and does its own
4113 * page existence check.
4117 public function isKnown() {
4118 return $this->isAlwaysKnown() ||
$this->exists();
4122 * Does this page have source text?
4126 public function hasSourceText() {
4127 if ( $this->exists() ) {
4131 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4132 // If the page doesn't exist but is a known system message, default
4133 // message content will be displayed, same for language subpages-
4134 // Use always content language to avoid loading hundreds of languages
4135 // to get the link color.
4136 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
4137 list( $name, ) = MessageCache
::singleton()->figureMessage(
4138 $contLang->lcfirst( $this->getText() )
4140 $message = wfMessage( $name )->inLanguage( $contLang )->useDatabase( false );
4141 return $message->exists();
4148 * Get the default (plain) message contents for an page that overrides an
4149 * interface message key.
4151 * Primary use cases:
4154 * - Show default when viewing the page. The Article::getSubstituteContent
4155 * method displays the default message content, instead of the
4156 * 'noarticletext' placeholder message normally used.
4159 * - Title of edit page. When creating an interface message override,
4160 * the editor is told they are "Editing the page", instead of
4161 * "Creating the page". (EditPage::setHeaders)
4162 * - Edit notice. The 'translateinterface' edit notice is shown when creating
4163 * or editing a an interface message override. (EditPage::showIntro)
4164 * - Opening the editor. The contents of the localisation message are used
4165 * as contents of the editor when creating a new page in the MediaWiki
4166 * namespace. This simplifies the process for editors when "changing"
4167 * an interface message by creating an override. (EditPage::getContentObject)
4168 * - Showing a diff. The left-hand side of a diff when an editor is
4169 * previewing their changes before saving the creation of a page in the
4170 * MediaWiki namespace. (EditPage::showDiff)
4171 * - Disallowing a save. When attempting to create a a MediaWiki-namespace
4172 * page with the proposed content matching the interface message default,
4173 * the save is rejected, the same way we disallow blank pages from being
4174 * created. (EditPage::internalAttemptSave)
4177 * - Default content, when using the 'prepend' or 'append' feature.
4180 * - Label the create action as "Edit", if the page can be an override.
4182 * @return string|bool
4184 public function getDefaultMessageText() {
4185 if ( $this->mNamespace
!= NS_MEDIAWIKI
) { // Just in case
4189 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4190 MediaWikiServices
::getInstance()->getContentLanguage()->lcfirst( $this->getText() )
4192 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4194 if ( $message->exists() ) {
4195 return $message->plain();
4202 * Updates page_touched for this page; called from LinksUpdate.php
4204 * @param string|null $purgeTime [optional] TS_MW timestamp
4205 * @return bool True if the update succeeded
4207 public function invalidateCache( $purgeTime = null ) {
4208 if ( wfReadOnly() ) {
4210 } elseif ( $this->mArticleID
=== 0 ) {
4211 return true; // avoid gap locking if we know it's not there
4214 $dbw = wfGetDB( DB_MASTER
);
4215 $dbw->onTransactionPreCommitOrIdle(
4216 function () use ( $dbw ) {
4217 ResourceLoaderWikiModule
::invalidateModuleCache(
4218 $this, null, null, $dbw->getDomainID() );
4223 $conds = $this->pageCond();
4224 DeferredUpdates
::addUpdate(
4225 new AutoCommitUpdate(
4228 function ( IDatabase
$dbw, $fname ) use ( $conds, $purgeTime ) {
4229 $dbTimestamp = $dbw->timestamp( $purgeTime ?
: time() );
4232 [ 'page_touched' => $dbTimestamp ],
4233 $conds +
[ 'page_touched < ' . $dbw->addQuotes( $dbTimestamp ) ],
4236 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $this );
4239 DeferredUpdates
::PRESEND
4246 * Update page_touched timestamps and send CDN purge messages for
4247 * pages linking to this title. May be sent to the job queue depending
4248 * on the number of links. Typically called on create and delete.
4250 public function touchLinks() {
4251 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this, 'pagelinks', 'page-touch' ) );
4252 if ( $this->mNamespace
== NS_CATEGORY
) {
4253 DeferredUpdates
::addUpdate(
4254 new HTMLCacheUpdate( $this, 'categorylinks', 'category-touch' )
4260 * Get the last touched timestamp
4262 * @param IDatabase|null $db
4263 * @return string|false Last-touched timestamp
4265 public function getTouched( $db = null ) {
4266 if ( $db === null ) {
4267 $db = wfGetDB( DB_REPLICA
);
4269 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4274 * Get the timestamp when this page was updated since the user last saw it.
4276 * @param User|null $user
4277 * @return string|bool|null String timestamp, false if not watched, null if nothing is unseen
4279 public function getNotificationTimestamp( $user = null ) {
4282 // Assume current user if none given
4286 // Check cache first
4287 $uid = $user->getId();
4291 // avoid isset here, as it'll return false for null entries
4292 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4293 return $this->mNotificationTimestamp
[$uid];
4295 // Don't cache too much!
4296 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4297 $this->mNotificationTimestamp
= [];
4300 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
4301 $watchedItem = $store->getWatchedItem( $user, $this );
4302 if ( $watchedItem ) {
4303 $this->mNotificationTimestamp
[$uid] = $watchedItem->getNotificationTimestamp();
4305 $this->mNotificationTimestamp
[$uid] = false;
4308 return $this->mNotificationTimestamp
[$uid];
4312 * Generate strings used for xml 'id' names in monobook tabs
4314 * @param string $prepend Defaults to 'nstab-'
4315 * @return string XML 'id' name
4317 public function getNamespaceKey( $prepend = 'nstab-' ) {
4318 // Gets the subject namespace of this title
4319 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
4320 $subjectNS = $nsInfo->getSubject( $this->mNamespace
);
4321 // Prefer canonical namespace name for HTML IDs
4322 $namespaceKey = $nsInfo->getCanonicalName( $subjectNS );
4323 if ( $namespaceKey === false ) {
4324 // Fallback to localised text
4325 $namespaceKey = $this->getSubjectNsText();
4327 // Makes namespace key lowercase
4328 $namespaceKey = MediaWikiServices
::getInstance()->getContentLanguage()->lc( $namespaceKey );
4330 if ( $namespaceKey == '' ) {
4331 $namespaceKey = 'main';
4333 // Changes file to image for backwards compatibility
4334 if ( $namespaceKey == 'file' ) {
4335 $namespaceKey = 'image';
4337 return $prepend . $namespaceKey;
4341 * Get all extant redirects to this Title
4343 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4344 * @return Title[] Array of Title redirects to this title
4346 public function getRedirectsHere( $ns = null ) {
4349 $dbr = wfGetDB( DB_REPLICA
);
4351 'rd_namespace' => $this->mNamespace
,
4352 'rd_title' => $this->mDbkeyform
,
4355 if ( $this->isExternal() ) {
4356 $where['rd_interwiki'] = $this->mInterwiki
;
4358 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4360 if ( !is_null( $ns ) ) {
4361 $where['page_namespace'] = $ns;
4364 $res = $dbr->select(
4365 [ 'redirect', 'page' ],
4366 [ 'page_namespace', 'page_title' ],
4371 foreach ( $res as $row ) {
4372 $redirs[] = self
::newFromRow( $row );
4378 * Check if this Title is a valid redirect target
4382 public function isValidRedirectTarget() {
4383 global $wgInvalidRedirectTargets;
4385 if ( $this->isSpecialPage() ) {
4386 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4387 if ( $this->isSpecial( 'Userlogout' ) ) {
4391 foreach ( $wgInvalidRedirectTargets as $target ) {
4392 if ( $this->isSpecial( $target ) ) {
4402 * Get a backlink cache object
4404 * @return BacklinkCache
4406 public function getBacklinkCache() {
4407 return BacklinkCache
::get( $this );
4411 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4415 public function canUseNoindex() {
4416 global $wgExemptFromUserRobotsControl;
4418 $bannedNamespaces = $wgExemptFromUserRobotsControl ??
4419 MediaWikiServices
::getInstance()->getNamespaceInfo()->getContentNamespaces();
4421 return !in_array( $this->mNamespace
, $bannedNamespaces );
4425 * Returns the raw sort key to be used for categories, with the specified
4426 * prefix. This will be fed to Collation::getSortKey() to get a
4427 * binary sortkey that can be used for actual sorting.
4429 * @param string $prefix The prefix to be used, specified using
4430 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4434 public function getCategorySortkey( $prefix = '' ) {
4435 $unprefixed = $this->getText();
4437 // Anything that uses this hook should only depend
4438 // on the Title object passed in, and should probably
4439 // tell the users to run updateCollations.php --force
4440 // in order to re-sort existing category relations.
4441 Hooks
::run( 'GetDefaultSortkey', [ $this, &$unprefixed ] );
4442 if ( $prefix !== '' ) {
4443 # Separate with a line feed, so the unprefixed part is only used as
4444 # a tiebreaker when two pages have the exact same prefix.
4445 # In UCA, tab is the only character that can sort above LF
4446 # so we strip both of them from the original prefix.
4447 $prefix = strtr( $prefix, "\n\t", ' ' );
4448 return "$prefix\n$unprefixed";
4454 * Returns the page language code saved in the database, if $wgPageLanguageUseDB is set
4455 * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
4456 * the db, it will return NULL.
4458 * @return string|null|bool
4460 private function getDbPageLanguageCode() {
4461 global $wgPageLanguageUseDB;
4463 // check, if the page language could be saved in the database, and if so and
4464 // the value is not requested already, lookup the page language using LinkCache
4465 if ( $wgPageLanguageUseDB && $this->mDbPageLanguage
=== false ) {
4466 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
4467 $linkCache->addLinkObj( $this );
4468 $this->mDbPageLanguage
= $linkCache->getGoodLinkFieldObj( $this, 'lang' );
4471 return $this->mDbPageLanguage
;
4475 * Get the language in which the content of this page is written in
4476 * wikitext. Defaults to content language, but in certain cases it can be
4477 * e.g. $wgLang (such as special pages, which are in the user language).
4482 public function getPageLanguage() {
4483 global $wgLang, $wgLanguageCode;
4484 if ( $this->isSpecialPage() ) {
4485 // special pages are in the user language
4489 // Checking if DB language is set
4490 $dbPageLanguage = $this->getDbPageLanguageCode();
4491 if ( $dbPageLanguage ) {
4492 return wfGetLangObj( $dbPageLanguage );
4495 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
4496 // Note that this may depend on user settings, so the cache should
4497 // be only per-request.
4498 // NOTE: ContentHandler::getPageLanguage() may need to load the
4499 // content to determine the page language!
4500 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4502 $contentHandler = ContentHandler
::getForTitle( $this );
4503 $langObj = $contentHandler->getPageLanguage( $this );
4504 $this->mPageLanguage
= [ $langObj->getCode(), $wgLanguageCode ];
4506 $langObj = Language
::factory( $this->mPageLanguage
[0] );
4513 * Get the language in which the content of this page is written when
4514 * viewed by user. Defaults to content language, but in certain cases it can be
4515 * e.g. $wgLang (such as special pages, which are in the user language).
4520 public function getPageViewLanguage() {
4523 if ( $this->isSpecialPage() ) {
4524 // If the user chooses a variant, the content is actually
4525 // in a language whose code is the variant code.
4526 $variant = $wgLang->getPreferredVariant();
4527 if ( $wgLang->getCode() !== $variant ) {
4528 return Language
::factory( $variant );
4534 // Checking if DB language is set
4535 $dbPageLanguage = $this->getDbPageLanguageCode();
4536 if ( $dbPageLanguage ) {
4537 $pageLang = wfGetLangObj( $dbPageLanguage );
4538 $variant = $pageLang->getPreferredVariant();
4539 if ( $pageLang->getCode() !== $variant ) {
4540 $pageLang = Language
::factory( $variant );
4546 // @note Can't be cached persistently, depends on user settings.
4547 // @note ContentHandler::getPageViewLanguage() may need to load the
4548 // content to determine the page language!
4549 $contentHandler = ContentHandler
::getForTitle( $this );
4550 $pageLang = $contentHandler->getPageViewLanguage( $this );
4555 * Get a list of rendered edit notices for this page.
4557 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4558 * they will already be wrapped in paragraphs.
4561 * @param int $oldid Revision ID that's being edited
4564 public function getEditNotices( $oldid = 0 ) {
4567 // Optional notice for the entire namespace
4568 $editnotice_ns = 'editnotice-' . $this->mNamespace
;
4569 $msg = wfMessage( $editnotice_ns );
4570 if ( $msg->exists() ) {
4571 $html = $msg->parseAsBlock();
4572 // Edit notices may have complex logic, but output nothing (T91715)
4573 if ( trim( $html ) !== '' ) {
4574 $notices[$editnotice_ns] = Html
::rawElement(
4578 'mw-editnotice-namespace',
4579 Sanitizer
::escapeClass( "mw-$editnotice_ns" )
4587 MediaWikiServices
::getInstance()->getNamespaceInfo()->
4588 hasSubpages( $this->mNamespace
)
4590 // Optional notice for page itself and any parent page
4591 $editnotice_base = $editnotice_ns;
4592 foreach ( explode( '/', $this->mDbkeyform
) as $part ) {
4593 $editnotice_base .= '-' . $part;
4594 $msg = wfMessage( $editnotice_base );
4595 if ( $msg->exists() ) {
4596 $html = $msg->parseAsBlock();
4597 if ( trim( $html ) !== '' ) {
4598 $notices[$editnotice_base] = Html
::rawElement(
4602 'mw-editnotice-base',
4603 Sanitizer
::escapeClass( "mw-$editnotice_base" )
4611 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
4612 $editnoticeText = $editnotice_ns . '-' . strtr( $this->mDbkeyform
, '/', '-' );
4613 $msg = wfMessage( $editnoticeText );
4614 if ( $msg->exists() ) {
4615 $html = $msg->parseAsBlock();
4616 if ( trim( $html ) !== '' ) {
4617 $notices[$editnoticeText] = Html
::rawElement(
4621 'mw-editnotice-page',
4622 Sanitizer
::escapeClass( "mw-$editnoticeText" )
4630 Hooks
::run( 'TitleGetEditNotices', [ $this, $oldid, &$notices ] );
4637 public function __sleep() {
4645 'mDefaultNamespace',
4649 public function __wakeup() {
4650 $this->mArticleID
= ( $this->mNamespace
>= 0 ) ?
-1 : 0;
4651 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
4652 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );