3 * Representation of a title within %MediaWiki.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
25 use Wikimedia\Rdbms\Database
;
26 use Wikimedia\Rdbms\IDatabase
;
27 use MediaWiki\Linker\LinkTarget
;
28 use MediaWiki\Interwiki\InterwikiLookup
;
29 use MediaWiki\MediaWikiServices
;
32 * Represents a title within MediaWiki.
33 * Optionally may contain an interwiki designation or namespace.
34 * @note This class can fetch various kinds of data from the database;
35 * however, it does so inefficiently.
36 * @note Consider using a TitleValue object instead. TitleValue is more lightweight
37 * and does not rely on global state or the database.
39 class Title
implements LinkTarget
{
40 /** @var MapCacheLRU */
41 static private $titleCache = null;
44 * Title::newFromText maintains a cache to avoid expensive re-normalization of
45 * commonly used titles. On a batch operation this can become a memory leak
46 * if not bounded. After hitting this many titles reset the cache.
48 const CACHE_MAX
= 1000;
51 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
52 * to use the master DB
54 const GAID_FOR_UPDATE
= 1;
57 * @name Private member variables
58 * Please use the accessor functions instead.
63 /** @var string Text form (spaces not underscores) of the main part */
64 public $mTextform = '';
66 /** @var string URL-encoded form of the main part */
67 public $mUrlform = '';
69 /** @var string Main part with underscores */
70 public $mDbkeyform = '';
72 /** @var string Database key with the initial letter in the case specified by the user */
73 protected $mUserCaseDBKey;
75 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
76 public $mNamespace = NS_MAIN
;
78 /** @var string Interwiki prefix */
79 public $mInterwiki = '';
81 /** @var bool Was this Title created from a string with a local interwiki prefix? */
82 private $mLocalInterwiki = false;
84 /** @var string Title fragment (i.e. the bit after the #) */
85 public $mFragment = '';
87 /** @var int Article ID, fetched from the link cache on demand */
88 public $mArticleID = -1;
90 /** @var bool|int ID of most recent revision */
91 protected $mLatestID = false;
94 * @var bool|string ID of the page's content model, i.e. one of the
95 * CONTENT_MODEL_XXX constants
97 private $mContentModel = false;
100 * @var bool If a content model was forced via setContentModel()
101 * this will be true to avoid having other code paths reset it
103 private $mForcedContentModel = false;
105 /** @var int Estimated number of revisions; null of not loaded */
106 private $mEstimateRevisions;
108 /** @var array Array of groups allowed to edit this article */
109 public $mRestrictions = [];
112 * @var string|bool Comma-separated set of permission keys
113 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
114 * Edit and move sections are separated by a colon
115 * Example: "edit=autoconfirmed,sysop:move=sysop"
117 protected $mOldRestrictions = false;
119 /** @var bool Cascade restrictions on this page to included templates and images? */
120 public $mCascadeRestriction;
122 /** Caching the results of getCascadeProtectionSources */
123 public $mCascadingRestrictions;
125 /** @var array When do the restrictions on this page expire? */
126 protected $mRestrictionsExpiry = [];
128 /** @var bool Are cascading restrictions in effect on this page? */
129 protected $mHasCascadingRestrictions;
131 /** @var array Where are the cascading restrictions coming from on this page? */
132 public $mCascadeSources;
134 /** @var bool Boolean for initialisation on demand */
135 public $mRestrictionsLoaded = false;
138 * Text form including namespace/interwiki, initialised on demand
140 * Only public to share cache with TitleFormatter
145 public $prefixedText = null;
147 /** @var mixed Cached value for getTitleProtection (create protection) */
148 public $mTitleProtection;
151 * @var int Namespace index when there is no namespace. Don't change the
152 * following default, NS_MAIN is hardcoded in several places. See T2696.
153 * Zero except in {{transclusion}} tags.
155 public $mDefaultNamespace = NS_MAIN
;
157 /** @var int The page length, 0 for special pages */
158 protected $mLength = -1;
160 /** @var null Is the article at this title a redirect? */
161 public $mRedirect = null;
163 /** @var array Associative array of user ID -> timestamp/false */
164 private $mNotificationTimestamp = [];
166 /** @var bool Whether a page has any subpages */
167 private $mHasSubpages;
169 /** @var bool The (string) language code of the page's language and content code. */
170 private $mPageLanguage = false;
172 /** @var string|bool|null The page language code from the database, null if not saved in
173 * the database or false if not loaded, yet. */
174 private $mDbPageLanguage = false;
176 /** @var TitleValue A corresponding TitleValue object */
177 private $mTitleValue = null;
179 /** @var bool Would deleting this page be a big deletion? */
180 private $mIsBigDeletion = null;
184 * B/C kludge: provide a TitleParser for use by Title.
185 * Ideally, Title would have no methods that need this.
186 * Avoid usage of this singleton by using TitleValue
187 * and the associated services when possible.
189 * @return TitleFormatter
191 private static function getTitleFormatter() {
192 return MediaWikiServices
::getInstance()->getTitleFormatter();
196 * B/C kludge: provide an InterwikiLookup for use by Title.
197 * Ideally, Title would have no methods that need this.
198 * Avoid usage of this singleton by using TitleValue
199 * and the associated services when possible.
201 * @return InterwikiLookup
203 private static function getInterwikiLookup() {
204 return MediaWikiServices
::getInstance()->getInterwikiLookup();
210 function __construct() {
214 * Create a new Title from a prefixed DB key
216 * @param string $key The database key, which has underscores
217 * instead of spaces, possibly including namespace and
219 * @return Title|null Title, or null on an error
221 public static function newFromDBkey( $key ) {
223 $t->mDbkeyform
= $key;
226 $t->secureAndSplit();
228 } catch ( MalformedTitleException
$ex ) {
234 * Create a new Title from a TitleValue
236 * @param TitleValue $titleValue Assumed to be safe.
240 public static function newFromTitleValue( TitleValue
$titleValue ) {
241 return self
::newFromLinkTarget( $titleValue );
245 * Create a new Title from a LinkTarget
247 * @param LinkTarget $linkTarget Assumed to be safe.
251 public static function newFromLinkTarget( LinkTarget
$linkTarget ) {
252 if ( $linkTarget instanceof Title
) {
253 // Special case if it's already a Title object
256 return self
::makeTitle(
257 $linkTarget->getNamespace(),
258 $linkTarget->getText(),
259 $linkTarget->getFragment(),
260 $linkTarget->getInterwiki()
265 * Create a new Title from text, such as what one would find in a link. De-
266 * codes any HTML entities in the text.
268 * Title objects returned by this method are guaranteed to be valid, and
269 * thus return true from the isValid() method.
271 * @param string|int|null $text The link text; spaces, prefixes, and an
272 * initial ':' indicating the main namespace are accepted.
273 * @param int $defaultNamespace The namespace to use if none is specified
274 * by a prefix. If you want to force a specific namespace even if
275 * $text might begin with a namespace prefix, use makeTitle() or
277 * @throws InvalidArgumentException
278 * @return Title|null Title or null on an error.
280 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
281 // DWIM: Integers can be passed in here when page titles are used as array keys.
282 if ( $text !== null && !is_string( $text ) && !is_int( $text ) ) {
283 throw new InvalidArgumentException( '$text must be a string.' );
285 if ( $text === null ) {
290 return self
::newFromTextThrow( strval( $text ), $defaultNamespace );
291 } catch ( MalformedTitleException
$ex ) {
297 * Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,
298 * rather than returning null.
300 * The exception subclasses encode detailed information about why the title is invalid.
302 * Title objects returned by this method are guaranteed to be valid, and
303 * thus return true from the isValid() method.
305 * @see Title::newFromText
308 * @param string $text Title text to check
309 * @param int $defaultNamespace
310 * @throws MalformedTitleException If the title is invalid
313 public static function newFromTextThrow( $text, $defaultNamespace = NS_MAIN
) {
314 if ( is_object( $text ) ) {
315 throw new MWException( '$text must be a string, given an object' );
316 } elseif ( $text === null ) {
317 // Legacy code relies on MalformedTitleException being thrown in this case
318 // (happens when URL with no title in it is parsed). TODO fix
319 throw new MalformedTitleException( 'title-invalid-empty' );
322 $titleCache = self
::getTitleCache();
324 // Wiki pages often contain multiple links to the same page.
325 // Title normalization and parsing can become expensive on pages with many
326 // links, so we can save a little time by caching them.
327 // In theory these are value objects and won't get changed...
328 if ( $defaultNamespace == NS_MAIN
) {
329 $t = $titleCache->get( $text );
335 // Convert things like é ā or 〗 into normalized (T16952) text
336 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
339 $t->mDbkeyform
= strtr( $filteredText, ' ', '_' );
340 $t->mDefaultNamespace
= intval( $defaultNamespace );
342 $t->secureAndSplit();
343 if ( $defaultNamespace == NS_MAIN
) {
344 $titleCache->set( $text, $t );
350 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
352 * Example of wrong and broken code:
353 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
355 * Example of right code:
356 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
358 * Create a new Title from URL-encoded text. Ensures that
359 * the given title's length does not exceed the maximum.
361 * @param string $url The title, as might be taken from a URL
362 * @return Title|null The new object, or null on an error
364 public static function newFromURL( $url ) {
367 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
368 # but some URLs used it as a space replacement and they still come
369 # from some external search tools.
370 if ( strpos( self
::legalChars(), '+' ) === false ) {
371 $url = strtr( $url, '+', ' ' );
374 $t->mDbkeyform
= strtr( $url, ' ', '_' );
377 $t->secureAndSplit();
379 } catch ( MalformedTitleException
$ex ) {
385 * @return MapCacheLRU
387 private static function getTitleCache() {
388 if ( self
::$titleCache == null ) {
389 self
::$titleCache = new MapCacheLRU( self
::CACHE_MAX
);
391 return self
::$titleCache;
395 * Returns a list of fields that are to be selected for initializing Title
396 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
397 * whether to include page_content_model.
401 protected static function getSelectFields() {
402 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
405 'page_namespace', 'page_title', 'page_id',
406 'page_len', 'page_is_redirect', 'page_latest',
409 if ( $wgContentHandlerUseDB ) {
410 $fields[] = 'page_content_model';
413 if ( $wgPageLanguageUseDB ) {
414 $fields[] = 'page_lang';
421 * Create a new Title from an article ID
423 * @param int $id The page_id corresponding to the Title to create
424 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
425 * @return Title|null The new object, or null on an error
427 public static function newFromID( $id, $flags = 0 ) {
428 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
429 $row = $db->selectRow(
431 self
::getSelectFields(),
432 [ 'page_id' => $id ],
435 if ( $row !== false ) {
436 $title = self
::newFromRow( $row );
444 * Make an array of titles from an array of IDs
446 * @param int[] $ids Array of IDs
447 * @return Title[] Array of Titles
449 public static function newFromIDs( $ids ) {
450 if ( !count( $ids ) ) {
453 $dbr = wfGetDB( DB_REPLICA
);
457 self
::getSelectFields(),
458 [ 'page_id' => $ids ],
463 foreach ( $res as $row ) {
464 $titles[] = self
::newFromRow( $row );
470 * Make a Title object from a DB row
472 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
473 * @return Title Corresponding Title
475 public static function newFromRow( $row ) {
476 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
477 $t->loadFromRow( $row );
482 * Load Title object fields from a DB row.
483 * If false is given, the title will be treated as non-existing.
485 * @param stdClass|bool $row Database row
487 public function loadFromRow( $row ) {
488 if ( $row ) { // page found
489 if ( isset( $row->page_id
) ) {
490 $this->mArticleID
= (int)$row->page_id
;
492 if ( isset( $row->page_len
) ) {
493 $this->mLength
= (int)$row->page_len
;
495 if ( isset( $row->page_is_redirect
) ) {
496 $this->mRedirect
= (bool)$row->page_is_redirect
;
498 if ( isset( $row->page_latest
) ) {
499 $this->mLatestID
= (int)$row->page_latest
;
501 if ( !$this->mForcedContentModel
&& isset( $row->page_content_model
) ) {
502 $this->mContentModel
= strval( $row->page_content_model
);
503 } elseif ( !$this->mForcedContentModel
) {
504 $this->mContentModel
= false; # initialized lazily in getContentModel()
506 if ( isset( $row->page_lang
) ) {
507 $this->mDbPageLanguage
= (string)$row->page_lang
;
509 if ( isset( $row->page_restrictions
) ) {
510 $this->mOldRestrictions
= $row->page_restrictions
;
512 } else { // page not found
513 $this->mArticleID
= 0;
515 $this->mRedirect
= false;
516 $this->mLatestID
= 0;
517 if ( !$this->mForcedContentModel
) {
518 $this->mContentModel
= false; # initialized lazily in getContentModel()
524 * Create a new Title from a namespace index and a DB key.
526 * It's assumed that $ns and $title are safe, for instance when
527 * they came directly from the database or a special page name,
528 * not from user input.
530 * No validation is applied. For convenience, spaces are normalized
531 * to underscores, so that e.g. user_text fields can be used directly.
533 * @note This method may return Title objects that are "invalid"
534 * according to the isValid() method. This is usually caused by
535 * configuration changes: e.g. a namespace that was once defined is
536 * no longer configured, or a character that was once allowed in
537 * titles is now forbidden.
539 * @param int $ns The namespace of the article
540 * @param string $title The unprefixed database key form
541 * @param string $fragment The link fragment (after the "#")
542 * @param string $interwiki The interwiki prefix
543 * @return Title The new object
545 public static function makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
547 $t->mInterwiki
= $interwiki;
548 $t->mFragment
= $fragment;
549 $t->mNamespace
= $ns = intval( $ns );
550 $t->mDbkeyform
= strtr( $title, ' ', '_' );
551 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
552 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
553 $t->mTextform
= strtr( $title, '_', ' ' );
554 $t->mContentModel
= false; # initialized lazily in getContentModel()
559 * Create a new Title from a namespace index and a DB key.
560 * The parameters will be checked for validity, which is a bit slower
561 * than makeTitle() but safer for user-provided data.
563 * Title objects returned by makeTitleSafe() are guaranteed to be valid,
564 * that is, they return true from the isValid() method. If no valid Title
565 * can be constructed from the input, this method returns null.
567 * @param int $ns The namespace of the article
568 * @param string $title Database key form
569 * @param string $fragment The link fragment (after the "#")
570 * @param string $interwiki Interwiki prefix
571 * @return Title|null The new object, or null on an error
573 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
574 // NOTE: ideally, this would just call makeTitle() and then isValid(),
575 // but presently, that means more overhead on a potential performance hotspot.
577 if ( !MWNamespace
::exists( $ns ) ) {
582 $t->mDbkeyform
= self
::makeName( $ns, $title, $fragment, $interwiki, true );
585 $t->secureAndSplit();
587 } catch ( MalformedTitleException
$ex ) {
593 * Create a new Title for the Main Page
595 * @return Title The new object
597 public static function newMainPage() {
598 $title = self
::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
599 // Don't give fatal errors if the message is broken
601 $title = self
::newFromText( 'Main Page' );
607 * Get the prefixed DB key associated with an ID
609 * @param int $id The page_id of the article
610 * @return Title|null An object representing the article, or null if no such article was found
612 public static function nameOf( $id ) {
613 $dbr = wfGetDB( DB_REPLICA
);
615 $s = $dbr->selectRow(
617 [ 'page_namespace', 'page_title' ],
618 [ 'page_id' => $id ],
621 if ( $s === false ) {
625 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
630 * Get a regex character class describing the legal characters in a link
632 * @return string The list of characters, not delimited
634 public static function legalChars() {
635 global $wgLegalTitleChars;
636 return $wgLegalTitleChars;
640 * Utility method for converting a character sequence from bytes to Unicode.
642 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
643 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
645 * @param string $byteClass
648 public static function convertByteClassToUnicodeClass( $byteClass ) {
649 $length = strlen( $byteClass );
651 $x0 = $x1 = $x2 = '';
653 $d0 = $d1 = $d2 = '';
654 // Decoded integer codepoints
655 $ord0 = $ord1 = $ord2 = 0;
657 $r0 = $r1 = $r2 = '';
661 $allowUnicode = false;
662 for ( $pos = 0; $pos < $length; $pos++
) {
663 // Shift the queues down
672 // Load the current input token and decoded values
673 $inChar = $byteClass[$pos];
674 if ( $inChar == '\\' ) {
675 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
676 $x0 = $inChar . $m[0];
677 $d0 = chr( hexdec( $m[1] ) );
678 $pos +
= strlen( $m[0] );
679 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
680 $x0 = $inChar . $m[0];
681 $d0 = chr( octdec( $m[0] ) );
682 $pos +
= strlen( $m[0] );
683 } elseif ( $pos +
1 >= $length ) {
686 $d0 = $byteClass[$pos +
1];
694 // Load the current re-encoded value
695 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
696 $r0 = sprintf( '\x%02x', $ord0 );
697 } elseif ( $ord0 >= 0x80 ) {
698 // Allow unicode if a single high-bit character appears
699 $r0 = sprintf( '\x%02x', $ord0 );
700 $allowUnicode = true;
701 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
707 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
709 if ( $ord2 > $ord0 ) {
711 } elseif ( $ord0 >= 0x80 ) {
713 $allowUnicode = true;
714 if ( $ord2 < 0x80 ) {
715 // Keep the non-unicode section of the range
722 // Reset state to the initial value
723 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
724 } elseif ( $ord2 < 0x80 ) {
729 if ( $ord1 < 0x80 ) {
732 if ( $ord0 < 0x80 ) {
735 if ( $allowUnicode ) {
736 $out .= '\u0080-\uFFFF';
742 * Make a prefixed DB key from a DB key and a namespace index
744 * @param int $ns Numerical representation of the namespace
745 * @param string $title The DB key form the title
746 * @param string $fragment The link fragment (after the "#")
747 * @param string $interwiki The interwiki prefix
748 * @param bool $canonicalNamespace If true, use the canonical name for
749 * $ns instead of the localized version.
750 * @return string The prefixed form of the title
752 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
753 $canonicalNamespace = false
755 if ( $canonicalNamespace ) {
756 $namespace = MWNamespace
::getCanonicalName( $ns );
758 $namespace = MediaWikiServices
::getInstance()->getContentLanguage()->getNsText( $ns );
760 $name = $namespace == '' ?
$title : "$namespace:$title";
761 if ( strval( $interwiki ) != '' ) {
762 $name = "$interwiki:$name";
764 if ( strval( $fragment ) != '' ) {
765 $name .= '#' . $fragment;
771 * Escape a text fragment, say from a link, for a URL
773 * @deprecated since 1.30, use Sanitizer::escapeIdForLink() or escapeIdForExternalInterwiki()
775 * @param string $fragment Containing a URL or link fragment (after the "#")
776 * @return string Escaped string
778 static function escapeFragmentForURL( $fragment ) {
779 wfDeprecated( __METHOD__
, '1.30' );
780 # Note that we don't urlencode the fragment. urlencoded Unicode
781 # fragments appear not to work in IE (at least up to 7) or in at least
782 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
783 # to care if they aren't encoded.
784 return Sanitizer
::escapeId( $fragment, 'noninitial' );
788 * Callback for usort() to do title sorts by (namespace, title)
790 * @param LinkTarget $a
791 * @param LinkTarget $b
793 * @return int Result of string comparison, or namespace comparison
795 public static function compare( LinkTarget
$a, LinkTarget
$b ) {
796 return $a->getNamespace() <=> $b->getNamespace()
797 ?
: strcmp( $a->getText(), $b->getText() );
801 * Returns true if the title is valid, false if it is invalid.
803 * Valid titles can be round-tripped via makeTitleSafe() and newFromText().
804 * Invalid titles may get returned from makeTitle(), and it may be useful to
805 * allow them to exist, e.g. in order to process log entries about pages in
806 * namespaces that belong to extensions that are no longer installed.
808 * @note This method is relatively expensive. When constructing Title
809 * objects that need to be valid, use an instantiator method that is guaranteed
810 * to return valid titles, such as makeTitleSafe() or newFromText().
814 public function isValid() {
815 if ( !MWNamespace
::exists( $this->mNamespace
) ) {
820 $parser = MediaWikiServices
::getInstance()->getTitleParser();
821 $parser->parseTitle( $this->mDbkeyform
, $this->mNamespace
);
823 } catch ( MalformedTitleException
$ex ) {
829 * Determine whether the object refers to a page within
830 * this project (either this wiki or a wiki with a local
831 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
833 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
835 public function isLocal() {
836 if ( $this->isExternal() ) {
837 $iw = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
839 return $iw->isLocal();
846 * Is this Title interwiki?
850 public function isExternal() {
851 return $this->mInterwiki
!== '';
855 * Get the interwiki prefix
857 * Use Title::isExternal to check if a interwiki is set
859 * @return string Interwiki prefix
861 public function getInterwiki() {
862 return $this->mInterwiki
;
866 * Was this a local interwiki link?
870 public function wasLocalInterwiki() {
871 return $this->mLocalInterwiki
;
875 * Determine whether the object refers to a page within
876 * this project and is transcludable.
878 * @return bool True if this is transcludable
880 public function isTrans() {
881 if ( !$this->isExternal() ) {
885 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->isTranscludable();
889 * Returns the DB name of the distant wiki which owns the object.
891 * @return string|false The DB name
893 public function getTransWikiID() {
894 if ( !$this->isExternal() ) {
898 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->getWikiID();
902 * Get a TitleValue object representing this Title.
904 * @note Not all valid Titles have a corresponding valid TitleValue
905 * (e.g. TitleValues cannot represent page-local links that have a
906 * fragment but no title text).
908 * @return TitleValue|null
910 public function getTitleValue() {
911 if ( $this->mTitleValue
=== null ) {
913 $this->mTitleValue
= new TitleValue(
919 } catch ( InvalidArgumentException
$ex ) {
920 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
921 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
925 return $this->mTitleValue
;
929 * Get the text form (spaces not underscores) of the main part
931 * @return string Main part of the title
933 public function getText() {
934 return $this->mTextform
;
938 * Get the URL-encoded form of the main part
940 * @return string Main part of the title, URL-encoded
942 public function getPartialURL() {
943 return $this->mUrlform
;
947 * Get the main part with underscores
949 * @return string Main part of the title, with underscores
951 public function getDBkey() {
952 return $this->mDbkeyform
;
956 * Get the DB key with the initial letter case as specified by the user
958 * @return string DB key
960 function getUserCaseDBKey() {
961 if ( !is_null( $this->mUserCaseDBKey
) ) {
962 return $this->mUserCaseDBKey
;
964 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
965 return $this->mDbkeyform
;
970 * Get the namespace index, i.e. one of the NS_xxxx constants.
972 * @return int Namespace index
974 public function getNamespace() {
975 return $this->mNamespace
;
979 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
981 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
982 * @return string Content model id
984 public function getContentModel( $flags = 0 ) {
985 if ( !$this->mForcedContentModel
986 && ( !$this->mContentModel ||
$flags === self
::GAID_FOR_UPDATE
)
987 && $this->getArticleID( $flags )
989 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
990 $linkCache->addLinkObj( $this ); # in case we already had an article ID
991 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
994 if ( !$this->mContentModel
) {
995 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
998 return $this->mContentModel
;
1002 * Convenience method for checking a title's content model name
1004 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
1005 * @return bool True if $this->getContentModel() == $id
1007 public function hasContentModel( $id ) {
1008 return $this->getContentModel() == $id;
1012 * Set a proposed content model for the page for permissions
1013 * checking. This does not actually change the content model
1016 * Additionally, you should make sure you've checked
1017 * ContentHandler::canBeUsedOn() first.
1020 * @param string $model CONTENT_MODEL_XXX constant
1022 public function setContentModel( $model ) {
1023 $this->mContentModel
= $model;
1024 $this->mForcedContentModel
= true;
1028 * Get the namespace text
1030 * @return string|false Namespace text
1032 public function getNsText() {
1033 if ( $this->isExternal() ) {
1034 // This probably shouldn't even happen, except for interwiki transclusion.
1035 // If possible, use the canonical name for the foreign namespace.
1036 $nsText = MWNamespace
::getCanonicalName( $this->mNamespace
);
1037 if ( $nsText !== false ) {
1043 $formatter = self
::getTitleFormatter();
1044 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
1045 } catch ( InvalidArgumentException
$ex ) {
1046 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
1052 * Get the namespace text of the subject (rather than talk) page
1054 * @return string Namespace text
1056 public function getSubjectNsText() {
1057 return MediaWikiServices
::getInstance()->getContentLanguage()->
1058 getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
1062 * Get the namespace text of the talk page
1064 * @return string Namespace text
1066 public function getTalkNsText() {
1067 return MediaWikiServices
::getInstance()->getContentLanguage()->
1068 getNsText( MWNamespace
::getTalk( $this->mNamespace
) );
1072 * Can this title have a corresponding talk page?
1074 * @deprecated since 1.30, use canHaveTalkPage() instead.
1076 * @return bool True if this title either is a talk page or can have a talk page associated.
1078 public function canTalk() {
1079 return $this->canHaveTalkPage();
1083 * Can this title have a corresponding talk page?
1085 * @see MWNamespace::hasTalkNamespace
1088 * @return bool True if this title either is a talk page or can have a talk page associated.
1090 public function canHaveTalkPage() {
1091 return MWNamespace
::hasTalkNamespace( $this->mNamespace
);
1095 * Is this in a namespace that allows actual pages?
1099 public function canExist() {
1100 return $this->mNamespace
>= NS_MAIN
;
1104 * Can this title be added to a user's watchlist?
1108 public function isWatchable() {
1109 return !$this->isExternal() && MWNamespace
::isWatchable( $this->mNamespace
);
1113 * Returns true if this is a special page.
1117 public function isSpecialPage() {
1118 return $this->mNamespace
== NS_SPECIAL
;
1122 * Returns true if this title resolves to the named special page
1124 * @param string $name The special page name
1127 public function isSpecial( $name ) {
1128 if ( $this->isSpecialPage() ) {
1129 list( $thisName, /* $subpage */ ) =
1130 MediaWikiServices
::getInstance()->getSpecialPageFactory()->
1131 resolveAlias( $this->mDbkeyform
);
1132 if ( $name == $thisName ) {
1140 * If the Title refers to a special page alias which is not the local default, resolve
1141 * the alias, and localise the name as necessary. Otherwise, return $this
1145 public function fixSpecialName() {
1146 if ( $this->isSpecialPage() ) {
1147 $spFactory = MediaWikiServices
::getInstance()->getSpecialPageFactory();
1148 list( $canonicalName, $par ) = $spFactory->resolveAlias( $this->mDbkeyform
);
1149 if ( $canonicalName ) {
1150 $localName = $spFactory->getLocalNameFor( $canonicalName, $par );
1151 if ( $localName != $this->mDbkeyform
) {
1152 return self
::makeTitle( NS_SPECIAL
, $localName );
1160 * Returns true if the title is inside the specified namespace.
1162 * Please make use of this instead of comparing to getNamespace()
1163 * This function is much more resistant to changes we may make
1164 * to namespaces than code that makes direct comparisons.
1165 * @param int $ns The namespace
1169 public function inNamespace( $ns ) {
1170 return MWNamespace
::equals( $this->mNamespace
, $ns );
1174 * Returns true if the title is inside one of the specified namespaces.
1176 * @param int|int[] $namespaces,... The namespaces to check for
1180 public function inNamespaces( /* ... */ ) {
1181 $namespaces = func_get_args();
1182 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1183 $namespaces = $namespaces[0];
1186 foreach ( $namespaces as $ns ) {
1187 if ( $this->inNamespace( $ns ) ) {
1196 * Returns true if the title has the same subject namespace as the
1197 * namespace specified.
1198 * For example this method will take NS_USER and return true if namespace
1199 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1200 * as their subject namespace.
1202 * This is MUCH simpler than individually testing for equivalence
1203 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1208 public function hasSubjectNamespace( $ns ) {
1209 return MWNamespace
::subjectEquals( $this->mNamespace
, $ns );
1213 * Is this Title in a namespace which contains content?
1214 * In other words, is this a content page, for the purposes of calculating
1219 public function isContentPage() {
1220 return MWNamespace
::isContent( $this->mNamespace
);
1224 * Would anybody with sufficient privileges be able to move this page?
1225 * Some pages just aren't movable.
1229 public function isMovable() {
1230 if ( !MWNamespace
::isMovable( $this->mNamespace
) ||
$this->isExternal() ) {
1231 // Interwiki title or immovable namespace. Hooks don't get to override here
1236 Hooks
::run( 'TitleIsMovable', [ $this, &$result ] );
1241 * Is this the mainpage?
1242 * @note Title::newFromText seems to be sufficiently optimized by the title
1243 * cache that we don't need to over-optimize by doing direct comparisons and
1244 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1245 * ends up reporting something differently than $title->isMainPage();
1250 public function isMainPage() {
1251 return $this->equals( self
::newMainPage() );
1255 * Is this a subpage?
1259 public function isSubpage() {
1260 return MWNamespace
::hasSubpages( $this->mNamespace
)
1261 ?
strpos( $this->getText(), '/' ) !== false
1266 * Is this a conversion table for the LanguageConverter?
1270 public function isConversionTable() {
1271 // @todo ConversionTable should become a separate content model.
1273 return $this->mNamespace
== NS_MEDIAWIKI
&&
1274 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1278 * Does that page contain wikitext, or it is JS, CSS or whatever?
1282 public function isWikitextPage() {
1283 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1287 * Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the
1288 * global UI. This is generally true for pages in the MediaWiki namespace having
1289 * CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
1291 * This method does *not* return true for per-user JS/JSON/CSS. Use isUserConfigPage()
1294 * Note that this method should not return true for pages that contain and show
1295 * "inactive" CSS, JSON, or JS.
1300 public function isSiteConfigPage() {
1302 $this->isSiteCssConfigPage()
1303 ||
$this->isSiteJsonConfigPage()
1304 ||
$this->isSiteJsConfigPage()
1310 * @deprecated Since 1.31; use ::isSiteConfigPage() instead (which also checks for JSON pages)
1312 public function isCssOrJsPage() {
1313 wfDeprecated( __METHOD__
, '1.31' );
1314 return ( NS_MEDIAWIKI
== $this->mNamespace
1315 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1316 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
1320 * Is this a "config" (.css, .json, or .js) sub-page of a user page?
1325 public function isUserConfigPage() {
1327 $this->isUserCssConfigPage()
1328 ||
$this->isUserJsonConfigPage()
1329 ||
$this->isUserJsConfigPage()
1335 * @deprecated Since 1.31; use ::isUserConfigPage() instead (which also checks for JSON pages)
1337 public function isCssJsSubpage() {
1338 wfDeprecated( __METHOD__
, '1.31' );
1339 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1340 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1341 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
1345 * Trim down a .css, .json, or .js subpage title to get the corresponding skin name
1347 * @return string Containing skin name from .css, .json, or .js subpage title
1350 public function getSkinFromConfigSubpage() {
1351 $subpage = explode( '/', $this->mTextform
);
1352 $subpage = $subpage[count( $subpage ) - 1];
1353 $lastdot = strrpos( $subpage, '.' );
1354 if ( $lastdot === false ) {
1355 return $subpage; # Never happens: only called for names ending in '.css'/'.json'/'.js'
1357 return substr( $subpage, 0, $lastdot );
1361 * @deprecated Since 1.31; use ::getSkinFromConfigSubpage() instead
1362 * @return string Containing skin name from .css, .json, or .js subpage title
1364 public function getSkinFromCssJsSubpage() {
1365 wfDeprecated( __METHOD__
, '1.31' );
1366 return $this->getSkinFromConfigSubpage();
1370 * Is this a CSS "config" sub-page of a user page?
1375 public function isUserCssConfigPage() {
1377 NS_USER
== $this->mNamespace
1378 && $this->isSubpage()
1379 && $this->hasContentModel( CONTENT_MODEL_CSS
)
1384 * @deprecated Since 1.31; use ::isUserCssConfigPage()
1387 public function isCssSubpage() {
1388 wfDeprecated( __METHOD__
, '1.31' );
1389 return $this->isUserCssConfigPage();
1393 * Is this a JSON "config" sub-page of a user page?
1398 public function isUserJsonConfigPage() {
1400 NS_USER
== $this->mNamespace
1401 && $this->isSubpage()
1402 && $this->hasContentModel( CONTENT_MODEL_JSON
)
1407 * Is this a JS "config" sub-page of a user page?
1412 public function isUserJsConfigPage() {
1414 NS_USER
== $this->mNamespace
1415 && $this->isSubpage()
1416 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1421 * @deprecated Since 1.31; use ::isUserJsConfigPage()
1424 public function isJsSubpage() {
1425 wfDeprecated( __METHOD__
, '1.31' );
1426 return $this->isUserJsConfigPage();
1430 * Is this a sitewide CSS "config" page?
1435 public function isSiteCssConfigPage() {
1437 NS_MEDIAWIKI
== $this->mNamespace
1439 $this->hasContentModel( CONTENT_MODEL_CSS
)
1440 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1441 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1442 ||
substr( $this->mDbkeyform
, -4 ) === '.css'
1448 * Is this a sitewide JSON "config" page?
1453 public function isSiteJsonConfigPage() {
1455 NS_MEDIAWIKI
== $this->mNamespace
1457 $this->hasContentModel( CONTENT_MODEL_JSON
)
1458 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1459 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1460 ||
substr( $this->mDbkeyform
, -5 ) === '.json'
1466 * Is this a sitewide JS "config" page?
1471 public function isSiteJsConfigPage() {
1473 NS_MEDIAWIKI
== $this->mNamespace
1475 $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1476 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1477 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1478 ||
substr( $this->mDbkeyform
, -3 ) === '.js'
1484 * Is this a message which can contain raw HTML?
1489 public function isRawHtmlMessage() {
1490 global $wgRawHtmlMessages;
1492 if ( !$this->inNamespace( NS_MEDIAWIKI
) ) {
1495 $message = lcfirst( $this->getRootTitle()->getDBkey() );
1496 return in_array( $message, $wgRawHtmlMessages, true );
1500 * Is this a talk page of some sort?
1504 public function isTalkPage() {
1505 return MWNamespace
::isTalk( $this->mNamespace
);
1509 * Get a Title object associated with the talk page of this article
1511 * @return Title The object for the talk page
1513 public function getTalkPage() {
1514 return self
::makeTitle( MWNamespace
::getTalk( $this->mNamespace
), $this->mDbkeyform
);
1518 * Get a Title object associated with the talk page of this article,
1519 * if such a talk page can exist.
1523 * @return Title|null The object for the talk page,
1524 * or null if no associated talk page can exist, according to canHaveTalkPage().
1526 public function getTalkPageIfDefined() {
1527 if ( !$this->canHaveTalkPage() ) {
1531 return $this->getTalkPage();
1535 * Get a title object associated with the subject page of this
1538 * @return Title The object for the subject page
1540 public function getSubjectPage() {
1541 // Is this the same title?
1542 $subjectNS = MWNamespace
::getSubject( $this->mNamespace
);
1543 if ( $this->mNamespace
== $subjectNS ) {
1546 return self
::makeTitle( $subjectNS, $this->mDbkeyform
);
1550 * Get the other title for this page, if this is a subject page
1551 * get the talk page, if it is a subject page get the talk page
1554 * @throws MWException If the page doesn't have an other page
1557 public function getOtherPage() {
1558 if ( $this->isSpecialPage() ) {
1559 throw new MWException( 'Special pages cannot have other pages' );
1561 if ( $this->isTalkPage() ) {
1562 return $this->getSubjectPage();
1564 if ( !$this->canHaveTalkPage() ) {
1565 throw new MWException( "{$this->getPrefixedText()} does not have an other page" );
1567 return $this->getTalkPage();
1572 * Get the default namespace index, for when there is no namespace
1574 * @return int Default namespace index
1576 public function getDefaultNamespace() {
1577 return $this->mDefaultNamespace
;
1581 * Get the Title fragment (i.e.\ the bit after the #) in text form
1583 * Use Title::hasFragment to check for a fragment
1585 * @return string Title fragment
1587 public function getFragment() {
1588 return $this->mFragment
;
1592 * Check if a Title fragment is set
1597 public function hasFragment() {
1598 return $this->mFragment
!== '';
1602 * Get the fragment in URL form, including the "#" character if there is one
1604 * @return string Fragment in URL form
1606 public function getFragmentForURL() {
1607 if ( !$this->hasFragment() ) {
1609 } elseif ( $this->isExternal()
1610 && !self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->isLocal()
1612 return '#' . Sanitizer
::escapeIdForExternalInterwiki( $this->mFragment
);
1614 return '#' . Sanitizer
::escapeIdForLink( $this->mFragment
);
1618 * Set the fragment for this title. Removes the first character from the
1619 * specified fragment before setting, so it assumes you're passing it with
1622 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1623 * or Title::createFragmentTarget().
1624 * Still in active use privately.
1627 * @param string $fragment Text
1629 public function setFragment( $fragment ) {
1630 $this->mFragment
= strtr( substr( $fragment, 1 ), '_', ' ' );
1634 * Creates a new Title for a different fragment of the same page.
1637 * @param string $fragment
1640 public function createFragmentTarget( $fragment ) {
1641 return self
::makeTitle(
1650 * Prefix some arbitrary text with the namespace or interwiki prefix
1653 * @param string $name The text
1654 * @return string The prefixed text
1656 private function prefix( $name ) {
1658 if ( $this->isExternal() ) {
1659 $p = $this->mInterwiki
. ':';
1662 if ( 0 != $this->mNamespace
) {
1663 $nsText = $this->getNsText();
1665 if ( $nsText === false ) {
1666 // See T165149. Awkward, but better than erroneously linking to the main namespace.
1667 $nsText = MediaWikiServices
::getInstance()->getContentLanguage()->
1668 getNsText( NS_SPECIAL
) . ":Badtitle/NS{$this->mNamespace}";
1671 $p .= $nsText . ':';
1677 * Get the prefixed database key form
1679 * @return string The prefixed title, with underscores and
1680 * any interwiki and namespace prefixes
1682 public function getPrefixedDBkey() {
1683 $s = $this->prefix( $this->mDbkeyform
);
1684 $s = strtr( $s, ' ', '_' );
1689 * Get the prefixed title with spaces.
1690 * This is the form usually used for display
1692 * @return string The prefixed title, with spaces
1694 public function getPrefixedText() {
1695 if ( $this->prefixedText
=== null ) {
1696 $s = $this->prefix( $this->mTextform
);
1697 $s = strtr( $s, '_', ' ' );
1698 $this->prefixedText
= $s;
1700 return $this->prefixedText
;
1704 * Return a string representation of this title
1706 * @return string Representation of this title
1708 public function __toString() {
1709 return $this->getPrefixedText();
1713 * Get the prefixed title with spaces, plus any fragment
1714 * (part beginning with '#')
1716 * @return string The prefixed title, with spaces and the fragment, including '#'
1718 public function getFullText() {
1719 $text = $this->getPrefixedText();
1720 if ( $this->hasFragment() ) {
1721 $text .= '#' . $this->mFragment
;
1727 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1731 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1735 * @return string Root name
1738 public function getRootText() {
1739 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1740 return $this->getText();
1743 return strtok( $this->getText(), '/' );
1747 * Get the root page name title, i.e. the leftmost part before any slashes
1751 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1752 * # returns: Title{User:Foo}
1755 * @return Title Root title
1758 public function getRootTitle() {
1759 return self
::makeTitle( $this->mNamespace
, $this->getRootText() );
1763 * Get the base page name without a namespace, i.e. the part before the subpage name
1767 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1768 * # returns: 'Foo/Bar'
1771 * @return string Base name
1773 public function getBaseText() {
1774 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1775 return $this->getText();
1778 $parts = explode( '/', $this->getText() );
1779 # Don't discard the real title if there's no subpage involved
1780 if ( count( $parts ) > 1 ) {
1781 unset( $parts[count( $parts ) - 1] );
1783 return implode( '/', $parts );
1787 * Get the base page name title, i.e. the part before the subpage name
1791 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1792 * # returns: Title{User:Foo/Bar}
1795 * @return Title Base title
1798 public function getBaseTitle() {
1799 return self
::makeTitle( $this->mNamespace
, $this->getBaseText() );
1803 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1807 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1811 * @return string Subpage name
1813 public function getSubpageText() {
1814 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1815 return $this->mTextform
;
1817 $parts = explode( '/', $this->mTextform
);
1818 return $parts[count( $parts ) - 1];
1822 * Get the title for a subpage of the current page
1826 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1827 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1830 * @param string $text The subpage name to add to the title
1831 * @return Title Subpage title
1834 public function getSubpage( $text ) {
1835 return self
::makeTitleSafe( $this->mNamespace
, $this->getText() . '/' . $text );
1839 * Get a URL-encoded form of the subpage text
1841 * @return string URL-encoded subpage name
1843 public function getSubpageUrlForm() {
1844 $text = $this->getSubpageText();
1845 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1850 * Get a URL-encoded title (not an actual URL) including interwiki
1852 * @return string The URL-encoded form
1854 public function getPrefixedURL() {
1855 $s = $this->prefix( $this->mDbkeyform
);
1856 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1861 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1862 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1863 * second argument named variant. This was deprecated in favor
1864 * of passing an array of option with a "variant" key
1865 * Once $query2 is removed for good, this helper can be dropped
1866 * and the wfArrayToCgi moved to getLocalURL();
1868 * @since 1.19 (r105919)
1869 * @param array|string $query
1870 * @param string|string[]|bool $query2
1873 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1874 if ( $query2 !== false ) {
1875 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1876 "method called with a second parameter is deprecated. Add your " .
1877 "parameter to an array passed as the first parameter.", "1.19" );
1879 if ( is_array( $query ) ) {
1880 $query = wfArrayToCgi( $query );
1883 if ( is_string( $query2 ) ) {
1884 // $query2 is a string, we will consider this to be
1885 // a deprecated $variant argument and add it to the query
1886 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1888 $query2 = wfArrayToCgi( $query2 );
1890 // If we have $query content add a & to it first
1894 // Now append the queries together
1901 * Get a real URL referring to this title, with interwiki link and
1904 * @see self::getLocalURL for the arguments.
1906 * @param string|string[] $query
1907 * @param string|string[]|bool $query2
1908 * @param string|int|null $proto Protocol type to use in URL
1909 * @return string The URL
1911 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1912 $query = self
::fixUrlQueryArgs( $query, $query2 );
1914 # Hand off all the decisions on urls to getLocalURL
1915 $url = $this->getLocalURL( $query );
1917 # Expand the url to make it a full url. Note that getLocalURL has the
1918 # potential to output full urls for a variety of reasons, so we use
1919 # wfExpandUrl instead of simply prepending $wgServer
1920 $url = wfExpandUrl( $url, $proto );
1922 # Finally, add the fragment.
1923 $url .= $this->getFragmentForURL();
1924 // Avoid PHP 7.1 warning from passing $this by reference
1926 Hooks
::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
1931 * Get a url appropriate for making redirects based on an untrusted url arg
1933 * This is basically the same as getFullUrl(), but in the case of external
1934 * interwikis, we send the user to a landing page, to prevent possible
1935 * phishing attacks and the like.
1937 * @note Uses current protocol by default, since technically relative urls
1938 * aren't allowed in redirects per HTTP spec, so this is not suitable for
1939 * places where the url gets cached, as might pollute between
1940 * https and non-https users.
1941 * @see self::getLocalURL for the arguments.
1942 * @param array|string $query
1943 * @param string $proto Protocol type to use in URL
1944 * @return string A url suitable to use in an HTTP location header.
1946 public function getFullUrlForRedirect( $query = '', $proto = PROTO_CURRENT
) {
1948 if ( $this->isExternal() ) {
1949 $target = SpecialPage
::getTitleFor(
1951 $this->getPrefixedDBkey()
1954 return $target->getFullURL( $query, false, $proto );
1958 * Get a URL with no fragment or server name (relative URL) from a Title object.
1959 * If this page is generated with action=render, however,
1960 * $wgServer is prepended to make an absolute URL.
1962 * @see self::getFullURL to always get an absolute URL.
1963 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
1964 * valid to link, locally, to the current Title.
1965 * @see self::newFromText to produce a Title object.
1967 * @param string|string[] $query An optional query string,
1968 * not used for interwiki links. Can be specified as an associative array as well,
1969 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1970 * Some query patterns will trigger various shorturl path replacements.
1971 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
1972 * be an array. If a string is passed it will be interpreted as a deprecated
1973 * variant argument and urlencoded into a variant= argument.
1974 * This second query argument will be added to the $query
1975 * The second parameter is deprecated since 1.19. Pass it as a key,value
1976 * pair in the first parameter array instead.
1978 * @return string String of the URL.
1980 public function getLocalURL( $query = '', $query2 = false ) {
1981 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1983 $query = self
::fixUrlQueryArgs( $query, $query2 );
1985 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
1987 $namespace = $this->getNsText();
1988 if ( $namespace != '' ) {
1989 # Can this actually happen? Interwikis shouldn't be parsed.
1990 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1993 $url = $interwiki->getURL( $namespace . $this->mDbkeyform
);
1994 $url = wfAppendQuery( $url, $query );
1996 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1997 if ( $query == '' ) {
1998 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1999 // Avoid PHP 7.1 warning from passing $this by reference
2001 Hooks
::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
2003 global $wgVariantArticlePath, $wgActionPaths;
2007 if ( !empty( $wgActionPaths )
2008 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
2010 $action = urldecode( $matches[2] );
2011 if ( isset( $wgActionPaths[$action] ) ) {
2012 $query = $matches[1];
2013 if ( isset( $matches[4] ) ) {
2014 $query .= $matches[4];
2016 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
2017 if ( $query != '' ) {
2018 $url = wfAppendQuery( $url, $query );
2024 && $wgVariantArticlePath
2025 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
2026 && $this->getPageLanguage()->equals(
2027 MediaWikiServices
::getInstance()->getContentLanguage() )
2028 && $this->getPageLanguage()->hasVariants()
2030 $variant = urldecode( $matches[1] );
2031 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
2032 // Only do the variant replacement if the given variant is a valid
2033 // variant for the page's language.
2034 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
2035 $url = str_replace( '$1', $dbkey, $url );
2039 if ( $url === false ) {
2040 if ( $query == '-' ) {
2043 $url = "{$wgScript}?title={$dbkey}&{$query}";
2046 // Avoid PHP 7.1 warning from passing $this by reference
2048 Hooks
::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
2050 // @todo FIXME: This causes breakage in various places when we
2051 // actually expected a local URL and end up with dupe prefixes.
2052 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
2053 $url = $wgServer . $url;
2056 // Avoid PHP 7.1 warning from passing $this by reference
2058 Hooks
::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
2063 * Get a URL that's the simplest URL that will be valid to link, locally,
2064 * to the current Title. It includes the fragment, but does not include
2065 * the server unless action=render is used (or the link is external). If
2066 * there's a fragment but the prefixed text is empty, we just return a link
2069 * The result obviously should not be URL-escaped, but does need to be
2070 * HTML-escaped if it's being output in HTML.
2072 * @param string|string[] $query
2073 * @param bool $query2
2074 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
2075 * or false (default) for no expansion
2076 * @see self::getLocalURL for the arguments.
2077 * @return string The URL
2079 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
2080 if ( $this->isExternal() ||
$proto !== false ) {
2081 $ret = $this->getFullURL( $query, $query2, $proto );
2082 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
2083 $ret = $this->getFragmentForURL();
2085 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
2091 * Get the URL form for an internal link.
2092 * - Used in various CDN-related code, in case we have a different
2093 * internal hostname for the server from the exposed one.
2095 * This uses $wgInternalServer to qualify the path, or $wgServer
2096 * if $wgInternalServer is not set. If the server variable used is
2097 * protocol-relative, the URL will be expanded to http://
2099 * @see self::getLocalURL for the arguments.
2100 * @param string $query
2101 * @param string|bool $query2
2102 * @return string The URL
2104 public function getInternalURL( $query = '', $query2 = false ) {
2105 global $wgInternalServer, $wgServer;
2106 $query = self
::fixUrlQueryArgs( $query, $query2 );
2107 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
2108 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
2109 // Avoid PHP 7.1 warning from passing $this by reference
2111 Hooks
::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
2116 * Get the URL for a canonical link, for use in things like IRC and
2117 * e-mail notifications. Uses $wgCanonicalServer and the
2118 * GetCanonicalURL hook.
2120 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
2122 * @see self::getLocalURL for the arguments.
2123 * @param string $query
2124 * @param string|bool $query2
2125 * @return string The URL
2128 public function getCanonicalURL( $query = '', $query2 = false ) {
2129 $query = self
::fixUrlQueryArgs( $query, $query2 );
2130 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
2131 // Avoid PHP 7.1 warning from passing $this by reference
2133 Hooks
::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
2138 * Get the edit URL for this Title
2140 * @return string The URL, or a null string if this is an interwiki link
2142 public function getEditURL() {
2143 if ( $this->isExternal() ) {
2146 $s = $this->getLocalURL( 'action=edit' );
2152 * Can $user perform $action on this page?
2153 * This skips potentially expensive cascading permission checks
2154 * as well as avoids expensive error formatting
2156 * Suitable for use for nonessential UI controls in common cases, but
2157 * _not_ for functional access control.
2159 * May provide false positives, but should never provide a false negative.
2161 * @param string $action Action that permission needs to be checked for
2162 * @param User|null $user User to check (since 1.19); $wgUser will be used if not provided.
2165 public function quickUserCan( $action, $user = null ) {
2166 return $this->userCan( $action, $user, false );
2170 * Can $user perform $action on this page?
2172 * @param string $action Action that permission needs to be checked for
2173 * @param User|null $user User to check (since 1.19); $wgUser will be used if not
2175 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2178 public function userCan( $action, $user = null, $rigor = 'secure' ) {
2179 if ( !$user instanceof User
) {
2184 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $rigor, true ) );
2188 * Can $user perform $action on this page?
2190 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
2192 * @param string $action Action that permission needs to be checked for
2193 * @param User $user User to check
2194 * @param string $rigor One of (quick,full,secure)
2195 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2196 * - full : does cheap and expensive checks possibly from a replica DB
2197 * - secure : does cheap and expensive checks, using the master as needed
2198 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
2199 * whose corresponding errors may be ignored.
2200 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2202 public function getUserPermissionsErrors(
2203 $action, $user, $rigor = 'secure', $ignoreErrors = []
2205 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $rigor );
2207 // Remove the errors being ignored.
2208 foreach ( $errors as $index => $error ) {
2209 $errKey = is_array( $error ) ?
$error[0] : $error;
2211 if ( in_array( $errKey, $ignoreErrors ) ) {
2212 unset( $errors[$index] );
2214 if ( $errKey instanceof MessageSpecifier
&& in_array( $errKey->getKey(), $ignoreErrors ) ) {
2215 unset( $errors[$index] );
2223 * Permissions checks that fail most often, and which are easiest to test.
2225 * @param string $action The action to check
2226 * @param User $user User to check
2227 * @param array $errors List of current errors
2228 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2229 * @param bool $short Short circuit on first error
2231 * @return array List of errors
2233 private function checkQuickPermissions( $action, $user, $errors, $rigor, $short ) {
2234 if ( !Hooks
::run( 'TitleQuickPermissions',
2235 [ $this, $user, $action, &$errors, ( $rigor !== 'quick' ), $short ] )
2240 if ( $action == 'create' ) {
2242 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
2243 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
2245 $errors[] = $user->isAnon() ?
[ 'nocreatetext' ] : [ 'nocreate-loggedin' ];
2247 } elseif ( $action == 'move' ) {
2248 if ( !$user->isAllowed( 'move-rootuserpages' )
2249 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
2250 // Show user page-specific message only if the user can move other pages
2251 $errors[] = [ 'cant-move-user-page' ];
2254 // Check if user is allowed to move files if it's a file
2255 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
2256 $errors[] = [ 'movenotallowedfile' ];
2259 // Check if user is allowed to move category pages if it's a category page
2260 if ( $this->mNamespace
== NS_CATEGORY
&& !$user->isAllowed( 'move-categorypages' ) ) {
2261 $errors[] = [ 'cant-move-category-page' ];
2264 if ( !$user->isAllowed( 'move' ) ) {
2265 // User can't move anything
2266 $userCanMove = User
::groupHasPermission( 'user', 'move' );
2267 $autoconfirmedCanMove = User
::groupHasPermission( 'autoconfirmed', 'move' );
2268 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
2269 // custom message if logged-in users without any special rights can move
2270 $errors[] = [ 'movenologintext' ];
2272 $errors[] = [ 'movenotallowed' ];
2275 } elseif ( $action == 'move-target' ) {
2276 if ( !$user->isAllowed( 'move' ) ) {
2277 // User can't move anything
2278 $errors[] = [ 'movenotallowed' ];
2279 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
2280 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
2281 // Show user page-specific message only if the user can move other pages
2282 $errors[] = [ 'cant-move-to-user-page' ];
2283 } elseif ( !$user->isAllowed( 'move-categorypages' )
2284 && $this->mNamespace
== NS_CATEGORY
) {
2285 // Show category page-specific message only if the user can move other pages
2286 $errors[] = [ 'cant-move-to-category-page' ];
2288 } elseif ( !$user->isAllowed( $action ) ) {
2289 $errors[] = $this->missingPermissionError( $action, $short );
2296 * Add the resulting error code to the errors array
2298 * @param array $errors List of current errors
2299 * @param array $result Result of errors
2301 * @return array List of errors
2303 private function resultToError( $errors, $result ) {
2304 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2305 // A single array representing an error
2306 $errors[] = $result;
2307 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2308 // A nested array representing multiple errors
2309 $errors = array_merge( $errors, $result );
2310 } elseif ( $result !== '' && is_string( $result ) ) {
2311 // A string representing a message-id
2312 $errors[] = [ $result ];
2313 } elseif ( $result instanceof MessageSpecifier
) {
2314 // A message specifier representing an error
2315 $errors[] = [ $result ];
2316 } elseif ( $result === false ) {
2317 // a generic "We don't want them to do that"
2318 $errors[] = [ 'badaccess-group0' ];
2324 * Check various permission hooks
2326 * @param string $action The action to check
2327 * @param User $user User to check
2328 * @param array $errors List of current errors
2329 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2330 * @param bool $short Short circuit on first error
2332 * @return array List of errors
2334 private function checkPermissionHooks( $action, $user, $errors, $rigor, $short ) {
2335 // Use getUserPermissionsErrors instead
2337 // Avoid PHP 7.1 warning from passing $this by reference
2339 if ( !Hooks
::run( 'userCan', [ &$titleRef, &$user, $action, &$result ] ) ) {
2340 return $result ?
[] : [ [ 'badaccess-group0' ] ];
2342 // Check getUserPermissionsErrors hook
2343 // Avoid PHP 7.1 warning from passing $this by reference
2345 if ( !Hooks
::run( 'getUserPermissionsErrors', [ &$titleRef, &$user, $action, &$result ] ) ) {
2346 $errors = $this->resultToError( $errors, $result );
2348 // Check getUserPermissionsErrorsExpensive hook
2351 && !( $short && count( $errors ) > 0 )
2352 && !Hooks
::run( 'getUserPermissionsErrorsExpensive', [ &$titleRef, &$user, $action, &$result ] )
2354 $errors = $this->resultToError( $errors, $result );
2361 * Check permissions on special pages & namespaces
2363 * @param string $action The action to check
2364 * @param User $user User to check
2365 * @param array $errors List of current errors
2366 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2367 * @param bool $short Short circuit on first error
2369 * @return array List of errors
2371 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $rigor, $short ) {
2372 # Only 'createaccount' can be performed on special pages,
2373 # which don't actually exist in the DB.
2374 if ( $this->isSpecialPage() && $action !== 'createaccount' ) {
2375 $errors[] = [ 'ns-specialprotected' ];
2378 # Check $wgNamespaceProtection for restricted namespaces
2379 if ( $this->isNamespaceProtected( $user ) ) {
2380 $ns = $this->mNamespace
== NS_MAIN ?
2381 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2382 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
2383 [ 'protectedinterface', $action ] : [ 'namespaceprotected', $ns, $action ];
2390 * Check sitewide CSS/JSON/JS permissions
2392 * @param string $action The action to check
2393 * @param User $user User to check
2394 * @param array $errors List of current errors
2395 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2396 * @param bool $short Short circuit on first error
2398 * @return array List of errors
2400 private function checkSiteConfigPermissions( $action, $user, $errors, $rigor, $short ) {
2401 if ( $action != 'patrol' ) {
2403 // Sitewide CSS/JSON/JS changes, like all NS_MEDIAWIKI changes, also require the
2404 // editinterface right. That's implemented as a restriction so no check needed here.
2405 if ( $this->isSiteCssConfigPage() && !$user->isAllowed( 'editsitecss' ) ) {
2406 $error = [ 'sitecssprotected', $action ];
2407 } elseif ( $this->isSiteJsonConfigPage() && !$user->isAllowed( 'editsitejson' ) ) {
2408 $error = [ 'sitejsonprotected', $action ];
2409 } elseif ( $this->isSiteJsConfigPage() && !$user->isAllowed( 'editsitejs' ) ) {
2410 $error = [ 'sitejsprotected', $action ];
2411 } elseif ( $this->isRawHtmlMessage() ) {
2412 // Raw HTML can be used to deploy CSS or JS so require rights for both.
2413 if ( !$user->isAllowed( 'editsitejs' ) ) {
2414 $error = [ 'sitejsprotected', $action ];
2415 } elseif ( !$user->isAllowed( 'editsitecss' ) ) {
2416 $error = [ 'sitecssprotected', $action ];
2421 if ( $user->isAllowed( 'editinterface' ) ) {
2422 // Most users / site admins will probably find out about the new, more restrictive
2423 // permissions by failing to edit something. Give them more info.
2424 // TODO remove this a few release cycles after 1.32
2425 $error = [ 'interfaceadmin-info', wfMessage( $error[0], $error[1] ) ];
2435 * Check CSS/JSON/JS sub-page permissions
2437 * @param string $action The action to check
2438 * @param User $user User to check
2439 * @param array $errors List of current errors
2440 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2441 * @param bool $short Short circuit on first error
2443 * @return array List of errors
2445 private function checkUserConfigPermissions( $action, $user, $errors, $rigor, $short ) {
2446 # Protect css/json/js subpages of user pages
2447 # XXX: this might be better using restrictions
2449 if ( $action === 'patrol' ) {
2453 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
2454 // Users need editmyuser* to edit their own CSS/JSON/JS subpages.
2456 $this->isUserCssConfigPage()
2457 && !$user->isAllowedAny( 'editmyusercss', 'editusercss' )
2459 $errors[] = [ 'mycustomcssprotected', $action ];
2461 $this->isUserJsonConfigPage()
2462 && !$user->isAllowedAny( 'editmyuserjson', 'edituserjson' )
2464 $errors[] = [ 'mycustomjsonprotected', $action ];
2466 $this->isUserJsConfigPage()
2467 && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' )
2469 $errors[] = [ 'mycustomjsprotected', $action ];
2472 // Users need editmyuser* to edit their own CSS/JSON/JS subpages, except for
2473 // deletion/suppression which cannot be used for attacks and we want to avoid the
2474 // situation where an unprivileged user can post abusive content on their subpages
2475 // and only very highly privileged users could remove it.
2476 if ( !in_array( $action, [ 'delete', 'deleterevision', 'suppressrevision' ], true ) ) {
2478 $this->isUserCssConfigPage()
2479 && !$user->isAllowed( 'editusercss' )
2481 $errors[] = [ 'customcssprotected', $action ];
2483 $this->isUserJsonConfigPage()
2484 && !$user->isAllowed( 'edituserjson' )
2486 $errors[] = [ 'customjsonprotected', $action ];
2488 $this->isUserJsConfigPage()
2489 && !$user->isAllowed( 'edituserjs' )
2491 $errors[] = [ 'customjsprotected', $action ];
2500 * Check against page_restrictions table requirements on this
2501 * page. The user must possess all required rights for this
2504 * @param string $action The action to check
2505 * @param User $user User to check
2506 * @param array $errors List of current errors
2507 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2508 * @param bool $short Short circuit on first error
2510 * @return array List of errors
2512 private function checkPageRestrictions( $action, $user, $errors, $rigor, $short ) {
2513 foreach ( $this->getRestrictions( $action ) as $right ) {
2514 // Backwards compatibility, rewrite sysop -> editprotected
2515 if ( $right == 'sysop' ) {
2516 $right = 'editprotected';
2518 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2519 if ( $right == 'autoconfirmed' ) {
2520 $right = 'editsemiprotected';
2522 if ( $right == '' ) {
2525 if ( !$user->isAllowed( $right ) ) {
2526 $errors[] = [ 'protectedpagetext', $right, $action ];
2527 } elseif ( $this->mCascadeRestriction
&& !$user->isAllowed( 'protect' ) ) {
2528 $errors[] = [ 'protectedpagetext', 'protect', $action ];
2536 * Check restrictions on cascading pages.
2538 * @param string $action The action to check
2539 * @param User $user User to check
2540 * @param array $errors List of current errors
2541 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2542 * @param bool $short Short circuit on first error
2544 * @return array List of errors
2546 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $rigor, $short ) {
2547 if ( $rigor !== 'quick' && !$this->isUserConfigPage() ) {
2548 # We /could/ use the protection level on the source page, but it's
2549 # fairly ugly as we have to establish a precedence hierarchy for pages
2550 # included by multiple cascade-protected pages. So just restrict
2551 # it to people with 'protect' permission, as they could remove the
2552 # protection anyway.
2553 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2554 # Cascading protection depends on more than this page...
2555 # Several cascading protected pages may include this page...
2556 # Check each cascading level
2557 # This is only for protection restrictions, not for all actions
2558 if ( isset( $restrictions[$action] ) ) {
2559 foreach ( $restrictions[$action] as $right ) {
2560 // Backwards compatibility, rewrite sysop -> editprotected
2561 if ( $right == 'sysop' ) {
2562 $right = 'editprotected';
2564 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2565 if ( $right == 'autoconfirmed' ) {
2566 $right = 'editsemiprotected';
2568 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2570 foreach ( $cascadingSources as $page ) {
2571 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2573 $errors[] = [ 'cascadeprotected', count( $cascadingSources ), $pages, $action ];
2583 * Check action permissions not already checked in checkQuickPermissions
2585 * @param string $action The action to check
2586 * @param User $user User to check
2587 * @param array $errors List of current errors
2588 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2589 * @param bool $short Short circuit on first error
2591 * @return array List of errors
2593 private function checkActionPermissions( $action, $user, $errors, $rigor, $short ) {
2594 global $wgDeleteRevisionsLimit, $wgLang;
2596 if ( $action == 'protect' ) {
2597 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2598 // If they can't edit, they shouldn't protect.
2599 $errors[] = [ 'protect-cantedit' ];
2601 } elseif ( $action == 'create' ) {
2602 $title_protection = $this->getTitleProtection();
2603 if ( $title_protection ) {
2604 if ( $title_protection['permission'] == ''
2605 ||
!$user->isAllowed( $title_protection['permission'] )
2609 User
::whoIs( $title_protection['user'] ),
2610 $title_protection['reason']
2614 } elseif ( $action == 'move' ) {
2615 // Check for immobile pages
2616 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2617 // Specific message for this case
2618 $errors[] = [ 'immobile-source-namespace', $this->getNsText() ];
2619 } elseif ( !$this->isMovable() ) {
2620 // Less specific message for rarer cases
2621 $errors[] = [ 'immobile-source-page' ];
2623 } elseif ( $action == 'move-target' ) {
2624 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2625 $errors[] = [ 'immobile-target-namespace', $this->getNsText() ];
2626 } elseif ( !$this->isMovable() ) {
2627 $errors[] = [ 'immobile-target-page' ];
2629 } elseif ( $action == 'delete' ) {
2630 $tempErrors = $this->checkPageRestrictions( 'edit', $user, [], $rigor, true );
2631 if ( !$tempErrors ) {
2632 $tempErrors = $this->checkCascadingSourcesRestrictions( 'edit',
2633 $user, $tempErrors, $rigor, true );
2635 if ( $tempErrors ) {
2636 // If protection keeps them from editing, they shouldn't be able to delete.
2637 $errors[] = [ 'deleteprotected' ];
2639 if ( $rigor !== 'quick' && $wgDeleteRevisionsLimit
2640 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2642 $errors[] = [ 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ];
2644 } elseif ( $action === 'undelete' ) {
2645 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2646 // Undeleting implies editing
2647 $errors[] = [ 'undelete-cantedit' ];
2649 if ( !$this->exists()
2650 && count( $this->getUserPermissionsErrorsInternal( 'create', $user, $rigor, true ) )
2652 // Undeleting where nothing currently exists implies creating
2653 $errors[] = [ 'undelete-cantcreate' ];
2660 * Check that the user isn't blocked from editing.
2662 * @param string $action The action to check
2663 * @param User $user User to check
2664 * @param array $errors List of current errors
2665 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2666 * @param bool $short Short circuit on first error
2668 * @return array List of errors
2670 private function checkUserBlock( $action, $user, $errors, $rigor, $short ) {
2671 global $wgEmailConfirmToEdit, $wgBlockDisablesLogin;
2672 // Account creation blocks handled at userlogin.
2673 // Unblocking handled in SpecialUnblock
2674 if ( $rigor === 'quick' ||
in_array( $action, [ 'createaccount', 'unblock' ] ) ) {
2678 // Optimize for a very common case
2679 if ( $action === 'read' && !$wgBlockDisablesLogin ) {
2683 if ( $wgEmailConfirmToEdit
2684 && !$user->isEmailConfirmed()
2685 && $action === 'edit'
2687 $errors[] = [ 'confirmedittext' ];
2690 $useReplica = ( $rigor !== 'secure' );
2691 $block = $user->getBlock( $useReplica );
2693 // The block may explicitly allow an action (like "read" or "upload").
2694 if ( $block && $block->prevents( $action ) === false ) {
2698 // Determine if the user is blocked from this action on this page.
2700 // @todo FIXME: Pass the relevant context into this function.
2701 $action = Action
::factory( $action, WikiPage
::factory( $this ), RequestContext
::getMain() );
2702 } catch ( Exception
$e ) {
2706 // If no action object is returned, assume that the action requires unblock
2707 // which is the default.
2708 if ( !$action ||
$action->requiresUnblock() ) {
2709 if ( $user->isBlockedFrom( $this, $useReplica ) ) {
2710 // @todo FIXME: Pass the relevant context into this function.
2712 ?
$block->getPermissionsError( RequestContext
::getMain() )
2713 : [ 'badaccess-group0' ];
2721 * Check that the user is allowed to read this page.
2723 * @param string $action The action to check
2724 * @param User $user User to check
2725 * @param array $errors List of current errors
2726 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2727 * @param bool $short Short circuit on first error
2729 * @return array List of errors
2731 private function checkReadPermissions( $action, $user, $errors, $rigor, $short ) {
2732 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2734 $whitelisted = false;
2735 if ( User
::isEveryoneAllowed( 'read' ) ) {
2736 # Shortcut for public wikis, allows skipping quite a bit of code
2737 $whitelisted = true;
2738 } elseif ( $user->isAllowed( 'read' ) ) {
2739 # If the user is allowed to read pages, he is allowed to read all pages
2740 $whitelisted = true;
2741 } elseif ( $this->isSpecial( 'Userlogin' )
2742 ||
$this->isSpecial( 'PasswordReset' )
2743 ||
$this->isSpecial( 'Userlogout' )
2745 # Always grant access to the login page.
2746 # Even anons need to be able to log in.
2747 $whitelisted = true;
2748 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2749 # Time to check the whitelist
2750 # Only do these checks is there's something to check against
2751 $name = $this->getPrefixedText();
2752 $dbName = $this->getPrefixedDBkey();
2754 // Check for explicit whitelisting with and without underscores
2755 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2756 $whitelisted = true;
2757 } elseif ( $this->mNamespace
== NS_MAIN
) {
2758 # Old settings might have the title prefixed with
2759 # a colon for main-namespace pages
2760 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2761 $whitelisted = true;
2763 } elseif ( $this->isSpecialPage() ) {
2764 # If it's a special page, ditch the subpage bit and check again
2765 $name = $this->mDbkeyform
;
2766 list( $name, /* $subpage */ ) =
2767 MediaWikiServices
::getInstance()->getSpecialPageFactory()->
2768 resolveAlias( $name );
2770 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2771 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2772 $whitelisted = true;
2778 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2779 $name = $this->getPrefixedText();
2780 // Check for regex whitelisting
2781 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2782 if ( preg_match( $listItem, $name ) ) {
2783 $whitelisted = true;
2789 if ( !$whitelisted ) {
2790 # If the title is not whitelisted, give extensions a chance to do so...
2791 Hooks
::run( 'TitleReadWhitelist', [ $this, $user, &$whitelisted ] );
2792 if ( !$whitelisted ) {
2793 $errors[] = $this->missingPermissionError( $action, $short );
2801 * Get a description array when the user doesn't have the right to perform
2802 * $action (i.e. when User::isAllowed() returns false)
2804 * @param string $action The action to check
2805 * @param bool $short Short circuit on first error
2806 * @return array Array containing an error message key and any parameters
2808 private function missingPermissionError( $action, $short ) {
2809 // We avoid expensive display logic for quickUserCan's and such
2811 return [ 'badaccess-group0' ];
2814 return User
::newFatalPermissionDeniedStatus( $action )->getErrorsArray()[0];
2818 * Can $user perform $action on this page? This is an internal function,
2819 * with multiple levels of checks depending on performance needs; see $rigor below.
2820 * It does not check wfReadOnly().
2822 * @param string $action Action that permission needs to be checked for
2823 * @param User $user User to check
2824 * @param string $rigor One of (quick,full,secure)
2825 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2826 * - full : does cheap and expensive checks possibly from a replica DB
2827 * - secure : does cheap and expensive checks, using the master as needed
2828 * @param bool $short Set this to true to stop after the first permission error.
2829 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2831 protected function getUserPermissionsErrorsInternal(
2832 $action, $user, $rigor = 'secure', $short = false
2834 if ( $rigor === true ) {
2835 $rigor = 'secure'; // b/c
2836 } elseif ( $rigor === false ) {
2837 $rigor = 'quick'; // b/c
2838 } elseif ( !in_array( $rigor, [ 'quick', 'full', 'secure' ] ) ) {
2839 throw new Exception( "Invalid rigor parameter '$rigor'." );
2842 # Read has special handling
2843 if ( $action == 'read' ) {
2845 'checkPermissionHooks',
2846 'checkReadPermissions',
2847 'checkUserBlock', // for wgBlockDisablesLogin
2849 # Don't call checkSpecialsAndNSPermissions, checkSiteConfigPermissions
2850 # or checkUserConfigPermissions here as it will lead to duplicate
2851 # error messages. This is okay to do since anywhere that checks for
2852 # create will also check for edit, and those checks are called for edit.
2853 } elseif ( $action == 'create' ) {
2855 'checkQuickPermissions',
2856 'checkPermissionHooks',
2857 'checkPageRestrictions',
2858 'checkCascadingSourcesRestrictions',
2859 'checkActionPermissions',
2864 'checkQuickPermissions',
2865 'checkPermissionHooks',
2866 'checkSpecialsAndNSPermissions',
2867 'checkSiteConfigPermissions',
2868 'checkUserConfigPermissions',
2869 'checkPageRestrictions',
2870 'checkCascadingSourcesRestrictions',
2871 'checkActionPermissions',
2877 while ( count( $checks ) > 0 &&
2878 !( $short && count( $errors ) > 0 ) ) {
2879 $method = array_shift( $checks );
2880 $errors = $this->$method( $action, $user, $errors, $rigor, $short );
2887 * Get a filtered list of all restriction types supported by this wiki.
2888 * @param bool $exists True to get all restriction types that apply to
2889 * titles that do exist, False for all restriction types that apply to
2890 * titles that do not exist
2893 public static function getFilteredRestrictionTypes( $exists = true ) {
2894 global $wgRestrictionTypes;
2895 $types = $wgRestrictionTypes;
2897 # Remove the create restriction for existing titles
2898 $types = array_diff( $types, [ 'create' ] );
2900 # Only the create and upload restrictions apply to non-existing titles
2901 $types = array_intersect( $types, [ 'create', 'upload' ] );
2907 * Returns restriction types for the current Title
2909 * @return array Applicable restriction types
2911 public function getRestrictionTypes() {
2912 if ( $this->isSpecialPage() ) {
2916 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2918 if ( $this->mNamespace
!= NS_FILE
) {
2919 # Remove the upload restriction for non-file titles
2920 $types = array_diff( $types, [ 'upload' ] );
2923 Hooks
::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2925 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2926 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2932 * Is this title subject to title protection?
2933 * Title protection is the one applied against creation of such title.
2935 * @return array|bool An associative array representing any existent title
2936 * protection, or false if there's none.
2938 public function getTitleProtection() {
2939 $protection = $this->getTitleProtectionInternal();
2940 if ( $protection ) {
2941 if ( $protection['permission'] == 'sysop' ) {
2942 $protection['permission'] = 'editprotected'; // B/C
2944 if ( $protection['permission'] == 'autoconfirmed' ) {
2945 $protection['permission'] = 'editsemiprotected'; // B/C
2952 * Fetch title protection settings
2954 * To work correctly, $this->loadRestrictions() needs to have access to the
2955 * actual protections in the database without munging 'sysop' =>
2956 * 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other
2957 * callers probably want $this->getTitleProtection() instead.
2959 * @return array|bool
2961 protected function getTitleProtectionInternal() {
2962 // Can't protect pages in special namespaces
2963 if ( $this->mNamespace
< 0 ) {
2967 // Can't protect pages that exist.
2968 if ( $this->exists() ) {
2972 if ( $this->mTitleProtection
=== null ) {
2973 $dbr = wfGetDB( DB_REPLICA
);
2974 $commentStore = CommentStore
::getStore();
2975 $commentQuery = $commentStore->getJoin( 'pt_reason' );
2976 $res = $dbr->select(
2977 [ 'protected_titles' ] +
$commentQuery['tables'],
2979 'user' => 'pt_user',
2980 'expiry' => 'pt_expiry',
2981 'permission' => 'pt_create_perm'
2982 ] +
$commentQuery['fields'],
2983 [ 'pt_namespace' => $this->mNamespace
, 'pt_title' => $this->mDbkeyform
],
2986 $commentQuery['joins']
2989 // fetchRow returns false if there are no rows.
2990 $row = $dbr->fetchRow( $res );
2992 $this->mTitleProtection
= [
2993 'user' => $row['user'],
2994 'expiry' => $dbr->decodeExpiry( $row['expiry'] ),
2995 'permission' => $row['permission'],
2996 'reason' => $commentStore->getComment( 'pt_reason', $row )->text
,
2999 $this->mTitleProtection
= false;
3002 return $this->mTitleProtection
;
3006 * Remove any title protection due to page existing
3008 public function deleteTitleProtection() {
3009 $dbw = wfGetDB( DB_MASTER
);
3013 [ 'pt_namespace' => $this->mNamespace
, 'pt_title' => $this->mDbkeyform
],
3016 $this->mTitleProtection
= false;
3020 * Is this page "semi-protected" - the *only* protection levels are listed
3021 * in $wgSemiprotectedRestrictionLevels?
3023 * @param string $action Action to check (default: edit)
3026 public function isSemiProtected( $action = 'edit' ) {
3027 global $wgSemiprotectedRestrictionLevels;
3029 $restrictions = $this->getRestrictions( $action );
3030 $semi = $wgSemiprotectedRestrictionLevels;
3031 if ( !$restrictions ||
!$semi ) {
3032 // Not protected, or all protection is full protection
3036 // Remap autoconfirmed to editsemiprotected for BC
3037 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
3038 $semi[$key] = 'editsemiprotected';
3040 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
3041 $restrictions[$key] = 'editsemiprotected';
3044 return !array_diff( $restrictions, $semi );
3048 * Does the title correspond to a protected article?
3050 * @param string $action The action the page is protected from,
3051 * by default checks all actions.
3054 public function isProtected( $action = '' ) {
3055 global $wgRestrictionLevels;
3057 $restrictionTypes = $this->getRestrictionTypes();
3059 # Special pages have inherent protection
3060 if ( $this->isSpecialPage() ) {
3064 # Check regular protection levels
3065 foreach ( $restrictionTypes as $type ) {
3066 if ( $action == $type ||
$action == '' ) {
3067 $r = $this->getRestrictions( $type );
3068 foreach ( $wgRestrictionLevels as $level ) {
3069 if ( in_array( $level, $r ) && $level != '' ) {
3080 * Determines if $user is unable to edit this page because it has been protected
3081 * by $wgNamespaceProtection.
3083 * @param User $user User object to check permissions
3086 public function isNamespaceProtected( User
$user ) {
3087 global $wgNamespaceProtection;
3089 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
3090 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
3091 if ( $right != '' && !$user->isAllowed( $right ) ) {
3100 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
3102 * @return bool If the page is subject to cascading restrictions.
3104 public function isCascadeProtected() {
3105 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
3106 return ( $sources > 0 );
3110 * Determines whether cascading protection sources have already been loaded from
3113 * @param bool $getPages True to check if the pages are loaded, or false to check
3114 * if the status is loaded.
3115 * @return bool Whether or not the specified information has been loaded
3118 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
3119 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
3123 * Cascading protection: Get the source of any cascading restrictions on this page.
3125 * @param bool $getPages Whether or not to retrieve the actual pages
3126 * that the restrictions have come from and the actual restrictions
3128 * @return array Two elements: First is an array of Title objects of the
3129 * pages from which cascading restrictions have come, false for
3130 * none, or true if such restrictions exist but $getPages was not
3131 * set. Second is an array like that returned by
3132 * Title::getAllRestrictions(), or an empty array if $getPages is
3135 public function getCascadeProtectionSources( $getPages = true ) {
3136 $pagerestrictions = [];
3138 if ( $this->mCascadeSources
!== null && $getPages ) {
3139 return [ $this->mCascadeSources
, $this->mCascadingRestrictions
];
3140 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
3141 return [ $this->mHasCascadingRestrictions
, $pagerestrictions ];
3144 $dbr = wfGetDB( DB_REPLICA
);
3146 if ( $this->mNamespace
== NS_FILE
) {
3147 $tables = [ 'imagelinks', 'page_restrictions' ];
3149 'il_to' => $this->mDbkeyform
,
3154 $tables = [ 'templatelinks', 'page_restrictions' ];
3156 'tl_namespace' => $this->mNamespace
,
3157 'tl_title' => $this->mDbkeyform
,
3164 $cols = [ 'pr_page', 'page_namespace', 'page_title',
3165 'pr_expiry', 'pr_type', 'pr_level' ];
3166 $where_clauses[] = 'page_id=pr_page';
3169 $cols = [ 'pr_expiry' ];
3172 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
3174 $sources = $getPages ?
[] : false;
3175 $now = wfTimestampNow();
3177 foreach ( $res as $row ) {
3178 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
3179 if ( $expiry > $now ) {
3181 $page_id = $row->pr_page
;
3182 $page_ns = $row->page_namespace
;
3183 $page_title = $row->page_title
;
3184 $sources[$page_id] = self
::makeTitle( $page_ns, $page_title );
3185 # Add groups needed for each restriction type if its not already there
3186 # Make sure this restriction type still exists
3188 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
3189 $pagerestrictions[$row->pr_type
] = [];
3193 isset( $pagerestrictions[$row->pr_type
] )
3194 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
3196 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
3205 $this->mCascadeSources
= $sources;
3206 $this->mCascadingRestrictions
= $pagerestrictions;
3208 $this->mHasCascadingRestrictions
= $sources;
3211 return [ $sources, $pagerestrictions ];
3215 * Accessor for mRestrictionsLoaded
3217 * @return bool Whether or not the page's restrictions have already been
3218 * loaded from the database
3221 public function areRestrictionsLoaded() {
3222 return $this->mRestrictionsLoaded
;
3226 * Accessor/initialisation for mRestrictions
3228 * @param string $action Action that permission needs to be checked for
3229 * @return array Restriction levels needed to take the action. All levels are
3230 * required. Note that restriction levels are normally user rights, but 'sysop'
3231 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
3232 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
3234 public function getRestrictions( $action ) {
3235 if ( !$this->mRestrictionsLoaded
) {
3236 $this->loadRestrictions();
3238 return $this->mRestrictions
[$action] ??
[];
3242 * Accessor/initialisation for mRestrictions
3244 * @return array Keys are actions, values are arrays as returned by
3245 * Title::getRestrictions()
3248 public function getAllRestrictions() {
3249 if ( !$this->mRestrictionsLoaded
) {
3250 $this->loadRestrictions();
3252 return $this->mRestrictions
;
3256 * Get the expiry time for the restriction against a given action
3258 * @param string $action
3259 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
3260 * or not protected at all, or false if the action is not recognised.
3262 public function getRestrictionExpiry( $action ) {
3263 if ( !$this->mRestrictionsLoaded
) {
3264 $this->loadRestrictions();
3266 return $this->mRestrictionsExpiry
[$action] ??
false;
3270 * Returns cascading restrictions for the current article
3274 function areRestrictionsCascading() {
3275 if ( !$this->mRestrictionsLoaded
) {
3276 $this->loadRestrictions();
3279 return $this->mCascadeRestriction
;
3283 * Compiles list of active page restrictions from both page table (pre 1.10)
3284 * and page_restrictions table for this existing page.
3285 * Public for usage by LiquidThreads.
3287 * @param array $rows Array of db result objects
3288 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
3289 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
3290 * Edit and move sections are separated by a colon
3291 * Example: "edit=autoconfirmed,sysop:move=sysop"
3293 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
3294 $dbr = wfGetDB( DB_REPLICA
);
3296 $restrictionTypes = $this->getRestrictionTypes();
3298 foreach ( $restrictionTypes as $type ) {
3299 $this->mRestrictions
[$type] = [];
3300 $this->mRestrictionsExpiry
[$type] = 'infinity';
3303 $this->mCascadeRestriction
= false;
3305 # Backwards-compatibility: also load the restrictions from the page record (old format).
3306 if ( $oldFashionedRestrictions !== null ) {
3307 $this->mOldRestrictions
= $oldFashionedRestrictions;
3310 if ( $this->mOldRestrictions
=== false ) {
3311 $this->mOldRestrictions
= $dbr->selectField( 'page', 'page_restrictions',
3312 [ 'page_id' => $this->getArticleID() ], __METHOD__
);
3315 if ( $this->mOldRestrictions
!= '' ) {
3316 foreach ( explode( ':', trim( $this->mOldRestrictions
) ) as $restrict ) {
3317 $temp = explode( '=', trim( $restrict ) );
3318 if ( count( $temp ) == 1 ) {
3319 // old old format should be treated as edit/move restriction
3320 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
3321 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
3323 $restriction = trim( $temp[1] );
3324 if ( $restriction != '' ) { // some old entries are empty
3325 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
3331 if ( count( $rows ) ) {
3332 # Current system - load second to make them override.
3333 $now = wfTimestampNow();
3335 # Cycle through all the restrictions.
3336 foreach ( $rows as $row ) {
3337 // Don't take care of restrictions types that aren't allowed
3338 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
3342 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
3344 // Only apply the restrictions if they haven't expired!
3345 if ( !$expiry ||
$expiry > $now ) {
3346 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
3347 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
3349 $this->mCascadeRestriction |
= $row->pr_cascade
;
3354 $this->mRestrictionsLoaded
= true;
3358 * Load restrictions from the page_restrictions table
3360 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
3361 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
3362 * Edit and move sections are separated by a colon
3363 * Example: "edit=autoconfirmed,sysop:move=sysop"
3365 public function loadRestrictions( $oldFashionedRestrictions = null ) {
3366 if ( $this->mRestrictionsLoaded
) {
3370 $id = $this->getArticleID();
3372 $cache = ObjectCache
::getMainWANInstance();
3373 $fname = __METHOD__
;
3374 $rows = $cache->getWithSetCallback(
3375 // Page protections always leave a new null revision
3376 $cache->makeKey( 'page-restrictions', $id, $this->getLatestRevID() ),
3378 function ( $curValue, &$ttl, array &$setOpts ) use ( $fname ) {
3379 $dbr = wfGetDB( DB_REPLICA
);
3381 $setOpts +
= Database
::getCacheSetOptions( $dbr );
3383 return iterator_to_array(
3385 'page_restrictions',
3386 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
3387 [ 'pr_page' => $this->getArticleID() ],
3394 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
3396 $title_protection = $this->getTitleProtectionInternal();
3398 if ( $title_protection ) {
3399 $now = wfTimestampNow();
3400 $expiry = wfGetDB( DB_REPLICA
)->decodeExpiry( $title_protection['expiry'] );
3402 if ( !$expiry ||
$expiry > $now ) {
3403 // Apply the restrictions
3404 $this->mRestrictionsExpiry
['create'] = $expiry;
3405 $this->mRestrictions
['create'] =
3406 explode( ',', trim( $title_protection['permission'] ) );
3407 } else { // Get rid of the old restrictions
3408 $this->mTitleProtection
= false;
3411 $this->mRestrictionsExpiry
['create'] = 'infinity';
3413 $this->mRestrictionsLoaded
= true;
3418 * Flush the protection cache in this object and force reload from the database.
3419 * This is used when updating protection from WikiPage::doUpdateRestrictions().
3421 public function flushRestrictions() {
3422 $this->mRestrictionsLoaded
= false;
3423 $this->mTitleProtection
= null;
3427 * Purge expired restrictions from the page_restrictions table
3429 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
3431 static function purgeExpiredRestrictions() {
3432 if ( wfReadOnly() ) {
3436 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
3437 wfGetDB( DB_MASTER
),
3439 function ( IDatabase
$dbw, $fname ) {
3440 $config = MediaWikiServices
::getInstance()->getMainConfig();
3441 $ids = $dbw->selectFieldValues(
3442 'page_restrictions',
3444 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3446 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
3449 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
3454 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
3455 wfGetDB( DB_MASTER
),
3457 function ( IDatabase
$dbw, $fname ) {
3460 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3468 * Does this have subpages? (Warning, usually requires an extra DB query.)
3472 public function hasSubpages() {
3473 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3478 # We dynamically add a member variable for the purpose of this method
3479 # alone to cache the result. There's no point in having it hanging
3480 # around uninitialized in every Title object; therefore we only add it
3481 # if needed and don't declare it statically.
3482 if ( $this->mHasSubpages
=== null ) {
3483 $this->mHasSubpages
= false;
3484 $subpages = $this->getSubpages( 1 );
3485 if ( $subpages instanceof TitleArray
) {
3486 $this->mHasSubpages
= (bool)$subpages->count();
3490 return $this->mHasSubpages
;
3494 * Get all subpages of this page.
3496 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3497 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3498 * doesn't allow subpages
3500 public function getSubpages( $limit = -1 ) {
3501 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3505 $dbr = wfGetDB( DB_REPLICA
);
3506 $conds['page_namespace'] = $this->mNamespace
;
3507 $conds[] = 'page_title ' . $dbr->buildLike( $this->mDbkeyform
. '/', $dbr->anyString() );
3509 if ( $limit > -1 ) {
3510 $options['LIMIT'] = $limit;
3512 return TitleArray
::newFromResult(
3513 $dbr->select( 'page',
3514 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
3523 * Is there a version of this page in the deletion archive?
3525 * @return int The number of archived revisions
3527 public function isDeleted() {
3528 if ( $this->mNamespace
< 0 ) {
3531 $dbr = wfGetDB( DB_REPLICA
);
3533 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3534 [ 'ar_namespace' => $this->mNamespace
, 'ar_title' => $this->mDbkeyform
],
3537 if ( $this->mNamespace
== NS_FILE
) {
3538 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
3539 [ 'fa_name' => $this->mDbkeyform
],
3548 * Is there a version of this page in the deletion archive?
3552 public function isDeletedQuick() {
3553 if ( $this->mNamespace
< 0 ) {
3556 $dbr = wfGetDB( DB_REPLICA
);
3557 $deleted = (bool)$dbr->selectField( 'archive', '1',
3558 [ 'ar_namespace' => $this->mNamespace
, 'ar_title' => $this->mDbkeyform
],
3561 if ( !$deleted && $this->mNamespace
== NS_FILE
) {
3562 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3563 [ 'fa_name' => $this->mDbkeyform
],
3571 * Get the article ID for this Title from the link cache,
3572 * adding it if necessary
3574 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3576 * @return int The ID
3578 public function getArticleID( $flags = 0 ) {
3579 if ( $this->mNamespace
< 0 ) {
3580 $this->mArticleID
= 0;
3581 return $this->mArticleID
;
3583 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3584 if ( $flags & self
::GAID_FOR_UPDATE
) {
3585 $oldUpdate = $linkCache->forUpdate( true );
3586 $linkCache->clearLink( $this );
3587 $this->mArticleID
= $linkCache->addLinkObj( $this );
3588 $linkCache->forUpdate( $oldUpdate );
3590 if ( -1 == $this->mArticleID
) {
3591 $this->mArticleID
= $linkCache->addLinkObj( $this );
3594 return $this->mArticleID
;
3598 * Is this an article that is a redirect page?
3599 * Uses link cache, adding it if necessary
3601 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3604 public function isRedirect( $flags = 0 ) {
3605 if ( !is_null( $this->mRedirect
) ) {
3606 return $this->mRedirect
;
3608 if ( !$this->getArticleID( $flags ) ) {
3609 $this->mRedirect
= false;
3610 return $this->mRedirect
;
3613 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3614 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3615 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3616 if ( $cached === null ) {
3617 # Trust LinkCache's state over our own
3618 # LinkCache is telling us that the page doesn't exist, despite there being cached
3619 # data relating to an existing page in $this->mArticleID. Updaters should clear
3620 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3621 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3622 # LinkCache to refresh its data from the master.
3623 $this->mRedirect
= false;
3624 return $this->mRedirect
;
3627 $this->mRedirect
= (bool)$cached;
3629 return $this->mRedirect
;
3633 * What is the length of this page?
3634 * Uses link cache, adding it if necessary
3636 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3639 public function getLength( $flags = 0 ) {
3640 if ( $this->mLength
!= -1 ) {
3641 return $this->mLength
;
3643 if ( !$this->getArticleID( $flags ) ) {
3645 return $this->mLength
;
3647 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3648 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3649 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3650 if ( $cached === null ) {
3651 # Trust LinkCache's state over our own, as for isRedirect()
3653 return $this->mLength
;
3656 $this->mLength
= intval( $cached );
3658 return $this->mLength
;
3662 * What is the page_latest field for this page?
3664 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3665 * @return int Int or 0 if the page doesn't exist
3667 public function getLatestRevID( $flags = 0 ) {
3668 if ( !( $flags & self
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
3669 return intval( $this->mLatestID
);
3671 if ( !$this->getArticleID( $flags ) ) {
3672 $this->mLatestID
= 0;
3673 return $this->mLatestID
;
3675 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3676 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3677 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3678 if ( $cached === null ) {
3679 # Trust LinkCache's state over our own, as for isRedirect()
3680 $this->mLatestID
= 0;
3681 return $this->mLatestID
;
3684 $this->mLatestID
= intval( $cached );
3686 return $this->mLatestID
;
3690 * This clears some fields in this object, and clears any associated
3691 * keys in the "bad links" section of the link cache.
3693 * - This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow
3694 * loading of the new page_id. It's also called from
3695 * WikiPage::doDeleteArticleReal()
3697 * @param int $newid The new Article ID
3699 public function resetArticleID( $newid ) {
3700 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3701 $linkCache->clearLink( $this );
3703 if ( $newid === false ) {
3704 $this->mArticleID
= -1;
3706 $this->mArticleID
= intval( $newid );
3708 $this->mRestrictionsLoaded
= false;
3709 $this->mRestrictions
= [];
3710 $this->mOldRestrictions
= false;
3711 $this->mRedirect
= null;
3712 $this->mLength
= -1;
3713 $this->mLatestID
= false;
3714 $this->mContentModel
= false;
3715 $this->mEstimateRevisions
= null;
3716 $this->mPageLanguage
= false;
3717 $this->mDbPageLanguage
= false;
3718 $this->mIsBigDeletion
= null;
3721 public static function clearCaches() {
3722 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3723 $linkCache->clear();
3725 $titleCache = self
::getTitleCache();
3726 $titleCache->clear();
3730 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3732 * @param string $text Containing title to capitalize
3733 * @param int $ns Namespace index, defaults to NS_MAIN
3734 * @return string Containing capitalized title
3736 public static function capitalize( $text, $ns = NS_MAIN
) {
3737 if ( MWNamespace
::isCapitalized( $ns ) ) {
3738 return MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $text );
3745 * Secure and split - main initialisation function for this object
3747 * Assumes that mDbkeyform has been set, and is urldecoded
3748 * and uses underscores, but not otherwise munged. This function
3749 * removes illegal characters, splits off the interwiki and
3750 * namespace prefixes, sets the other forms, and canonicalizes
3753 * @throws MalformedTitleException On invalid titles
3754 * @return bool True on success
3756 private function secureAndSplit() {
3757 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3758 // the parsing code with Title, while avoiding massive refactoring.
3759 // @todo: get rid of secureAndSplit, refactor parsing code.
3760 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3761 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3762 $titleCodec = MediaWikiServices
::getInstance()->getTitleParser();
3763 // MalformedTitleException can be thrown here
3764 $parts = $titleCodec->splitTitleString( $this->mDbkeyform
, $this->mDefaultNamespace
);
3767 $this->setFragment( '#' . $parts['fragment'] );
3768 $this->mInterwiki
= $parts['interwiki'];
3769 $this->mLocalInterwiki
= $parts['local_interwiki'];
3770 $this->mNamespace
= $parts['namespace'];
3771 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3773 $this->mDbkeyform
= $parts['dbkey'];
3774 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3775 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );
3777 # We already know that some pages won't be in the database!
3778 if ( $this->isExternal() ||
$this->isSpecialPage() ) {
3779 $this->mArticleID
= 0;
3786 * Get an array of Title objects linking to this Title
3787 * Also stores the IDs in the link cache.
3789 * WARNING: do not use this function on arbitrary user-supplied titles!
3790 * On heavily-used templates it will max out the memory.
3792 * @param array $options May be FOR UPDATE
3793 * @param string $table Table name
3794 * @param string $prefix Fields prefix
3795 * @return Title[] Array of Title objects linking here
3797 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3798 if ( count( $options ) > 0 ) {
3799 $db = wfGetDB( DB_MASTER
);
3801 $db = wfGetDB( DB_REPLICA
);
3806 self
::getSelectFields(),
3808 "{$prefix}_from=page_id",
3809 "{$prefix}_namespace" => $this->mNamespace
,
3810 "{$prefix}_title" => $this->mDbkeyform
],
3816 if ( $res->numRows() ) {
3817 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3818 foreach ( $res as $row ) {
3819 $titleObj = self
::makeTitle( $row->page_namespace
, $row->page_title
);
3821 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3822 $retVal[] = $titleObj;
3830 * Get an array of Title objects using this Title as a template
3831 * Also stores the IDs in the link cache.
3833 * WARNING: do not use this function on arbitrary user-supplied titles!
3834 * On heavily-used templates it will max out the memory.
3836 * @param array $options Query option to Database::select()
3837 * @return Title[] Array of Title the Title objects linking here
3839 public function getTemplateLinksTo( $options = [] ) {
3840 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3844 * Get an array of Title objects linked from this Title
3845 * Also stores the IDs in the link cache.
3847 * WARNING: do not use this function on arbitrary user-supplied titles!
3848 * On heavily-used templates it will max out the memory.
3850 * @param array $options Query option to Database::select()
3851 * @param string $table Table name
3852 * @param string $prefix Fields prefix
3853 * @return array Array of Title objects linking here
3855 public function getLinksFrom( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3856 $id = $this->getArticleID();
3858 # If the page doesn't exist; there can't be any link from this page
3863 $db = wfGetDB( DB_REPLICA
);
3865 $blNamespace = "{$prefix}_namespace";
3866 $blTitle = "{$prefix}_title";
3868 $pageQuery = WikiPage
::getQueryInfo();
3870 [ $table, 'nestpage' => $pageQuery['tables'] ],
3872 [ $blNamespace, $blTitle ],
3873 $pageQuery['fields']
3875 [ "{$prefix}_from" => $id ],
3880 [ "page_namespace=$blNamespace", "page_title=$blTitle" ]
3881 ] ] +
$pageQuery['joins']
3885 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3886 foreach ( $res as $row ) {
3887 if ( $row->page_id
) {
3888 $titleObj = self
::newFromRow( $row );
3890 $titleObj = self
::makeTitle( $row->$blNamespace, $row->$blTitle );
3891 $linkCache->addBadLinkObj( $titleObj );
3893 $retVal[] = $titleObj;
3900 * Get an array of Title objects used on this Title as a template
3901 * Also stores the IDs in the link cache.
3903 * WARNING: do not use this function on arbitrary user-supplied titles!
3904 * On heavily-used templates it will max out the memory.
3906 * @param array $options May be FOR UPDATE
3907 * @return Title[] Array of Title the Title objects used here
3909 public function getTemplateLinksFrom( $options = [] ) {
3910 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3914 * Get an array of Title objects referring to non-existent articles linked
3917 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3918 * should use redirect table in this case).
3919 * @return Title[] Array of Title the Title objects
3921 public function getBrokenLinksFrom() {
3922 if ( $this->getArticleID() == 0 ) {
3923 # All links from article ID 0 are false positives
3927 $dbr = wfGetDB( DB_REPLICA
);
3928 $res = $dbr->select(
3929 [ 'page', 'pagelinks' ],
3930 [ 'pl_namespace', 'pl_title' ],
3932 'pl_from' => $this->getArticleID(),
3933 'page_namespace IS NULL'
3939 [ 'pl_namespace=page_namespace', 'pl_title=page_title' ]
3945 foreach ( $res as $row ) {
3946 $retVal[] = self
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3952 * Get a list of URLs to purge from the CDN cache when this
3955 * @return string[] Array of String the URLs
3957 public function getCdnUrls() {
3959 $this->getInternalURL(),
3960 $this->getInternalURL( 'action=history' )
3963 $pageLang = $this->getPageLanguage();
3964 if ( $pageLang->hasVariants() ) {
3965 $variants = $pageLang->getVariants();
3966 foreach ( $variants as $vCode ) {
3967 $urls[] = $this->getInternalURL( $vCode );
3971 // If we are looking at a css/js user subpage, purge the action=raw.
3972 if ( $this->isUserJsConfigPage() ) {
3973 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/javascript' );
3974 } elseif ( $this->isUserJsonConfigPage() ) {
3975 $urls[] = $this->getInternalURL( 'action=raw&ctype=application/json' );
3976 } elseif ( $this->isUserCssConfigPage() ) {
3977 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/css' );
3980 Hooks
::run( 'TitleSquidURLs', [ $this, &$urls ] );
3985 * @deprecated since 1.27 use getCdnUrls()
3987 public function getSquidURLs() {
3988 return $this->getCdnUrls();
3992 * Purge all applicable CDN URLs
3994 public function purgeSquid() {
3995 DeferredUpdates
::addUpdate(
3996 new CdnCacheUpdate( $this->getCdnUrls() ),
3997 DeferredUpdates
::PRESEND
4002 * Check whether a given move operation would be valid.
4003 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
4005 * @deprecated since 1.25, use MovePage's methods instead
4006 * @param Title &$nt The new title
4007 * @param bool $auth Whether to check user permissions (uses $wgUser)
4008 * @param string $reason Is the log summary of the move, used for spam checking
4009 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
4011 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
4014 if ( !( $nt instanceof Title
) ) {
4015 // Normally we'd add this to $errors, but we'll get
4016 // lots of syntax errors if $nt is not an object
4017 return [ [ 'badtitletext' ] ];
4020 $mp = new MovePage( $this, $nt );
4021 $errors = $mp->isValidMove()->getErrorsArray();
4023 $errors = wfMergeErrorArrays(
4025 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
4029 return $errors ?
: true;
4033 * Check if the requested move target is a valid file move target
4034 * @todo move this to MovePage
4035 * @param Title $nt Target title
4036 * @return array List of errors
4038 protected function validateFileMoveOperation( $nt ) {
4043 $destFile = wfLocalFile( $nt );
4044 $destFile->load( File
::READ_LATEST
);
4045 if ( !$wgUser->isAllowed( 'reupload-shared' )
4046 && !$destFile->exists() && wfFindFile( $nt )
4048 $errors[] = [ 'file-exists-sharedrepo' ];
4055 * Move a title to a new location
4057 * @deprecated since 1.25, use the MovePage class instead
4058 * @param Title &$nt The new title
4059 * @param bool $auth Indicates whether $wgUser's permissions
4061 * @param string $reason The reason for the move
4062 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
4063 * Ignored if the user doesn't have the suppressredirect right.
4064 * @param array $changeTags Applied to the entry in the move log and redirect page revision
4065 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
4067 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true,
4068 array $changeTags = []
4071 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
4072 if ( is_array( $err ) ) {
4073 // Auto-block user's IP if the account was "hard" blocked
4074 $wgUser->spreadAnyEditBlock();
4077 // Check suppressredirect permission
4078 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
4079 $createRedirect = true;
4082 $mp = new MovePage( $this, $nt );
4083 $status = $mp->move( $wgUser, $reason, $createRedirect, $changeTags );
4084 if ( $status->isOK() ) {
4087 return $status->getErrorsArray();
4092 * Move this page's subpages to be subpages of $nt
4094 * @param Title $nt Move target
4095 * @param bool $auth Whether $wgUser's permissions should be checked
4096 * @param string $reason The reason for the move
4097 * @param bool $createRedirect Whether to create redirects from the old subpages to
4098 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
4099 * @param array $changeTags Applied to the entry in the move log and redirect page revision
4100 * @return array Array with old page titles as keys, and strings (new page titles) or
4101 * getUserPermissionsErrors()-like arrays (errors) as values, or a
4102 * getUserPermissionsErrors()-like error array with numeric indices if
4103 * no pages were moved
4105 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true,
4106 array $changeTags = []
4108 global $wgMaximumMovedPages;
4109 // Check permissions
4110 if ( !$this->userCan( 'move-subpages' ) ) {
4112 [ 'cant-move-subpages' ],
4115 // Do the source and target namespaces support subpages?
4116 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
4118 [ 'namespace-nosubpages', MWNamespace
::getCanonicalName( $this->mNamespace
) ],
4121 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
4123 [ 'namespace-nosubpages', MWNamespace
::getCanonicalName( $nt->getNamespace() ) ],
4127 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
4130 foreach ( $subpages as $oldSubpage ) {
4132 if ( $count > $wgMaximumMovedPages ) {
4133 $retval[$oldSubpage->getPrefixedText()] = [
4134 [ 'movepage-max-pages', $wgMaximumMovedPages ],
4139 // We don't know whether this function was called before
4140 // or after moving the root page, so check both
4142 if ( $oldSubpage->getArticleID() == $this->getArticleID()
4143 ||
$oldSubpage->getArticleID() == $nt->getArticleID()
4145 // When moving a page to a subpage of itself,
4146 // don't move it twice
4149 $newPageName = preg_replace(
4150 '#^' . preg_quote( $this->mDbkeyform
, '#' ) . '#',
4151 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # T23234
4152 $oldSubpage->getDBkey() );
4153 if ( $oldSubpage->isTalkPage() ) {
4154 $newNs = $nt->getTalkPage()->getNamespace();
4156 $newNs = $nt->getSubjectPage()->getNamespace();
4158 # T16385: we need makeTitleSafe because the new page names may
4159 # be longer than 255 characters.
4160 $newSubpage = self
::makeTitleSafe( $newNs, $newPageName );
4162 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect, $changeTags );
4163 if ( $success === true ) {
4164 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
4166 $retval[$oldSubpage->getPrefixedText()] = $success;
4173 * Checks if this page is just a one-rev redirect.
4174 * Adds lock, so don't use just for light purposes.
4178 public function isSingleRevRedirect() {
4179 global $wgContentHandlerUseDB;
4181 $dbw = wfGetDB( DB_MASTER
);
4184 $fields = [ 'page_is_redirect', 'page_latest', 'page_id' ];
4185 if ( $wgContentHandlerUseDB ) {
4186 $fields[] = 'page_content_model';
4189 $row = $dbw->selectRow( 'page',
4195 # Cache some fields we may want
4196 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
4197 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
4198 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
4199 $this->mContentModel
= $row && isset( $row->page_content_model
)
4200 ?
strval( $row->page_content_model
)
4203 if ( !$this->mRedirect
) {
4206 # Does the article have a history?
4207 $row = $dbw->selectField( [ 'page', 'revision' ],
4209 [ 'page_namespace' => $this->mNamespace
,
4210 'page_title' => $this->mDbkeyform
,
4212 'page_latest != rev_id'
4217 # Return true if there was no history
4218 return ( $row === false );
4222 * Checks if $this can be moved to a given Title
4223 * - Selects for update, so don't call it unless you mean business
4225 * @deprecated since 1.25, use MovePage's methods instead
4226 * @param Title $nt The new title to check
4229 public function isValidMoveTarget( $nt ) {
4230 # Is it an existing file?
4231 if ( $nt->getNamespace() == NS_FILE
) {
4232 $file = wfLocalFile( $nt );
4233 $file->load( File
::READ_LATEST
);
4234 if ( $file->exists() ) {
4235 wfDebug( __METHOD__
. ": file exists\n" );
4239 # Is it a redirect with no history?
4240 if ( !$nt->isSingleRevRedirect() ) {
4241 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
4244 # Get the article text
4245 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
4246 if ( !is_object( $rev ) ) {
4249 $content = $rev->getContent();
4250 # Does the redirect point to the source?
4251 # Or is it a broken self-redirect, usually caused by namespace collisions?
4252 $redirTitle = $content ?
$content->getRedirectTarget() : null;
4254 if ( $redirTitle ) {
4255 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
4256 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
4257 wfDebug( __METHOD__
. ": redirect points to other page\n" );
4263 # Fail safe (not a redirect after all. strange.)
4264 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4265 " is a redirect, but it doesn't contain a valid redirect.\n" );
4271 * Get categories to which this Title belongs and return an array of
4272 * categories' names.
4274 * @return array Array of parents in the form:
4275 * $parent => $currentarticle
4277 public function getParentCategories() {
4280 $titleKey = $this->getArticleID();
4282 if ( $titleKey === 0 ) {
4286 $dbr = wfGetDB( DB_REPLICA
);
4288 $res = $dbr->select(
4291 [ 'cl_from' => $titleKey ],
4295 if ( $res->numRows() > 0 ) {
4296 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
4297 foreach ( $res as $row ) {
4298 // $data[] = Title::newFromText( $contLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
4299 $data[$contLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] =
4300 $this->getFullText();
4307 * Get a tree of parent categories
4309 * @param array $children Array with the children in the keys, to check for circular refs
4310 * @return array Tree of parent categories
4312 public function getParentCategoryTree( $children = [] ) {
4314 $parents = $this->getParentCategories();
4317 foreach ( $parents as $parent => $current ) {
4318 if ( array_key_exists( $parent, $children ) ) {
4319 # Circular reference
4320 $stack[$parent] = [];
4322 $nt = self
::newFromText( $parent );
4324 $stack[$parent] = $nt->getParentCategoryTree( $children +
[ $parent => 1 ] );
4334 * Get an associative array for selecting this title from
4337 * @return array Array suitable for the $where parameter of DB::select()
4339 public function pageCond() {
4340 if ( $this->mArticleID
> 0 ) {
4341 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4342 return [ 'page_id' => $this->mArticleID
];
4344 return [ 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
];
4349 * Get next/previous revision ID relative to another revision ID
4350 * @param int $revId Revision ID. Get the revision that was before this one.
4351 * @param int $flags Title::GAID_FOR_UPDATE
4352 * @param string $dir 'next' or 'prev'
4353 * @return int|bool New revision ID, or false if none exists
4355 private function getRelativeRevisionID( $revId, $flags, $dir ) {
4356 $revId = (int)$revId;
4357 if ( $dir === 'next' ) {
4360 } elseif ( $dir === 'prev' ) {
4364 throw new InvalidArgumentException( '$dir must be "next" or "prev"' );
4367 if ( $flags & self
::GAID_FOR_UPDATE
) {
4368 $db = wfGetDB( DB_MASTER
);
4370 $db = wfGetDB( DB_REPLICA
, 'contributions' );
4373 // Intentionally not caring if the specified revision belongs to this
4374 // page. We only care about the timestamp.
4375 $ts = $db->selectField( 'revision', 'rev_timestamp', [ 'rev_id' => $revId ], __METHOD__
);
4376 if ( $ts === false ) {
4377 $ts = $db->selectField( 'archive', 'ar_timestamp', [ 'ar_rev_id' => $revId ], __METHOD__
);
4378 if ( $ts === false ) {
4379 // Or should this throw an InvalidArgumentException or something?
4383 $ts = $db->addQuotes( $ts );
4385 $revId = $db->selectField( 'revision', 'rev_id',
4387 'rev_page' => $this->getArticleID( $flags ),
4388 "rev_timestamp $op $ts OR (rev_timestamp = $ts AND rev_id $op $revId)"
4392 'ORDER BY' => "rev_timestamp $sort, rev_id $sort",
4393 'IGNORE INDEX' => 'rev_timestamp', // Probably needed for T159319
4397 if ( $revId === false ) {
4400 return intval( $revId );
4405 * Get the revision ID of the previous revision
4407 * @param int $revId Revision ID. Get the revision that was before this one.
4408 * @param int $flags Title::GAID_FOR_UPDATE
4409 * @return int|bool Old revision ID, or false if none exists
4411 public function getPreviousRevisionID( $revId, $flags = 0 ) {
4412 return $this->getRelativeRevisionID( $revId, $flags, 'prev' );
4416 * Get the revision ID of the next revision
4418 * @param int $revId Revision ID. Get the revision that was after this one.
4419 * @param int $flags Title::GAID_FOR_UPDATE
4420 * @return int|bool Next revision ID, or false if none exists
4422 public function getNextRevisionID( $revId, $flags = 0 ) {
4423 return $this->getRelativeRevisionID( $revId, $flags, 'next' );
4427 * Get the first revision of the page
4429 * @param int $flags Title::GAID_FOR_UPDATE
4430 * @return Revision|null If page doesn't exist
4432 public function getFirstRevision( $flags = 0 ) {
4433 $pageId = $this->getArticleID( $flags );
4435 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
4436 $revQuery = Revision
::getQueryInfo();
4437 $row = $db->selectRow( $revQuery['tables'], $revQuery['fields'],
4438 [ 'rev_page' => $pageId ],
4441 'ORDER BY' => 'rev_timestamp ASC, rev_id ASC',
4442 'IGNORE INDEX' => [ 'revision' => 'rev_timestamp' ], // See T159319
4447 return new Revision( $row, 0, $this );
4454 * Get the oldest revision timestamp of this page
4456 * @param int $flags Title::GAID_FOR_UPDATE
4457 * @return string|null MW timestamp
4459 public function getEarliestRevTime( $flags = 0 ) {
4460 $rev = $this->getFirstRevision( $flags );
4461 return $rev ?
$rev->getTimestamp() : null;
4465 * Check if this is a new page
4469 public function isNewPage() {
4470 $dbr = wfGetDB( DB_REPLICA
);
4471 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4475 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4479 public function isBigDeletion() {
4480 global $wgDeleteRevisionsLimit;
4482 if ( !$wgDeleteRevisionsLimit ) {
4486 if ( $this->mIsBigDeletion
=== null ) {
4487 $dbr = wfGetDB( DB_REPLICA
);
4489 $revCount = $dbr->selectRowCount(
4492 [ 'rev_page' => $this->getArticleID() ],
4494 [ 'LIMIT' => $wgDeleteRevisionsLimit +
1 ]
4497 $this->mIsBigDeletion
= $revCount > $wgDeleteRevisionsLimit;
4500 return $this->mIsBigDeletion
;
4504 * Get the approximate revision count of this page.
4508 public function estimateRevisionCount() {
4509 if ( !$this->exists() ) {
4513 if ( $this->mEstimateRevisions
=== null ) {
4514 $dbr = wfGetDB( DB_REPLICA
);
4515 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4516 [ 'rev_page' => $this->getArticleID() ], __METHOD__
);
4519 return $this->mEstimateRevisions
;
4523 * Get the number of revisions between the given revision.
4524 * Used for diffs and other things that really need it.
4526 * @param int|Revision $old Old revision or rev ID (first before range)
4527 * @param int|Revision $new New revision or rev ID (first after range)
4528 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4529 * @return int Number of revisions between these revisions.
4531 public function countRevisionsBetween( $old, $new, $max = null ) {
4532 if ( !( $old instanceof Revision
) ) {
4533 $old = Revision
::newFromTitle( $this, (int)$old );
4535 if ( !( $new instanceof Revision
) ) {
4536 $new = Revision
::newFromTitle( $this, (int)$new );
4538 if ( !$old ||
!$new ) {
4539 return 0; // nothing to compare
4541 $dbr = wfGetDB( DB_REPLICA
);
4543 'rev_page' => $this->getArticleID(),
4544 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4545 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4547 if ( $max !== null ) {
4548 return $dbr->selectRowCount( 'revision', '1',
4551 [ 'LIMIT' => $max +
1 ] // extra to detect truncation
4554 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
4559 * Get the authors between the given revisions or revision IDs.
4560 * Used for diffs and other things that really need it.
4564 * @param int|Revision $old Old revision or rev ID (first before range by default)
4565 * @param int|Revision $new New revision or rev ID (first after range by default)
4566 * @param int $limit Maximum number of authors
4567 * @param string|array $options (Optional): Single option, or an array of options:
4568 * 'include_old' Include $old in the range; $new is excluded.
4569 * 'include_new' Include $new in the range; $old is excluded.
4570 * 'include_both' Include both $old and $new in the range.
4571 * Unknown option values are ignored.
4572 * @return array|null Names of revision authors in the range; null if not both revisions exist
4574 public function getAuthorsBetween( $old, $new, $limit, $options = [] ) {
4575 if ( !( $old instanceof Revision
) ) {
4576 $old = Revision
::newFromTitle( $this, (int)$old );
4578 if ( !( $new instanceof Revision
) ) {
4579 $new = Revision
::newFromTitle( $this, (int)$new );
4581 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4582 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4583 // in the sanity check below?
4584 if ( !$old ||
!$new ) {
4585 return null; // nothing to compare
4590 $options = (array)$options;
4591 if ( in_array( 'include_old', $options ) ) {
4594 if ( in_array( 'include_new', $options ) ) {
4597 if ( in_array( 'include_both', $options ) ) {
4601 // No DB query needed if $old and $new are the same or successive revisions:
4602 if ( $old->getId() === $new->getId() ) {
4603 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
4605 [ $old->getUserText( Revision
::RAW
) ];
4606 } elseif ( $old->getId() === $new->getParentId() ) {
4607 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4608 $authors[] = $old->getUserText( Revision
::RAW
);
4609 if ( $old->getUserText( Revision
::RAW
) != $new->getUserText( Revision
::RAW
) ) {
4610 $authors[] = $new->getUserText( Revision
::RAW
);
4612 } elseif ( $old_cmp === '>=' ) {
4613 $authors[] = $old->getUserText( Revision
::RAW
);
4614 } elseif ( $new_cmp === '<=' ) {
4615 $authors[] = $new->getUserText( Revision
::RAW
);
4619 $dbr = wfGetDB( DB_REPLICA
);
4620 $revQuery = Revision
::getQueryInfo();
4621 $authors = $dbr->selectFieldValues(
4622 $revQuery['tables'],
4623 $revQuery['fields']['rev_user_text'],
4625 'rev_page' => $this->getArticleID(),
4626 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4627 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4629 [ 'DISTINCT', 'LIMIT' => $limit +
1 ], // add one so caller knows it was truncated
4636 * Get the number of authors between the given revisions or revision IDs.
4637 * Used for diffs and other things that really need it.
4639 * @param int|Revision $old Old revision or rev ID (first before range by default)
4640 * @param int|Revision $new New revision or rev ID (first after range by default)
4641 * @param int $limit Maximum number of authors
4642 * @param string|array $options (Optional): Single option, or an array of options:
4643 * 'include_old' Include $old in the range; $new is excluded.
4644 * 'include_new' Include $new in the range; $old is excluded.
4645 * 'include_both' Include both $old and $new in the range.
4646 * Unknown option values are ignored.
4647 * @return int Number of revision authors in the range; zero if not both revisions exist
4649 public function countAuthorsBetween( $old, $new, $limit, $options = [] ) {
4650 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4651 return $authors ?
count( $authors ) : 0;
4655 * Compare with another title.
4657 * @param Title $title
4660 public function equals( Title
$title ) {
4661 // Note: === is necessary for proper matching of number-like titles.
4662 return $this->mInterwiki
=== $title->mInterwiki
4663 && $this->mNamespace
== $title->mNamespace
4664 && $this->mDbkeyform
=== $title->mDbkeyform
;
4668 * Check if this title is a subpage of another title
4670 * @param Title $title
4673 public function isSubpageOf( Title
$title ) {
4674 return $this->mInterwiki
=== $title->mInterwiki
4675 && $this->mNamespace
== $title->mNamespace
4676 && strpos( $this->mDbkeyform
, $title->mDbkeyform
. '/' ) === 0;
4680 * Check if page exists. For historical reasons, this function simply
4681 * checks for the existence of the title in the page table, and will
4682 * thus return false for interwiki links, special pages and the like.
4683 * If you want to know if a title can be meaningfully viewed, you should
4684 * probably call the isKnown() method instead.
4686 * @param int $flags An optional bit field; may be Title::GAID_FOR_UPDATE to check
4687 * from master/for update
4690 public function exists( $flags = 0 ) {
4691 $exists = $this->getArticleID( $flags ) != 0;
4692 Hooks
::run( 'TitleExists', [ $this, &$exists ] );
4697 * Should links to this title be shown as potentially viewable (i.e. as
4698 * "bluelinks"), even if there's no record by this title in the page
4701 * This function is semi-deprecated for public use, as well as somewhat
4702 * misleadingly named. You probably just want to call isKnown(), which
4703 * calls this function internally.
4705 * (ISSUE: Most of these checks are cheap, but the file existence check
4706 * can potentially be quite expensive. Including it here fixes a lot of
4707 * existing code, but we might want to add an optional parameter to skip
4708 * it and any other expensive checks.)
4712 public function isAlwaysKnown() {
4716 * Allows overriding default behavior for determining if a page exists.
4717 * If $isKnown is kept as null, regular checks happen. If it's
4718 * a boolean, this value is returned by the isKnown method.
4722 * @param Title $title
4723 * @param bool|null $isKnown
4725 Hooks
::run( 'TitleIsAlwaysKnown', [ $this, &$isKnown ] );
4727 if ( !is_null( $isKnown ) ) {
4731 if ( $this->isExternal() ) {
4732 return true; // any interwiki link might be viewable, for all we know
4735 switch ( $this->mNamespace
) {
4738 // file exists, possibly in a foreign repo
4739 return (bool)wfFindFile( $this );
4741 // valid special page
4742 return MediaWikiServices
::getInstance()->getSpecialPageFactory()->
4743 exists( $this->mDbkeyform
);
4745 // selflink, possibly with fragment
4746 return $this->mDbkeyform
== '';
4748 // known system message
4749 return $this->hasSourceText() !== false;
4756 * Does this title refer to a page that can (or might) be meaningfully
4757 * viewed? In particular, this function may be used to determine if
4758 * links to the title should be rendered as "bluelinks" (as opposed to
4759 * "redlinks" to non-existent pages).
4760 * Adding something else to this function will cause inconsistency
4761 * since LinkHolderArray calls isAlwaysKnown() and does its own
4762 * page existence check.
4766 public function isKnown() {
4767 return $this->isAlwaysKnown() ||
$this->exists();
4771 * Does this page have source text?
4775 public function hasSourceText() {
4776 if ( $this->exists() ) {
4780 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4781 // If the page doesn't exist but is a known system message, default
4782 // message content will be displayed, same for language subpages-
4783 // Use always content language to avoid loading hundreds of languages
4784 // to get the link color.
4785 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
4786 list( $name, ) = MessageCache
::singleton()->figureMessage(
4787 $contLang->lcfirst( $this->getText() )
4789 $message = wfMessage( $name )->inLanguage( $contLang )->useDatabase( false );
4790 return $message->exists();
4797 * Get the default (plain) message contents for an page that overrides an
4798 * interface message key.
4800 * Primary use cases:
4803 * - Show default when viewing the page. The Article::getSubstituteContent
4804 * method displays the default message content, instead of the
4805 * 'noarticletext' placeholder message normally used.
4808 * - Title of edit page. When creating an interface message override,
4809 * the editor is told they are "Editing the page", instead of
4810 * "Creating the page". (EditPage::setHeaders)
4811 * - Edit notice. The 'translateinterface' edit notice is shown when creating
4812 * or editing a an interface message override. (EditPage::showIntro)
4813 * - Opening the editor. The contents of the localisation message are used
4814 * as contents of the editor when creating a new page in the MediaWiki
4815 * namespace. This simplifies the process for editors when "changing"
4816 * an interface message by creating an override. (EditPage::getContentObject)
4817 * - Showing a diff. The left-hand side of a diff when an editor is
4818 * previewing their changes before saving the creation of a page in the
4819 * MediaWiki namespace. (EditPage::showDiff)
4820 * - Disallowing a save. When attempting to create a a MediaWiki-namespace
4821 * page with the proposed content matching the interface message default,
4822 * the save is rejected, the same way we disallow blank pages from being
4823 * created. (EditPage::internalAttemptSave)
4826 * - Default content, when using the 'prepend' or 'append' feature.
4829 * - Label the create action as "Edit", if the page can be an override.
4831 * @return string|bool
4833 public function getDefaultMessageText() {
4834 if ( $this->mNamespace
!= NS_MEDIAWIKI
) { // Just in case
4838 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4839 MediaWikiServices
::getInstance()->getContentLanguage()->lcfirst( $this->getText() )
4841 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4843 if ( $message->exists() ) {
4844 return $message->plain();
4851 * Updates page_touched for this page; called from LinksUpdate.php
4853 * @param string|null $purgeTime [optional] TS_MW timestamp
4854 * @return bool True if the update succeeded
4856 public function invalidateCache( $purgeTime = null ) {
4857 if ( wfReadOnly() ) {
4859 } elseif ( $this->mArticleID
=== 0 ) {
4860 return true; // avoid gap locking if we know it's not there
4863 $dbw = wfGetDB( DB_MASTER
);
4864 $dbw->onTransactionPreCommitOrIdle(
4865 function () use ( $dbw ) {
4866 ResourceLoaderWikiModule
::invalidateModuleCache(
4867 $this, null, null, $dbw->getDomainId() );
4872 $conds = $this->pageCond();
4873 DeferredUpdates
::addUpdate(
4874 new AutoCommitUpdate(
4877 function ( IDatabase
$dbw, $fname ) use ( $conds, $purgeTime ) {
4878 $dbTimestamp = $dbw->timestamp( $purgeTime ?
: time() );
4881 [ 'page_touched' => $dbTimestamp ],
4882 $conds +
[ 'page_touched < ' . $dbw->addQuotes( $dbTimestamp ) ],
4885 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $this );
4888 DeferredUpdates
::PRESEND
4895 * Update page_touched timestamps and send CDN purge messages for
4896 * pages linking to this title. May be sent to the job queue depending
4897 * on the number of links. Typically called on create and delete.
4899 public function touchLinks() {
4900 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this, 'pagelinks', 'page-touch' ) );
4901 if ( $this->mNamespace
== NS_CATEGORY
) {
4902 DeferredUpdates
::addUpdate(
4903 new HTMLCacheUpdate( $this, 'categorylinks', 'category-touch' )
4909 * Get the last touched timestamp
4911 * @param IDatabase|null $db
4912 * @return string|false Last-touched timestamp
4914 public function getTouched( $db = null ) {
4915 if ( $db === null ) {
4916 $db = wfGetDB( DB_REPLICA
);
4918 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4923 * Get the timestamp when this page was updated since the user last saw it.
4925 * @param User|null $user
4926 * @return string|null
4928 public function getNotificationTimestamp( $user = null ) {
4931 // Assume current user if none given
4935 // Check cache first
4936 $uid = $user->getId();
4940 // avoid isset here, as it'll return false for null entries
4941 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4942 return $this->mNotificationTimestamp
[$uid];
4944 // Don't cache too much!
4945 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4946 $this->mNotificationTimestamp
= [];
4949 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
4950 $watchedItem = $store->getWatchedItem( $user, $this );
4951 if ( $watchedItem ) {
4952 $this->mNotificationTimestamp
[$uid] = $watchedItem->getNotificationTimestamp();
4954 $this->mNotificationTimestamp
[$uid] = false;
4957 return $this->mNotificationTimestamp
[$uid];
4961 * Generate strings used for xml 'id' names in monobook tabs
4963 * @param string $prepend Defaults to 'nstab-'
4964 * @return string XML 'id' name
4966 public function getNamespaceKey( $prepend = 'nstab-' ) {
4967 // Gets the subject namespace of this title
4968 $subjectNS = MWNamespace
::getSubject( $this->mNamespace
);
4969 // Prefer canonical namespace name for HTML IDs
4970 $namespaceKey = MWNamespace
::getCanonicalName( $subjectNS );
4971 if ( $namespaceKey === false ) {
4972 // Fallback to localised text
4973 $namespaceKey = $this->getSubjectNsText();
4975 // Makes namespace key lowercase
4976 $namespaceKey = MediaWikiServices
::getInstance()->getContentLanguage()->lc( $namespaceKey );
4978 if ( $namespaceKey == '' ) {
4979 $namespaceKey = 'main';
4981 // Changes file to image for backwards compatibility
4982 if ( $namespaceKey == 'file' ) {
4983 $namespaceKey = 'image';
4985 return $prepend . $namespaceKey;
4989 * Get all extant redirects to this Title
4991 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4992 * @return Title[] Array of Title redirects to this title
4994 public function getRedirectsHere( $ns = null ) {
4997 $dbr = wfGetDB( DB_REPLICA
);
4999 'rd_namespace' => $this->mNamespace
,
5000 'rd_title' => $this->mDbkeyform
,
5003 if ( $this->isExternal() ) {
5004 $where['rd_interwiki'] = $this->mInterwiki
;
5006 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
5008 if ( !is_null( $ns ) ) {
5009 $where['page_namespace'] = $ns;
5012 $res = $dbr->select(
5013 [ 'redirect', 'page' ],
5014 [ 'page_namespace', 'page_title' ],
5019 foreach ( $res as $row ) {
5020 $redirs[] = self
::newFromRow( $row );
5026 * Check if this Title is a valid redirect target
5030 public function isValidRedirectTarget() {
5031 global $wgInvalidRedirectTargets;
5033 if ( $this->isSpecialPage() ) {
5034 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
5035 if ( $this->isSpecial( 'Userlogout' ) ) {
5039 foreach ( $wgInvalidRedirectTargets as $target ) {
5040 if ( $this->isSpecial( $target ) ) {
5050 * Get a backlink cache object
5052 * @return BacklinkCache
5054 public function getBacklinkCache() {
5055 return BacklinkCache
::get( $this );
5059 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
5063 public function canUseNoindex() {
5064 global $wgExemptFromUserRobotsControl;
5066 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
5067 ? MWNamespace
::getContentNamespaces()
5068 : $wgExemptFromUserRobotsControl;
5070 return !in_array( $this->mNamespace
, $bannedNamespaces );
5074 * Returns the raw sort key to be used for categories, with the specified
5075 * prefix. This will be fed to Collation::getSortKey() to get a
5076 * binary sortkey that can be used for actual sorting.
5078 * @param string $prefix The prefix to be used, specified using
5079 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
5083 public function getCategorySortkey( $prefix = '' ) {
5084 $unprefixed = $this->getText();
5086 // Anything that uses this hook should only depend
5087 // on the Title object passed in, and should probably
5088 // tell the users to run updateCollations.php --force
5089 // in order to re-sort existing category relations.
5090 Hooks
::run( 'GetDefaultSortkey', [ $this, &$unprefixed ] );
5091 if ( $prefix !== '' ) {
5092 # Separate with a line feed, so the unprefixed part is only used as
5093 # a tiebreaker when two pages have the exact same prefix.
5094 # In UCA, tab is the only character that can sort above LF
5095 # so we strip both of them from the original prefix.
5096 $prefix = strtr( $prefix, "\n\t", ' ' );
5097 return "$prefix\n$unprefixed";
5103 * Returns the page language code saved in the database, if $wgPageLanguageUseDB is set
5104 * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
5105 * the db, it will return NULL.
5107 * @return string|null|bool
5109 private function getDbPageLanguageCode() {
5110 global $wgPageLanguageUseDB;
5112 // check, if the page language could be saved in the database, and if so and
5113 // the value is not requested already, lookup the page language using LinkCache
5114 if ( $wgPageLanguageUseDB && $this->mDbPageLanguage
=== false ) {
5115 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
5116 $linkCache->addLinkObj( $this );
5117 $this->mDbPageLanguage
= $linkCache->getGoodLinkFieldObj( $this, 'lang' );
5120 return $this->mDbPageLanguage
;
5124 * Get the language in which the content of this page is written in
5125 * wikitext. Defaults to content language, but in certain cases it can be
5126 * e.g. $wgLang (such as special pages, which are in the user language).
5131 public function getPageLanguage() {
5132 global $wgLang, $wgLanguageCode;
5133 if ( $this->isSpecialPage() ) {
5134 // special pages are in the user language
5138 // Checking if DB language is set
5139 $dbPageLanguage = $this->getDbPageLanguageCode();
5140 if ( $dbPageLanguage ) {
5141 return wfGetLangObj( $dbPageLanguage );
5144 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
5145 // Note that this may depend on user settings, so the cache should
5146 // be only per-request.
5147 // NOTE: ContentHandler::getPageLanguage() may need to load the
5148 // content to determine the page language!
5149 // Checking $wgLanguageCode hasn't changed for the benefit of unit
5151 $contentHandler = ContentHandler
::getForTitle( $this );
5152 $langObj = $contentHandler->getPageLanguage( $this );
5153 $this->mPageLanguage
= [ $langObj->getCode(), $wgLanguageCode ];
5155 $langObj = Language
::factory( $this->mPageLanguage
[0] );
5162 * Get the language in which the content of this page is written when
5163 * viewed by user. Defaults to content language, but in certain cases it can be
5164 * e.g. $wgLang (such as special pages, which are in the user language).
5169 public function getPageViewLanguage() {
5172 if ( $this->isSpecialPage() ) {
5173 // If the user chooses a variant, the content is actually
5174 // in a language whose code is the variant code.
5175 $variant = $wgLang->getPreferredVariant();
5176 if ( $wgLang->getCode() !== $variant ) {
5177 return Language
::factory( $variant );
5183 // Checking if DB language is set
5184 $dbPageLanguage = $this->getDbPageLanguageCode();
5185 if ( $dbPageLanguage ) {
5186 $pageLang = wfGetLangObj( $dbPageLanguage );
5187 $variant = $pageLang->getPreferredVariant();
5188 if ( $pageLang->getCode() !== $variant ) {
5189 $pageLang = Language
::factory( $variant );
5195 // @note Can't be cached persistently, depends on user settings.
5196 // @note ContentHandler::getPageViewLanguage() may need to load the
5197 // content to determine the page language!
5198 $contentHandler = ContentHandler
::getForTitle( $this );
5199 $pageLang = $contentHandler->getPageViewLanguage( $this );
5204 * Get a list of rendered edit notices for this page.
5206 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
5207 * they will already be wrapped in paragraphs.
5210 * @param int $oldid Revision ID that's being edited
5213 public function getEditNotices( $oldid = 0 ) {
5216 // Optional notice for the entire namespace
5217 $editnotice_ns = 'editnotice-' . $this->mNamespace
;
5218 $msg = wfMessage( $editnotice_ns );
5219 if ( $msg->exists() ) {
5220 $html = $msg->parseAsBlock();
5221 // Edit notices may have complex logic, but output nothing (T91715)
5222 if ( trim( $html ) !== '' ) {
5223 $notices[$editnotice_ns] = Html
::rawElement(
5227 'mw-editnotice-namespace',
5228 Sanitizer
::escapeClass( "mw-$editnotice_ns" )
5235 if ( MWNamespace
::hasSubpages( $this->mNamespace
) ) {
5236 // Optional notice for page itself and any parent page
5237 $parts = explode( '/', $this->mDbkeyform
);
5238 $editnotice_base = $editnotice_ns;
5239 while ( count( $parts ) > 0 ) {
5240 $editnotice_base .= '-' . array_shift( $parts );
5241 $msg = wfMessage( $editnotice_base );
5242 if ( $msg->exists() ) {
5243 $html = $msg->parseAsBlock();
5244 if ( trim( $html ) !== '' ) {
5245 $notices[$editnotice_base] = Html
::rawElement(
5249 'mw-editnotice-base',
5250 Sanitizer
::escapeClass( "mw-$editnotice_base" )
5258 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
5259 $editnoticeText = $editnotice_ns . '-' . strtr( $this->mDbkeyform
, '/', '-' );
5260 $msg = wfMessage( $editnoticeText );
5261 if ( $msg->exists() ) {
5262 $html = $msg->parseAsBlock();
5263 if ( trim( $html ) !== '' ) {
5264 $notices[$editnoticeText] = Html
::rawElement(
5268 'mw-editnotice-page',
5269 Sanitizer
::escapeClass( "mw-$editnoticeText" )
5277 Hooks
::run( 'TitleGetEditNotices', [ $this, $oldid, &$notices ] );
5284 public function __sleep() {
5292 'mDefaultNamespace',
5296 public function __wakeup() {
5297 $this->mArticleID
= ( $this->mNamespace
>= 0 ) ?
-1 : 0;
5298 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
5299 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );