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 and inject it into link cache.
56 * @deprecated since 1.34, use Title::READ_LATEST instead.
58 const GAID_FOR_UPDATE
= 512;
61 * Flag for use with factory methods like newFromLinkTarget() that have
62 * a $forceClone parameter. If set, the method must return a new instance.
63 * Without this flag, some factory methods may return existing instances.
67 const NEW_CLONE
= 'clone';
70 * @name Private member variables
71 * Please use the accessor functions instead.
76 /** @var string Text form (spaces not underscores) of the main part */
77 public $mTextform = '';
78 /** @var string URL-encoded form of the main part */
79 public $mUrlform = '';
80 /** @var string Main part with underscores */
81 public $mDbkeyform = '';
82 /** @var string Database key with the initial letter in the case specified by the user */
83 protected $mUserCaseDBKey;
84 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
85 public $mNamespace = NS_MAIN
;
86 /** @var string Interwiki prefix */
87 public $mInterwiki = '';
88 /** @var bool Was this Title created from a string with a local interwiki prefix? */
89 private $mLocalInterwiki = false;
90 /** @var string Title fragment (i.e. the bit after the #) */
91 public $mFragment = '';
93 /** @var int Article ID, fetched from the link cache on demand */
94 public $mArticleID = -1;
96 /** @var bool|int ID of most recent revision */
97 protected $mLatestID = false;
100 * @var bool|string ID of the page's content model, i.e. one of the
101 * CONTENT_MODEL_XXX constants
103 private $mContentModel = false;
106 * @var bool If a content model was forced via setContentModel()
107 * this will be true to avoid having other code paths reset it
109 private $mForcedContentModel = false;
111 /** @var int Estimated number of revisions; null of not loaded */
112 private $mEstimateRevisions;
114 /** @var array Array of groups allowed to edit this article */
115 public $mRestrictions = [];
118 * @var string|bool Comma-separated set of permission keys
119 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
120 * Edit and move sections are separated by a colon
121 * Example: "edit=autoconfirmed,sysop:move=sysop"
123 protected $mOldRestrictions = false;
125 /** @var bool Cascade restrictions on this page to included templates and images? */
126 public $mCascadeRestriction;
128 /** Caching the results of getCascadeProtectionSources */
129 public $mCascadingRestrictions;
131 /** @var array When do the restrictions on this page expire? */
132 protected $mRestrictionsExpiry = [];
134 /** @var bool Are cascading restrictions in effect on this page? */
135 protected $mHasCascadingRestrictions;
137 /** @var array Where are the cascading restrictions coming from on this page? */
138 public $mCascadeSources;
140 /** @var bool Boolean for initialisation on demand */
141 public $mRestrictionsLoaded = false;
144 * Text form including namespace/interwiki, initialised on demand
146 * Only public to share cache with TitleFormatter
151 public $prefixedText = null;
153 /** @var mixed Cached value for getTitleProtection (create protection) */
154 public $mTitleProtection;
157 * @var int Namespace index when there is no namespace. Don't change the
158 * following default, NS_MAIN is hardcoded in several places. See T2696.
159 * Zero except in {{transclusion}} tags.
161 public $mDefaultNamespace = NS_MAIN
;
163 /** @var int The page length, 0 for special pages */
164 protected $mLength = -1;
166 /** @var null Is the article at this title a redirect? */
167 public $mRedirect = null;
169 /** @var array Associative array of user ID -> timestamp/false */
170 private $mNotificationTimestamp = [];
172 /** @var bool Whether a page has any subpages */
173 private $mHasSubpages;
175 /** @var array|null The (string) language code of the page's language and content code. */
176 private $mPageLanguage;
178 /** @var string|bool|null The page language code from the database, null if not saved in
179 * the database or false if not loaded, yet.
181 private $mDbPageLanguage = false;
183 /** @var TitleValue|null A corresponding TitleValue object */
184 private $mTitleValue = null;
186 /** @var bool|null Would deleting this page be a big deletion? */
187 private $mIsBigDeletion = null;
191 * B/C kludge: provide a TitleParser for use by Title.
192 * Ideally, Title would have no methods that need this.
193 * Avoid usage of this singleton by using TitleValue
194 * and the associated services when possible.
196 * @return TitleFormatter
198 private static function getTitleFormatter() {
199 return MediaWikiServices
::getInstance()->getTitleFormatter();
203 * B/C kludge: provide an InterwikiLookup for use by Title.
204 * Ideally, Title would have no methods that need this.
205 * Avoid usage of this singleton by using TitleValue
206 * and the associated services when possible.
208 * @return InterwikiLookup
210 private static function getInterwikiLookup() {
211 return MediaWikiServices
::getInstance()->getInterwikiLookup();
217 function __construct() {
221 * Create a new Title from a prefixed DB key
223 * @param string $key The database key, which has underscores
224 * instead of spaces, possibly including namespace and
226 * @return Title|null Title, or null on an error
228 public static function newFromDBkey( $key ) {
230 $t->mDbkeyform
= $key;
233 $t->secureAndSplit();
235 } catch ( MalformedTitleException
$ex ) {
241 * Returns a Title given a TitleValue.
242 * If the given TitleValue is already a Title instance, that instance is returned,
243 * unless $forceClone is "clone". If $forceClone is "clone" and the given TitleValue
244 * is already a Title instance, that instance is copied using the clone operator.
246 * @deprecated since 1.34, use newFromLinkTarget or castFromLinkTarget
248 * @param TitleValue $titleValue Assumed to be safe.
249 * @param string $forceClone set to NEW_CLONE to ensure a fresh instance is returned.
253 public static function newFromTitleValue( TitleValue
$titleValue, $forceClone = '' ) {
254 return self
::newFromLinkTarget( $titleValue, $forceClone );
258 * Returns a Title given a LinkTarget.
259 * If the given LinkTarget is already a Title instance, that instance is returned,
260 * unless $forceClone is "clone". If $forceClone is "clone" and the given LinkTarget
261 * is already a Title instance, that instance is copied using the clone operator.
263 * @param LinkTarget $linkTarget Assumed to be safe.
264 * @param string $forceClone set to NEW_CLONE to ensure a fresh instance is returned.
268 public static function newFromLinkTarget( LinkTarget
$linkTarget, $forceClone = '' ) {
269 if ( $linkTarget instanceof Title
) {
270 // Special case if it's already a Title object
271 if ( $forceClone === self
::NEW_CLONE
) {
272 return clone $linkTarget;
277 return self
::makeTitle(
278 $linkTarget->getNamespace(),
279 $linkTarget->getText(),
280 $linkTarget->getFragment(),
281 $linkTarget->getInterwiki()
286 * Same as newFromLinkTarget, but if passed null, returns null.
288 * @param LinkTarget|null $linkTarget Assumed to be safe (if not null).
292 public static function castFromLinkTarget( $linkTarget ) {
293 return $linkTarget ? self
::newFromLinkTarget( $linkTarget ) : null;
297 * Create a new Title from text, such as what one would find in a link. De-
298 * codes any HTML entities in the text.
300 * Title objects returned by this method are guaranteed to be valid, and
301 * thus return true from the isValid() method.
303 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
304 * It may instead be a cached instance created previously, with references to it remaining
307 * @param string|int|null $text The link text; spaces, prefixes, and an
308 * initial ':' indicating the main namespace are accepted.
309 * @param int $defaultNamespace The namespace to use if none is specified
310 * by a prefix. If you want to force a specific namespace even if
311 * $text might begin with a namespace prefix, use makeTitle() or
313 * @throws InvalidArgumentException
314 * @return Title|null Title or null on an error.
316 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
317 // DWIM: Integers can be passed in here when page titles are used as array keys.
318 if ( $text !== null && !is_string( $text ) && !is_int( $text ) ) {
319 throw new InvalidArgumentException( '$text must be a string.' );
321 if ( $text === null ) {
326 return self
::newFromTextThrow( (string)$text, $defaultNamespace );
327 } catch ( MalformedTitleException
$ex ) {
333 * Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,
334 * rather than returning null.
336 * The exception subclasses encode detailed information about why the title is invalid.
338 * Title objects returned by this method are guaranteed to be valid, and
339 * thus return true from the isValid() method.
341 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
342 * It may instead be a cached instance created previously, with references to it remaining
345 * @see Title::newFromText
348 * @param string $text Title text to check
349 * @param int $defaultNamespace
350 * @throws MalformedTitleException If the title is invalid
353 public static function newFromTextThrow( $text, $defaultNamespace = NS_MAIN
) {
354 if ( is_object( $text ) ) {
355 throw new MWException( '$text must be a string, given an object' );
356 } elseif ( $text === null ) {
357 // Legacy code relies on MalformedTitleException being thrown in this case
358 // (happens when URL with no title in it is parsed). TODO fix
359 throw new MalformedTitleException( 'title-invalid-empty' );
362 $titleCache = self
::getTitleCache();
364 // Wiki pages often contain multiple links to the same page.
365 // Title normalization and parsing can become expensive on pages with many
366 // links, so we can save a little time by caching them.
367 // In theory these are value objects and won't get changed...
368 if ( $defaultNamespace == NS_MAIN
) {
369 $t = $titleCache->get( $text );
375 // Convert things like é ā or 〗 into normalized (T16952) text
376 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
379 $t->mDbkeyform
= strtr( $filteredText, ' ', '_' );
380 $t->mDefaultNamespace
= (int)$defaultNamespace;
382 $t->secureAndSplit();
383 if ( $defaultNamespace == NS_MAIN
) {
384 $titleCache->set( $text, $t );
390 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
392 * Example of wrong and broken code:
393 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
395 * Example of right code:
396 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
398 * Create a new Title from URL-encoded text. Ensures that
399 * the given title's length does not exceed the maximum.
401 * @param string $url The title, as might be taken from a URL
402 * @return Title|null The new object, or null on an error
404 public static function newFromURL( $url ) {
407 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
408 # but some URLs used it as a space replacement and they still come
409 # from some external search tools.
410 if ( strpos( self
::legalChars(), '+' ) === false ) {
411 $url = strtr( $url, '+', ' ' );
414 $t->mDbkeyform
= strtr( $url, ' ', '_' );
417 $t->secureAndSplit();
419 } catch ( MalformedTitleException
$ex ) {
425 * @return MapCacheLRU
427 private static function getTitleCache() {
428 if ( self
::$titleCache === null ) {
429 self
::$titleCache = new MapCacheLRU( self
::CACHE_MAX
);
431 return self
::$titleCache;
435 * Returns a list of fields that are to be selected for initializing Title
436 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
437 * whether to include page_content_model.
441 protected static function getSelectFields() {
442 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
445 'page_namespace', 'page_title', 'page_id',
446 'page_len', 'page_is_redirect', 'page_latest',
449 if ( $wgContentHandlerUseDB ) {
450 $fields[] = 'page_content_model';
453 if ( $wgPageLanguageUseDB ) {
454 $fields[] = 'page_lang';
461 * Create a new Title from an article ID
463 * @param int $id The page_id corresponding to the Title to create
464 * @param int $flags Bitfield of class READ_* constants
465 * @return Title|null The new object, or null on an error
467 public static function newFromID( $id, $flags = 0 ) {
468 $flags |
= ( $flags & self
::GAID_FOR_UPDATE
) ? self
::READ_LATEST
: 0; // b/c
469 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
470 $row = wfGetDB( $index )->selectRow(
472 self
::getSelectFields(),
473 [ 'page_id' => $id ],
477 if ( $row !== false ) {
478 $title = self
::newFromRow( $row );
487 * Make an array of titles from an array of IDs
489 * @param int[] $ids Array of IDs
490 * @return Title[] Array of Titles
492 public static function newFromIDs( $ids ) {
493 if ( !count( $ids ) ) {
496 $dbr = wfGetDB( DB_REPLICA
);
500 self
::getSelectFields(),
501 [ 'page_id' => $ids ],
506 foreach ( $res as $row ) {
507 $titles[] = self
::newFromRow( $row );
513 * Make a Title object from a DB row
515 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
516 * @return Title Corresponding Title
518 public static function newFromRow( $row ) {
519 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
520 $t->loadFromRow( $row );
525 * Load Title object fields from a DB row.
526 * If false is given, the title will be treated as non-existing.
528 * @param stdClass|bool $row Database row
530 public function loadFromRow( $row ) {
531 if ( $row ) { // page found
532 if ( isset( $row->page_id
) ) {
533 $this->mArticleID
= (int)$row->page_id
;
535 if ( isset( $row->page_len
) ) {
536 $this->mLength
= (int)$row->page_len
;
538 if ( isset( $row->page_is_redirect
) ) {
539 $this->mRedirect
= (bool)$row->page_is_redirect
;
541 if ( isset( $row->page_latest
) ) {
542 $this->mLatestID
= (int)$row->page_latest
;
544 if ( isset( $row->page_content_model
) ) {
545 $this->lazyFillContentModel( $row->page_content_model
);
547 $this->lazyFillContentModel( false ); // lazily-load getContentModel()
549 if ( isset( $row->page_lang
) ) {
550 $this->mDbPageLanguage
= (string)$row->page_lang
;
552 if ( isset( $row->page_restrictions
) ) {
553 $this->mOldRestrictions
= $row->page_restrictions
;
555 } else { // page not found
556 $this->mArticleID
= 0;
558 $this->mRedirect
= false;
559 $this->mLatestID
= 0;
560 $this->lazyFillContentModel( false ); // lazily-load getContentModel()
565 * Create a new Title from a namespace index and a DB key.
567 * It's assumed that $ns and $title are safe, for instance when
568 * they came directly from the database or a special page name,
569 * not from user input.
571 * No validation is applied. For convenience, spaces are normalized
572 * to underscores, so that e.g. user_text fields can be used directly.
574 * @note This method may return Title objects that are "invalid"
575 * according to the isValid() method. This is usually caused by
576 * configuration changes: e.g. a namespace that was once defined is
577 * no longer configured, or a character that was once allowed in
578 * titles is now forbidden.
580 * @param int $ns The namespace of the article
581 * @param string $title The unprefixed database key form
582 * @param string $fragment The link fragment (after the "#")
583 * @param string $interwiki The interwiki prefix
584 * @return Title The new object
586 public static function makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
588 $t->mInterwiki
= $interwiki;
589 $t->mFragment
= $fragment;
590 $t->mNamespace
= $ns = (int)$ns;
591 $t->mDbkeyform
= strtr( $title, ' ', '_' );
592 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
593 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
594 $t->mTextform
= strtr( $title, '_', ' ' );
599 * Create a new Title from a namespace index and a DB key.
600 * The parameters will be checked for validity, which is a bit slower
601 * than makeTitle() but safer for user-provided data.
603 * Title objects returned by makeTitleSafe() are guaranteed to be valid,
604 * that is, they return true from the isValid() method. If no valid Title
605 * can be constructed from the input, this method returns null.
607 * @param int $ns The namespace of the article
608 * @param string $title Database key form
609 * @param string $fragment The link fragment (after the "#")
610 * @param string $interwiki Interwiki prefix
611 * @return Title|null The new object, or null on an error
613 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
614 // NOTE: ideally, this would just call makeTitle() and then isValid(),
615 // but presently, that means more overhead on a potential performance hotspot.
617 if ( !MediaWikiServices
::getInstance()->getNamespaceInfo()->exists( $ns ) ) {
622 $t->mDbkeyform
= self
::makeName( $ns, $title, $fragment, $interwiki, true );
625 $t->secureAndSplit();
627 } catch ( MalformedTitleException
$ex ) {
633 * Create a new Title for the Main Page
635 * This uses the 'mainpage' interface message, which could be specified in
636 * `$wgForceUIMsgAsContentMsg`. If that is the case, then calling this method
637 * will use the user language, which would involve initialising the session
638 * via `RequestContext::getMain()->getLanguage()`. For session-less endpoints,
639 * be sure to pass in a MessageLocalizer (such as your own RequestContext,
640 * or ResourceloaderContext) to prevent an error.
642 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
643 * It may instead be a cached instance created previously, with references to it remaining
646 * @param MessageLocalizer|null $localizer An optional context to use (since 1.34)
649 public static function newMainPage( MessageLocalizer
$localizer = null ) {
651 $msg = $localizer->msg( 'mainpage' );
653 $msg = wfMessage( 'mainpage' );
656 $title = self
::newFromText( $msg->inContentLanguage()->text() );
658 // Every page renders at least one link to the Main Page (e.g. sidebar).
659 // If the localised value is invalid, don't produce fatal errors that
660 // would make the wiki inaccessible (and hard to fix the invalid message).
661 // Gracefully fallback...
663 $title = self
::newFromText( 'Main Page' );
669 * Get the prefixed DB key associated with an ID
671 * @param int $id The page_id of the article
672 * @return string|null An object representing the article, or null if no such article was found
674 public static function nameOf( $id ) {
675 $dbr = wfGetDB( DB_REPLICA
);
677 $s = $dbr->selectRow(
679 [ 'page_namespace', 'page_title' ],
680 [ 'page_id' => $id ],
683 if ( $s === false ) {
687 return self
::makeName( $s->page_namespace
, $s->page_title
);
691 * Get a regex character class describing the legal characters in a link
693 * @return string The list of characters, not delimited
695 public static function legalChars() {
696 global $wgLegalTitleChars;
697 return $wgLegalTitleChars;
701 * Utility method for converting a character sequence from bytes to Unicode.
703 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
704 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
706 * @param string $byteClass
709 public static function convertByteClassToUnicodeClass( $byteClass ) {
710 $length = strlen( $byteClass );
712 $x0 = $x1 = $x2 = '';
714 $d0 = $d1 = $d2 = '';
715 // Decoded integer codepoints
716 $ord0 = $ord1 = $ord2 = 0;
718 $r0 = $r1 = $r2 = '';
722 $allowUnicode = false;
723 for ( $pos = 0; $pos < $length; $pos++
) {
724 // Shift the queues down
733 // Load the current input token and decoded values
734 $inChar = $byteClass[$pos];
735 if ( $inChar == '\\' ) {
736 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
737 $x0 = $inChar . $m[0];
738 $d0 = chr( hexdec( $m[1] ) );
739 $pos +
= strlen( $m[0] );
740 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
741 $x0 = $inChar . $m[0];
742 $d0 = chr( octdec( $m[0] ) );
743 $pos +
= strlen( $m[0] );
744 } elseif ( $pos +
1 >= $length ) {
747 $d0 = $byteClass[$pos +
1];
755 // Load the current re-encoded value
756 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
757 $r0 = sprintf( '\x%02x', $ord0 );
758 } elseif ( $ord0 >= 0x80 ) {
759 // Allow unicode if a single high-bit character appears
760 $r0 = sprintf( '\x%02x', $ord0 );
761 $allowUnicode = true;
762 // @phan-suppress-next-line PhanParamSuspiciousOrder false positive
763 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
769 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
771 if ( $ord2 > $ord0 ) {
773 } elseif ( $ord0 >= 0x80 ) {
775 $allowUnicode = true;
776 if ( $ord2 < 0x80 ) {
777 // Keep the non-unicode section of the range
784 // Reset state to the initial value
785 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
786 } elseif ( $ord2 < 0x80 ) {
791 if ( $ord1 < 0x80 ) {
794 if ( $ord0 < 0x80 ) {
797 if ( $allowUnicode ) {
798 $out .= '\u0080-\uFFFF';
804 * Make a prefixed DB key from a DB key and a namespace index
806 * @param int $ns Numerical representation of the namespace
807 * @param string $title The DB key form the title
808 * @param string $fragment The link fragment (after the "#")
809 * @param string $interwiki The interwiki prefix
810 * @param bool $canonicalNamespace If true, use the canonical name for
811 * $ns instead of the localized version.
812 * @return string The prefixed form of the title
814 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
815 $canonicalNamespace = false
817 if ( $canonicalNamespace ) {
818 $namespace = MediaWikiServices
::getInstance()->getNamespaceInfo()->
819 getCanonicalName( $ns );
821 $namespace = MediaWikiServices
::getInstance()->getContentLanguage()->getNsText( $ns );
823 $name = $namespace == '' ?
$title : "$namespace:$title";
824 if ( strval( $interwiki ) != '' ) {
825 $name = "$interwiki:$name";
827 if ( strval( $fragment ) != '' ) {
828 $name .= '#' . $fragment;
834 * Callback for usort() to do title sorts by (namespace, title)
836 * @param LinkTarget $a
837 * @param LinkTarget $b
839 * @return int Result of string comparison, or namespace comparison
841 public static function compare( LinkTarget
$a, LinkTarget
$b ) {
842 return $a->getNamespace() <=> $b->getNamespace()
843 ?
: strcmp( $a->getText(), $b->getText() );
847 * Returns true if the title is valid, false if it is invalid.
849 * Valid titles can be round-tripped via makeTitle() and newFromText().
850 * Their DB key can be used in the database, though it may not have the correct
853 * Invalid titles may get returned from makeTitle(), and it may be useful to
854 * allow them to exist, e.g. in order to process log entries about pages in
855 * namespaces that belong to extensions that are no longer installed.
857 * @note This method is relatively expensive. When constructing Title
858 * objects that need to be valid, use an instantiator method that is guaranteed
859 * to return valid titles, such as makeTitleSafe() or newFromText().
863 public function isValid() {
864 $services = MediaWikiServices
::getInstance();
865 if ( !$services->getNamespaceInfo()->exists( $this->mNamespace
) ) {
870 $services->getTitleParser()->parseTitle( $this->mDbkeyform
, $this->mNamespace
);
871 } catch ( MalformedTitleException
$ex ) {
876 // Title value applies basic syntax checks. Should perhaps be moved elsewhere.
883 } catch ( InvalidArgumentException
$ex ) {
891 * Determine whether the object refers to a page within
892 * this project (either this wiki or a wiki with a local
893 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
895 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
897 public function isLocal() {
898 if ( $this->isExternal() ) {
899 $iw = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
901 return $iw->isLocal();
908 * Is this Title interwiki?
912 public function isExternal() {
913 return $this->mInterwiki
!== '';
917 * Get the interwiki prefix
919 * Use Title::isExternal to check if a interwiki is set
921 * @return string Interwiki prefix
923 public function getInterwiki() {
924 return $this->mInterwiki
;
928 * Was this a local interwiki link?
932 public function wasLocalInterwiki() {
933 return $this->mLocalInterwiki
;
937 * Determine whether the object refers to a page within
938 * this project and is transcludable.
940 * @return bool True if this is transcludable
942 public function isTrans() {
943 if ( !$this->isExternal() ) {
947 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->isTranscludable();
951 * Returns the DB name of the distant wiki which owns the object.
953 * @return string|false The DB name
955 public function getTransWikiID() {
956 if ( !$this->isExternal() ) {
960 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->getWikiID();
964 * Get a TitleValue object representing this Title.
966 * @note Not all valid Titles have a corresponding valid TitleValue
967 * (e.g. TitleValues cannot represent page-local links that have a
968 * fragment but no title text).
970 * @return TitleValue|null
972 public function getTitleValue() {
973 if ( $this->mTitleValue
=== null ) {
975 $this->mTitleValue
= new TitleValue(
981 } catch ( InvalidArgumentException
$ex ) {
982 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
983 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
987 return $this->mTitleValue
;
991 * Get the text form (spaces not underscores) of the main part
993 * @return string Main part of the title
995 public function getText() {
996 return $this->mTextform
;
1000 * Get the URL-encoded form of the main part
1002 * @return string Main part of the title, URL-encoded
1004 public function getPartialURL() {
1005 return $this->mUrlform
;
1009 * Get the main part with underscores
1011 * @return string Main part of the title, with underscores
1013 public function getDBkey() {
1014 return $this->mDbkeyform
;
1018 * Get the DB key with the initial letter case as specified by the user
1019 * @deprecated since 1.33; please use Title::getDBKey() instead
1021 * @return string DB key
1023 function getUserCaseDBKey() {
1024 if ( !is_null( $this->mUserCaseDBKey
) ) {
1025 return $this->mUserCaseDBKey
;
1027 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
1028 return $this->mDbkeyform
;
1033 * Get the namespace index, i.e. one of the NS_xxxx constants.
1035 * @return int Namespace index
1037 public function getNamespace() {
1038 return $this->mNamespace
;
1042 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
1044 * @todo Deprecate this in favor of SlotRecord::getModel()
1046 * @param int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
1047 * @return string Content model id
1049 public function getContentModel( $flags = 0 ) {
1050 if ( $this->mForcedContentModel
) {
1051 if ( !$this->mContentModel
) {
1052 throw new RuntimeException( 'Got out of sync; an empty model is being forced' );
1054 // Content model is locked to the currently loaded one
1055 return $this->mContentModel
;
1058 if ( DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
) ) {
1059 $this->lazyFillContentModel( $this->loadFieldFromDB( 'page_content_model', $flags ) );
1061 ( !$this->mContentModel ||
$flags & self
::GAID_FOR_UPDATE
) &&
1062 $this->getArticleId( $flags )
1064 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
1065 $linkCache->addLinkObj( $this ); # in case we already had an article ID
1066 $this->lazyFillContentModel( $linkCache->getGoodLinkFieldObj( $this, 'model' ) );
1069 if ( !$this->mContentModel
) {
1070 $this->lazyFillContentModel( ContentHandler
::getDefaultModelFor( $this ) );
1073 return $this->mContentModel
;
1077 * Convenience method for checking a title's content model name
1079 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
1080 * @return bool True if $this->getContentModel() == $id
1082 public function hasContentModel( $id ) {
1083 return $this->getContentModel() == $id;
1087 * Set a proposed content model for the page for permissions checking
1089 * This does not actually change the content model of a title in the DB.
1090 * It only affects this particular Title instance. The content model is
1091 * forced to remain this value until another setContentModel() call.
1093 * ContentHandler::canBeUsedOn() should be checked before calling this
1094 * if there is any doubt regarding the applicability of the content model
1097 * @param string $model CONTENT_MODEL_XXX constant
1099 public function setContentModel( $model ) {
1100 if ( (string)$model === '' ) {
1101 throw new InvalidArgumentException( "Missing CONTENT_MODEL_* constant" );
1104 $this->mContentModel
= $model;
1105 $this->mForcedContentModel
= true;
1109 * If the content model field is not frozen then update it with a retreived value
1111 * @param string|bool $model CONTENT_MODEL_XXX constant or false
1113 private function lazyFillContentModel( $model ) {
1114 if ( !$this->mForcedContentModel
) {
1115 $this->mContentModel
= ( $model === false ) ?
false : (string)$model;
1120 * Get the namespace text
1122 * @return string|false Namespace text
1124 public function getNsText() {
1125 if ( $this->isExternal() ) {
1126 // This probably shouldn't even happen, except for interwiki transclusion.
1127 // If possible, use the canonical name for the foreign namespace.
1128 $nsText = MediaWikiServices
::getInstance()->getNamespaceInfo()->
1129 getCanonicalName( $this->mNamespace
);
1130 if ( $nsText !== false ) {
1136 $formatter = self
::getTitleFormatter();
1137 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
1138 } catch ( InvalidArgumentException
$ex ) {
1139 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
1145 * Get the namespace text of the subject (rather than talk) page
1147 * @return string Namespace text
1149 public function getSubjectNsText() {
1150 $services = MediaWikiServices
::getInstance();
1151 return $services->getContentLanguage()->
1152 getNsText( $services->getNamespaceInfo()->getSubject( $this->mNamespace
) );
1156 * Get the namespace text of the talk page
1158 * @return string Namespace text
1160 public function getTalkNsText() {
1161 $services = MediaWikiServices
::getInstance();
1162 return $services->getContentLanguage()->
1163 getNsText( $services->getNamespaceInfo()->getTalk( $this->mNamespace
) );
1167 * Can this title have a corresponding talk page?
1169 * False for relative section links (with getText() === ''),
1170 * interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.
1172 * @see NamespaceInfo::canHaveTalkPage
1175 * @return bool True if this title either is a talk page or can have a talk page associated.
1177 public function canHaveTalkPage() {
1178 return MediaWikiServices
::getInstance()->getNamespaceInfo()->canHaveTalkPage( $this );
1182 * Is this in a namespace that allows actual pages?
1186 public function canExist() {
1187 return $this->mNamespace
>= NS_MAIN
;
1191 * Can this title be added to a user's watchlist?
1193 * False for relative section links (with getText() === ''),
1194 * interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.
1198 public function isWatchable() {
1199 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
1200 return $this->getText() !== '' && !$this->isExternal() &&
1201 $nsInfo->isWatchable( $this->mNamespace
);
1205 * Returns true if this is a special page.
1209 public function isSpecialPage() {
1210 return $this->mNamespace
== NS_SPECIAL
;
1214 * Returns true if this title resolves to the named special page
1216 * @param string $name The special page name
1219 public function isSpecial( $name ) {
1220 if ( $this->isSpecialPage() ) {
1221 list( $thisName, /* $subpage */ ) =
1222 MediaWikiServices
::getInstance()->getSpecialPageFactory()->
1223 resolveAlias( $this->mDbkeyform
);
1224 if ( $name == $thisName ) {
1232 * If the Title refers to a special page alias which is not the local default, resolve
1233 * the alias, and localise the name as necessary. Otherwise, return $this
1237 public function fixSpecialName() {
1238 if ( $this->isSpecialPage() ) {
1239 $spFactory = MediaWikiServices
::getInstance()->getSpecialPageFactory();
1240 list( $canonicalName, $par ) = $spFactory->resolveAlias( $this->mDbkeyform
);
1241 if ( $canonicalName ) {
1242 $localName = $spFactory->getLocalNameFor( $canonicalName, $par );
1243 if ( $localName != $this->mDbkeyform
) {
1244 return self
::makeTitle( NS_SPECIAL
, $localName );
1252 * Returns true if the title is inside the specified namespace.
1254 * Please make use of this instead of comparing to getNamespace()
1255 * This function is much more resistant to changes we may make
1256 * to namespaces than code that makes direct comparisons.
1257 * @param int $ns The namespace
1261 public function inNamespace( $ns ) {
1262 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1263 equals( $this->mNamespace
, $ns );
1267 * Returns true if the title is inside one of the specified namespaces.
1269 * @param int|int[] $namespaces,... The namespaces to check for
1272 * @suppress PhanCommentParamOnEmptyParamList Cannot make variadic due to HHVM bug, T191668#5263929
1274 public function inNamespaces( /* ... */ ) {
1275 $namespaces = func_get_args();
1276 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1277 $namespaces = $namespaces[0];
1280 foreach ( $namespaces as $ns ) {
1281 if ( $this->inNamespace( $ns ) ) {
1290 * Returns true if the title has the same subject namespace as the
1291 * namespace specified.
1292 * For example this method will take NS_USER and return true if namespace
1293 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1294 * as their subject namespace.
1296 * This is MUCH simpler than individually testing for equivalence
1297 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1302 public function hasSubjectNamespace( $ns ) {
1303 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1304 subjectEquals( $this->mNamespace
, $ns );
1308 * Is this Title in a namespace which contains content?
1309 * In other words, is this a content page, for the purposes of calculating
1314 public function isContentPage() {
1315 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1316 isContent( $this->mNamespace
);
1320 * Would anybody with sufficient privileges be able to move this page?
1321 * Some pages just aren't movable.
1325 public function isMovable() {
1327 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
1328 isMovable( $this->mNamespace
) ||
$this->isExternal()
1330 // Interwiki title or immovable namespace. Hooks don't get to override here
1335 Hooks
::run( 'TitleIsMovable', [ $this, &$result ] );
1340 * Is this the mainpage?
1341 * @note Title::newFromText seems to be sufficiently optimized by the title
1342 * cache that we don't need to over-optimize by doing direct comparisons and
1343 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1344 * ends up reporting something differently than $title->isMainPage();
1349 public function isMainPage() {
1350 return $this->equals( self
::newMainPage() );
1354 * Is this a subpage?
1358 public function isSubpage() {
1359 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1360 hasSubpages( $this->mNamespace
)
1361 ?
strpos( $this->getText(), '/' ) !== false
1366 * Is this a conversion table for the LanguageConverter?
1370 public function isConversionTable() {
1371 // @todo ConversionTable should become a separate content model.
1373 return $this->mNamespace
== NS_MEDIAWIKI
&&
1374 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1378 * Does that page contain wikitext, or it is JS, CSS or whatever?
1382 public function isWikitextPage() {
1383 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1387 * Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the
1388 * global UI. This is generally true for pages in the MediaWiki namespace having
1389 * CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
1391 * This method does *not* return true for per-user JS/JSON/CSS. Use isUserConfigPage()
1394 * Note that this method should not return true for pages that contain and show
1395 * "inactive" CSS, JSON, or JS.
1400 public function isSiteConfigPage() {
1402 $this->isSiteCssConfigPage()
1403 ||
$this->isSiteJsonConfigPage()
1404 ||
$this->isSiteJsConfigPage()
1409 * Is this a "config" (.css, .json, or .js) sub-page of a user page?
1414 public function isUserConfigPage() {
1416 $this->isUserCssConfigPage()
1417 ||
$this->isUserJsonConfigPage()
1418 ||
$this->isUserJsConfigPage()
1423 * Trim down a .css, .json, or .js subpage title to get the corresponding skin name
1425 * @return string Containing skin name from .css, .json, or .js subpage title
1428 public function getSkinFromConfigSubpage() {
1429 $subpage = explode( '/', $this->mTextform
);
1430 $subpage = $subpage[count( $subpage ) - 1];
1431 $lastdot = strrpos( $subpage, '.' );
1432 if ( $lastdot === false ) {
1433 return $subpage; # Never happens: only called for names ending in '.css'/'.json'/'.js'
1435 return substr( $subpage, 0, $lastdot );
1439 * Is this a CSS "config" sub-page of a user page?
1444 public function isUserCssConfigPage() {
1446 NS_USER
== $this->mNamespace
1447 && $this->isSubpage()
1448 && $this->hasContentModel( CONTENT_MODEL_CSS
)
1453 * Is this a JSON "config" sub-page of a user page?
1458 public function isUserJsonConfigPage() {
1460 NS_USER
== $this->mNamespace
1461 && $this->isSubpage()
1462 && $this->hasContentModel( CONTENT_MODEL_JSON
)
1467 * Is this a JS "config" sub-page of a user page?
1472 public function isUserJsConfigPage() {
1474 NS_USER
== $this->mNamespace
1475 && $this->isSubpage()
1476 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1481 * Is this a sitewide CSS "config" page?
1486 public function isSiteCssConfigPage() {
1488 NS_MEDIAWIKI
== $this->mNamespace
1490 $this->hasContentModel( CONTENT_MODEL_CSS
)
1491 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1492 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1493 ||
substr( $this->mDbkeyform
, -4 ) === '.css'
1499 * Is this a sitewide JSON "config" page?
1504 public function isSiteJsonConfigPage() {
1506 NS_MEDIAWIKI
== $this->mNamespace
1508 $this->hasContentModel( CONTENT_MODEL_JSON
)
1509 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1510 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1511 ||
substr( $this->mDbkeyform
, -5 ) === '.json'
1517 * Is this a sitewide JS "config" page?
1522 public function isSiteJsConfigPage() {
1524 NS_MEDIAWIKI
== $this->mNamespace
1526 $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1527 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1528 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1529 ||
substr( $this->mDbkeyform
, -3 ) === '.js'
1535 * Is this a message which can contain raw HTML?
1540 public function isRawHtmlMessage() {
1541 global $wgRawHtmlMessages;
1543 if ( !$this->inNamespace( NS_MEDIAWIKI
) ) {
1546 $message = lcfirst( $this->getRootTitle()->getDBkey() );
1547 return in_array( $message, $wgRawHtmlMessages, true );
1551 * Is this a talk page of some sort?
1555 public function isTalkPage() {
1556 return MediaWikiServices
::getInstance()->getNamespaceInfo()->
1557 isTalk( $this->mNamespace
);
1561 * Get a Title object associated with the talk page of this article
1563 * @deprecated since 1.34, use getTalkPageIfDefined() or NamespaceInfo::getTalkPage()
1564 * with NamespaceInfo::canHaveTalkPage().
1565 * @return Title The object for the talk page
1566 * @throws MWException if $target doesn't have talk pages, e.g. because it's in NS_SPECIAL
1567 * or because it's a relative link, or an interwiki link.
1569 public function getTalkPage() {
1570 return self
::castFromLinkTarget(
1571 MediaWikiServices
::getInstance()->getNamespaceInfo()->getTalkPage( $this ) );
1575 * Get a Title object associated with the talk page of this article,
1576 * if such a talk page can exist.
1580 * @return Title|null The object for the talk page,
1581 * or null if no associated talk page can exist, according to canHaveTalkPage().
1583 public function getTalkPageIfDefined() {
1584 if ( !$this->canHaveTalkPage() ) {
1588 return $this->getTalkPage();
1592 * Get a title object associated with the subject page of this
1595 * @deprecated since 1.34, use NamespaceInfo::getSubjectPage
1596 * @return Title The object for the subject page
1598 public function getSubjectPage() {
1599 return self
::castFromLinkTarget(
1600 MediaWikiServices
::getInstance()->getNamespaceInfo()->getSubjectPage( $this ) );
1604 * Get the other title for this page, if this is a subject page
1605 * get the talk page, if it is a subject page get the talk page
1607 * @deprecated since 1.34, use NamespaceInfo::getAssociatedPage
1609 * @throws MWException If the page doesn't have an other page
1612 public function getOtherPage() {
1613 return self
::castFromLinkTarget(
1614 MediaWikiServices
::getInstance()->getNamespaceInfo()->getAssociatedPage( $this ) );
1618 * Get the default namespace index, for when there is no namespace
1620 * @return int Default namespace index
1622 public function getDefaultNamespace() {
1623 return $this->mDefaultNamespace
;
1627 * Get the Title fragment (i.e.\ the bit after the #) in text form
1629 * Use Title::hasFragment to check for a fragment
1631 * @return string Title fragment
1633 public function getFragment() {
1634 return $this->mFragment
;
1638 * Check if a Title fragment is set
1643 public function hasFragment() {
1644 return $this->mFragment
!== '';
1648 * Get the fragment in URL form, including the "#" character if there is one
1650 * @return string Fragment in URL form
1652 public function getFragmentForURL() {
1653 if ( !$this->hasFragment() ) {
1655 } elseif ( $this->isExternal() ) {
1656 // Note: If the interwiki is unknown, it's treated as a namespace on the local wiki,
1657 // so we treat it like a local interwiki.
1658 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
1659 if ( $interwiki && !$interwiki->isLocal() ) {
1660 return '#' . Sanitizer
::escapeIdForExternalInterwiki( $this->mFragment
);
1664 return '#' . Sanitizer
::escapeIdForLink( $this->mFragment
);
1668 * Set the fragment for this title. Removes the first character from the
1669 * specified fragment before setting, so it assumes you're passing it with
1672 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1673 * or Title::createFragmentTarget().
1674 * Still in active use privately.
1677 * @param string $fragment Text
1679 public function setFragment( $fragment ) {
1680 $this->mFragment
= strtr( substr( $fragment, 1 ), '_', ' ' );
1684 * Creates a new Title for a different fragment of the same page.
1687 * @param string $fragment
1690 public function createFragmentTarget( $fragment ) {
1691 return self
::makeTitle(
1700 * Prefix some arbitrary text with the namespace or interwiki prefix
1703 * @param string $name The text
1704 * @return string The prefixed text
1706 private function prefix( $name ) {
1708 if ( $this->isExternal() ) {
1709 $p = $this->mInterwiki
. ':';
1712 if ( $this->mNamespace
!= 0 ) {
1713 $nsText = $this->getNsText();
1715 if ( $nsText === false ) {
1716 // See T165149. Awkward, but better than erroneously linking to the main namespace.
1717 $nsText = MediaWikiServices
::getInstance()->getContentLanguage()->
1718 getNsText( NS_SPECIAL
) . ":Badtitle/NS{$this->mNamespace}";
1721 $p .= $nsText . ':';
1727 * Get the prefixed database key form
1729 * @return string The prefixed title, with underscores and
1730 * any interwiki and namespace prefixes
1732 public function getPrefixedDBkey() {
1733 $s = $this->prefix( $this->mDbkeyform
);
1734 $s = strtr( $s, ' ', '_' );
1739 * Get the prefixed title with spaces.
1740 * This is the form usually used for display
1742 * @return string The prefixed title, with spaces
1744 public function getPrefixedText() {
1745 if ( $this->prefixedText
=== null ) {
1746 $s = $this->prefix( $this->mTextform
);
1747 $s = strtr( $s, '_', ' ' );
1748 $this->prefixedText
= $s;
1750 return $this->prefixedText
;
1754 * Return a string representation of this title
1756 * @return string Representation of this title
1758 public function __toString() {
1759 return $this->getPrefixedText();
1763 * Get the prefixed title with spaces, plus any fragment
1764 * (part beginning with '#')
1766 * @return string The prefixed title, with spaces and the fragment, including '#'
1768 public function getFullText() {
1769 $text = $this->getPrefixedText();
1770 if ( $this->hasFragment() ) {
1771 $text .= '#' . $this->mFragment
;
1777 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1779 * @note the return value may contain trailing whitespace and is thus
1780 * not safe for use with makeTitle or TitleValue.
1784 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1788 * @return string Root name
1791 public function getRootText() {
1793 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
1794 hasSubpages( $this->mNamespace
)
1795 ||
strtok( $this->getText(), '/' ) === false
1797 return $this->getText();
1800 return strtok( $this->getText(), '/' );
1804 * Get the root page name title, i.e. the leftmost part before any slashes
1808 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1809 * # returns: Title{User:Foo}
1812 * @return Title Root title
1815 public function getRootTitle() {
1816 $title = self
::makeTitleSafe( $this->mNamespace
, $this->getRootText() );
1817 Assert
::postcondition(
1819 'makeTitleSafe() should always return a Title for the text returned by getRootText().'
1825 * Get the base page name without a namespace, i.e. the part before the subpage name
1827 * @note the return value may contain trailing whitespace and is thus
1828 * not safe for use with makeTitle or TitleValue.
1832 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1833 * # returns: 'Foo/Bar'
1836 * @return string Base name
1838 public function getBaseText() {
1839 $text = $this->getText();
1841 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
1842 hasSubpages( $this->mNamespace
)
1847 $lastSlashPos = strrpos( $text, '/' );
1848 // Don't discard the real title if there's no subpage involved
1849 if ( $lastSlashPos === false ) {
1853 return substr( $text, 0, $lastSlashPos );
1857 * Get the base page name title, i.e. the part before the subpage name.
1861 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1862 * # returns: Title{User:Foo/Bar}
1865 * @return Title Base title
1868 public function getBaseTitle() {
1869 $title = self
::makeTitleSafe( $this->mNamespace
, $this->getBaseText() );
1870 Assert
::postcondition(
1872 'makeTitleSafe() should always return a Title for the text returned by getBaseText().'
1878 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1882 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1886 * @return string Subpage name
1888 public function getSubpageText() {
1890 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
1891 hasSubpages( $this->mNamespace
)
1893 return $this->mTextform
;
1895 $parts = explode( '/', $this->mTextform
);
1896 return $parts[count( $parts ) - 1];
1900 * Get the title for a subpage of the current page
1904 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1905 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1908 * @param string $text The subpage name to add to the title
1909 * @return Title|null Subpage title, or null on an error
1912 public function getSubpage( $text ) {
1913 return self
::makeTitleSafe(
1915 $this->getText() . '/' . $text,
1922 * Get a URL-encoded form of the subpage text
1924 * @return string URL-encoded subpage name
1926 public function getSubpageUrlForm() {
1927 $text = $this->getSubpageText();
1928 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1933 * Get a URL-encoded title (not an actual URL) including interwiki
1935 * @return string The URL-encoded form
1937 public function getPrefixedURL() {
1938 $s = $this->prefix( $this->mDbkeyform
);
1939 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1944 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1945 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1946 * second argument named variant. This was deprecated in favor
1947 * of passing an array of option with a "variant" key
1948 * Once $query2 is removed for good, this helper can be dropped
1949 * and the wfArrayToCgi moved to getLocalURL();
1951 * @since 1.19 (r105919)
1952 * @param array|string $query
1953 * @param string|string[]|bool $query2
1956 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1957 if ( $query2 !== false ) {
1958 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1959 "method called with a second parameter is deprecated. Add your " .
1960 "parameter to an array passed as the first parameter.", "1.19" );
1962 if ( is_array( $query ) ) {
1963 $query = wfArrayToCgi( $query );
1966 if ( is_string( $query2 ) ) {
1967 // $query2 is a string, we will consider this to be
1968 // a deprecated $variant argument and add it to the query
1969 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1971 $query2 = wfArrayToCgi( $query2 );
1973 // If we have $query content add a & to it first
1977 // Now append the queries together
1984 * Get a real URL referring to this title, with interwiki link and
1987 * @see self::getLocalURL for the arguments.
1989 * @param string|string[] $query
1990 * @param string|string[]|bool $query2
1991 * @param string|int|null $proto Protocol type to use in URL
1992 * @return string The URL
1994 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1995 $query = self
::fixUrlQueryArgs( $query, $query2 );
1997 # Hand off all the decisions on urls to getLocalURL
1998 $url = $this->getLocalURL( $query );
2000 # Expand the url to make it a full url. Note that getLocalURL has the
2001 # potential to output full urls for a variety of reasons, so we use
2002 # wfExpandUrl instead of simply prepending $wgServer
2003 $url = wfExpandUrl( $url, $proto );
2005 # Finally, add the fragment.
2006 $url .= $this->getFragmentForURL();
2007 // Avoid PHP 7.1 warning from passing $this by reference
2009 Hooks
::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
2014 * Get a url appropriate for making redirects based on an untrusted url arg
2016 * This is basically the same as getFullUrl(), but in the case of external
2017 * interwikis, we send the user to a landing page, to prevent possible
2018 * phishing attacks and the like.
2020 * @note Uses current protocol by default, since technically relative urls
2021 * aren't allowed in redirects per HTTP spec, so this is not suitable for
2022 * places where the url gets cached, as might pollute between
2023 * https and non-https users.
2024 * @see self::getLocalURL for the arguments.
2025 * @param array|string $query
2026 * @param string $proto Protocol type to use in URL
2027 * @return string A url suitable to use in an HTTP location header.
2029 public function getFullUrlForRedirect( $query = '', $proto = PROTO_CURRENT
) {
2031 if ( $this->isExternal() ) {
2032 $target = SpecialPage
::getTitleFor(
2034 $this->getPrefixedDBkey()
2037 return $target->getFullURL( $query, false, $proto );
2041 * Get a URL with no fragment or server name (relative URL) from a Title object.
2042 * If this page is generated with action=render, however,
2043 * $wgServer is prepended to make an absolute URL.
2045 * @see self::getFullURL to always get an absolute URL.
2046 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
2047 * valid to link, locally, to the current Title.
2048 * @see self::newFromText to produce a Title object.
2050 * @param string|string[] $query An optional query string,
2051 * not used for interwiki links. Can be specified as an associative array as well,
2052 * e.g., [ 'action' => 'edit' ] (keys and values will be URL-escaped).
2053 * Some query patterns will trigger various shorturl path replacements.
2054 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
2055 * be an array. If a string is passed it will be interpreted as a deprecated
2056 * variant argument and urlencoded into a variant= argument.
2057 * This second query argument will be added to the $query
2058 * The second parameter is deprecated since 1.19. Pass it as a key,value
2059 * pair in the first parameter array instead.
2061 * @return string String of the URL.
2063 public function getLocalURL( $query = '', $query2 = false ) {
2064 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
2066 $query = self
::fixUrlQueryArgs( $query, $query2 );
2068 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
2070 $namespace = $this->getNsText();
2071 if ( $namespace != '' ) {
2072 # Can this actually happen? Interwikis shouldn't be parsed.
2073 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
2076 $url = $interwiki->getURL( $namespace . $this->mDbkeyform
);
2077 $url = wfAppendQuery( $url, $query );
2079 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
2080 if ( $query == '' ) {
2081 $url = str_replace( '$1', $dbkey, $wgArticlePath );
2082 // Avoid PHP 7.1 warning from passing $this by reference
2084 Hooks
::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
2086 global $wgVariantArticlePath, $wgActionPaths;
2090 if ( !empty( $wgActionPaths )
2091 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
2093 $action = urldecode( $matches[2] );
2094 if ( isset( $wgActionPaths[$action] ) ) {
2095 $query = $matches[1];
2096 if ( isset( $matches[4] ) ) {
2097 $query .= $matches[4];
2099 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
2100 if ( $query != '' ) {
2101 $url = wfAppendQuery( $url, $query );
2107 && $wgVariantArticlePath
2108 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
2109 && $this->getPageLanguage()->equals(
2110 MediaWikiServices
::getInstance()->getContentLanguage() )
2111 && $this->getPageLanguage()->hasVariants()
2113 $variant = urldecode( $matches[1] );
2114 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
2115 // Only do the variant replacement if the given variant is a valid
2116 // variant for the page's language.
2117 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
2118 $url = str_replace( '$1', $dbkey, $url );
2122 if ( $url === false ) {
2123 if ( $query == '-' ) {
2126 $url = "{$wgScript}?title={$dbkey}&{$query}";
2129 // Avoid PHP 7.1 warning from passing $this by reference
2131 Hooks
::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
2133 // @todo FIXME: This causes breakage in various places when we
2134 // actually expected a local URL and end up with dupe prefixes.
2135 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
2136 $url = $wgServer . $url;
2139 // Avoid PHP 7.1 warning from passing $this by reference
2141 Hooks
::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
2146 * Get a URL that's the simplest URL that will be valid to link, locally,
2147 * to the current Title. It includes the fragment, but does not include
2148 * the server unless action=render is used (or the link is external). If
2149 * there's a fragment but the prefixed text is empty, we just return a link
2152 * The result obviously should not be URL-escaped, but does need to be
2153 * HTML-escaped if it's being output in HTML.
2155 * @param string|string[] $query
2156 * @param bool $query2
2157 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
2158 * or false (default) for no expansion
2159 * @see self::getLocalURL for the arguments.
2160 * @return string The URL
2162 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
2163 if ( $this->isExternal() ||
$proto !== false ) {
2164 $ret = $this->getFullURL( $query, $query2, $proto );
2165 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
2166 $ret = $this->getFragmentForURL();
2168 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
2174 * Get the URL form for an internal link.
2175 * - Used in various CDN-related code, in case we have a different
2176 * internal hostname for the server from the exposed one.
2178 * This uses $wgInternalServer to qualify the path, or $wgServer
2179 * if $wgInternalServer is not set. If the server variable used is
2180 * protocol-relative, the URL will be expanded to http://
2182 * @see self::getLocalURL for the arguments.
2183 * @param string|string[] $query
2184 * @param string|bool $query2 Deprecated
2185 * @return string The URL
2187 public function getInternalURL( $query = '', $query2 = false ) {
2188 global $wgInternalServer, $wgServer;
2189 $query = self
::fixUrlQueryArgs( $query, $query2 );
2190 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
2191 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
2192 // Avoid PHP 7.1 warning from passing $this by reference
2194 Hooks
::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
2199 * Get the URL for a canonical link, for use in things like IRC and
2200 * e-mail notifications. Uses $wgCanonicalServer and the
2201 * GetCanonicalURL hook.
2203 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
2205 * @see self::getLocalURL for the arguments.
2206 * @param string|string[] $query
2207 * @param string|bool $query2 Deprecated
2208 * @return string The URL
2211 public function getCanonicalURL( $query = '', $query2 = false ) {
2212 $query = self
::fixUrlQueryArgs( $query, $query2 );
2213 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
2214 // Avoid PHP 7.1 warning from passing $this by reference
2216 Hooks
::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
2221 * Get the edit URL for this Title
2223 * @return string The URL, or a null string if this is an interwiki link
2225 public function getEditURL() {
2226 if ( $this->isExternal() ) {
2229 $s = $this->getLocalURL( 'action=edit' );
2235 * Can $user perform $action on this page?
2236 * This skips potentially expensive cascading permission checks
2237 * as well as avoids expensive error formatting
2239 * Suitable for use for nonessential UI controls in common cases, but
2240 * _not_ for functional access control.
2242 * May provide false positives, but should never provide a false negative.
2244 * @param string $action Action that permission needs to be checked for
2245 * @param User|null $user User to check (since 1.19); $wgUser will be used if not provided.
2250 * @deprecated since 1.33,
2251 * use MediaWikiServices::getInstance()->getPermissionManager()->quickUserCan(..) instead
2254 public function quickUserCan( $action, $user = null ) {
2255 return $this->userCan( $action, $user, false );
2259 * Can $user perform $action on this page?
2261 * @param string $action Action that permission needs to be checked for
2262 * @param User|null $user User to check (since 1.19); $wgUser will be used if not
2264 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2269 * @deprecated since 1.33,
2270 * use MediaWikiServices::getInstance()->getPermissionManager()->userCan(..) instead
2273 public function userCan( $action, $user = null, $rigor = PermissionManager
::RIGOR_SECURE
) {
2274 if ( !$user instanceof User
) {
2279 // TODO: this is for b/c, eventually will be removed
2280 if ( $rigor === true ) {
2281 $rigor = PermissionManager
::RIGOR_SECURE
; // b/c
2282 } elseif ( $rigor === false ) {
2283 $rigor = PermissionManager
::RIGOR_QUICK
; // b/c
2286 return MediaWikiServices
::getInstance()->getPermissionManager()
2287 ->userCan( $action, $user, $this, $rigor );
2291 * Can $user perform $action on this page?
2293 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
2295 * @param string $action Action that permission needs to be checked for
2296 * @param User $user User to check
2297 * @param string $rigor One of (quick,full,secure)
2298 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2299 * - full : does cheap and expensive checks possibly from a replica DB
2300 * - secure : does cheap and expensive checks, using the master as needed
2301 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
2302 * whose corresponding errors may be ignored.
2304 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2307 * @deprecated since 1.33,
2308 * use MediaWikiServices::getInstance()->getPermissionManager()->getPermissionErrors()
2311 public function getUserPermissionsErrors(
2312 $action, $user, $rigor = PermissionManager
::RIGOR_SECURE
, $ignoreErrors = []
2314 // TODO: this is for b/c, eventually will be removed
2315 if ( $rigor === true ) {
2316 $rigor = PermissionManager
::RIGOR_SECURE
; // b/c
2317 } elseif ( $rigor === false ) {
2318 $rigor = PermissionManager
::RIGOR_QUICK
; // b/c
2321 return MediaWikiServices
::getInstance()->getPermissionManager()
2322 ->getPermissionErrors( $action, $user, $this, $rigor, $ignoreErrors );
2326 * Get a filtered list of all restriction types supported by this wiki.
2327 * @param bool $exists True to get all restriction types that apply to
2328 * titles that do exist, False for all restriction types that apply to
2329 * titles that do not exist
2332 public static function getFilteredRestrictionTypes( $exists = true ) {
2333 global $wgRestrictionTypes;
2334 $types = $wgRestrictionTypes;
2336 # Remove the create restriction for existing titles
2337 $types = array_diff( $types, [ 'create' ] );
2339 # Only the create and upload restrictions apply to non-existing titles
2340 $types = array_intersect( $types, [ 'create', 'upload' ] );
2346 * Returns restriction types for the current Title
2348 * @return array Applicable restriction types
2350 public function getRestrictionTypes() {
2351 if ( $this->isSpecialPage() ) {
2355 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2357 if ( $this->mNamespace
!= NS_FILE
) {
2358 # Remove the upload restriction for non-file titles
2359 $types = array_diff( $types, [ 'upload' ] );
2362 Hooks
::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2364 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2365 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2371 * Is this title subject to title protection?
2372 * Title protection is the one applied against creation of such title.
2374 * @return array|bool An associative array representing any existent title
2375 * protection, or false if there's none.
2377 public function getTitleProtection() {
2378 $protection = $this->getTitleProtectionInternal();
2379 if ( $protection ) {
2380 if ( $protection['permission'] == 'sysop' ) {
2381 $protection['permission'] = 'editprotected'; // B/C
2383 if ( $protection['permission'] == 'autoconfirmed' ) {
2384 $protection['permission'] = 'editsemiprotected'; // B/C
2391 * Fetch title protection settings
2393 * To work correctly, $this->loadRestrictions() needs to have access to the
2394 * actual protections in the database without munging 'sysop' =>
2395 * 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other
2396 * callers probably want $this->getTitleProtection() instead.
2398 * @return array|bool
2400 protected function getTitleProtectionInternal() {
2401 // Can't protect pages in special namespaces
2402 if ( $this->mNamespace
< 0 ) {
2406 // Can't protect pages that exist.
2407 if ( $this->exists() ) {
2411 if ( $this->mTitleProtection
=== null ) {
2412 $dbr = wfGetDB( DB_REPLICA
);
2413 $commentStore = CommentStore
::getStore();
2414 $commentQuery = $commentStore->getJoin( 'pt_reason' );
2415 $res = $dbr->select(
2416 [ 'protected_titles' ] +
$commentQuery['tables'],
2418 'user' => 'pt_user',
2419 'expiry' => 'pt_expiry',
2420 'permission' => 'pt_create_perm'
2421 ] +
$commentQuery['fields'],
2422 [ 'pt_namespace' => $this->mNamespace
, 'pt_title' => $this->mDbkeyform
],
2425 $commentQuery['joins']
2428 // fetchRow returns false if there are no rows.
2429 $row = $dbr->fetchRow( $res );
2431 $this->mTitleProtection
= [
2432 'user' => $row['user'],
2433 'expiry' => $dbr->decodeExpiry( $row['expiry'] ),
2434 'permission' => $row['permission'],
2435 'reason' => $commentStore->getComment( 'pt_reason', $row )->text
,
2438 $this->mTitleProtection
= false;
2441 return $this->mTitleProtection
;
2445 * Remove any title protection due to page existing
2447 public function deleteTitleProtection() {
2448 $dbw = wfGetDB( DB_MASTER
);
2452 [ 'pt_namespace' => $this->mNamespace
, 'pt_title' => $this->mDbkeyform
],
2455 $this->mTitleProtection
= false;
2459 * Is this page "semi-protected" - the *only* protection levels are listed
2460 * in $wgSemiprotectedRestrictionLevels?
2462 * @param string $action Action to check (default: edit)
2465 public function isSemiProtected( $action = 'edit' ) {
2466 global $wgSemiprotectedRestrictionLevels;
2468 $restrictions = $this->getRestrictions( $action );
2469 $semi = $wgSemiprotectedRestrictionLevels;
2470 if ( !$restrictions ||
!$semi ) {
2471 // Not protected, or all protection is full protection
2475 // Remap autoconfirmed to editsemiprotected for BC
2476 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2477 $semi[$key] = 'editsemiprotected';
2479 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2480 $restrictions[$key] = 'editsemiprotected';
2483 return !array_diff( $restrictions, $semi );
2487 * Does the title correspond to a protected article?
2489 * @param string $action The action the page is protected from,
2490 * by default checks all actions.
2493 public function isProtected( $action = '' ) {
2494 global $wgRestrictionLevels;
2496 $restrictionTypes = $this->getRestrictionTypes();
2498 # Special pages have inherent protection
2499 if ( $this->isSpecialPage() ) {
2503 # Check regular protection levels
2504 foreach ( $restrictionTypes as $type ) {
2505 if ( $action == $type ||
$action == '' ) {
2506 $r = $this->getRestrictions( $type );
2507 foreach ( $wgRestrictionLevels as $level ) {
2508 if ( in_array( $level, $r ) && $level != '' ) {
2519 * Determines if $user is unable to edit this page because it has been protected
2520 * by $wgNamespaceProtection.
2522 * @deprecated since 1.34 Don't use this function in new code.
2523 * @param User $user User object to check permissions
2526 public function isNamespaceProtected( User
$user ) {
2527 global $wgNamespaceProtection;
2529 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2530 $permissionManager = MediaWikiServices
::getInstance()->getPermissionManager();
2531 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2532 if ( !$permissionManager->userHasRight( $user, $right ) ) {
2541 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2543 * @return bool If the page is subject to cascading restrictions.
2545 public function isCascadeProtected() {
2546 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2547 return ( $sources > 0 );
2551 * Determines whether cascading protection sources have already been loaded from
2554 * @param bool $getPages True to check if the pages are loaded, or false to check
2555 * if the status is loaded.
2556 * @return bool Whether or not the specified information has been loaded
2559 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2560 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
2564 * Cascading protection: Get the source of any cascading restrictions on this page.
2566 * @param bool $getPages Whether or not to retrieve the actual pages
2567 * that the restrictions have come from and the actual restrictions
2569 * @return array Two elements: First is an array of Title objects of the
2570 * pages from which cascading restrictions have come, false for
2571 * none, or true if such restrictions exist but $getPages was not
2572 * set. Second is an array like that returned by
2573 * Title::getAllRestrictions(), or an empty array if $getPages is
2576 public function getCascadeProtectionSources( $getPages = true ) {
2577 $pagerestrictions = [];
2579 if ( $this->mCascadeSources
!== null && $getPages ) {
2580 return [ $this->mCascadeSources
, $this->mCascadingRestrictions
];
2581 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
2582 return [ $this->mHasCascadingRestrictions
, $pagerestrictions ];
2585 $dbr = wfGetDB( DB_REPLICA
);
2587 if ( $this->mNamespace
== NS_FILE
) {
2588 $tables = [ 'imagelinks', 'page_restrictions' ];
2590 'il_to' => $this->mDbkeyform
,
2595 $tables = [ 'templatelinks', 'page_restrictions' ];
2597 'tl_namespace' => $this->mNamespace
,
2598 'tl_title' => $this->mDbkeyform
,
2605 $cols = [ 'pr_page', 'page_namespace', 'page_title',
2606 'pr_expiry', 'pr_type', 'pr_level' ];
2607 $where_clauses[] = 'page_id=pr_page';
2610 $cols = [ 'pr_expiry' ];
2613 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2615 $sources = $getPages ?
[] : false;
2616 $now = wfTimestampNow();
2618 foreach ( $res as $row ) {
2619 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
2620 if ( $expiry > $now ) {
2622 $page_id = $row->pr_page
;
2623 $page_ns = $row->page_namespace
;
2624 $page_title = $row->page_title
;
2625 $sources[$page_id] = self
::makeTitle( $page_ns, $page_title );
2626 # Add groups needed for each restriction type if its not already there
2627 # Make sure this restriction type still exists
2629 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2630 $pagerestrictions[$row->pr_type
] = [];
2634 isset( $pagerestrictions[$row->pr_type
] )
2635 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
2637 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2646 $this->mCascadeSources
= $sources;
2647 $this->mCascadingRestrictions
= $pagerestrictions;
2649 $this->mHasCascadingRestrictions
= $sources;
2652 return [ $sources, $pagerestrictions ];
2656 * Accessor for mRestrictionsLoaded
2658 * @return bool Whether or not the page's restrictions have already been
2659 * loaded from the database
2662 public function areRestrictionsLoaded() {
2663 return $this->mRestrictionsLoaded
;
2667 * Accessor/initialisation for mRestrictions
2669 * @param string $action Action that permission needs to be checked for
2670 * @return array Restriction levels needed to take the action. All levels are
2671 * required. Note that restriction levels are normally user rights, but 'sysop'
2672 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
2673 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
2675 public function getRestrictions( $action ) {
2676 if ( !$this->mRestrictionsLoaded
) {
2677 $this->loadRestrictions();
2679 return $this->mRestrictions
[$action] ??
[];
2683 * Accessor/initialisation for mRestrictions
2685 * @return array Keys are actions, values are arrays as returned by
2686 * Title::getRestrictions()
2689 public function getAllRestrictions() {
2690 if ( !$this->mRestrictionsLoaded
) {
2691 $this->loadRestrictions();
2693 return $this->mRestrictions
;
2697 * Get the expiry time for the restriction against a given action
2699 * @param string $action
2700 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2701 * or not protected at all, or false if the action is not recognised.
2703 public function getRestrictionExpiry( $action ) {
2704 if ( !$this->mRestrictionsLoaded
) {
2705 $this->loadRestrictions();
2707 return $this->mRestrictionsExpiry
[$action] ??
false;
2711 * Returns cascading restrictions for the current article
2715 function areRestrictionsCascading() {
2716 if ( !$this->mRestrictionsLoaded
) {
2717 $this->loadRestrictions();
2720 return $this->mCascadeRestriction
;
2724 * Compiles list of active page restrictions from both page table (pre 1.10)
2725 * and page_restrictions table for this existing page.
2726 * Public for usage by LiquidThreads.
2728 * @param array $rows Array of db result objects
2729 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
2730 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
2731 * Edit and move sections are separated by a colon
2732 * Example: "edit=autoconfirmed,sysop:move=sysop"
2734 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2735 // This function will only read rows from a table that we migrated away
2736 // from before adding READ_LATEST support to loadRestrictions, so we
2737 // don't need to support reading from DB_MASTER here.
2738 $dbr = wfGetDB( DB_REPLICA
);
2740 $restrictionTypes = $this->getRestrictionTypes();
2742 foreach ( $restrictionTypes as $type ) {
2743 $this->mRestrictions
[$type] = [];
2744 $this->mRestrictionsExpiry
[$type] = 'infinity';
2747 $this->mCascadeRestriction
= false;
2749 # Backwards-compatibility: also load the restrictions from the page record (old format).
2750 if ( $oldFashionedRestrictions !== null ) {
2751 $this->mOldRestrictions
= $oldFashionedRestrictions;
2754 if ( $this->mOldRestrictions
=== false ) {
2755 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
2756 $linkCache->addLinkObj( $this ); # in case we already had an article ID
2757 $this->mOldRestrictions
= $linkCache->getGoodLinkFieldObj( $this, 'restrictions' );
2760 if ( $this->mOldRestrictions
!= '' ) {
2761 foreach ( explode( ':', trim( $this->mOldRestrictions
) ) as $restrict ) {
2762 $temp = explode( '=', trim( $restrict ) );
2763 if ( count( $temp ) == 1 ) {
2764 // old old format should be treated as edit/move restriction
2765 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2766 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2768 $restriction = trim( $temp[1] );
2769 if ( $restriction != '' ) { // some old entries are empty
2770 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
2776 if ( count( $rows ) ) {
2777 # Current system - load second to make them override.
2778 $now = wfTimestampNow();
2780 # Cycle through all the restrictions.
2781 foreach ( $rows as $row ) {
2782 // Don't take care of restrictions types that aren't allowed
2783 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
2787 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
2789 // Only apply the restrictions if they haven't expired!
2790 if ( !$expiry ||
$expiry > $now ) {
2791 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2792 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2794 $this->mCascadeRestriction |
= $row->pr_cascade
;
2799 $this->mRestrictionsLoaded
= true;
2803 * Load restrictions from the page_restrictions table
2805 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
2806 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
2807 * Edit and move sections are separated by a colon
2808 * Example: "edit=autoconfirmed,sysop:move=sysop"
2809 * @param int $flags A bit field. If self::READ_LATEST is set, skip replicas and read
2810 * from the master DB.
2812 public function loadRestrictions( $oldFashionedRestrictions = null, $flags = 0 ) {
2813 $readLatest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
2814 if ( $this->mRestrictionsLoaded
&& !$readLatest ) {
2818 $id = $this->getArticleID( $flags );
2820 $fname = __METHOD__
;
2821 $loadRestrictionsFromDb = function ( IDatabase
$dbr ) use ( $fname, $id ) {
2822 return iterator_to_array(
2824 'page_restrictions',
2825 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
2826 [ 'pr_page' => $id ],
2832 if ( $readLatest ) {
2833 $dbr = wfGetDB( DB_MASTER
);
2834 $rows = $loadRestrictionsFromDb( $dbr );
2836 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
2837 $rows = $cache->getWithSetCallback(
2838 // Page protections always leave a new null revision
2839 $cache->makeKey( 'page-restrictions', 'v1', $id, $this->getLatestRevID() ),
2841 function ( $curValue, &$ttl, array &$setOpts ) use ( $loadRestrictionsFromDb ) {
2842 $dbr = wfGetDB( DB_REPLICA
);
2844 $setOpts +
= Database
::getCacheSetOptions( $dbr );
2845 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2846 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2847 // @TODO: cleanup Title cache and caller assumption mess in general
2848 $ttl = WANObjectCache
::TTL_UNCACHEABLE
;
2851 return $loadRestrictionsFromDb( $dbr );
2856 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2858 $title_protection = $this->getTitleProtectionInternal();
2860 if ( $title_protection ) {
2861 $now = wfTimestampNow();
2862 $expiry = wfGetDB( DB_REPLICA
)->decodeExpiry( $title_protection['expiry'] );
2864 if ( !$expiry ||
$expiry > $now ) {
2865 // Apply the restrictions
2866 $this->mRestrictionsExpiry
['create'] = $expiry;
2867 $this->mRestrictions
['create'] =
2868 explode( ',', trim( $title_protection['permission'] ) );
2869 } else { // Get rid of the old restrictions
2870 $this->mTitleProtection
= false;
2873 $this->mRestrictionsExpiry
['create'] = 'infinity';
2875 $this->mRestrictionsLoaded
= true;
2880 * Flush the protection cache in this object and force reload from the database.
2881 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2883 public function flushRestrictions() {
2884 $this->mRestrictionsLoaded
= false;
2885 $this->mTitleProtection
= null;
2889 * Purge expired restrictions from the page_restrictions table
2891 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
2893 static function purgeExpiredRestrictions() {
2894 if ( wfReadOnly() ) {
2898 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
2899 wfGetDB( DB_MASTER
),
2901 function ( IDatabase
$dbw, $fname ) {
2902 $config = MediaWikiServices
::getInstance()->getMainConfig();
2903 $ids = $dbw->selectFieldValues(
2904 'page_restrictions',
2906 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
2908 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
2911 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
2916 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
2917 wfGetDB( DB_MASTER
),
2919 function ( IDatabase
$dbw, $fname ) {
2922 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
2930 * Does this have subpages? (Warning, usually requires an extra DB query.)
2934 public function hasSubpages() {
2936 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
2937 hasSubpages( $this->mNamespace
)
2943 # We dynamically add a member variable for the purpose of this method
2944 # alone to cache the result. There's no point in having it hanging
2945 # around uninitialized in every Title object; therefore we only add it
2946 # if needed and don't declare it statically.
2947 if ( $this->mHasSubpages
=== null ) {
2948 $this->mHasSubpages
= false;
2949 $subpages = $this->getSubpages( 1 );
2950 if ( $subpages instanceof TitleArray
) {
2951 $this->mHasSubpages
= (bool)$subpages->current();
2955 return $this->mHasSubpages
;
2959 * Get all subpages of this page.
2961 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
2962 * @return TitleArray|array TitleArray, or empty array if this page's namespace
2963 * doesn't allow subpages
2965 public function getSubpages( $limit = -1 ) {
2967 !MediaWikiServices
::getInstance()->getNamespaceInfo()->
2968 hasSubpages( $this->mNamespace
)
2973 $dbr = wfGetDB( DB_REPLICA
);
2974 $conds = [ 'page_namespace' => $this->mNamespace
];
2975 $conds[] = 'page_title ' . $dbr->buildLike( $this->mDbkeyform
. '/', $dbr->anyString() );
2977 if ( $limit > -1 ) {
2978 $options['LIMIT'] = $limit;
2980 return TitleArray
::newFromResult(
2981 $dbr->select( 'page',
2982 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
2991 * Is there a version of this page in the deletion archive?
2993 * @return int The number of archived revisions
2995 public function isDeleted() {
2996 if ( $this->mNamespace
< 0 ) {
2999 $dbr = wfGetDB( DB_REPLICA
);
3001 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3002 [ 'ar_namespace' => $this->mNamespace
, 'ar_title' => $this->mDbkeyform
],
3005 if ( $this->mNamespace
== NS_FILE
) {
3006 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
3007 [ 'fa_name' => $this->mDbkeyform
],
3016 * Is there a version of this page in the deletion archive?
3020 public function isDeletedQuick() {
3021 if ( $this->mNamespace
< 0 ) {
3024 $dbr = wfGetDB( DB_REPLICA
);
3025 $deleted = (bool)$dbr->selectField( 'archive', '1',
3026 [ 'ar_namespace' => $this->mNamespace
, 'ar_title' => $this->mDbkeyform
],
3029 if ( !$deleted && $this->mNamespace
== NS_FILE
) {
3030 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3031 [ 'fa_name' => $this->mDbkeyform
],
3039 * Get the article ID for this Title from the link cache,
3040 * adding it if necessary
3042 * @param int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
3043 * @return int The ID
3045 public function getArticleID( $flags = 0 ) {
3046 if ( $this->mNamespace
< 0 ) {
3047 $this->mArticleID
= 0;
3049 return $this->mArticleID
;
3052 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3053 if ( $flags & self
::GAID_FOR_UPDATE
) {
3054 $oldUpdate = $linkCache->forUpdate( true );
3055 $linkCache->clearLink( $this );
3056 $this->mArticleID
= $linkCache->addLinkObj( $this );
3057 $linkCache->forUpdate( $oldUpdate );
3058 } elseif ( DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
) ) {
3059 $this->mArticleID
= (int)$this->loadFieldFromDB( 'page_id', $flags );
3060 } elseif ( $this->mArticleID
== -1 ) {
3061 $this->mArticleID
= $linkCache->addLinkObj( $this );
3064 return $this->mArticleID
;
3068 * Is this an article that is a redirect page?
3069 * Uses link cache, adding it if necessary
3071 * @param int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
3074 public function isRedirect( $flags = 0 ) {
3075 if ( DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
) ) {
3076 $this->mRedirect
= (bool)$this->loadFieldFromDB( 'page_is_redirect', $flags );
3078 if ( $this->mRedirect
!== null ) {
3079 return $this->mRedirect
;
3080 } elseif ( !$this->getArticleID( $flags ) ) {
3081 $this->mRedirect
= false;
3083 return $this->mRedirect
;
3086 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3087 $linkCache->addLinkObj( $this ); // in case we already had an article ID
3088 // Note that LinkCache returns null if it thinks the page does not exist;
3089 // always trust the state of LinkCache over that of this Title instance.
3090 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3093 return $this->mRedirect
;
3097 * What is the length of this page?
3098 * Uses link cache, adding it if necessary
3100 * @param int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
3103 public function getLength( $flags = 0 ) {
3104 if ( DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
) ) {
3105 $this->mLength
= (int)$this->loadFieldFromDB( 'page_len', $flags );
3107 if ( $this->mLength
!= -1 ) {
3108 return $this->mLength
;
3109 } elseif ( !$this->getArticleID( $flags ) ) {
3111 return $this->mLength
;
3114 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3115 $linkCache->addLinkObj( $this ); // in case we already had an article ID
3116 // Note that LinkCache returns null if it thinks the page does not exist;
3117 // always trust the state of LinkCache over that of this Title instance.
3118 $this->mLength
= (int)$linkCache->getGoodLinkFieldObj( $this, 'length' );
3121 return $this->mLength
;
3125 * What is the page_latest field for this page?
3127 * @param int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
3128 * @return int Int or 0 if the page doesn't exist
3130 public function getLatestRevID( $flags = 0 ) {
3131 if ( DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
) ) {
3132 $this->mLatestID
= (int)$this->loadFieldFromDB( 'page_latest', $flags );
3134 if ( $this->mLatestID
!== false ) {
3135 return (int)$this->mLatestID
;
3136 } elseif ( !$this->getArticleID( $flags ) ) {
3137 $this->mLatestID
= 0;
3139 return $this->mLatestID
;
3142 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3143 $linkCache->addLinkObj( $this ); // in case we already had an article ID
3144 // Note that LinkCache returns null if it thinks the page does not exist;
3145 // always trust the state of LinkCache over that of this Title instance.
3146 $this->mLatestID
= (int)$linkCache->getGoodLinkFieldObj( $this, 'revision' );
3149 return $this->mLatestID
;
3153 * Inject a page ID, reset DB-loaded fields, and clear the link cache for this title
3155 * This can be called on page insertion to allow loading of the new page_id without
3156 * having to create a new Title instance. Likewise with deletion.
3158 * @note This overrides Title::setContentModel()
3160 * @param int|bool $id Page ID, 0 for non-existant, or false for "unknown" (lazy-load)
3162 public function resetArticleID( $id ) {
3163 if ( $id === false ) {
3164 $this->mArticleID
= -1;
3166 $this->mArticleID
= (int)$id;
3168 $this->mRestrictionsLoaded
= false;
3169 $this->mRestrictions
= [];
3170 $this->mOldRestrictions
= false;
3171 $this->mRedirect
= null;
3172 $this->mLength
= -1;
3173 $this->mLatestID
= false;
3174 $this->mContentModel
= false;
3175 $this->mForcedContentModel
= false;
3176 $this->mEstimateRevisions
= null;
3177 $this->mPageLanguage
= null;
3178 $this->mDbPageLanguage
= false;
3179 $this->mIsBigDeletion
= null;
3181 MediaWikiServices
::getInstance()->getLinkCache()->clearLink( $this );
3184 public static function clearCaches() {
3185 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3186 $linkCache->clear();
3188 $titleCache = self
::getTitleCache();
3189 $titleCache->clear();
3193 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3195 * @param string $text Containing title to capitalize
3196 * @param int $ns Namespace index, defaults to NS_MAIN
3197 * @return string Containing capitalized title
3199 public static function capitalize( $text, $ns = NS_MAIN
) {
3200 $services = MediaWikiServices
::getInstance();
3201 if ( $services->getNamespaceInfo()->isCapitalized( $ns ) ) {
3202 return $services->getContentLanguage()->ucfirst( $text );
3209 * Secure and split - main initialisation function for this object
3211 * Assumes that mDbkeyform has been set, and is urldecoded
3212 * and uses underscores, but not otherwise munged. This function
3213 * removes illegal characters, splits off the interwiki and
3214 * namespace prefixes, sets the other forms, and canonicalizes
3217 * @throws MalformedTitleException On invalid titles
3218 * @return bool True on success
3220 private function secureAndSplit() {
3221 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3222 // the parsing code with Title, while avoiding massive refactoring.
3223 // @todo: get rid of secureAndSplit, refactor parsing code.
3224 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3225 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3226 /** @var MediaWikiTitleCodec $titleCodec */
3227 $titleCodec = MediaWikiServices
::getInstance()->getTitleParser();
3228 '@phan-var MediaWikiTitleCodec $titleCodec';
3229 // MalformedTitleException can be thrown here
3230 $parts = $titleCodec->splitTitleString( $this->mDbkeyform
, $this->mDefaultNamespace
);
3233 $this->setFragment( '#' . $parts['fragment'] );
3234 $this->mInterwiki
= $parts['interwiki'];
3235 $this->mLocalInterwiki
= $parts['local_interwiki'];
3236 $this->mNamespace
= $parts['namespace'];
3237 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3239 $this->mDbkeyform
= $parts['dbkey'];
3240 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3241 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );
3243 # We already know that some pages won't be in the database!
3244 if ( $this->isExternal() ||
$this->isSpecialPage() ) {
3245 $this->mArticleID
= 0;
3252 * Get an array of Title objects linking to this Title
3253 * Also stores the IDs in the link cache.
3255 * WARNING: do not use this function on arbitrary user-supplied titles!
3256 * On heavily-used templates it will max out the memory.
3258 * @param array $options May be FOR UPDATE
3259 * @param string $table Table name
3260 * @param string $prefix Fields prefix
3261 * @return Title[] Array of Title objects linking here
3263 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3264 if ( count( $options ) > 0 ) {
3265 $db = wfGetDB( DB_MASTER
);
3267 $db = wfGetDB( DB_REPLICA
);
3272 self
::getSelectFields(),
3274 "{$prefix}_from=page_id",
3275 "{$prefix}_namespace" => $this->mNamespace
,
3276 "{$prefix}_title" => $this->mDbkeyform
],
3282 if ( $res->numRows() ) {
3283 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3284 foreach ( $res as $row ) {
3285 $titleObj = self
::makeTitle( $row->page_namespace
, $row->page_title
);
3287 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3288 $retVal[] = $titleObj;
3296 * Get an array of Title objects using this Title as a template
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 * @return Title[] Array of Title the Title objects linking here
3305 public function getTemplateLinksTo( $options = [] ) {
3306 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3310 * Get an array of Title objects linked from this Title
3311 * Also stores the IDs in the link cache.
3313 * WARNING: do not use this function on arbitrary user-supplied titles!
3314 * On heavily-used templates it will max out the memory.
3316 * @param array $options Query option to Database::select()
3317 * @param string $table Table name
3318 * @param string $prefix Fields prefix
3319 * @return array Array of Title objects linking here
3321 public function getLinksFrom( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3322 $id = $this->getArticleID();
3324 # If the page doesn't exist; there can't be any link from this page
3329 $db = wfGetDB( DB_REPLICA
);
3331 $blNamespace = "{$prefix}_namespace";
3332 $blTitle = "{$prefix}_title";
3334 $pageQuery = WikiPage
::getQueryInfo();
3336 [ $table, 'nestpage' => $pageQuery['tables'] ],
3338 [ $blNamespace, $blTitle ],
3339 $pageQuery['fields']
3341 [ "{$prefix}_from" => $id ],
3346 [ "page_namespace=$blNamespace", "page_title=$blTitle" ]
3347 ] ] +
$pageQuery['joins']
3351 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3352 foreach ( $res as $row ) {
3353 if ( $row->page_id
) {
3354 $titleObj = self
::newFromRow( $row );
3356 $titleObj = self
::makeTitle( $row->$blNamespace, $row->$blTitle );
3357 $linkCache->addBadLinkObj( $titleObj );
3359 $retVal[] = $titleObj;
3366 * Get an array of Title objects used on this Title as a template
3367 * Also stores the IDs in the link cache.
3369 * WARNING: do not use this function on arbitrary user-supplied titles!
3370 * On heavily-used templates it will max out the memory.
3372 * @param array $options May be FOR UPDATE
3373 * @return Title[] Array of Title the Title objects used here
3375 public function getTemplateLinksFrom( $options = [] ) {
3376 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3380 * Get an array of Title objects referring to non-existent articles linked
3383 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3384 * should use redirect table in this case).
3385 * @return Title[] Array of Title the Title objects
3387 public function getBrokenLinksFrom() {
3388 if ( $this->getArticleID() == 0 ) {
3389 # All links from article ID 0 are false positives
3393 $dbr = wfGetDB( DB_REPLICA
);
3394 $res = $dbr->select(
3395 [ 'page', 'pagelinks' ],
3396 [ 'pl_namespace', 'pl_title' ],
3398 'pl_from' => $this->getArticleID(),
3399 'page_namespace IS NULL'
3405 [ 'pl_namespace=page_namespace', 'pl_title=page_title' ]
3411 foreach ( $res as $row ) {
3412 $retVal[] = self
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3418 * Get a list of URLs to purge from the CDN cache when this
3421 * @return string[] Array of String the URLs
3423 public function getCdnUrls() {
3425 $this->getInternalURL(),
3426 $this->getInternalURL( 'action=history' )
3429 $pageLang = $this->getPageLanguage();
3430 if ( $pageLang->hasVariants() ) {
3431 $variants = $pageLang->getVariants();
3432 foreach ( $variants as $vCode ) {
3433 $urls[] = $this->getInternalURL( $vCode );
3437 // If we are looking at a css/js user subpage, purge the action=raw.
3438 if ( $this->isUserJsConfigPage() ) {
3439 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/javascript' );
3440 } elseif ( $this->isUserJsonConfigPage() ) {
3441 $urls[] = $this->getInternalURL( 'action=raw&ctype=application/json' );
3442 } elseif ( $this->isUserCssConfigPage() ) {
3443 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/css' );
3446 Hooks
::run( 'TitleSquidURLs', [ $this, &$urls ] );
3451 * Purge all applicable CDN URLs
3453 public function purgeSquid() {
3454 DeferredUpdates
::addUpdate(
3455 new CdnCacheUpdate( $this->getCdnUrls() ),
3456 DeferredUpdates
::PRESEND
3461 * Check whether a given move operation would be valid.
3462 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3464 * @deprecated since 1.25, use MovePage's methods instead
3465 * @param Title &$nt The new title
3466 * @param bool $auth Whether to check user permissions (uses $wgUser)
3467 * @param string $reason Is the log summary of the move, used for spam checking
3468 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3470 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3471 wfDeprecated( __METHOD__
, '1.25' );
3475 if ( !( $nt instanceof Title
) ) {
3476 // Normally we'd add this to $errors, but we'll get
3477 // lots of syntax errors if $nt is not an object
3478 return [ [ 'badtitletext' ] ];
3481 $mp = MediaWikiServices
::getInstance()->getMovePageFactory()->newMovePage( $this, $nt );
3482 $errors = $mp->isValidMove()->getErrorsArray();
3484 $errors = wfMergeErrorArrays(
3486 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
3490 return $errors ?
: true;
3494 * Move a title to a new location
3496 * @deprecated since 1.25, use the MovePage class instead
3497 * @param Title &$nt The new title
3498 * @param bool $auth Indicates whether $wgUser's permissions
3500 * @param string $reason The reason for the move
3501 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3502 * Ignored if the user doesn't have the suppressredirect right.
3503 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3504 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3506 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true,
3507 array $changeTags = []
3509 wfDeprecated( __METHOD__
, '1.25' );
3513 $mp = MediaWikiServices
::getInstance()->getMovePageFactory()->newMovePage( $this, $nt );
3514 $method = $auth ?
'moveIfAllowed' : 'move';
3515 /** @var Status $status */
3516 $status = $mp->$method( $wgUser, $reason, $createRedirect, $changeTags );
3517 if ( $status->isOK() ) {
3520 return $status->getErrorsArray();
3525 * Move this page's subpages to be subpages of $nt
3527 * @deprecated since 1.34, use MovePage instead
3528 * @param Title $nt Move target
3529 * @param bool $auth Whether $wgUser's permissions should be checked
3530 * @param string $reason The reason for the move
3531 * @param bool $createRedirect Whether to create redirects from the old subpages to
3532 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3533 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3534 * @return array Array with old page titles as keys, and strings (new page titles) or
3535 * getUserPermissionsErrors()-like arrays (errors) as values, or a
3536 * getUserPermissionsErrors()-like error array with numeric indices if
3537 * no pages were moved
3539 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true,
3540 array $changeTags = []
3542 wfDeprecated( __METHOD__
, '1.34' );
3546 $mp = new MovePage( $this, $nt );
3547 $method = $auth ?
'moveSubpagesIfAllowed' : 'moveSubpages';
3548 /** @var Status $result */
3549 $result = $mp->$method( $wgUser, $reason, $createRedirect, $changeTags );
3551 if ( !$result->isOK() ) {
3552 return $result->getErrorsArray();
3556 foreach ( $result->getValue() as $key => $status ) {
3557 /** @var Status $status */
3558 if ( $status->isOK() ) {
3559 $retval[$key] = $status->getValue();
3561 $retval[$key] = $status->getErrorsArray();
3568 * Locks the page row and check if this page is single revision redirect
3570 * This updates the cached fields of this instance via Title::loadFromRow()
3574 public function isSingleRevRedirect() {
3575 global $wgContentHandlerUseDB;
3577 $dbw = wfGetDB( DB_MASTER
);
3580 $fields = [ 'page_is_redirect', 'page_latest', 'page_id' ];
3581 if ( $wgContentHandlerUseDB ) {
3582 $fields[] = 'page_content_model';
3585 $row = $dbw->selectRow( 'page',
3591 # Cache some fields we may want
3592 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3593 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3594 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3595 $this->mContentModel
= $row && isset( $row->page_content_model
)
3596 ?
strval( $row->page_content_model
)
3599 if ( !$this->mRedirect
) {
3602 # Does the article have a history?
3603 $row = $dbw->selectField( [ 'page', 'revision' ],
3605 [ 'page_namespace' => $this->mNamespace
,
3606 'page_title' => $this->mDbkeyform
,
3608 'page_latest != rev_id'
3613 # Return true if there was no history
3614 return ( $row === false );
3618 * Checks if $this can be moved to a given Title
3619 * - Selects for update, so don't call it unless you mean business
3621 * @deprecated since 1.25, use MovePage's methods instead
3622 * @param Title $nt The new title to check
3625 public function isValidMoveTarget( $nt ) {
3626 wfDeprecated( __METHOD__
, '1.25' );
3628 # Is it an existing file?
3629 if ( $nt->getNamespace() == NS_FILE
) {
3630 $file = MediaWikiServices
::getInstance()->getRepoGroup()->getLocalRepo()
3632 $file->load( File
::READ_LATEST
);
3633 if ( $file->exists() ) {
3634 wfDebug( __METHOD__
. ": file exists\n" );
3638 # Is it a redirect with no history?
3639 if ( !$nt->isSingleRevRedirect() ) {
3640 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3643 # Get the article text
3644 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
3645 if ( !is_object( $rev ) ) {
3648 $content = $rev->getContent();
3649 # Does the redirect point to the source?
3650 # Or is it a broken self-redirect, usually caused by namespace collisions?
3651 $redirTitle = $content ?
$content->getRedirectTarget() : null;
3653 if ( $redirTitle ) {
3654 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3655 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3656 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3662 # Fail safe (not a redirect after all. strange.)
3663 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
3664 " is a redirect, but it doesn't contain a valid redirect.\n" );
3670 * Get categories to which this Title belongs and return an array of
3671 * categories' names.
3673 * @return array Array of parents in the form:
3674 * $parent => $currentarticle
3676 public function getParentCategories() {
3679 $titleKey = $this->getArticleID();
3681 if ( $titleKey === 0 ) {
3685 $dbr = wfGetDB( DB_REPLICA
);
3687 $res = $dbr->select(
3690 [ 'cl_from' => $titleKey ],
3694 if ( $res->numRows() > 0 ) {
3695 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
3696 foreach ( $res as $row ) {
3697 // $data[] = Title::newFromText( $contLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
3698 $data[$contLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] =
3699 $this->getFullText();
3706 * Get a tree of parent categories
3708 * @param array $children Array with the children in the keys, to check for circular refs
3709 * @return array Tree of parent categories
3711 public function getParentCategoryTree( $children = [] ) {
3713 $parents = $this->getParentCategories();
3716 foreach ( $parents as $parent => $current ) {
3717 if ( array_key_exists( $parent, $children ) ) {
3718 # Circular reference
3719 $stack[$parent] = [];
3721 $nt = self
::newFromText( $parent );
3723 $stack[$parent] = $nt->getParentCategoryTree( $children +
[ $parent => 1 ] );
3733 * Get an associative array for selecting this title from
3736 * @return array Array suitable for the $where parameter of DB::select()
3738 public function pageCond() {
3739 if ( $this->mArticleID
> 0 ) {
3740 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3741 return [ 'page_id' => $this->mArticleID
];
3743 return [ 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
];
3748 * Get next/previous revision ID relative to another revision ID
3749 * @param int $revId Revision ID. Get the revision that was before this one.
3750 * @param int $flags Bitfield of class READ_* constants
3751 * @param string $dir 'next' or 'prev'
3752 * @return int|bool New revision ID, or false if none exists
3754 private function getRelativeRevisionID( $revId, $flags, $dir ) {
3755 $rl = MediaWikiServices
::getInstance()->getRevisionLookup();
3756 $rev = $rl->getRevisionById( $revId, $flags );
3761 $oldRev = ( $dir === 'next' )
3762 ?
$rl->getNextRevision( $rev, $flags )
3763 : $rl->getPreviousRevision( $rev, $flags );
3765 return $oldRev ?
$oldRev->getId() : false;
3769 * Get the revision ID of the previous revision
3771 * @deprecated since 1.34, use RevisionLookup::getPreviousRevision
3772 * @param int $revId Revision ID. Get the revision that was before this one.
3773 * @param int $flags Bitfield of class READ_* constants
3774 * @return int|bool Old revision ID, or false if none exists
3776 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3777 return $this->getRelativeRevisionID( $revId, $flags, 'prev' );
3781 * Get the revision ID of the next revision
3783 * @deprecated since 1.34, use RevisionLookup::getNextRevision
3784 * @param int $revId Revision ID. Get the revision that was after this one.
3785 * @param int $flags Bitfield of class READ_* constants
3786 * @return int|bool Next revision ID, or false if none exists
3788 public function getNextRevisionID( $revId, $flags = 0 ) {
3789 return $this->getRelativeRevisionID( $revId, $flags, 'next' );
3793 * Get the first revision of the page
3795 * @param int $flags Bitfield of class READ_* constants
3796 * @return Revision|null If page doesn't exist
3798 public function getFirstRevision( $flags = 0 ) {
3799 $pageId = $this->getArticleID( $flags );
3801 $flags |
= ( $flags & self
::GAID_FOR_UPDATE
) ? self
::READ_LATEST
: 0; // b/c
3802 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
3803 $revQuery = Revision
::getQueryInfo();
3804 $row = wfGetDB( $index )->selectRow(
3805 $revQuery['tables'], $revQuery['fields'],
3806 [ 'rev_page' => $pageId ],
3810 'ORDER BY' => 'rev_timestamp ASC, rev_id ASC',
3811 'IGNORE INDEX' => [ 'revision' => 'rev_timestamp' ], // See T159319
3818 return new Revision( $row, 0, $this );
3825 * Get the oldest revision timestamp of this page
3827 * @param int $flags Bitfield of class READ_* constants
3828 * @return string|null MW timestamp
3830 public function getEarliestRevTime( $flags = 0 ) {
3831 $rev = $this->getFirstRevision( $flags );
3832 return $rev ?
$rev->getTimestamp() : null;
3836 * Check if this is a new page
3840 public function isNewPage() {
3841 $dbr = wfGetDB( DB_REPLICA
);
3842 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3846 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
3850 public function isBigDeletion() {
3851 global $wgDeleteRevisionsLimit;
3853 if ( !$wgDeleteRevisionsLimit ) {
3857 if ( $this->mIsBigDeletion
=== null ) {
3858 $dbr = wfGetDB( DB_REPLICA
);
3860 $revCount = $dbr->selectRowCount(
3863 [ 'rev_page' => $this->getArticleID() ],
3865 [ 'LIMIT' => $wgDeleteRevisionsLimit +
1 ]
3868 $this->mIsBigDeletion
= $revCount > $wgDeleteRevisionsLimit;
3871 return $this->mIsBigDeletion
;
3875 * Get the approximate revision count of this page.
3879 public function estimateRevisionCount() {
3880 if ( !$this->exists() ) {
3884 if ( $this->mEstimateRevisions
=== null ) {
3885 $dbr = wfGetDB( DB_REPLICA
);
3886 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
3887 [ 'rev_page' => $this->getArticleID() ], __METHOD__
);
3890 return $this->mEstimateRevisions
;
3894 * Get the number of revisions between the given revision.
3895 * Used for diffs and other things that really need it.
3897 * @param int|Revision $old Old revision or rev ID (first before range)
3898 * @param int|Revision $new New revision or rev ID (first after range)
3899 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
3900 * @return int Number of revisions between these revisions.
3902 public function countRevisionsBetween( $old, $new, $max = null ) {
3903 if ( !( $old instanceof Revision
) ) {
3904 $old = Revision
::newFromTitle( $this, (int)$old );
3906 if ( !( $new instanceof Revision
) ) {
3907 $new = Revision
::newFromTitle( $this, (int)$new );
3909 if ( !$old ||
!$new ) {
3910 return 0; // nothing to compare
3912 $dbr = wfGetDB( DB_REPLICA
);
3914 'rev_page' => $this->getArticleID(),
3915 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3916 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3918 if ( $max !== null ) {
3919 return $dbr->selectRowCount( 'revision', '1',
3922 [ 'LIMIT' => $max +
1 ] // extra to detect truncation
3925 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
3930 * Get the authors between the given revisions or revision IDs.
3931 * Used for diffs and other things that really need it.
3935 * @param int|Revision $old Old revision or rev ID (first before range by default)
3936 * @param int|Revision $new New revision or rev ID (first after range by default)
3937 * @param int $limit Maximum number of authors
3938 * @param string|array $options (Optional): Single option, or an array of options:
3939 * 'include_old' Include $old in the range; $new is excluded.
3940 * 'include_new' Include $new in the range; $old is excluded.
3941 * 'include_both' Include both $old and $new in the range.
3942 * Unknown option values are ignored.
3943 * @return array|null Names of revision authors in the range; null if not both revisions exist
3945 public function getAuthorsBetween( $old, $new, $limit, $options = [] ) {
3946 if ( !( $old instanceof Revision
) ) {
3947 $old = Revision
::newFromTitle( $this, (int)$old );
3949 if ( !( $new instanceof Revision
) ) {
3950 $new = Revision
::newFromTitle( $this, (int)$new );
3952 // XXX: what if Revision objects are passed in, but they don't refer to this title?
3953 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
3954 // in the sanity check below?
3955 if ( !$old ||
!$new ) {
3956 return null; // nothing to compare
3961 $options = (array)$options;
3962 if ( in_array( 'include_old', $options ) ) {
3965 if ( in_array( 'include_new', $options ) ) {
3968 if ( in_array( 'include_both', $options ) ) {
3972 // No DB query needed if $old and $new are the same or successive revisions:
3973 if ( $old->getId() === $new->getId() ) {
3974 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
3976 [ $old->getUserText( RevisionRecord
::RAW
) ];
3977 } elseif ( $old->getId() === $new->getParentId() ) {
3978 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
3979 $authors[] = $oldUserText = $old->getUserText( RevisionRecord
::RAW
);
3980 $newUserText = $new->getUserText( RevisionRecord
::RAW
);
3981 if ( $oldUserText != $newUserText ) {
3982 $authors[] = $newUserText;
3984 } elseif ( $old_cmp === '>=' ) {
3985 $authors[] = $old->getUserText( RevisionRecord
::RAW
);
3986 } elseif ( $new_cmp === '<=' ) {
3987 $authors[] = $new->getUserText( RevisionRecord
::RAW
);
3991 $dbr = wfGetDB( DB_REPLICA
);
3992 $revQuery = Revision
::getQueryInfo();
3993 $authors = $dbr->selectFieldValues(
3994 $revQuery['tables'],
3995 $revQuery['fields']['rev_user_text'],
3997 'rev_page' => $this->getArticleID(),
3998 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3999 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4001 [ 'DISTINCT', 'LIMIT' => $limit +
1 ], // add one so caller knows it was truncated
4008 * Get the number of authors between the given revisions or revision IDs.
4009 * Used for diffs and other things that really need it.
4011 * @param int|Revision $old Old revision or rev ID (first before range by default)
4012 * @param int|Revision $new New revision or rev ID (first after range by default)
4013 * @param int $limit Maximum number of authors
4014 * @param string|array $options (Optional): Single option, or an array of options:
4015 * 'include_old' Include $old in the range; $new is excluded.
4016 * 'include_new' Include $new in the range; $old is excluded.
4017 * 'include_both' Include both $old and $new in the range.
4018 * Unknown option values are ignored.
4019 * @return int Number of revision authors in the range; zero if not both revisions exist
4021 public function countAuthorsBetween( $old, $new, $limit, $options = [] ) {
4022 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4023 return $authors ?
count( $authors ) : 0;
4027 * Compare with another title.
4029 * @param LinkTarget $title
4032 public function equals( LinkTarget
$title ) {
4033 // Note: === is necessary for proper matching of number-like titles.
4034 return $this->mInterwiki
=== $title->getInterwiki()
4035 && $this->mNamespace
== $title->getNamespace()
4036 && $this->mDbkeyform
=== $title->getDBkey();
4040 * Check if this title is a subpage of another title
4042 * @param Title $title
4045 public function isSubpageOf( Title
$title ) {
4046 return $this->mInterwiki
=== $title->mInterwiki
4047 && $this->mNamespace
== $title->mNamespace
4048 && strpos( $this->mDbkeyform
, $title->mDbkeyform
. '/' ) === 0;
4052 * Check if page exists. For historical reasons, this function simply
4053 * checks for the existence of the title in the page table, and will
4054 * thus return false for interwiki links, special pages and the like.
4055 * If you want to know if a title can be meaningfully viewed, you should
4056 * probably call the isKnown() method instead.
4058 * @param int $flags Either a bitfield of class READ_* constants or GAID_FOR_UPDATE
4061 public function exists( $flags = 0 ) {
4062 $exists = $this->getArticleID( $flags ) != 0;
4063 Hooks
::run( 'TitleExists', [ $this, &$exists ] );
4068 * Should links to this title be shown as potentially viewable (i.e. as
4069 * "bluelinks"), even if there's no record by this title in the page
4072 * This function is semi-deprecated for public use, as well as somewhat
4073 * misleadingly named. You probably just want to call isKnown(), which
4074 * calls this function internally.
4076 * (ISSUE: Most of these checks are cheap, but the file existence check
4077 * can potentially be quite expensive. Including it here fixes a lot of
4078 * existing code, but we might want to add an optional parameter to skip
4079 * it and any other expensive checks.)
4083 public function isAlwaysKnown() {
4087 * Allows overriding default behavior for determining if a page exists.
4088 * If $isKnown is kept as null, regular checks happen. If it's
4089 * a boolean, this value is returned by the isKnown method.
4093 * @param Title $title
4094 * @param bool|null $isKnown
4096 Hooks
::run( 'TitleIsAlwaysKnown', [ $this, &$isKnown ] );
4098 if ( !is_null( $isKnown ) ) {
4102 if ( $this->isExternal() ) {
4103 return true; // any interwiki link might be viewable, for all we know
4106 $services = MediaWikiServices
::getInstance();
4107 switch ( $this->mNamespace
) {
4110 // file exists, possibly in a foreign repo
4111 return (bool)$services->getRepoGroup()->findFile( $this );
4113 // valid special page
4114 return $services->getSpecialPageFactory()->exists( $this->mDbkeyform
);
4116 // selflink, possibly with fragment
4117 return $this->mDbkeyform
== '';
4119 // known system message
4120 return $this->hasSourceText() !== false;
4127 * Does this title refer to a page that can (or might) be meaningfully
4128 * viewed? In particular, this function may be used to determine if
4129 * links to the title should be rendered as "bluelinks" (as opposed to
4130 * "redlinks" to non-existent pages).
4131 * Adding something else to this function will cause inconsistency
4132 * since LinkHolderArray calls isAlwaysKnown() and does its own
4133 * page existence check.
4137 public function isKnown() {
4138 return $this->isAlwaysKnown() ||
$this->exists();
4142 * Does this page have source text?
4146 public function hasSourceText() {
4147 if ( $this->exists() ) {
4151 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4152 // If the page doesn't exist but is a known system message, default
4153 // message content will be displayed, same for language subpages-
4154 // Use always content language to avoid loading hundreds of languages
4155 // to get the link color.
4156 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
4157 list( $name, ) = MessageCache
::singleton()->figureMessage(
4158 $contLang->lcfirst( $this->getText() )
4160 $message = wfMessage( $name )->inLanguage( $contLang )->useDatabase( false );
4161 return $message->exists();
4168 * Get the default (plain) message contents for an page that overrides an
4169 * interface message key.
4171 * Primary use cases:
4174 * - Show default when viewing the page. The Article::getSubstituteContent
4175 * method displays the default message content, instead of the
4176 * 'noarticletext' placeholder message normally used.
4179 * - Title of edit page. When creating an interface message override,
4180 * the editor is told they are "Editing the page", instead of
4181 * "Creating the page". (EditPage::setHeaders)
4182 * - Edit notice. The 'translateinterface' edit notice is shown when creating
4183 * or editing a an interface message override. (EditPage::showIntro)
4184 * - Opening the editor. The contents of the localisation message are used
4185 * as contents of the editor when creating a new page in the MediaWiki
4186 * namespace. This simplifies the process for editors when "changing"
4187 * an interface message by creating an override. (EditPage::getContentObject)
4188 * - Showing a diff. The left-hand side of a diff when an editor is
4189 * previewing their changes before saving the creation of a page in the
4190 * MediaWiki namespace. (EditPage::showDiff)
4191 * - Disallowing a save. When attempting to create a a MediaWiki-namespace
4192 * page with the proposed content matching the interface message default,
4193 * the save is rejected, the same way we disallow blank pages from being
4194 * created. (EditPage::internalAttemptSave)
4197 * - Default content, when using the 'prepend' or 'append' feature.
4200 * - Label the create action as "Edit", if the page can be an override.
4202 * @return string|bool
4204 public function getDefaultMessageText() {
4205 if ( $this->mNamespace
!= NS_MEDIAWIKI
) { // Just in case
4209 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4210 MediaWikiServices
::getInstance()->getContentLanguage()->lcfirst( $this->getText() )
4212 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4214 if ( $message->exists() ) {
4215 return $message->plain();
4222 * Updates page_touched for this page; called from LinksUpdate.php
4224 * @param string|null $purgeTime [optional] TS_MW timestamp
4225 * @return bool True if the update succeeded
4227 public function invalidateCache( $purgeTime = null ) {
4228 if ( wfReadOnly() ) {
4230 } elseif ( $this->mArticleID
=== 0 ) {
4231 return true; // avoid gap locking if we know it's not there
4234 $dbw = wfGetDB( DB_MASTER
);
4235 $dbw->onTransactionPreCommitOrIdle(
4236 function () use ( $dbw ) {
4237 ResourceLoaderWikiModule
::invalidateModuleCache(
4238 $this, null, null, $dbw->getDomainID() );
4243 $conds = $this->pageCond();
4244 DeferredUpdates
::addUpdate(
4245 new AutoCommitUpdate(
4248 function ( IDatabase
$dbw, $fname ) use ( $conds, $purgeTime ) {
4249 $dbTimestamp = $dbw->timestamp( $purgeTime ?
: time() );
4252 [ 'page_touched' => $dbTimestamp ],
4253 $conds +
[ 'page_touched < ' . $dbw->addQuotes( $dbTimestamp ) ],
4256 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $this );
4259 DeferredUpdates
::PRESEND
4266 * Update page_touched timestamps and send CDN purge messages for
4267 * pages linking to this title. May be sent to the job queue depending
4268 * on the number of links. Typically called on create and delete.
4270 public function touchLinks() {
4271 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this, 'pagelinks', 'page-touch' ) );
4272 if ( $this->mNamespace
== NS_CATEGORY
) {
4273 DeferredUpdates
::addUpdate(
4274 new HTMLCacheUpdate( $this, 'categorylinks', 'category-touch' )
4280 * Get the last touched timestamp
4282 * @param IDatabase|null $db
4283 * @return string|false Last-touched timestamp
4285 public function getTouched( $db = null ) {
4286 if ( $db === null ) {
4287 $db = wfGetDB( DB_REPLICA
);
4289 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4294 * Get the timestamp when this page was updated since the user last saw it.
4296 * @param User|null $user
4297 * @return string|bool|null String timestamp, false if not watched, null if nothing is unseen
4299 public function getNotificationTimestamp( $user = null ) {
4302 // Assume current user if none given
4306 // Check cache first
4307 $uid = $user->getId();
4311 // avoid isset here, as it'll return false for null entries
4312 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4313 return $this->mNotificationTimestamp
[$uid];
4315 // Don't cache too much!
4316 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4317 $this->mNotificationTimestamp
= [];
4320 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
4321 $watchedItem = $store->getWatchedItem( $user, $this );
4322 if ( $watchedItem ) {
4323 $this->mNotificationTimestamp
[$uid] = $watchedItem->getNotificationTimestamp();
4325 $this->mNotificationTimestamp
[$uid] = false;
4328 return $this->mNotificationTimestamp
[$uid];
4332 * Generate strings used for xml 'id' names in monobook tabs
4334 * @param string $prepend Defaults to 'nstab-'
4335 * @return string XML 'id' name
4337 public function getNamespaceKey( $prepend = 'nstab-' ) {
4338 // Gets the subject namespace of this title
4339 $nsInfo = MediaWikiServices
::getInstance()->getNamespaceInfo();
4340 $subjectNS = $nsInfo->getSubject( $this->mNamespace
);
4341 // Prefer canonical namespace name for HTML IDs
4342 $namespaceKey = $nsInfo->getCanonicalName( $subjectNS );
4343 if ( $namespaceKey === false ) {
4344 // Fallback to localised text
4345 $namespaceKey = $this->getSubjectNsText();
4347 // Makes namespace key lowercase
4348 $namespaceKey = MediaWikiServices
::getInstance()->getContentLanguage()->lc( $namespaceKey );
4350 if ( $namespaceKey == '' ) {
4351 $namespaceKey = 'main';
4353 // Changes file to image for backwards compatibility
4354 if ( $namespaceKey == 'file' ) {
4355 $namespaceKey = 'image';
4357 return $prepend . $namespaceKey;
4361 * Get all extant redirects to this Title
4363 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4364 * @return Title[] Array of Title redirects to this title
4366 public function getRedirectsHere( $ns = null ) {
4369 $dbr = wfGetDB( DB_REPLICA
);
4371 'rd_namespace' => $this->mNamespace
,
4372 'rd_title' => $this->mDbkeyform
,
4375 if ( $this->isExternal() ) {
4376 $where['rd_interwiki'] = $this->mInterwiki
;
4378 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4380 if ( !is_null( $ns ) ) {
4381 $where['page_namespace'] = $ns;
4384 $res = $dbr->select(
4385 [ 'redirect', 'page' ],
4386 [ 'page_namespace', 'page_title' ],
4391 foreach ( $res as $row ) {
4392 $redirs[] = self
::newFromRow( $row );
4398 * Check if this Title is a valid redirect target
4402 public function isValidRedirectTarget() {
4403 global $wgInvalidRedirectTargets;
4405 if ( $this->isSpecialPage() ) {
4406 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4407 if ( $this->isSpecial( 'Userlogout' ) ) {
4411 foreach ( $wgInvalidRedirectTargets as $target ) {
4412 if ( $this->isSpecial( $target ) ) {
4422 * Get a backlink cache object
4424 * @return BacklinkCache
4426 public function getBacklinkCache() {
4427 return BacklinkCache
::get( $this );
4431 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4435 public function canUseNoindex() {
4436 global $wgExemptFromUserRobotsControl;
4438 $bannedNamespaces = $wgExemptFromUserRobotsControl ??
4439 MediaWikiServices
::getInstance()->getNamespaceInfo()->getContentNamespaces();
4441 return !in_array( $this->mNamespace
, $bannedNamespaces );
4445 * Returns the raw sort key to be used for categories, with the specified
4446 * prefix. This will be fed to Collation::getSortKey() to get a
4447 * binary sortkey that can be used for actual sorting.
4449 * @param string $prefix The prefix to be used, specified using
4450 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4454 public function getCategorySortkey( $prefix = '' ) {
4455 $unprefixed = $this->getText();
4457 // Anything that uses this hook should only depend
4458 // on the Title object passed in, and should probably
4459 // tell the users to run updateCollations.php --force
4460 // in order to re-sort existing category relations.
4461 Hooks
::run( 'GetDefaultSortkey', [ $this, &$unprefixed ] );
4462 if ( $prefix !== '' ) {
4463 # Separate with a line feed, so the unprefixed part is only used as
4464 # a tiebreaker when two pages have the exact same prefix.
4465 # In UCA, tab is the only character that can sort above LF
4466 # so we strip both of them from the original prefix.
4467 $prefix = strtr( $prefix, "\n\t", ' ' );
4468 return "$prefix\n$unprefixed";
4474 * Returns the page language code saved in the database, if $wgPageLanguageUseDB is set
4475 * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
4476 * the db, it will return NULL.
4478 * @return string|null|bool
4480 private function getDbPageLanguageCode() {
4481 global $wgPageLanguageUseDB;
4483 // check, if the page language could be saved in the database, and if so and
4484 // the value is not requested already, lookup the page language using LinkCache
4485 if ( $wgPageLanguageUseDB && $this->mDbPageLanguage
=== false ) {
4486 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
4487 $linkCache->addLinkObj( $this );
4488 $this->mDbPageLanguage
= $linkCache->getGoodLinkFieldObj( $this, 'lang' );
4491 return $this->mDbPageLanguage
;
4495 * Get the language in which the content of this page is written in
4496 * wikitext. Defaults to content language, but in certain cases it can be
4497 * e.g. $wgLang (such as special pages, which are in the user language).
4502 public function getPageLanguage() {
4503 global $wgLang, $wgLanguageCode;
4504 if ( $this->isSpecialPage() ) {
4505 // special pages are in the user language
4509 // Checking if DB language is set
4510 $dbPageLanguage = $this->getDbPageLanguageCode();
4511 if ( $dbPageLanguage ) {
4512 return wfGetLangObj( $dbPageLanguage );
4515 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
4516 // Note that this may depend on user settings, so the cache should
4517 // be only per-request.
4518 // NOTE: ContentHandler::getPageLanguage() may need to load the
4519 // content to determine the page language!
4520 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4522 $contentHandler = ContentHandler
::getForTitle( $this );
4523 $langObj = $contentHandler->getPageLanguage( $this );
4524 $this->mPageLanguage
= [ $langObj->getCode(), $wgLanguageCode ];
4526 $langObj = Language
::factory( $this->mPageLanguage
[0] );
4533 * Get the language in which the content of this page is written when
4534 * viewed by user. Defaults to content language, but in certain cases it can be
4535 * e.g. $wgLang (such as special pages, which are in the user language).
4540 public function getPageViewLanguage() {
4543 if ( $this->isSpecialPage() ) {
4544 // If the user chooses a variant, the content is actually
4545 // in a language whose code is the variant code.
4546 $variant = $wgLang->getPreferredVariant();
4547 if ( $wgLang->getCode() !== $variant ) {
4548 return Language
::factory( $variant );
4554 // Checking if DB language is set
4555 $dbPageLanguage = $this->getDbPageLanguageCode();
4556 if ( $dbPageLanguage ) {
4557 $pageLang = wfGetLangObj( $dbPageLanguage );
4558 $variant = $pageLang->getPreferredVariant();
4559 if ( $pageLang->getCode() !== $variant ) {
4560 $pageLang = Language
::factory( $variant );
4566 // @note Can't be cached persistently, depends on user settings.
4567 // @note ContentHandler::getPageViewLanguage() may need to load the
4568 // content to determine the page language!
4569 $contentHandler = ContentHandler
::getForTitle( $this );
4570 $pageLang = $contentHandler->getPageViewLanguage( $this );
4575 * Get a list of rendered edit notices for this page.
4577 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4578 * they will already be wrapped in paragraphs.
4581 * @param int $oldid Revision ID that's being edited
4584 public function getEditNotices( $oldid = 0 ) {
4587 // Optional notice for the entire namespace
4588 $editnotice_ns = 'editnotice-' . $this->mNamespace
;
4589 $msg = wfMessage( $editnotice_ns );
4590 if ( $msg->exists() ) {
4591 $html = $msg->parseAsBlock();
4592 // Edit notices may have complex logic, but output nothing (T91715)
4593 if ( trim( $html ) !== '' ) {
4594 $notices[$editnotice_ns] = Html
::rawElement(
4598 'mw-editnotice-namespace',
4599 Sanitizer
::escapeClass( "mw-$editnotice_ns" )
4607 MediaWikiServices
::getInstance()->getNamespaceInfo()->
4608 hasSubpages( $this->mNamespace
)
4610 // Optional notice for page itself and any parent page
4611 $editnotice_base = $editnotice_ns;
4612 foreach ( explode( '/', $this->mDbkeyform
) as $part ) {
4613 $editnotice_base .= '-' . $part;
4614 $msg = wfMessage( $editnotice_base );
4615 if ( $msg->exists() ) {
4616 $html = $msg->parseAsBlock();
4617 if ( trim( $html ) !== '' ) {
4618 $notices[$editnotice_base] = Html
::rawElement(
4622 'mw-editnotice-base',
4623 Sanitizer
::escapeClass( "mw-$editnotice_base" )
4631 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
4632 $editnoticeText = $editnotice_ns . '-' . strtr( $this->mDbkeyform
, '/', '-' );
4633 $msg = wfMessage( $editnoticeText );
4634 if ( $msg->exists() ) {
4635 $html = $msg->parseAsBlock();
4636 if ( trim( $html ) !== '' ) {
4637 $notices[$editnoticeText] = Html
::rawElement(
4641 'mw-editnotice-page',
4642 Sanitizer
::escapeClass( "mw-$editnoticeText" )
4650 Hooks
::run( 'TitleGetEditNotices', [ $this, $oldid, &$notices ] );
4655 * @param int $flags Bitfield of class READ_* constants
4656 * @return string|bool
4658 private function loadFieldFromDB( $field, $flags ) {
4659 if ( !in_array( $field, self
::getSelectFields(), true ) ) {
4660 return false; // field does not exist
4663 $flags |
= ( $flags & self
::GAID_FOR_UPDATE
) ? self
::READ_LATEST
: 0; // b/c
4664 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
4666 return wfGetDB( $index )->selectField(
4678 public function __sleep() {
4686 'mDefaultNamespace',
4690 public function __wakeup() {
4691 $this->mArticleID
= ( $this->mNamespace
>= 0 ) ?
-1 : 0;
4692 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
4693 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );