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 HashBagOStuff */
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;
137 /** @var string Text form including namespace/interwiki, initialised on demand */
138 protected $mPrefixedText = null;
140 /** @var mixed Cached value for getTitleProtection (create protection) */
141 public $mTitleProtection;
144 * @var int Namespace index when there is no namespace. Don't change the
145 * following default, NS_MAIN is hardcoded in several places. See T2696.
146 * Zero except in {{transclusion}} tags.
148 public $mDefaultNamespace = NS_MAIN
;
150 /** @var int The page length, 0 for special pages */
151 protected $mLength = -1;
153 /** @var null Is the article at this title a redirect? */
154 public $mRedirect = null;
156 /** @var array Associative array of user ID -> timestamp/false */
157 private $mNotificationTimestamp = [];
159 /** @var bool Whether a page has any subpages */
160 private $mHasSubpages;
162 /** @var bool The (string) language code of the page's language and content code. */
163 private $mPageLanguage = false;
165 /** @var string|bool|null The page language code from the database, null if not saved in
166 * the database or false if not loaded, yet. */
167 private $mDbPageLanguage = false;
169 /** @var TitleValue A corresponding TitleValue object */
170 private $mTitleValue = null;
172 /** @var bool Would deleting this page be a big deletion? */
173 private $mIsBigDeletion = null;
177 * B/C kludge: provide a TitleParser for use by Title.
178 * Ideally, Title would have no methods that need this.
179 * Avoid usage of this singleton by using TitleValue
180 * and the associated services when possible.
182 * @return TitleFormatter
184 private static function getTitleFormatter() {
185 return MediaWikiServices
::getInstance()->getTitleFormatter();
189 * B/C kludge: provide an InterwikiLookup for use by Title.
190 * Ideally, Title would have no methods that need this.
191 * Avoid usage of this singleton by using TitleValue
192 * and the associated services when possible.
194 * @return InterwikiLookup
196 private static function getInterwikiLookup() {
197 return MediaWikiServices
::getInstance()->getInterwikiLookup();
203 function __construct() {
207 * Create a new Title from a prefixed DB key
209 * @param string $key The database key, which has underscores
210 * instead of spaces, possibly including namespace and
212 * @return Title|null Title, or null on an error
214 public static function newFromDBkey( $key ) {
216 $t->mDbkeyform
= $key;
219 $t->secureAndSplit();
221 } catch ( MalformedTitleException
$ex ) {
227 * Create a new Title from a TitleValue
229 * @param TitleValue $titleValue Assumed to be safe.
233 public static function newFromTitleValue( TitleValue
$titleValue ) {
234 return self
::newFromLinkTarget( $titleValue );
238 * Create a new Title from a LinkTarget
240 * @param LinkTarget $linkTarget Assumed to be safe.
244 public static function newFromLinkTarget( LinkTarget
$linkTarget ) {
245 if ( $linkTarget instanceof Title
) {
246 // Special case if it's already a Title object
249 return self
::makeTitle(
250 $linkTarget->getNamespace(),
251 $linkTarget->getText(),
252 $linkTarget->getFragment(),
253 $linkTarget->getInterwiki()
258 * Create a new Title from text, such as what one would find in a link. De-
259 * codes any HTML entities in the text.
261 * Title objects returned by this method are guaranteed to be valid, and
262 * thus return true from the isValid() method.
264 * @param string|int|null $text The link text; spaces, prefixes, and an
265 * initial ':' indicating the main namespace are accepted.
266 * @param int $defaultNamespace The namespace to use if none is specified
267 * by a prefix. If you want to force a specific namespace even if
268 * $text might begin with a namespace prefix, use makeTitle() or
270 * @throws InvalidArgumentException
271 * @return Title|null Title or null on an error.
273 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
274 // DWIM: Integers can be passed in here when page titles are used as array keys.
275 if ( $text !== null && !is_string( $text ) && !is_int( $text ) ) {
276 throw new InvalidArgumentException( '$text must be a string.' );
278 if ( $text === null ) {
283 return self
::newFromTextThrow( strval( $text ), $defaultNamespace );
284 } catch ( MalformedTitleException
$ex ) {
290 * Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,
291 * rather than returning null.
293 * The exception subclasses encode detailed information about why the title is invalid.
295 * Title objects returned by this method are guaranteed to be valid, and
296 * thus return true from the isValid() method.
298 * @see Title::newFromText
301 * @param string $text Title text to check
302 * @param int $defaultNamespace
303 * @throws MalformedTitleException If the title is invalid
306 public static function newFromTextThrow( $text, $defaultNamespace = NS_MAIN
) {
307 if ( is_object( $text ) ) {
308 throw new MWException( '$text must be a string, given an object' );
311 $titleCache = self
::getTitleCache();
313 // Wiki pages often contain multiple links to the same page.
314 // Title normalization and parsing can become expensive on pages with many
315 // links, so we can save a little time by caching them.
316 // In theory these are value objects and won't get changed...
317 if ( $defaultNamespace == NS_MAIN
) {
318 $t = $titleCache->get( $text );
324 // Convert things like é ā or 〗 into normalized (T16952) text
325 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
328 $t->mDbkeyform
= strtr( $filteredText, ' ', '_' );
329 $t->mDefaultNamespace
= intval( $defaultNamespace );
331 $t->secureAndSplit();
332 if ( $defaultNamespace == NS_MAIN
) {
333 $titleCache->set( $text, $t );
339 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
341 * Example of wrong and broken code:
342 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
344 * Example of right code:
345 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
347 * Create a new Title from URL-encoded text. Ensures that
348 * the given title's length does not exceed the maximum.
350 * @param string $url The title, as might be taken from a URL
351 * @return Title|null The new object, or null on an error
353 public static function newFromURL( $url ) {
356 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
357 # but some URLs used it as a space replacement and they still come
358 # from some external search tools.
359 if ( strpos( self
::legalChars(), '+' ) === false ) {
360 $url = strtr( $url, '+', ' ' );
363 $t->mDbkeyform
= strtr( $url, ' ', '_' );
366 $t->secureAndSplit();
368 } catch ( MalformedTitleException
$ex ) {
374 * @return HashBagOStuff
376 private static function getTitleCache() {
377 if ( self
::$titleCache == null ) {
378 self
::$titleCache = new HashBagOStuff( [ 'maxKeys' => self
::CACHE_MAX
] );
380 return self
::$titleCache;
384 * Returns a list of fields that are to be selected for initializing Title
385 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
386 * whether to include page_content_model.
390 protected static function getSelectFields() {
391 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
394 'page_namespace', 'page_title', 'page_id',
395 'page_len', 'page_is_redirect', 'page_latest',
398 if ( $wgContentHandlerUseDB ) {
399 $fields[] = 'page_content_model';
402 if ( $wgPageLanguageUseDB ) {
403 $fields[] = 'page_lang';
410 * Create a new Title from an article ID
412 * @param int $id The page_id corresponding to the Title to create
413 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
414 * @return Title|null The new object, or null on an error
416 public static function newFromID( $id, $flags = 0 ) {
417 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
418 $row = $db->selectRow(
420 self
::getSelectFields(),
421 [ 'page_id' => $id ],
424 if ( $row !== false ) {
425 $title = self
::newFromRow( $row );
433 * Make an array of titles from an array of IDs
435 * @param int[] $ids Array of IDs
436 * @return Title[] Array of Titles
438 public static function newFromIDs( $ids ) {
439 if ( !count( $ids ) ) {
442 $dbr = wfGetDB( DB_REPLICA
);
446 self
::getSelectFields(),
447 [ 'page_id' => $ids ],
452 foreach ( $res as $row ) {
453 $titles[] = self
::newFromRow( $row );
459 * Make a Title object from a DB row
461 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
462 * @return Title Corresponding Title
464 public static function newFromRow( $row ) {
465 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
466 $t->loadFromRow( $row );
471 * Load Title object fields from a DB row.
472 * If false is given, the title will be treated as non-existing.
474 * @param stdClass|bool $row Database row
476 public function loadFromRow( $row ) {
477 if ( $row ) { // page found
478 if ( isset( $row->page_id
) ) {
479 $this->mArticleID
= (int)$row->page_id
;
481 if ( isset( $row->page_len
) ) {
482 $this->mLength
= (int)$row->page_len
;
484 if ( isset( $row->page_is_redirect
) ) {
485 $this->mRedirect
= (bool)$row->page_is_redirect
;
487 if ( isset( $row->page_latest
) ) {
488 $this->mLatestID
= (int)$row->page_latest
;
490 if ( !$this->mForcedContentModel
&& isset( $row->page_content_model
) ) {
491 $this->mContentModel
= strval( $row->page_content_model
);
492 } elseif ( !$this->mForcedContentModel
) {
493 $this->mContentModel
= false; # initialized lazily in getContentModel()
495 if ( isset( $row->page_lang
) ) {
496 $this->mDbPageLanguage
= (string)$row->page_lang
;
498 if ( isset( $row->page_restrictions
) ) {
499 $this->mOldRestrictions
= $row->page_restrictions
;
501 } else { // page not found
502 $this->mArticleID
= 0;
504 $this->mRedirect
= false;
505 $this->mLatestID
= 0;
506 if ( !$this->mForcedContentModel
) {
507 $this->mContentModel
= false; # initialized lazily in getContentModel()
513 * Create a new Title from a namespace index and a DB key.
515 * It's assumed that $ns and $title are safe, for instance when
516 * they came directly from the database or a special page name,
517 * not from user input.
519 * No validation is applied. For convenience, spaces are normalized
520 * to underscores, so that e.g. user_text fields can be used directly.
522 * @note This method may return Title objects that are "invalid"
523 * according to the isValid() method. This is usually caused by
524 * configuration changes: e.g. a namespace that was once defined is
525 * no longer configured, or a character that was once allowed in
526 * titles is now forbidden.
528 * @param int $ns The namespace of the article
529 * @param string $title The unprefixed database key form
530 * @param string $fragment The link fragment (after the "#")
531 * @param string $interwiki The interwiki prefix
532 * @return Title The new object
534 public static function makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
536 $t->mInterwiki
= $interwiki;
537 $t->mFragment
= $fragment;
538 $t->mNamespace
= $ns = intval( $ns );
539 $t->mDbkeyform
= strtr( $title, ' ', '_' );
540 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
541 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
542 $t->mTextform
= strtr( $title, '_', ' ' );
543 $t->mContentModel
= false; # initialized lazily in getContentModel()
548 * Create a new Title from a namespace index and a DB key.
549 * The parameters will be checked for validity, which is a bit slower
550 * than makeTitle() but safer for user-provided data.
552 * Title objects returned by makeTitleSafe() are guaranteed to be valid,
553 * that is, they return true from the isValid() method. If no valid Title
554 * can be constructed from the input, this method returns null.
556 * @param int $ns The namespace of the article
557 * @param string $title Database key form
558 * @param string $fragment The link fragment (after the "#")
559 * @param string $interwiki Interwiki prefix
560 * @return Title|null The new object, or null on an error
562 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
563 // NOTE: ideally, this would just call makeTitle() and then isValid(),
564 // but presently, that means more overhead on a potential performance hotspot.
566 if ( !MWNamespace
::exists( $ns ) ) {
571 $t->mDbkeyform
= self
::makeName( $ns, $title, $fragment, $interwiki, true );
574 $t->secureAndSplit();
576 } catch ( MalformedTitleException
$ex ) {
582 * Create a new Title for the Main Page
584 * @return Title The new object
586 public static function newMainPage() {
587 $title = self
::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
588 // Don't give fatal errors if the message is broken
590 $title = self
::newFromText( 'Main Page' );
596 * Get the prefixed DB key associated with an ID
598 * @param int $id The page_id of the article
599 * @return Title|null An object representing the article, or null if no such article was found
601 public static function nameOf( $id ) {
602 $dbr = wfGetDB( DB_REPLICA
);
604 $s = $dbr->selectRow(
606 [ 'page_namespace', 'page_title' ],
607 [ 'page_id' => $id ],
610 if ( $s === false ) {
614 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
619 * Get a regex character class describing the legal characters in a link
621 * @return string The list of characters, not delimited
623 public static function legalChars() {
624 global $wgLegalTitleChars;
625 return $wgLegalTitleChars;
629 * Utility method for converting a character sequence from bytes to Unicode.
631 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
632 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
634 * @param string $byteClass
637 public static function convertByteClassToUnicodeClass( $byteClass ) {
638 $length = strlen( $byteClass );
640 $x0 = $x1 = $x2 = '';
642 $d0 = $d1 = $d2 = '';
643 // Decoded integer codepoints
644 $ord0 = $ord1 = $ord2 = 0;
646 $r0 = $r1 = $r2 = '';
650 $allowUnicode = false;
651 for ( $pos = 0; $pos < $length; $pos++
) {
652 // Shift the queues down
661 // Load the current input token and decoded values
662 $inChar = $byteClass[$pos];
663 if ( $inChar == '\\' ) {
664 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos +
1 ) ) {
665 $x0 = $inChar . $m[0];
666 $d0 = chr( hexdec( $m[1] ) );
667 $pos +
= strlen( $m[0] );
668 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos +
1 ) ) {
669 $x0 = $inChar . $m[0];
670 $d0 = chr( octdec( $m[0] ) );
671 $pos +
= strlen( $m[0] );
672 } elseif ( $pos +
1 >= $length ) {
675 $d0 = $byteClass[$pos +
1];
683 // Load the current re-encoded value
684 if ( $ord0 < 32 ||
$ord0 == 0x7f ) {
685 $r0 = sprintf( '\x%02x', $ord0 );
686 } elseif ( $ord0 >= 0x80 ) {
687 // Allow unicode if a single high-bit character appears
688 $r0 = sprintf( '\x%02x', $ord0 );
689 $allowUnicode = true;
690 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
696 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
698 if ( $ord2 > $ord0 ) {
700 } elseif ( $ord0 >= 0x80 ) {
702 $allowUnicode = true;
703 if ( $ord2 < 0x80 ) {
704 // Keep the non-unicode section of the range
711 // Reset state to the initial value
712 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
713 } elseif ( $ord2 < 0x80 ) {
718 if ( $ord1 < 0x80 ) {
721 if ( $ord0 < 0x80 ) {
724 if ( $allowUnicode ) {
725 $out .= '\u0080-\uFFFF';
731 * Make a prefixed DB key from a DB key and a namespace index
733 * @param int $ns Numerical representation of the namespace
734 * @param string $title The DB key form the title
735 * @param string $fragment The link fragment (after the "#")
736 * @param string $interwiki The interwiki prefix
737 * @param bool $canonicalNamespace If true, use the canonical name for
738 * $ns instead of the localized version.
739 * @return string The prefixed form of the title
741 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
742 $canonicalNamespace = false
746 if ( $canonicalNamespace ) {
747 $namespace = MWNamespace
::getCanonicalName( $ns );
749 $namespace = $wgContLang->getNsText( $ns );
751 $name = $namespace == '' ?
$title : "$namespace:$title";
752 if ( strval( $interwiki ) != '' ) {
753 $name = "$interwiki:$name";
755 if ( strval( $fragment ) != '' ) {
756 $name .= '#' . $fragment;
762 * Escape a text fragment, say from a link, for a URL
764 * @deprecated since 1.30, use Sanitizer::escapeIdForLink() or escapeIdForExternalInterwiki()
766 * @param string $fragment Containing a URL or link fragment (after the "#")
767 * @return string Escaped string
769 static function escapeFragmentForURL( $fragment ) {
770 wfDeprecated( __METHOD__
, '1.30' );
771 # Note that we don't urlencode the fragment. urlencoded Unicode
772 # fragments appear not to work in IE (at least up to 7) or in at least
773 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
774 # to care if they aren't encoded.
775 return Sanitizer
::escapeId( $fragment, 'noninitial' );
779 * Callback for usort() to do title sorts by (namespace, title)
781 * @param LinkTarget $a
782 * @param LinkTarget $b
784 * @return int Result of string comparison, or namespace comparison
786 public static function compare( LinkTarget
$a, LinkTarget
$b ) {
787 return $a->getNamespace() <=> $b->getNamespace()
788 ?
: strcmp( $a->getText(), $b->getText() );
792 * Returns true if the title is valid, false if it is invalid.
794 * Valid titles can be round-tripped via makeTitleSafe() and newFromText().
795 * Invalid titles may get returned from makeTitle(), and it may be useful to
796 * allow them to exist, e.g. in order to process log entries about pages in
797 * namespaces that belong to extensions that are no longer installed.
799 * @note This method is relatively expensive. When constructing Title
800 * objects that need to be valid, use an instantiator method that is guaranteed
801 * to return valid titles, such as makeTitleSafe() or newFromText().
805 public function isValid() {
806 $ns = $this->getNamespace();
808 if ( !MWNamespace
::exists( $ns ) ) {
813 $parser = MediaWikiServices
::getInstance()->getTitleParser();
814 $parser->parseTitle( $this->getDBkey(), $ns );
816 } catch ( MalformedTitleException
$ex ) {
822 * Determine whether the object refers to a page within
823 * this project (either this wiki or a wiki with a local
824 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
826 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
828 public function isLocal() {
829 if ( $this->isExternal() ) {
830 $iw = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
832 return $iw->isLocal();
839 * Is this Title interwiki?
843 public function isExternal() {
844 return $this->mInterwiki
!== '';
848 * Get the interwiki prefix
850 * Use Title::isExternal to check if a interwiki is set
852 * @return string Interwiki prefix
854 public function getInterwiki() {
855 return $this->mInterwiki
;
859 * Was this a local interwiki link?
863 public function wasLocalInterwiki() {
864 return $this->mLocalInterwiki
;
868 * Determine whether the object refers to a page within
869 * this project and is transcludable.
871 * @return bool True if this is transcludable
873 public function isTrans() {
874 if ( !$this->isExternal() ) {
878 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->isTranscludable();
882 * Returns the DB name of the distant wiki which owns the object.
884 * @return string|false The DB name
886 public function getTransWikiID() {
887 if ( !$this->isExternal() ) {
891 return self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->getWikiID();
895 * Get a TitleValue object representing this Title.
897 * @note Not all valid Titles have a corresponding valid TitleValue
898 * (e.g. TitleValues cannot represent page-local links that have a
899 * fragment but no title text).
901 * @return TitleValue|null
903 public function getTitleValue() {
904 if ( $this->mTitleValue
=== null ) {
906 $this->mTitleValue
= new TitleValue(
907 $this->getNamespace(),
909 $this->getFragment(),
910 $this->getInterwiki()
912 } catch ( InvalidArgumentException
$ex ) {
913 wfDebug( __METHOD__
. ': Can\'t create a TitleValue for [[' .
914 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
918 return $this->mTitleValue
;
922 * Get the text form (spaces not underscores) of the main part
924 * @return string Main part of the title
926 public function getText() {
927 return $this->mTextform
;
931 * Get the URL-encoded form of the main part
933 * @return string Main part of the title, URL-encoded
935 public function getPartialURL() {
936 return $this->mUrlform
;
940 * Get the main part with underscores
942 * @return string Main part of the title, with underscores
944 public function getDBkey() {
945 return $this->mDbkeyform
;
949 * Get the DB key with the initial letter case as specified by the user
951 * @return string DB key
953 function getUserCaseDBKey() {
954 if ( !is_null( $this->mUserCaseDBKey
) ) {
955 return $this->mUserCaseDBKey
;
957 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
958 return $this->mDbkeyform
;
963 * Get the namespace index, i.e. one of the NS_xxxx constants.
965 * @return int Namespace index
967 public function getNamespace() {
968 return $this->mNamespace
;
972 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
974 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
975 * @return string Content model id
977 public function getContentModel( $flags = 0 ) {
978 if ( !$this->mForcedContentModel
979 && ( !$this->mContentModel ||
$flags === self
::GAID_FOR_UPDATE
)
980 && $this->getArticleID( $flags )
982 $linkCache = LinkCache
::singleton();
983 $linkCache->addLinkObj( $this ); # in case we already had an article ID
984 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
987 if ( !$this->mContentModel
) {
988 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
991 return $this->mContentModel
;
995 * Convenience method for checking a title's content model name
997 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
998 * @return bool True if $this->getContentModel() == $id
1000 public function hasContentModel( $id ) {
1001 return $this->getContentModel() == $id;
1005 * Set a proposed content model for the page for permissions
1006 * checking. This does not actually change the content model
1009 * Additionally, you should make sure you've checked
1010 * ContentHandler::canBeUsedOn() first.
1013 * @param string $model CONTENT_MODEL_XXX constant
1015 public function setContentModel( $model ) {
1016 $this->mContentModel
= $model;
1017 $this->mForcedContentModel
= true;
1021 * Get the namespace text
1023 * @return string|false Namespace text
1025 public function getNsText() {
1026 if ( $this->isExternal() ) {
1027 // This probably shouldn't even happen, except for interwiki transclusion.
1028 // If possible, use the canonical name for the foreign namespace.
1029 $nsText = MWNamespace
::getCanonicalName( $this->mNamespace
);
1030 if ( $nsText !== false ) {
1036 $formatter = self
::getTitleFormatter();
1037 return $formatter->getNamespaceName( $this->mNamespace
, $this->mDbkeyform
);
1038 } catch ( InvalidArgumentException
$ex ) {
1039 wfDebug( __METHOD__
. ': ' . $ex->getMessage() . "\n" );
1045 * Get the namespace text of the subject (rather than talk) page
1047 * @return string Namespace text
1049 public function getSubjectNsText() {
1051 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
1055 * Get the namespace text of the talk page
1057 * @return string Namespace text
1059 public function getTalkNsText() {
1061 return $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) );
1065 * Can this title have a corresponding talk page?
1067 * @deprecated since 1.30, use canHaveTalkPage() instead.
1069 * @return bool True if this title either is a talk page or can have a talk page associated.
1071 public function canTalk() {
1072 return $this->canHaveTalkPage();
1076 * Can this title have a corresponding talk page?
1078 * @see MWNamespace::hasTalkNamespace
1081 * @return bool True if this title either is a talk page or can have a talk page associated.
1083 public function canHaveTalkPage() {
1084 return MWNamespace
::hasTalkNamespace( $this->mNamespace
);
1088 * Is this in a namespace that allows actual pages?
1092 public function canExist() {
1093 return $this->mNamespace
>= NS_MAIN
;
1097 * Can this title be added to a user's watchlist?
1101 public function isWatchable() {
1102 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
1106 * Returns true if this is a special page.
1110 public function isSpecialPage() {
1111 return $this->getNamespace() == NS_SPECIAL
;
1115 * Returns true if this title resolves to the named special page
1117 * @param string $name The special page name
1120 public function isSpecial( $name ) {
1121 if ( $this->isSpecialPage() ) {
1122 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
1123 if ( $name == $thisName ) {
1131 * If the Title refers to a special page alias which is not the local default, resolve
1132 * the alias, and localise the name as necessary. Otherwise, return $this
1136 public function fixSpecialName() {
1137 if ( $this->isSpecialPage() ) {
1138 list( $canonicalName, $par ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
1139 if ( $canonicalName ) {
1140 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName, $par );
1141 if ( $localName != $this->mDbkeyform
) {
1142 return self
::makeTitle( NS_SPECIAL
, $localName );
1150 * Returns true if the title is inside the specified namespace.
1152 * Please make use of this instead of comparing to getNamespace()
1153 * This function is much more resistant to changes we may make
1154 * to namespaces than code that makes direct comparisons.
1155 * @param int $ns The namespace
1159 public function inNamespace( $ns ) {
1160 return MWNamespace
::equals( $this->getNamespace(), $ns );
1164 * Returns true if the title is inside one of the specified namespaces.
1166 * @param int|int[] $namespaces,... The namespaces to check for
1170 public function inNamespaces( /* ... */ ) {
1171 $namespaces = func_get_args();
1172 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1173 $namespaces = $namespaces[0];
1176 foreach ( $namespaces as $ns ) {
1177 if ( $this->inNamespace( $ns ) ) {
1186 * Returns true if the title has the same subject namespace as the
1187 * namespace specified.
1188 * For example this method will take NS_USER and return true if namespace
1189 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1190 * as their subject namespace.
1192 * This is MUCH simpler than individually testing for equivalence
1193 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1198 public function hasSubjectNamespace( $ns ) {
1199 return MWNamespace
::subjectEquals( $this->getNamespace(), $ns );
1203 * Is this Title in a namespace which contains content?
1204 * In other words, is this a content page, for the purposes of calculating
1209 public function isContentPage() {
1210 return MWNamespace
::isContent( $this->getNamespace() );
1214 * Would anybody with sufficient privileges be able to move this page?
1215 * Some pages just aren't movable.
1219 public function isMovable() {
1220 if ( !MWNamespace
::isMovable( $this->getNamespace() ) ||
$this->isExternal() ) {
1221 // Interwiki title or immovable namespace. Hooks don't get to override here
1226 Hooks
::run( 'TitleIsMovable', [ $this, &$result ] );
1231 * Is this the mainpage?
1232 * @note Title::newFromText seems to be sufficiently optimized by the title
1233 * cache that we don't need to over-optimize by doing direct comparisons and
1234 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1235 * ends up reporting something differently than $title->isMainPage();
1240 public function isMainPage() {
1241 return $this->equals( self
::newMainPage() );
1245 * Is this a subpage?
1249 public function isSubpage() {
1250 return MWNamespace
::hasSubpages( $this->mNamespace
)
1251 ?
strpos( $this->getText(), '/' ) !== false
1256 * Is this a conversion table for the LanguageConverter?
1260 public function isConversionTable() {
1261 // @todo ConversionTable should become a separate content model.
1263 return $this->getNamespace() == NS_MEDIAWIKI
&&
1264 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1268 * Does that page contain wikitext, or it is JS, CSS or whatever?
1272 public function isWikitextPage() {
1273 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
1277 * Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the
1278 * global UI. This is generally true for pages in the MediaWiki namespace having
1279 * CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
1281 * This method does *not* return true for per-user JS/JSON/CSS. Use isUserConfigPage()
1284 * Note that this method should not return true for pages that contain and show
1285 * "inactive" CSS, JSON, or JS.
1290 public function isSiteConfigPage() {
1292 NS_MEDIAWIKI
== $this->mNamespace
1294 $this->hasContentModel( CONTENT_MODEL_CSS
)
1295 ||
$this->hasContentModel( CONTENT_MODEL_JSON
)
1296 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1303 * @deprecated Since 1.31; use ::isSiteConfigPage() instead (which also checks for JSON pages)
1305 public function isCssOrJsPage() {
1306 wfDeprecated( __METHOD__
, '1.31' );
1307 return ( NS_MEDIAWIKI
== $this->mNamespace
1308 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1309 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
1313 * Is this a "config" (.css, .json, or .js) sub-page of a user page?
1318 public function isUserConfigPage() {
1320 NS_USER
== $this->mNamespace
1321 && $this->isSubpage()
1323 $this->hasContentModel( CONTENT_MODEL_CSS
)
1324 ||
$this->hasContentModel( CONTENT_MODEL_JSON
)
1325 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1332 * @deprecated Since 1.31; use ::isUserConfigPage() instead (which also checks for JSON pages)
1334 public function isCssJsSubpage() {
1335 wfDeprecated( __METHOD__
, '1.31' );
1336 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1337 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
1338 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
1342 * Trim down a .css, .json, or .js subpage title to get the corresponding skin name
1344 * @return string Containing skin name from .css, .json, or .js subpage title
1347 public function getSkinFromConfigSubpage() {
1348 $subpage = explode( '/', $this->mTextform
);
1349 $subpage = $subpage[count( $subpage ) - 1];
1350 $lastdot = strrpos( $subpage, '.' );
1351 if ( $lastdot === false ) {
1352 return $subpage; # Never happens: only called for names ending in '.css'/'.json'/'.js'
1354 return substr( $subpage, 0, $lastdot );
1358 * @deprecated Since 1.31; use ::getSkinFromConfigSubpage() instead
1359 * @return string Containing skin name from .css, .json, or .js subpage title
1361 public function getSkinFromCssJsSubpage() {
1362 wfDeprecated( __METHOD__
, '1.31' );
1363 return $this->getSkinFromConfigSubpage();
1367 * Is this a CSS "config" sub-page of a user page?
1372 public function isUserCssConfigPage() {
1374 NS_USER
== $this->mNamespace
1375 && $this->isSubpage()
1376 && $this->hasContentModel( CONTENT_MODEL_CSS
)
1381 * @deprecated Since 1.31; use ::isUserCssConfigPage()
1384 public function isCssSubpage() {
1385 wfDeprecated( __METHOD__
, '1.31' );
1386 return $this->isUserCssConfigPage();
1390 * Is this a JSON "config" sub-page of a user page?
1395 public function isUserJsonConfigPage() {
1397 NS_USER
== $this->mNamespace
1398 && $this->isSubpage()
1399 && $this->hasContentModel( CONTENT_MODEL_JSON
)
1404 * Is this a JS "config" sub-page of a user page?
1409 public function isUserJsConfigPage() {
1411 NS_USER
== $this->mNamespace
1412 && $this->isSubpage()
1413 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
)
1418 * @deprecated Since 1.31; use ::isUserJsConfigPage()
1421 public function isJsSubpage() {
1422 wfDeprecated( __METHOD__
, '1.31' );
1423 return $this->isUserJsConfigPage();
1427 * Is this a talk page of some sort?
1431 public function isTalkPage() {
1432 return MWNamespace
::isTalk( $this->getNamespace() );
1436 * Get a Title object associated with the talk page of this article
1438 * @return Title The object for the talk page
1440 public function getTalkPage() {
1441 return self
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
1445 * Get a Title object associated with the talk page of this article,
1446 * if such a talk page can exist.
1450 * @return Title|null The object for the talk page,
1451 * or null if no associated talk page can exist, according to canHaveTalkPage().
1453 public function getTalkPageIfDefined() {
1454 if ( !$this->canHaveTalkPage() ) {
1458 return $this->getTalkPage();
1462 * Get a title object associated with the subject page of this
1465 * @return Title The object for the subject page
1467 public function getSubjectPage() {
1468 // Is this the same title?
1469 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
1470 if ( $this->getNamespace() == $subjectNS ) {
1473 return self
::makeTitle( $subjectNS, $this->getDBkey() );
1477 * Get the other title for this page, if this is a subject page
1478 * get the talk page, if it is a subject page get the talk page
1481 * @throws MWException If the page doesn't have an other page
1484 public function getOtherPage() {
1485 if ( $this->isSpecialPage() ) {
1486 throw new MWException( 'Special pages cannot have other pages' );
1488 if ( $this->isTalkPage() ) {
1489 return $this->getSubjectPage();
1491 if ( !$this->canHaveTalkPage() ) {
1492 throw new MWException( "{$this->getPrefixedText()} does not have an other page" );
1494 return $this->getTalkPage();
1499 * Get the default namespace index, for when there is no namespace
1501 * @return int Default namespace index
1503 public function getDefaultNamespace() {
1504 return $this->mDefaultNamespace
;
1508 * Get the Title fragment (i.e.\ the bit after the #) in text form
1510 * Use Title::hasFragment to check for a fragment
1512 * @return string Title fragment
1514 public function getFragment() {
1515 return $this->mFragment
;
1519 * Check if a Title fragment is set
1524 public function hasFragment() {
1525 return $this->mFragment
!== '';
1529 * Get the fragment in URL form, including the "#" character if there is one
1531 * @return string Fragment in URL form
1533 public function getFragmentForURL() {
1534 if ( !$this->hasFragment() ) {
1536 } elseif ( $this->isExternal()
1537 && !self
::getInterwikiLookup()->fetch( $this->mInterwiki
)->isLocal()
1539 return '#' . Sanitizer
::escapeIdForExternalInterwiki( $this->getFragment() );
1541 return '#' . Sanitizer
::escapeIdForLink( $this->getFragment() );
1545 * Set the fragment for this title. Removes the first character from the
1546 * specified fragment before setting, so it assumes you're passing it with
1549 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1550 * or Title::createFragmentTarget().
1551 * Still in active use privately.
1554 * @param string $fragment Text
1556 public function setFragment( $fragment ) {
1557 $this->mFragment
= strtr( substr( $fragment, 1 ), '_', ' ' );
1561 * Creates a new Title for a different fragment of the same page.
1564 * @param string $fragment
1567 public function createFragmentTarget( $fragment ) {
1568 return self
::makeTitle(
1569 $this->getNamespace(),
1572 $this->getInterwiki()
1577 * Prefix some arbitrary text with the namespace or interwiki prefix
1580 * @param string $name The text
1581 * @return string The prefixed text
1583 private function prefix( $name ) {
1587 if ( $this->isExternal() ) {
1588 $p = $this->mInterwiki
. ':';
1591 if ( 0 != $this->mNamespace
) {
1592 $nsText = $this->getNsText();
1594 if ( $nsText === false ) {
1595 // See T165149. Awkward, but better than erroneously linking to the main namespace.
1596 $nsText = $wgContLang->getNsText( NS_SPECIAL
) . ":Badtitle/NS{$this->mNamespace}";
1599 $p .= $nsText . ':';
1605 * Get the prefixed database key form
1607 * @return string The prefixed title, with underscores and
1608 * any interwiki and namespace prefixes
1610 public function getPrefixedDBkey() {
1611 $s = $this->prefix( $this->mDbkeyform
);
1612 $s = strtr( $s, ' ', '_' );
1617 * Get the prefixed title with spaces.
1618 * This is the form usually used for display
1620 * @return string The prefixed title, with spaces
1622 public function getPrefixedText() {
1623 if ( $this->mPrefixedText
=== null ) {
1624 $s = $this->prefix( $this->mTextform
);
1625 $s = strtr( $s, '_', ' ' );
1626 $this->mPrefixedText
= $s;
1628 return $this->mPrefixedText
;
1632 * Return a string representation of this title
1634 * @return string Representation of this title
1636 public function __toString() {
1637 return $this->getPrefixedText();
1641 * Get the prefixed title with spaces, plus any fragment
1642 * (part beginning with '#')
1644 * @return string The prefixed title, with spaces and the fragment, including '#'
1646 public function getFullText() {
1647 $text = $this->getPrefixedText();
1648 if ( $this->hasFragment() ) {
1649 $text .= '#' . $this->getFragment();
1655 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1659 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1663 * @return string Root name
1666 public function getRootText() {
1667 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1668 return $this->getText();
1671 return strtok( $this->getText(), '/' );
1675 * Get the root page name title, i.e. the leftmost part before any slashes
1679 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1680 * # returns: Title{User:Foo}
1683 * @return Title Root title
1686 public function getRootTitle() {
1687 return self
::makeTitle( $this->getNamespace(), $this->getRootText() );
1691 * Get the base page name without a namespace, i.e. the part before the subpage name
1695 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1696 * # returns: 'Foo/Bar'
1699 * @return string Base name
1701 public function getBaseText() {
1702 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1703 return $this->getText();
1706 $parts = explode( '/', $this->getText() );
1707 # Don't discard the real title if there's no subpage involved
1708 if ( count( $parts ) > 1 ) {
1709 unset( $parts[count( $parts ) - 1] );
1711 return implode( '/', $parts );
1715 * Get the base page name title, i.e. the part before the subpage name
1719 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1720 * # returns: Title{User:Foo/Bar}
1723 * @return Title Base title
1726 public function getBaseTitle() {
1727 return self
::makeTitle( $this->getNamespace(), $this->getBaseText() );
1731 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1735 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1739 * @return string Subpage name
1741 public function getSubpageText() {
1742 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1743 return $this->mTextform
;
1745 $parts = explode( '/', $this->mTextform
);
1746 return $parts[count( $parts ) - 1];
1750 * Get the title for a subpage of the current page
1754 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1755 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1758 * @param string $text The subpage name to add to the title
1759 * @return Title Subpage title
1762 public function getSubpage( $text ) {
1763 return self
::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1767 * Get a URL-encoded form of the subpage text
1769 * @return string URL-encoded subpage name
1771 public function getSubpageUrlForm() {
1772 $text = $this->getSubpageText();
1773 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1778 * Get a URL-encoded title (not an actual URL) including interwiki
1780 * @return string The URL-encoded form
1782 public function getPrefixedURL() {
1783 $s = $this->prefix( $this->mDbkeyform
);
1784 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1789 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1790 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1791 * second argument named variant. This was deprecated in favor
1792 * of passing an array of option with a "variant" key
1793 * Once $query2 is removed for good, this helper can be dropped
1794 * and the wfArrayToCgi moved to getLocalURL();
1796 * @since 1.19 (r105919)
1797 * @param array|string $query
1798 * @param string|string[]|bool $query2
1801 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1802 if ( $query2 !== false ) {
1803 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1804 "method called with a second parameter is deprecated. Add your " .
1805 "parameter to an array passed as the first parameter.", "1.19" );
1807 if ( is_array( $query ) ) {
1808 $query = wfArrayToCgi( $query );
1811 if ( is_string( $query2 ) ) {
1812 // $query2 is a string, we will consider this to be
1813 // a deprecated $variant argument and add it to the query
1814 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1816 $query2 = wfArrayToCgi( $query2 );
1818 // If we have $query content add a & to it first
1822 // Now append the queries together
1829 * Get a real URL referring to this title, with interwiki link and
1832 * @see self::getLocalURL for the arguments.
1834 * @param string|string[] $query
1835 * @param string|string[]|bool $query2
1836 * @param string|int|null $proto Protocol type to use in URL
1837 * @return string The URL
1839 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1840 $query = self
::fixUrlQueryArgs( $query, $query2 );
1842 # Hand off all the decisions on urls to getLocalURL
1843 $url = $this->getLocalURL( $query );
1845 # Expand the url to make it a full url. Note that getLocalURL has the
1846 # potential to output full urls for a variety of reasons, so we use
1847 # wfExpandUrl instead of simply prepending $wgServer
1848 $url = wfExpandUrl( $url, $proto );
1850 # Finally, add the fragment.
1851 $url .= $this->getFragmentForURL();
1852 // Avoid PHP 7.1 warning from passing $this by reference
1854 Hooks
::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
1859 * Get a url appropriate for making redirects based on an untrusted url arg
1861 * This is basically the same as getFullUrl(), but in the case of external
1862 * interwikis, we send the user to a landing page, to prevent possible
1863 * phishing attacks and the like.
1865 * @note Uses current protocol by default, since technically relative urls
1866 * aren't allowed in redirects per HTTP spec, so this is not suitable for
1867 * places where the url gets cached, as might pollute between
1868 * https and non-https users.
1869 * @see self::getLocalURL for the arguments.
1870 * @param array|string $query
1871 * @param string $proto Protocol type to use in URL
1872 * @return string A url suitable to use in an HTTP location header.
1874 public function getFullUrlForRedirect( $query = '', $proto = PROTO_CURRENT
) {
1876 if ( $this->isExternal() ) {
1877 $target = SpecialPage
::getTitleFor(
1879 $this->getPrefixedDBkey()
1882 return $target->getFullURL( $query, false, $proto );
1886 * Get a URL with no fragment or server name (relative URL) from a Title object.
1887 * If this page is generated with action=render, however,
1888 * $wgServer is prepended to make an absolute URL.
1890 * @see self::getFullURL to always get an absolute URL.
1891 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
1892 * valid to link, locally, to the current Title.
1893 * @see self::newFromText to produce a Title object.
1895 * @param string|string[] $query An optional query string,
1896 * not used for interwiki links. Can be specified as an associative array as well,
1897 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1898 * Some query patterns will trigger various shorturl path replacements.
1899 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
1900 * be an array. If a string is passed it will be interpreted as a deprecated
1901 * variant argument and urlencoded into a variant= argument.
1902 * This second query argument will be added to the $query
1903 * The second parameter is deprecated since 1.19. Pass it as a key,value
1904 * pair in the first parameter array instead.
1906 * @return string String of the URL.
1908 public function getLocalURL( $query = '', $query2 = false ) {
1909 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1911 $query = self
::fixUrlQueryArgs( $query, $query2 );
1913 $interwiki = self
::getInterwikiLookup()->fetch( $this->mInterwiki
);
1915 $namespace = $this->getNsText();
1916 if ( $namespace != '' ) {
1917 # Can this actually happen? Interwikis shouldn't be parsed.
1918 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1921 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1922 $url = wfAppendQuery( $url, $query );
1924 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1925 if ( $query == '' ) {
1926 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1927 // Avoid PHP 7.1 warning from passing $this by reference
1929 Hooks
::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
1931 global $wgVariantArticlePath, $wgActionPaths, $wgContLang;
1935 if ( !empty( $wgActionPaths )
1936 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1938 $action = urldecode( $matches[2] );
1939 if ( isset( $wgActionPaths[$action] ) ) {
1940 $query = $matches[1];
1941 if ( isset( $matches[4] ) ) {
1942 $query .= $matches[4];
1944 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1945 if ( $query != '' ) {
1946 $url = wfAppendQuery( $url, $query );
1952 && $wgVariantArticlePath
1953 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1954 && $this->getPageLanguage()->equals( $wgContLang )
1955 && $this->getPageLanguage()->hasVariants()
1957 $variant = urldecode( $matches[1] );
1958 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1959 // Only do the variant replacement if the given variant is a valid
1960 // variant for the page's language.
1961 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1962 $url = str_replace( '$1', $dbkey, $url );
1966 if ( $url === false ) {
1967 if ( $query == '-' ) {
1970 $url = "{$wgScript}?title={$dbkey}&{$query}";
1973 // Avoid PHP 7.1 warning from passing $this by reference
1975 Hooks
::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
1977 // @todo FIXME: This causes breakage in various places when we
1978 // actually expected a local URL and end up with dupe prefixes.
1979 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1980 $url = $wgServer . $url;
1983 // Avoid PHP 7.1 warning from passing $this by reference
1985 Hooks
::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
1990 * Get a URL that's the simplest URL that will be valid to link, locally,
1991 * to the current Title. It includes the fragment, but does not include
1992 * the server unless action=render is used (or the link is external). If
1993 * there's a fragment but the prefixed text is empty, we just return a link
1996 * The result obviously should not be URL-escaped, but does need to be
1997 * HTML-escaped if it's being output in HTML.
1999 * @param string|string[] $query
2000 * @param bool $query2
2001 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
2002 * or false (default) for no expansion
2003 * @see self::getLocalURL for the arguments.
2004 * @return string The URL
2006 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
2007 if ( $this->isExternal() ||
$proto !== false ) {
2008 $ret = $this->getFullURL( $query, $query2, $proto );
2009 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
2010 $ret = $this->getFragmentForURL();
2012 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
2018 * Get the URL form for an internal link.
2019 * - Used in various CDN-related code, in case we have a different
2020 * internal hostname for the server from the exposed one.
2022 * This uses $wgInternalServer to qualify the path, or $wgServer
2023 * if $wgInternalServer is not set. If the server variable used is
2024 * protocol-relative, the URL will be expanded to http://
2026 * @see self::getLocalURL for the arguments.
2027 * @param string $query
2028 * @param string|bool $query2
2029 * @return string The URL
2031 public function getInternalURL( $query = '', $query2 = false ) {
2032 global $wgInternalServer, $wgServer;
2033 $query = self
::fixUrlQueryArgs( $query, $query2 );
2034 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
2035 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
2036 // Avoid PHP 7.1 warning from passing $this by reference
2038 Hooks
::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
2043 * Get the URL for a canonical link, for use in things like IRC and
2044 * e-mail notifications. Uses $wgCanonicalServer and the
2045 * GetCanonicalURL hook.
2047 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
2049 * @see self::getLocalURL for the arguments.
2050 * @param string $query
2051 * @param string|bool $query2
2052 * @return string The URL
2055 public function getCanonicalURL( $query = '', $query2 = false ) {
2056 $query = self
::fixUrlQueryArgs( $query, $query2 );
2057 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
2058 // Avoid PHP 7.1 warning from passing $this by reference
2060 Hooks
::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
2065 * Get the edit URL for this Title
2067 * @return string The URL, or a null string if this is an interwiki link
2069 public function getEditURL() {
2070 if ( $this->isExternal() ) {
2073 $s = $this->getLocalURL( 'action=edit' );
2079 * Can $user perform $action on this page?
2080 * This skips potentially expensive cascading permission checks
2081 * as well as avoids expensive error formatting
2083 * Suitable for use for nonessential UI controls in common cases, but
2084 * _not_ for functional access control.
2086 * May provide false positives, but should never provide a false negative.
2088 * @param string $action Action that permission needs to be checked for
2089 * @param User $user User to check (since 1.19); $wgUser will be used if not provided.
2092 public function quickUserCan( $action, $user = null ) {
2093 return $this->userCan( $action, $user, false );
2097 * Can $user perform $action on this page?
2099 * @param string $action Action that permission needs to be checked for
2100 * @param User $user User to check (since 1.19); $wgUser will be used if not
2102 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2105 public function userCan( $action, $user = null, $rigor = 'secure' ) {
2106 if ( !$user instanceof User
) {
2111 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $rigor, true ) );
2115 * Can $user perform $action on this page?
2117 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
2119 * @param string $action Action that permission needs to be checked for
2120 * @param User $user User to check
2121 * @param string $rigor One of (quick,full,secure)
2122 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2123 * - full : does cheap and expensive checks possibly from a replica DB
2124 * - secure : does cheap and expensive checks, using the master as needed
2125 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
2126 * whose corresponding errors may be ignored.
2127 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2129 public function getUserPermissionsErrors(
2130 $action, $user, $rigor = 'secure', $ignoreErrors = []
2132 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $rigor );
2134 // Remove the errors being ignored.
2135 foreach ( $errors as $index => $error ) {
2136 $errKey = is_array( $error ) ?
$error[0] : $error;
2138 if ( in_array( $errKey, $ignoreErrors ) ) {
2139 unset( $errors[$index] );
2141 if ( $errKey instanceof MessageSpecifier
&& in_array( $errKey->getKey(), $ignoreErrors ) ) {
2142 unset( $errors[$index] );
2150 * Permissions checks that fail most often, and which are easiest to test.
2152 * @param string $action The action to check
2153 * @param User $user User to check
2154 * @param array $errors List of current errors
2155 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2156 * @param bool $short Short circuit on first error
2158 * @return array List of errors
2160 private function checkQuickPermissions( $action, $user, $errors, $rigor, $short ) {
2161 if ( !Hooks
::run( 'TitleQuickPermissions',
2162 [ $this, $user, $action, &$errors, ( $rigor !== 'quick' ), $short ] )
2167 if ( $action == 'create' ) {
2169 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
2170 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
2172 $errors[] = $user->isAnon() ?
[ 'nocreatetext' ] : [ 'nocreate-loggedin' ];
2174 } elseif ( $action == 'move' ) {
2175 if ( !$user->isAllowed( 'move-rootuserpages' )
2176 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
2177 // Show user page-specific message only if the user can move other pages
2178 $errors[] = [ 'cant-move-user-page' ];
2181 // Check if user is allowed to move files if it's a file
2182 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
2183 $errors[] = [ 'movenotallowedfile' ];
2186 // Check if user is allowed to move category pages if it's a category page
2187 if ( $this->mNamespace
== NS_CATEGORY
&& !$user->isAllowed( 'move-categorypages' ) ) {
2188 $errors[] = [ 'cant-move-category-page' ];
2191 if ( !$user->isAllowed( 'move' ) ) {
2192 // User can't move anything
2193 $userCanMove = User
::groupHasPermission( 'user', 'move' );
2194 $autoconfirmedCanMove = User
::groupHasPermission( 'autoconfirmed', 'move' );
2195 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
2196 // custom message if logged-in users without any special rights can move
2197 $errors[] = [ 'movenologintext' ];
2199 $errors[] = [ 'movenotallowed' ];
2202 } elseif ( $action == 'move-target' ) {
2203 if ( !$user->isAllowed( 'move' ) ) {
2204 // User can't move anything
2205 $errors[] = [ 'movenotallowed' ];
2206 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
2207 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
2208 // Show user page-specific message only if the user can move other pages
2209 $errors[] = [ 'cant-move-to-user-page' ];
2210 } elseif ( !$user->isAllowed( 'move-categorypages' )
2211 && $this->mNamespace
== NS_CATEGORY
) {
2212 // Show category page-specific message only if the user can move other pages
2213 $errors[] = [ 'cant-move-to-category-page' ];
2215 } elseif ( !$user->isAllowed( $action ) ) {
2216 $errors[] = $this->missingPermissionError( $action, $short );
2223 * Add the resulting error code to the errors array
2225 * @param array $errors List of current errors
2226 * @param array $result Result of errors
2228 * @return array List of errors
2230 private function resultToError( $errors, $result ) {
2231 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2232 // A single array representing an error
2233 $errors[] = $result;
2234 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2235 // A nested array representing multiple errors
2236 $errors = array_merge( $errors, $result );
2237 } elseif ( $result !== '' && is_string( $result ) ) {
2238 // A string representing a message-id
2239 $errors[] = [ $result ];
2240 } elseif ( $result instanceof MessageSpecifier
) {
2241 // A message specifier representing an error
2242 $errors[] = [ $result ];
2243 } elseif ( $result === false ) {
2244 // a generic "We don't want them to do that"
2245 $errors[] = [ 'badaccess-group0' ];
2251 * Check various permission hooks
2253 * @param string $action The action to check
2254 * @param User $user User to check
2255 * @param array $errors List of current errors
2256 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2257 * @param bool $short Short circuit on first error
2259 * @return array List of errors
2261 private function checkPermissionHooks( $action, $user, $errors, $rigor, $short ) {
2262 // Use getUserPermissionsErrors instead
2264 // Avoid PHP 7.1 warning from passing $this by reference
2266 if ( !Hooks
::run( 'userCan', [ &$titleRef, &$user, $action, &$result ] ) ) {
2267 return $result ?
[] : [ [ 'badaccess-group0' ] ];
2269 // Check getUserPermissionsErrors hook
2270 // Avoid PHP 7.1 warning from passing $this by reference
2272 if ( !Hooks
::run( 'getUserPermissionsErrors', [ &$titleRef, &$user, $action, &$result ] ) ) {
2273 $errors = $this->resultToError( $errors, $result );
2275 // Check getUserPermissionsErrorsExpensive hook
2278 && !( $short && count( $errors ) > 0 )
2279 && !Hooks
::run( 'getUserPermissionsErrorsExpensive', [ &$titleRef, &$user, $action, &$result ] )
2281 $errors = $this->resultToError( $errors, $result );
2288 * Check permissions on special pages & namespaces
2290 * @param string $action The action to check
2291 * @param User $user User to check
2292 * @param array $errors List of current errors
2293 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2294 * @param bool $short Short circuit on first error
2296 * @return array List of errors
2298 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $rigor, $short ) {
2299 # Only 'createaccount' can be performed on special pages,
2300 # which don't actually exist in the DB.
2301 if ( $this->isSpecialPage() && $action !== 'createaccount' ) {
2302 $errors[] = [ 'ns-specialprotected' ];
2305 # Check $wgNamespaceProtection for restricted namespaces
2306 if ( $this->isNamespaceProtected( $user ) ) {
2307 $ns = $this->mNamespace
== NS_MAIN ?
2308 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2309 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
2310 [ 'protectedinterface', $action ] : [ 'namespaceprotected', $ns, $action ];
2317 * Check CSS/JSON/JS sub-page permissions
2319 * @param string $action The action to check
2320 * @param User $user User to check
2321 * @param array $errors List of current errors
2322 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2323 * @param bool $short Short circuit on first error
2325 * @return array List of errors
2327 private function checkUserConfigPermissions( $action, $user, $errors, $rigor, $short ) {
2328 # Protect css/json/js subpages of user pages
2329 # XXX: this might be better using restrictions
2331 if ( $action != 'patrol' ) {
2332 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
2334 $this->isUserCssConfigPage()
2335 && !$user->isAllowedAny( 'editmyusercss', 'editusercss' )
2337 $errors[] = [ 'mycustomcssprotected', $action ];
2339 $this->isUserJsonConfigPage()
2340 && !$user->isAllowedAny( 'editmyuserjson', 'edituserjson' )
2342 $errors[] = [ 'mycustomjsonprotected', $action ];
2344 $this->isUserJsConfigPage()
2345 && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' )
2347 $errors[] = [ 'mycustomjsprotected', $action ];
2351 $this->isUserCssConfigPage()
2352 && !$user->isAllowed( 'editusercss' )
2354 $errors[] = [ 'customcssprotected', $action ];
2356 $this->isUserJsonConfigPage()
2357 && !$user->isAllowed( 'edituserjson' )
2359 $errors[] = [ 'customjsonprotected', $action ];
2361 $this->isUserJsConfigPage()
2362 && !$user->isAllowed( 'edituserjs' )
2364 $errors[] = [ 'customjsprotected', $action ];
2373 * Check against page_restrictions table requirements on this
2374 * page. The user must possess all required rights for this
2377 * @param string $action The action to check
2378 * @param User $user User to check
2379 * @param array $errors List of current errors
2380 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2381 * @param bool $short Short circuit on first error
2383 * @return array List of errors
2385 private function checkPageRestrictions( $action, $user, $errors, $rigor, $short ) {
2386 foreach ( $this->getRestrictions( $action ) as $right ) {
2387 // Backwards compatibility, rewrite sysop -> editprotected
2388 if ( $right == 'sysop' ) {
2389 $right = 'editprotected';
2391 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2392 if ( $right == 'autoconfirmed' ) {
2393 $right = 'editsemiprotected';
2395 if ( $right == '' ) {
2398 if ( !$user->isAllowed( $right ) ) {
2399 $errors[] = [ 'protectedpagetext', $right, $action ];
2400 } elseif ( $this->mCascadeRestriction
&& !$user->isAllowed( 'protect' ) ) {
2401 $errors[] = [ 'protectedpagetext', 'protect', $action ];
2409 * Check restrictions on cascading pages.
2411 * @param string $action The action to check
2412 * @param User $user User to check
2413 * @param array $errors List of current errors
2414 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2415 * @param bool $short Short circuit on first error
2417 * @return array List of errors
2419 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $rigor, $short ) {
2420 if ( $rigor !== 'quick' && !$this->isUserConfigPage() ) {
2421 # We /could/ use the protection level on the source page, but it's
2422 # fairly ugly as we have to establish a precedence hierarchy for pages
2423 # included by multiple cascade-protected pages. So just restrict
2424 # it to people with 'protect' permission, as they could remove the
2425 # protection anyway.
2426 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2427 # Cascading protection depends on more than this page...
2428 # Several cascading protected pages may include this page...
2429 # Check each cascading level
2430 # This is only for protection restrictions, not for all actions
2431 if ( isset( $restrictions[$action] ) ) {
2432 foreach ( $restrictions[$action] as $right ) {
2433 // Backwards compatibility, rewrite sysop -> editprotected
2434 if ( $right == 'sysop' ) {
2435 $right = 'editprotected';
2437 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2438 if ( $right == 'autoconfirmed' ) {
2439 $right = 'editsemiprotected';
2441 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2443 foreach ( $cascadingSources as $page ) {
2444 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2446 $errors[] = [ 'cascadeprotected', count( $cascadingSources ), $pages, $action ];
2456 * Check action permissions not already checked in checkQuickPermissions
2458 * @param string $action The action to check
2459 * @param User $user User to check
2460 * @param array $errors List of current errors
2461 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2462 * @param bool $short Short circuit on first error
2464 * @return array List of errors
2466 private function checkActionPermissions( $action, $user, $errors, $rigor, $short ) {
2467 global $wgDeleteRevisionsLimit, $wgLang;
2469 if ( $action == 'protect' ) {
2470 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2471 // If they can't edit, they shouldn't protect.
2472 $errors[] = [ 'protect-cantedit' ];
2474 } elseif ( $action == 'create' ) {
2475 $title_protection = $this->getTitleProtection();
2476 if ( $title_protection ) {
2477 if ( $title_protection['permission'] == ''
2478 ||
!$user->isAllowed( $title_protection['permission'] )
2482 User
::whoIs( $title_protection['user'] ),
2483 $title_protection['reason']
2487 } elseif ( $action == 'move' ) {
2488 // Check for immobile pages
2489 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2490 // Specific message for this case
2491 $errors[] = [ 'immobile-source-namespace', $this->getNsText() ];
2492 } elseif ( !$this->isMovable() ) {
2493 // Less specific message for rarer cases
2494 $errors[] = [ 'immobile-source-page' ];
2496 } elseif ( $action == 'move-target' ) {
2497 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
2498 $errors[] = [ 'immobile-target-namespace', $this->getNsText() ];
2499 } elseif ( !$this->isMovable() ) {
2500 $errors[] = [ 'immobile-target-page' ];
2502 } elseif ( $action == 'delete' ) {
2503 $tempErrors = $this->checkPageRestrictions( 'edit', $user, [], $rigor, true );
2504 if ( !$tempErrors ) {
2505 $tempErrors = $this->checkCascadingSourcesRestrictions( 'edit',
2506 $user, $tempErrors, $rigor, true );
2508 if ( $tempErrors ) {
2509 // If protection keeps them from editing, they shouldn't be able to delete.
2510 $errors[] = [ 'deleteprotected' ];
2512 if ( $rigor !== 'quick' && $wgDeleteRevisionsLimit
2513 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2515 $errors[] = [ 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ];
2517 } elseif ( $action === 'undelete' ) {
2518 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2519 // Undeleting implies editing
2520 $errors[] = [ 'undelete-cantedit' ];
2522 if ( !$this->exists()
2523 && count( $this->getUserPermissionsErrorsInternal( 'create', $user, $rigor, true ) )
2525 // Undeleting where nothing currently exists implies creating
2526 $errors[] = [ 'undelete-cantcreate' ];
2533 * Check that the user isn't blocked from editing.
2535 * @param string $action The action to check
2536 * @param User $user User to check
2537 * @param array $errors List of current errors
2538 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2539 * @param bool $short Short circuit on first error
2541 * @return array List of errors
2543 private function checkUserBlock( $action, $user, $errors, $rigor, $short ) {
2544 global $wgEmailConfirmToEdit, $wgBlockDisablesLogin;
2545 // Account creation blocks handled at userlogin.
2546 // Unblocking handled in SpecialUnblock
2547 if ( $rigor === 'quick' ||
in_array( $action, [ 'createaccount', 'unblock' ] ) ) {
2551 // Optimize for a very common case
2552 if ( $action === 'read' && !$wgBlockDisablesLogin ) {
2556 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2557 $errors[] = [ 'confirmedittext' ];
2560 $useSlave = ( $rigor !== 'secure' );
2561 if ( ( $action == 'edit' ||
$action == 'create' )
2562 && !$user->isBlockedFrom( $this, $useSlave )
2564 // Don't block the user from editing their own talk page unless they've been
2565 // explicitly blocked from that too.
2566 } elseif ( $user->isBlocked() && $user->getBlock()->prevents( $action ) !== false ) {
2567 // @todo FIXME: Pass the relevant context into this function.
2568 $errors[] = $user->getBlock()->getPermissionsError( RequestContext
::getMain() );
2575 * Check that the user is allowed to read this page.
2577 * @param string $action The action to check
2578 * @param User $user User to check
2579 * @param array $errors List of current errors
2580 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2581 * @param bool $short Short circuit on first error
2583 * @return array List of errors
2585 private function checkReadPermissions( $action, $user, $errors, $rigor, $short ) {
2586 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2588 $whitelisted = false;
2589 if ( User
::isEveryoneAllowed( 'read' ) ) {
2590 # Shortcut for public wikis, allows skipping quite a bit of code
2591 $whitelisted = true;
2592 } elseif ( $user->isAllowed( 'read' ) ) {
2593 # If the user is allowed to read pages, he is allowed to read all pages
2594 $whitelisted = true;
2595 } elseif ( $this->isSpecial( 'Userlogin' )
2596 ||
$this->isSpecial( 'PasswordReset' )
2597 ||
$this->isSpecial( 'Userlogout' )
2599 # Always grant access to the login page.
2600 # Even anons need to be able to log in.
2601 $whitelisted = true;
2602 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2603 # Time to check the whitelist
2604 # Only do these checks is there's something to check against
2605 $name = $this->getPrefixedText();
2606 $dbName = $this->getPrefixedDBkey();
2608 // Check for explicit whitelisting with and without underscores
2609 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2610 $whitelisted = true;
2611 } elseif ( $this->getNamespace() == NS_MAIN
) {
2612 # Old settings might have the title prefixed with
2613 # a colon for main-namespace pages
2614 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2615 $whitelisted = true;
2617 } elseif ( $this->isSpecialPage() ) {
2618 # If it's a special page, ditch the subpage bit and check again
2619 $name = $this->getDBkey();
2620 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
2622 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2623 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2624 $whitelisted = true;
2630 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2631 $name = $this->getPrefixedText();
2632 // Check for regex whitelisting
2633 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2634 if ( preg_match( $listItem, $name ) ) {
2635 $whitelisted = true;
2641 if ( !$whitelisted ) {
2642 # If the title is not whitelisted, give extensions a chance to do so...
2643 Hooks
::run( 'TitleReadWhitelist', [ $this, $user, &$whitelisted ] );
2644 if ( !$whitelisted ) {
2645 $errors[] = $this->missingPermissionError( $action, $short );
2653 * Get a description array when the user doesn't have the right to perform
2654 * $action (i.e. when User::isAllowed() returns false)
2656 * @param string $action The action to check
2657 * @param bool $short Short circuit on first error
2658 * @return array Array containing an error message key and any parameters
2660 private function missingPermissionError( $action, $short ) {
2661 // We avoid expensive display logic for quickUserCan's and such
2663 return [ 'badaccess-group0' ];
2666 return User
::newFatalPermissionDeniedStatus( $action )->getErrorsArray()[0];
2670 * Can $user perform $action on this page? This is an internal function,
2671 * with multiple levels of checks depending on performance needs; see $rigor below.
2672 * It does not check wfReadOnly().
2674 * @param string $action Action that permission needs to be checked for
2675 * @param User $user User to check
2676 * @param string $rigor One of (quick,full,secure)
2677 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2678 * - full : does cheap and expensive checks possibly from a replica DB
2679 * - secure : does cheap and expensive checks, using the master as needed
2680 * @param bool $short Set this to true to stop after the first permission error.
2681 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2683 protected function getUserPermissionsErrorsInternal(
2684 $action, $user, $rigor = 'secure', $short = false
2686 if ( $rigor === true ) {
2687 $rigor = 'secure'; // b/c
2688 } elseif ( $rigor === false ) {
2689 $rigor = 'quick'; // b/c
2690 } elseif ( !in_array( $rigor, [ 'quick', 'full', 'secure' ] ) ) {
2691 throw new Exception( "Invalid rigor parameter '$rigor'." );
2694 # Read has special handling
2695 if ( $action == 'read' ) {
2697 'checkPermissionHooks',
2698 'checkReadPermissions',
2699 'checkUserBlock', // for wgBlockDisablesLogin
2701 # Don't call checkSpecialsAndNSPermissions or checkUserConfigPermissions
2702 # here as it will lead to duplicate error messages. This is okay to do
2703 # since anywhere that checks for create will also check for edit, and
2704 # those checks are called for edit.
2705 } elseif ( $action == 'create' ) {
2707 'checkQuickPermissions',
2708 'checkPermissionHooks',
2709 'checkPageRestrictions',
2710 'checkCascadingSourcesRestrictions',
2711 'checkActionPermissions',
2716 'checkQuickPermissions',
2717 'checkPermissionHooks',
2718 'checkSpecialsAndNSPermissions',
2719 'checkUserConfigPermissions',
2720 'checkPageRestrictions',
2721 'checkCascadingSourcesRestrictions',
2722 'checkActionPermissions',
2728 while ( count( $checks ) > 0 &&
2729 !( $short && count( $errors ) > 0 ) ) {
2730 $method = array_shift( $checks );
2731 $errors = $this->$method( $action, $user, $errors, $rigor, $short );
2738 * Get a filtered list of all restriction types supported by this wiki.
2739 * @param bool $exists True to get all restriction types that apply to
2740 * titles that do exist, False for all restriction types that apply to
2741 * titles that do not exist
2744 public static function getFilteredRestrictionTypes( $exists = true ) {
2745 global $wgRestrictionTypes;
2746 $types = $wgRestrictionTypes;
2748 # Remove the create restriction for existing titles
2749 $types = array_diff( $types, [ 'create' ] );
2751 # Only the create and upload restrictions apply to non-existing titles
2752 $types = array_intersect( $types, [ 'create', 'upload' ] );
2758 * Returns restriction types for the current Title
2760 * @return array Applicable restriction types
2762 public function getRestrictionTypes() {
2763 if ( $this->isSpecialPage() ) {
2767 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2769 if ( $this->getNamespace() != NS_FILE
) {
2770 # Remove the upload restriction for non-file titles
2771 $types = array_diff( $types, [ 'upload' ] );
2774 Hooks
::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2776 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2777 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2783 * Is this title subject to title protection?
2784 * Title protection is the one applied against creation of such title.
2786 * @return array|bool An associative array representing any existent title
2787 * protection, or false if there's none.
2789 public function getTitleProtection() {
2790 $protection = $this->getTitleProtectionInternal();
2791 if ( $protection ) {
2792 if ( $protection['permission'] == 'sysop' ) {
2793 $protection['permission'] = 'editprotected'; // B/C
2795 if ( $protection['permission'] == 'autoconfirmed' ) {
2796 $protection['permission'] = 'editsemiprotected'; // B/C
2803 * Fetch title protection settings
2805 * To work correctly, $this->loadRestrictions() needs to have access to the
2806 * actual protections in the database without munging 'sysop' =>
2807 * 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other
2808 * callers probably want $this->getTitleProtection() instead.
2810 * @return array|bool
2812 protected function getTitleProtectionInternal() {
2813 // Can't protect pages in special namespaces
2814 if ( $this->getNamespace() < 0 ) {
2818 // Can't protect pages that exist.
2819 if ( $this->exists() ) {
2823 if ( $this->mTitleProtection
=== null ) {
2824 $dbr = wfGetDB( DB_REPLICA
);
2825 $commentStore = CommentStore
::getStore();
2826 $commentQuery = $commentStore->getJoin( 'pt_reason' );
2827 $res = $dbr->select(
2828 [ 'protected_titles' ] +
$commentQuery['tables'],
2830 'user' => 'pt_user',
2831 'expiry' => 'pt_expiry',
2832 'permission' => 'pt_create_perm'
2833 ] +
$commentQuery['fields'],
2834 [ 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ],
2837 $commentQuery['joins']
2840 // fetchRow returns false if there are no rows.
2841 $row = $dbr->fetchRow( $res );
2843 $this->mTitleProtection
= [
2844 'user' => $row['user'],
2845 'expiry' => $dbr->decodeExpiry( $row['expiry'] ),
2846 'permission' => $row['permission'],
2847 'reason' => $commentStore->getComment( 'pt_reason', $row )->text
,
2850 $this->mTitleProtection
= false;
2853 return $this->mTitleProtection
;
2857 * Remove any title protection due to page existing
2859 public function deleteTitleProtection() {
2860 $dbw = wfGetDB( DB_MASTER
);
2864 [ 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ],
2867 $this->mTitleProtection
= false;
2871 * Is this page "semi-protected" - the *only* protection levels are listed
2872 * in $wgSemiprotectedRestrictionLevels?
2874 * @param string $action Action to check (default: edit)
2877 public function isSemiProtected( $action = 'edit' ) {
2878 global $wgSemiprotectedRestrictionLevels;
2880 $restrictions = $this->getRestrictions( $action );
2881 $semi = $wgSemiprotectedRestrictionLevels;
2882 if ( !$restrictions ||
!$semi ) {
2883 // Not protected, or all protection is full protection
2887 // Remap autoconfirmed to editsemiprotected for BC
2888 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2889 $semi[$key] = 'editsemiprotected';
2891 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2892 $restrictions[$key] = 'editsemiprotected';
2895 return !array_diff( $restrictions, $semi );
2899 * Does the title correspond to a protected article?
2901 * @param string $action The action the page is protected from,
2902 * by default checks all actions.
2905 public function isProtected( $action = '' ) {
2906 global $wgRestrictionLevels;
2908 $restrictionTypes = $this->getRestrictionTypes();
2910 # Special pages have inherent protection
2911 if ( $this->isSpecialPage() ) {
2915 # Check regular protection levels
2916 foreach ( $restrictionTypes as $type ) {
2917 if ( $action == $type ||
$action == '' ) {
2918 $r = $this->getRestrictions( $type );
2919 foreach ( $wgRestrictionLevels as $level ) {
2920 if ( in_array( $level, $r ) && $level != '' ) {
2931 * Determines if $user is unable to edit this page because it has been protected
2932 * by $wgNamespaceProtection.
2934 * @param User $user User object to check permissions
2937 public function isNamespaceProtected( User
$user ) {
2938 global $wgNamespaceProtection;
2940 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2941 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2942 if ( $right != '' && !$user->isAllowed( $right ) ) {
2951 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2953 * @return bool If the page is subject to cascading restrictions.
2955 public function isCascadeProtected() {
2956 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2957 return ( $sources > 0 );
2961 * Determines whether cascading protection sources have already been loaded from
2964 * @param bool $getPages True to check if the pages are loaded, or false to check
2965 * if the status is loaded.
2966 * @return bool Whether or not the specified information has been loaded
2969 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2970 return $getPages ?
$this->mCascadeSources
!== null : $this->mHasCascadingRestrictions
!== null;
2974 * Cascading protection: Get the source of any cascading restrictions on this page.
2976 * @param bool $getPages Whether or not to retrieve the actual pages
2977 * that the restrictions have come from and the actual restrictions
2979 * @return array Two elements: First is an array of Title objects of the
2980 * pages from which cascading restrictions have come, false for
2981 * none, or true if such restrictions exist but $getPages was not
2982 * set. Second is an array like that returned by
2983 * Title::getAllRestrictions(), or an empty array if $getPages is
2986 public function getCascadeProtectionSources( $getPages = true ) {
2987 $pagerestrictions = [];
2989 if ( $this->mCascadeSources
!== null && $getPages ) {
2990 return [ $this->mCascadeSources
, $this->mCascadingRestrictions
];
2991 } elseif ( $this->mHasCascadingRestrictions
!== null && !$getPages ) {
2992 return [ $this->mHasCascadingRestrictions
, $pagerestrictions ];
2995 $dbr = wfGetDB( DB_REPLICA
);
2997 if ( $this->getNamespace() == NS_FILE
) {
2998 $tables = [ 'imagelinks', 'page_restrictions' ];
3000 'il_to' => $this->getDBkey(),
3005 $tables = [ 'templatelinks', 'page_restrictions' ];
3007 'tl_namespace' => $this->getNamespace(),
3008 'tl_title' => $this->getDBkey(),
3015 $cols = [ 'pr_page', 'page_namespace', 'page_title',
3016 'pr_expiry', 'pr_type', 'pr_level' ];
3017 $where_clauses[] = 'page_id=pr_page';
3020 $cols = [ 'pr_expiry' ];
3023 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
3025 $sources = $getPages ?
[] : false;
3026 $now = wfTimestampNow();
3028 foreach ( $res as $row ) {
3029 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
3030 if ( $expiry > $now ) {
3032 $page_id = $row->pr_page
;
3033 $page_ns = $row->page_namespace
;
3034 $page_title = $row->page_title
;
3035 $sources[$page_id] = self
::makeTitle( $page_ns, $page_title );
3036 # Add groups needed for each restriction type if its not already there
3037 # Make sure this restriction type still exists
3039 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
3040 $pagerestrictions[$row->pr_type
] = [];
3044 isset( $pagerestrictions[$row->pr_type
] )
3045 && !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] )
3047 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
3056 $this->mCascadeSources
= $sources;
3057 $this->mCascadingRestrictions
= $pagerestrictions;
3059 $this->mHasCascadingRestrictions
= $sources;
3062 return [ $sources, $pagerestrictions ];
3066 * Accessor for mRestrictionsLoaded
3068 * @return bool Whether or not the page's restrictions have already been
3069 * loaded from the database
3072 public function areRestrictionsLoaded() {
3073 return $this->mRestrictionsLoaded
;
3077 * Accessor/initialisation for mRestrictions
3079 * @param string $action Action that permission needs to be checked for
3080 * @return array Restriction levels needed to take the action. All levels are
3081 * required. Note that restriction levels are normally user rights, but 'sysop'
3082 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
3083 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
3085 public function getRestrictions( $action ) {
3086 if ( !$this->mRestrictionsLoaded
) {
3087 $this->loadRestrictions();
3089 return $this->mRestrictions
[$action] ??
[];
3093 * Accessor/initialisation for mRestrictions
3095 * @return array Keys are actions, values are arrays as returned by
3096 * Title::getRestrictions()
3099 public function getAllRestrictions() {
3100 if ( !$this->mRestrictionsLoaded
) {
3101 $this->loadRestrictions();
3103 return $this->mRestrictions
;
3107 * Get the expiry time for the restriction against a given action
3109 * @param string $action
3110 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
3111 * or not protected at all, or false if the action is not recognised.
3113 public function getRestrictionExpiry( $action ) {
3114 if ( !$this->mRestrictionsLoaded
) {
3115 $this->loadRestrictions();
3117 return $this->mRestrictionsExpiry
[$action] ??
false;
3121 * Returns cascading restrictions for the current article
3125 function areRestrictionsCascading() {
3126 if ( !$this->mRestrictionsLoaded
) {
3127 $this->loadRestrictions();
3130 return $this->mCascadeRestriction
;
3134 * Compiles list of active page restrictions from both page table (pre 1.10)
3135 * and page_restrictions table for this existing page.
3136 * Public for usage by LiquidThreads.
3138 * @param array $rows Array of db result objects
3139 * @param string $oldFashionedRestrictions Comma-separated set of permission keys
3140 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
3141 * Edit and move sections are separated by a colon
3142 * Example: "edit=autoconfirmed,sysop:move=sysop"
3144 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
3145 $dbr = wfGetDB( DB_REPLICA
);
3147 $restrictionTypes = $this->getRestrictionTypes();
3149 foreach ( $restrictionTypes as $type ) {
3150 $this->mRestrictions
[$type] = [];
3151 $this->mRestrictionsExpiry
[$type] = 'infinity';
3154 $this->mCascadeRestriction
= false;
3156 # Backwards-compatibility: also load the restrictions from the page record (old format).
3157 if ( $oldFashionedRestrictions !== null ) {
3158 $this->mOldRestrictions
= $oldFashionedRestrictions;
3161 if ( $this->mOldRestrictions
=== false ) {
3162 $this->mOldRestrictions
= $dbr->selectField( 'page', 'page_restrictions',
3163 [ 'page_id' => $this->getArticleID() ], __METHOD__
);
3166 if ( $this->mOldRestrictions
!= '' ) {
3167 foreach ( explode( ':', trim( $this->mOldRestrictions
) ) as $restrict ) {
3168 $temp = explode( '=', trim( $restrict ) );
3169 if ( count( $temp ) == 1 ) {
3170 // old old format should be treated as edit/move restriction
3171 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
3172 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
3174 $restriction = trim( $temp[1] );
3175 if ( $restriction != '' ) { // some old entries are empty
3176 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
3182 if ( count( $rows ) ) {
3183 # Current system - load second to make them override.
3184 $now = wfTimestampNow();
3186 # Cycle through all the restrictions.
3187 foreach ( $rows as $row ) {
3188 // Don't take care of restrictions types that aren't allowed
3189 if ( !in_array( $row->pr_type
, $restrictionTypes ) ) {
3193 $expiry = $dbr->decodeExpiry( $row->pr_expiry
);
3195 // Only apply the restrictions if they haven't expired!
3196 if ( !$expiry ||
$expiry > $now ) {
3197 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
3198 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
3200 $this->mCascadeRestriction |
= $row->pr_cascade
;
3205 $this->mRestrictionsLoaded
= true;
3209 * Load restrictions from the page_restrictions table
3211 * @param string $oldFashionedRestrictions Comma-separated set of permission keys
3212 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
3213 * Edit and move sections are separated by a colon
3214 * Example: "edit=autoconfirmed,sysop:move=sysop"
3216 public function loadRestrictions( $oldFashionedRestrictions = null ) {
3217 if ( $this->mRestrictionsLoaded
) {
3221 $id = $this->getArticleID();
3223 $cache = ObjectCache
::getMainWANInstance();
3224 $rows = $cache->getWithSetCallback(
3225 // Page protections always leave a new null revision
3226 $cache->makeKey( 'page-restrictions', $id, $this->getLatestRevID() ),
3228 function ( $curValue, &$ttl, array &$setOpts ) {
3229 $dbr = wfGetDB( DB_REPLICA
);
3231 $setOpts +
= Database
::getCacheSetOptions( $dbr );
3233 return iterator_to_array(
3235 'page_restrictions',
3236 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
3237 [ 'pr_page' => $this->getArticleID() ],
3244 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
3246 $title_protection = $this->getTitleProtectionInternal();
3248 if ( $title_protection ) {
3249 $now = wfTimestampNow();
3250 $expiry = wfGetDB( DB_REPLICA
)->decodeExpiry( $title_protection['expiry'] );
3252 if ( !$expiry ||
$expiry > $now ) {
3253 // Apply the restrictions
3254 $this->mRestrictionsExpiry
['create'] = $expiry;
3255 $this->mRestrictions
['create'] =
3256 explode( ',', trim( $title_protection['permission'] ) );
3257 } else { // Get rid of the old restrictions
3258 $this->mTitleProtection
= false;
3261 $this->mRestrictionsExpiry
['create'] = 'infinity';
3263 $this->mRestrictionsLoaded
= true;
3268 * Flush the protection cache in this object and force reload from the database.
3269 * This is used when updating protection from WikiPage::doUpdateRestrictions().
3271 public function flushRestrictions() {
3272 $this->mRestrictionsLoaded
= false;
3273 $this->mTitleProtection
= null;
3277 * Purge expired restrictions from the page_restrictions table
3279 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
3281 static function purgeExpiredRestrictions() {
3282 if ( wfReadOnly() ) {
3286 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
3287 wfGetDB( DB_MASTER
),
3289 function ( IDatabase
$dbw, $fname ) {
3290 $config = MediaWikiServices
::getInstance()->getMainConfig();
3291 $ids = $dbw->selectFieldValues(
3292 'page_restrictions',
3294 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3296 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
3299 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
3304 DeferredUpdates
::addUpdate( new AtomicSectionUpdate(
3305 wfGetDB( DB_MASTER
),
3307 function ( IDatabase
$dbw, $fname ) {
3310 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3318 * Does this have subpages? (Warning, usually requires an extra DB query.)
3322 public function hasSubpages() {
3323 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
3328 # We dynamically add a member variable for the purpose of this method
3329 # alone to cache the result. There's no point in having it hanging
3330 # around uninitialized in every Title object; therefore we only add it
3331 # if needed and don't declare it statically.
3332 if ( $this->mHasSubpages
=== null ) {
3333 $this->mHasSubpages
= false;
3334 $subpages = $this->getSubpages( 1 );
3335 if ( $subpages instanceof TitleArray
) {
3336 $this->mHasSubpages
= (bool)$subpages->count();
3340 return $this->mHasSubpages
;
3344 * Get all subpages of this page.
3346 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3347 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3348 * doesn't allow subpages
3350 public function getSubpages( $limit = -1 ) {
3351 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3355 $dbr = wfGetDB( DB_REPLICA
);
3356 $conds['page_namespace'] = $this->getNamespace();
3357 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
3359 if ( $limit > -1 ) {
3360 $options['LIMIT'] = $limit;
3362 return TitleArray
::newFromResult(
3363 $dbr->select( 'page',
3364 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
3373 * Is there a version of this page in the deletion archive?
3375 * @return int The number of archived revisions
3377 public function isDeleted() {
3378 if ( $this->getNamespace() < 0 ) {
3381 $dbr = wfGetDB( DB_REPLICA
);
3383 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3384 [ 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ],
3387 if ( $this->getNamespace() == NS_FILE
) {
3388 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
3389 [ 'fa_name' => $this->getDBkey() ],
3398 * Is there a version of this page in the deletion archive?
3402 public function isDeletedQuick() {
3403 if ( $this->getNamespace() < 0 ) {
3406 $dbr = wfGetDB( DB_REPLICA
);
3407 $deleted = (bool)$dbr->selectField( 'archive', '1',
3408 [ 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ],
3411 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
3412 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3413 [ 'fa_name' => $this->getDBkey() ],
3421 * Get the article ID for this Title from the link cache,
3422 * adding it if necessary
3424 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3426 * @return int The ID
3428 public function getArticleID( $flags = 0 ) {
3429 if ( $this->getNamespace() < 0 ) {
3430 $this->mArticleID
= 0;
3431 return $this->mArticleID
;
3433 $linkCache = LinkCache
::singleton();
3434 if ( $flags & self
::GAID_FOR_UPDATE
) {
3435 $oldUpdate = $linkCache->forUpdate( true );
3436 $linkCache->clearLink( $this );
3437 $this->mArticleID
= $linkCache->addLinkObj( $this );
3438 $linkCache->forUpdate( $oldUpdate );
3440 if ( -1 == $this->mArticleID
) {
3441 $this->mArticleID
= $linkCache->addLinkObj( $this );
3444 return $this->mArticleID
;
3448 * Is this an article that is a redirect page?
3449 * Uses link cache, adding it if necessary
3451 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3454 public function isRedirect( $flags = 0 ) {
3455 if ( !is_null( $this->mRedirect
) ) {
3456 return $this->mRedirect
;
3458 if ( !$this->getArticleID( $flags ) ) {
3459 $this->mRedirect
= false;
3460 return $this->mRedirect
;
3463 $linkCache = LinkCache
::singleton();
3464 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3465 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3466 if ( $cached === null ) {
3467 # Trust LinkCache's state over our own
3468 # LinkCache is telling us that the page doesn't exist, despite there being cached
3469 # data relating to an existing page in $this->mArticleID. Updaters should clear
3470 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3471 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3472 # LinkCache to refresh its data from the master.
3473 $this->mRedirect
= false;
3474 return $this->mRedirect
;
3477 $this->mRedirect
= (bool)$cached;
3479 return $this->mRedirect
;
3483 * What is the length of this page?
3484 * Uses link cache, adding it if necessary
3486 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3489 public function getLength( $flags = 0 ) {
3490 if ( $this->mLength
!= -1 ) {
3491 return $this->mLength
;
3493 if ( !$this->getArticleID( $flags ) ) {
3495 return $this->mLength
;
3497 $linkCache = LinkCache
::singleton();
3498 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3499 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3500 if ( $cached === null ) {
3501 # Trust LinkCache's state over our own, as for isRedirect()
3503 return $this->mLength
;
3506 $this->mLength
= intval( $cached );
3508 return $this->mLength
;
3512 * What is the page_latest field for this page?
3514 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3515 * @return int Int or 0 if the page doesn't exist
3517 public function getLatestRevID( $flags = 0 ) {
3518 if ( !( $flags & self
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
3519 return intval( $this->mLatestID
);
3521 if ( !$this->getArticleID( $flags ) ) {
3522 $this->mLatestID
= 0;
3523 return $this->mLatestID
;
3525 $linkCache = LinkCache
::singleton();
3526 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3527 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3528 if ( $cached === null ) {
3529 # Trust LinkCache's state over our own, as for isRedirect()
3530 $this->mLatestID
= 0;
3531 return $this->mLatestID
;
3534 $this->mLatestID
= intval( $cached );
3536 return $this->mLatestID
;
3540 * This clears some fields in this object, and clears any associated
3541 * keys in the "bad links" section of the link cache.
3543 * - This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow
3544 * loading of the new page_id. It's also called from
3545 * WikiPage::doDeleteArticleReal()
3547 * @param int $newid The new Article ID
3549 public function resetArticleID( $newid ) {
3550 $linkCache = LinkCache
::singleton();
3551 $linkCache->clearLink( $this );
3553 if ( $newid === false ) {
3554 $this->mArticleID
= -1;
3556 $this->mArticleID
= intval( $newid );
3558 $this->mRestrictionsLoaded
= false;
3559 $this->mRestrictions
= [];
3560 $this->mOldRestrictions
= false;
3561 $this->mRedirect
= null;
3562 $this->mLength
= -1;
3563 $this->mLatestID
= false;
3564 $this->mContentModel
= false;
3565 $this->mEstimateRevisions
= null;
3566 $this->mPageLanguage
= false;
3567 $this->mDbPageLanguage
= false;
3568 $this->mIsBigDeletion
= null;
3571 public static function clearCaches() {
3572 $linkCache = LinkCache
::singleton();
3573 $linkCache->clear();
3575 $titleCache = self
::getTitleCache();
3576 $titleCache->clear();
3580 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3582 * @param string $text Containing title to capitalize
3583 * @param int $ns Namespace index, defaults to NS_MAIN
3584 * @return string Containing capitalized title
3586 public static function capitalize( $text, $ns = NS_MAIN
) {
3589 if ( MWNamespace
::isCapitalized( $ns ) ) {
3590 return $wgContLang->ucfirst( $text );
3597 * Secure and split - main initialisation function for this object
3599 * Assumes that mDbkeyform has been set, and is urldecoded
3600 * and uses underscores, but not otherwise munged. This function
3601 * removes illegal characters, splits off the interwiki and
3602 * namespace prefixes, sets the other forms, and canonicalizes
3605 * @throws MalformedTitleException On invalid titles
3606 * @return bool True on success
3608 private function secureAndSplit() {
3610 $this->mInterwiki
= '';
3611 $this->mFragment
= '';
3612 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
3614 $dbkey = $this->mDbkeyform
;
3616 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3617 // the parsing code with Title, while avoiding massive refactoring.
3618 // @todo: get rid of secureAndSplit, refactor parsing code.
3619 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3620 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3621 $titleCodec = MediaWikiServices
::getInstance()->getTitleParser();
3622 // MalformedTitleException can be thrown here
3623 $parts = $titleCodec->splitTitleString( $dbkey, $this->getDefaultNamespace() );
3626 $this->setFragment( '#' . $parts['fragment'] );
3627 $this->mInterwiki
= $parts['interwiki'];
3628 $this->mLocalInterwiki
= $parts['local_interwiki'];
3629 $this->mNamespace
= $parts['namespace'];
3630 $this->mUserCaseDBKey
= $parts['user_case_dbkey'];
3632 $this->mDbkeyform
= $parts['dbkey'];
3633 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
3634 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );
3636 # We already know that some pages won't be in the database!
3637 if ( $this->isExternal() ||
$this->isSpecialPage() ) {
3638 $this->mArticleID
= 0;
3645 * Get an array of Title objects linking to this Title
3646 * Also stores the IDs in the link cache.
3648 * WARNING: do not use this function on arbitrary user-supplied titles!
3649 * On heavily-used templates it will max out the memory.
3651 * @param array $options May be FOR UPDATE
3652 * @param string $table Table name
3653 * @param string $prefix Fields prefix
3654 * @return Title[] Array of Title objects linking here
3656 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3657 if ( count( $options ) > 0 ) {
3658 $db = wfGetDB( DB_MASTER
);
3660 $db = wfGetDB( DB_REPLICA
);
3665 self
::getSelectFields(),
3667 "{$prefix}_from=page_id",
3668 "{$prefix}_namespace" => $this->getNamespace(),
3669 "{$prefix}_title" => $this->getDBkey() ],
3675 if ( $res->numRows() ) {
3676 $linkCache = LinkCache
::singleton();
3677 foreach ( $res as $row ) {
3678 $titleObj = self
::makeTitle( $row->page_namespace
, $row->page_title
);
3680 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3681 $retVal[] = $titleObj;
3689 * Get an array of Title objects using this Title as a template
3690 * Also stores the IDs in the link cache.
3692 * WARNING: do not use this function on arbitrary user-supplied titles!
3693 * On heavily-used templates it will max out the memory.
3695 * @param array $options Query option to Database::select()
3696 * @return Title[] Array of Title the Title objects linking here
3698 public function getTemplateLinksTo( $options = [] ) {
3699 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3703 * Get an array of Title objects linked from this Title
3704 * Also stores the IDs in the link cache.
3706 * WARNING: do not use this function on arbitrary user-supplied titles!
3707 * On heavily-used templates it will max out the memory.
3709 * @param array $options Query option to Database::select()
3710 * @param string $table Table name
3711 * @param string $prefix Fields prefix
3712 * @return array Array of Title objects linking here
3714 public function getLinksFrom( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3715 $id = $this->getArticleID();
3717 # If the page doesn't exist; there can't be any link from this page
3722 $db = wfGetDB( DB_REPLICA
);
3724 $blNamespace = "{$prefix}_namespace";
3725 $blTitle = "{$prefix}_title";
3727 $pageQuery = WikiPage
::getQueryInfo();
3729 [ $table, 'nestpage' => $pageQuery['tables'] ],
3731 [ $blNamespace, $blTitle ],
3732 $pageQuery['fields']
3734 [ "{$prefix}_from" => $id ],
3739 [ "page_namespace=$blNamespace", "page_title=$blTitle" ]
3740 ] ] +
$pageQuery['joins']
3744 $linkCache = LinkCache
::singleton();
3745 foreach ( $res as $row ) {
3746 if ( $row->page_id
) {
3747 $titleObj = self
::newFromRow( $row );
3749 $titleObj = self
::makeTitle( $row->$blNamespace, $row->$blTitle );
3750 $linkCache->addBadLinkObj( $titleObj );
3752 $retVal[] = $titleObj;
3759 * Get an array of Title objects used on this Title as a template
3760 * Also stores the IDs in the link cache.
3762 * WARNING: do not use this function on arbitrary user-supplied titles!
3763 * On heavily-used templates it will max out the memory.
3765 * @param array $options May be FOR UPDATE
3766 * @return Title[] Array of Title the Title objects used here
3768 public function getTemplateLinksFrom( $options = [] ) {
3769 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3773 * Get an array of Title objects referring to non-existent articles linked
3776 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3777 * should use redirect table in this case).
3778 * @return Title[] Array of Title the Title objects
3780 public function getBrokenLinksFrom() {
3781 if ( $this->getArticleID() == 0 ) {
3782 # All links from article ID 0 are false positives
3786 $dbr = wfGetDB( DB_REPLICA
);
3787 $res = $dbr->select(
3788 [ 'page', 'pagelinks' ],
3789 [ 'pl_namespace', 'pl_title' ],
3791 'pl_from' => $this->getArticleID(),
3792 'page_namespace IS NULL'
3798 [ 'pl_namespace=page_namespace', 'pl_title=page_title' ]
3804 foreach ( $res as $row ) {
3805 $retVal[] = self
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3811 * Get a list of URLs to purge from the CDN cache when this
3814 * @return string[] Array of String the URLs
3816 public function getCdnUrls() {
3818 $this->getInternalURL(),
3819 $this->getInternalURL( 'action=history' )
3822 $pageLang = $this->getPageLanguage();
3823 if ( $pageLang->hasVariants() ) {
3824 $variants = $pageLang->getVariants();
3825 foreach ( $variants as $vCode ) {
3826 $urls[] = $this->getInternalURL( $vCode );
3830 // If we are looking at a css/js user subpage, purge the action=raw.
3831 if ( $this->isUserJsConfigPage() ) {
3832 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/javascript' );
3833 } elseif ( $this->isUserJsonConfigPage() ) {
3834 $urls[] = $this->getInternalURL( 'action=raw&ctype=application/json' );
3835 } elseif ( $this->isUserCssConfigPage() ) {
3836 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/css' );
3839 Hooks
::run( 'TitleSquidURLs', [ $this, &$urls ] );
3844 * @deprecated since 1.27 use getCdnUrls()
3846 public function getSquidURLs() {
3847 return $this->getCdnUrls();
3851 * Purge all applicable CDN URLs
3853 public function purgeSquid() {
3854 DeferredUpdates
::addUpdate(
3855 new CdnCacheUpdate( $this->getCdnUrls() ),
3856 DeferredUpdates
::PRESEND
3861 * Check whether a given move operation would be valid.
3862 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3864 * @deprecated since 1.25, use MovePage's methods instead
3865 * @param Title &$nt The new title
3866 * @param bool $auth Whether to check user permissions (uses $wgUser)
3867 * @param string $reason Is the log summary of the move, used for spam checking
3868 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3870 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3873 if ( !( $nt instanceof Title
) ) {
3874 // Normally we'd add this to $errors, but we'll get
3875 // lots of syntax errors if $nt is not an object
3876 return [ [ 'badtitletext' ] ];
3879 $mp = new MovePage( $this, $nt );
3880 $errors = $mp->isValidMove()->getErrorsArray();
3882 $errors = wfMergeErrorArrays(
3884 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
3888 return $errors ?
: true;
3892 * Check if the requested move target is a valid file move target
3893 * @todo move this to MovePage
3894 * @param Title $nt Target title
3895 * @return array List of errors
3897 protected function validateFileMoveOperation( $nt ) {
3902 $destFile = wfLocalFile( $nt );
3903 $destFile->load( File
::READ_LATEST
);
3904 if ( !$wgUser->isAllowed( 'reupload-shared' )
3905 && !$destFile->exists() && wfFindFile( $nt )
3907 $errors[] = [ 'file-exists-sharedrepo' ];
3914 * Move a title to a new location
3916 * @deprecated since 1.25, use the MovePage class instead
3917 * @param Title &$nt The new title
3918 * @param bool $auth Indicates whether $wgUser's permissions
3920 * @param string $reason The reason for the move
3921 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3922 * Ignored if the user doesn't have the suppressredirect right.
3923 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3924 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3926 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true,
3927 array $changeTags = []
3930 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3931 if ( is_array( $err ) ) {
3932 // Auto-block user's IP if the account was "hard" blocked
3933 $wgUser->spreadAnyEditBlock();
3936 // Check suppressredirect permission
3937 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3938 $createRedirect = true;
3941 $mp = new MovePage( $this, $nt );
3942 $status = $mp->move( $wgUser, $reason, $createRedirect, $changeTags );
3943 if ( $status->isOK() ) {
3946 return $status->getErrorsArray();
3951 * Move this page's subpages to be subpages of $nt
3953 * @param Title $nt Move target
3954 * @param bool $auth Whether $wgUser's permissions should be checked
3955 * @param string $reason The reason for the move
3956 * @param bool $createRedirect Whether to create redirects from the old subpages to
3957 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3958 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3959 * @return array Array with old page titles as keys, and strings (new page titles) or
3960 * getUserPermissionsErrors()-like arrays (errors) as values, or a
3961 * getUserPermissionsErrors()-like error array with numeric indices if
3962 * no pages were moved
3964 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true,
3965 array $changeTags = []
3967 global $wgMaximumMovedPages;
3968 // Check permissions
3969 if ( !$this->userCan( 'move-subpages' ) ) {
3971 [ 'cant-move-subpages' ],
3974 // Do the source and target namespaces support subpages?
3975 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3977 [ 'namespace-nosubpages', MWNamespace
::getCanonicalName( $this->getNamespace() ) ],
3980 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3982 [ 'namespace-nosubpages', MWNamespace
::getCanonicalName( $nt->getNamespace() ) ],
3986 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3989 foreach ( $subpages as $oldSubpage ) {
3991 if ( $count > $wgMaximumMovedPages ) {
3992 $retval[$oldSubpage->getPrefixedText()] = [
3993 [ 'movepage-max-pages', $wgMaximumMovedPages ],
3998 // We don't know whether this function was called before
3999 // or after moving the root page, so check both
4001 if ( $oldSubpage->getArticleID() == $this->getArticleID()
4002 ||
$oldSubpage->getArticleID() == $nt->getArticleID()
4004 // When moving a page to a subpage of itself,
4005 // don't move it twice
4008 $newPageName = preg_replace(
4009 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
4010 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # T23234
4011 $oldSubpage->getDBkey() );
4012 if ( $oldSubpage->isTalkPage() ) {
4013 $newNs = $nt->getTalkPage()->getNamespace();
4015 $newNs = $nt->getSubjectPage()->getNamespace();
4017 # T16385: we need makeTitleSafe because the new page names may
4018 # be longer than 255 characters.
4019 $newSubpage = self
::makeTitleSafe( $newNs, $newPageName );
4021 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect, $changeTags );
4022 if ( $success === true ) {
4023 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
4025 $retval[$oldSubpage->getPrefixedText()] = $success;
4032 * Checks if this page is just a one-rev redirect.
4033 * Adds lock, so don't use just for light purposes.
4037 public function isSingleRevRedirect() {
4038 global $wgContentHandlerUseDB;
4040 $dbw = wfGetDB( DB_MASTER
);
4043 $fields = [ 'page_is_redirect', 'page_latest', 'page_id' ];
4044 if ( $wgContentHandlerUseDB ) {
4045 $fields[] = 'page_content_model';
4048 $row = $dbw->selectRow( 'page',
4054 # Cache some fields we may want
4055 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
4056 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
4057 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
4058 $this->mContentModel
= $row && isset( $row->page_content_model
)
4059 ?
strval( $row->page_content_model
)
4062 if ( !$this->mRedirect
) {
4065 # Does the article have a history?
4066 $row = $dbw->selectField( [ 'page', 'revision' ],
4068 [ 'page_namespace' => $this->getNamespace(),
4069 'page_title' => $this->getDBkey(),
4071 'page_latest != rev_id'
4076 # Return true if there was no history
4077 return ( $row === false );
4081 * Checks if $this can be moved to a given Title
4082 * - Selects for update, so don't call it unless you mean business
4084 * @deprecated since 1.25, use MovePage's methods instead
4085 * @param Title $nt The new title to check
4088 public function isValidMoveTarget( $nt ) {
4089 # Is it an existing file?
4090 if ( $nt->getNamespace() == NS_FILE
) {
4091 $file = wfLocalFile( $nt );
4092 $file->load( File
::READ_LATEST
);
4093 if ( $file->exists() ) {
4094 wfDebug( __METHOD__
. ": file exists\n" );
4098 # Is it a redirect with no history?
4099 if ( !$nt->isSingleRevRedirect() ) {
4100 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
4103 # Get the article text
4104 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
4105 if ( !is_object( $rev ) ) {
4108 $content = $rev->getContent();
4109 # Does the redirect point to the source?
4110 # Or is it a broken self-redirect, usually caused by namespace collisions?
4111 $redirTitle = $content ?
$content->getRedirectTarget() : null;
4113 if ( $redirTitle ) {
4114 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
4115 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
4116 wfDebug( __METHOD__
. ": redirect points to other page\n" );
4122 # Fail safe (not a redirect after all. strange.)
4123 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4124 " is a redirect, but it doesn't contain a valid redirect.\n" );
4130 * Get categories to which this Title belongs and return an array of
4131 * categories' names.
4133 * @return array Array of parents in the form:
4134 * $parent => $currentarticle
4136 public function getParentCategories() {
4141 $titleKey = $this->getArticleID();
4143 if ( $titleKey === 0 ) {
4147 $dbr = wfGetDB( DB_REPLICA
);
4149 $res = $dbr->select(
4152 [ 'cl_from' => $titleKey ],
4156 if ( $res->numRows() > 0 ) {
4157 foreach ( $res as $row ) {
4158 // $data[] = Title::newFromText($wgContLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
4159 $data[$wgContLang->getNsText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
4166 * Get a tree of parent categories
4168 * @param array $children Array with the children in the keys, to check for circular refs
4169 * @return array Tree of parent categories
4171 public function getParentCategoryTree( $children = [] ) {
4173 $parents = $this->getParentCategories();
4176 foreach ( $parents as $parent => $current ) {
4177 if ( array_key_exists( $parent, $children ) ) {
4178 # Circular reference
4179 $stack[$parent] = [];
4181 $nt = self
::newFromText( $parent );
4183 $stack[$parent] = $nt->getParentCategoryTree( $children +
[ $parent => 1 ] );
4193 * Get an associative array for selecting this title from
4196 * @return array Array suitable for the $where parameter of DB::select()
4198 public function pageCond() {
4199 if ( $this->mArticleID
> 0 ) {
4200 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4201 return [ 'page_id' => $this->mArticleID
];
4203 return [ 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
];
4208 * Get next/previous revision ID relative to another revision ID
4209 * @param int $revId Revision ID. Get the revision that was before this one.
4210 * @param int $flags Title::GAID_FOR_UPDATE
4211 * @param string $dir 'next' or 'prev'
4212 * @return int|bool New revision ID, or false if none exists
4214 private function getRelativeRevisionID( $revId, $flags, $dir ) {
4215 $revId = (int)$revId;
4216 if ( $dir === 'next' ) {
4219 } elseif ( $dir === 'prev' ) {
4223 throw new InvalidArgumentException( '$dir must be "next" or "prev"' );
4226 if ( $flags & self
::GAID_FOR_UPDATE
) {
4227 $db = wfGetDB( DB_MASTER
);
4229 $db = wfGetDB( DB_REPLICA
, 'contributions' );
4232 // Intentionally not caring if the specified revision belongs to this
4233 // page. We only care about the timestamp.
4234 $ts = $db->selectField( 'revision', 'rev_timestamp', [ 'rev_id' => $revId ], __METHOD__
);
4235 if ( $ts === false ) {
4236 $ts = $db->selectField( 'archive', 'ar_timestamp', [ 'ar_rev_id' => $revId ], __METHOD__
);
4237 if ( $ts === false ) {
4238 // Or should this throw an InvalidArgumentException or something?
4242 $ts = $db->addQuotes( $ts );
4244 $revId = $db->selectField( 'revision', 'rev_id',
4246 'rev_page' => $this->getArticleID( $flags ),
4247 "rev_timestamp $op $ts OR (rev_timestamp = $ts AND rev_id $op $revId)"
4251 'ORDER BY' => "rev_timestamp $sort, rev_id $sort",
4252 'IGNORE INDEX' => 'rev_timestamp', // Probably needed for T159319
4256 if ( $revId === false ) {
4259 return intval( $revId );
4264 * Get the revision ID of the previous revision
4266 * @param int $revId Revision ID. Get the revision that was before this one.
4267 * @param int $flags Title::GAID_FOR_UPDATE
4268 * @return int|bool Old revision ID, or false if none exists
4270 public function getPreviousRevisionID( $revId, $flags = 0 ) {
4271 return $this->getRelativeRevisionID( $revId, $flags, 'prev' );
4275 * Get the revision ID of the next revision
4277 * @param int $revId Revision ID. Get the revision that was after this one.
4278 * @param int $flags Title::GAID_FOR_UPDATE
4279 * @return int|bool Next revision ID, or false if none exists
4281 public function getNextRevisionID( $revId, $flags = 0 ) {
4282 return $this->getRelativeRevisionID( $revId, $flags, 'next' );
4286 * Get the first revision of the page
4288 * @param int $flags Title::GAID_FOR_UPDATE
4289 * @return Revision|null If page doesn't exist
4291 public function getFirstRevision( $flags = 0 ) {
4292 $pageId = $this->getArticleID( $flags );
4294 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_REPLICA
);
4295 $revQuery = Revision
::getQueryInfo();
4296 $row = $db->selectRow( $revQuery['tables'], $revQuery['fields'],
4297 [ 'rev_page' => $pageId ],
4300 'ORDER BY' => 'rev_timestamp ASC, rev_id ASC',
4301 'IGNORE INDEX' => [ 'revision' => 'rev_timestamp' ], // See T159319
4306 return new Revision( $row );
4313 * Get the oldest revision timestamp of this page
4315 * @param int $flags Title::GAID_FOR_UPDATE
4316 * @return string MW timestamp
4318 public function getEarliestRevTime( $flags = 0 ) {
4319 $rev = $this->getFirstRevision( $flags );
4320 return $rev ?
$rev->getTimestamp() : null;
4324 * Check if this is a new page
4328 public function isNewPage() {
4329 $dbr = wfGetDB( DB_REPLICA
);
4330 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4334 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4338 public function isBigDeletion() {
4339 global $wgDeleteRevisionsLimit;
4341 if ( !$wgDeleteRevisionsLimit ) {
4345 if ( $this->mIsBigDeletion
=== null ) {
4346 $dbr = wfGetDB( DB_REPLICA
);
4348 $revCount = $dbr->selectRowCount(
4351 [ 'rev_page' => $this->getArticleID() ],
4353 [ 'LIMIT' => $wgDeleteRevisionsLimit +
1 ]
4356 $this->mIsBigDeletion
= $revCount > $wgDeleteRevisionsLimit;
4359 return $this->mIsBigDeletion
;
4363 * Get the approximate revision count of this page.
4367 public function estimateRevisionCount() {
4368 if ( !$this->exists() ) {
4372 if ( $this->mEstimateRevisions
=== null ) {
4373 $dbr = wfGetDB( DB_REPLICA
);
4374 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4375 [ 'rev_page' => $this->getArticleID() ], __METHOD__
);
4378 return $this->mEstimateRevisions
;
4382 * Get the number of revisions between the given revision.
4383 * Used for diffs and other things that really need it.
4385 * @param int|Revision $old Old revision or rev ID (first before range)
4386 * @param int|Revision $new New revision or rev ID (first after range)
4387 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4388 * @return int Number of revisions between these revisions.
4390 public function countRevisionsBetween( $old, $new, $max = null ) {
4391 if ( !( $old instanceof Revision
) ) {
4392 $old = Revision
::newFromTitle( $this, (int)$old );
4394 if ( !( $new instanceof Revision
) ) {
4395 $new = Revision
::newFromTitle( $this, (int)$new );
4397 if ( !$old ||
!$new ) {
4398 return 0; // nothing to compare
4400 $dbr = wfGetDB( DB_REPLICA
);
4402 'rev_page' => $this->getArticleID(),
4403 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4404 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4406 if ( $max !== null ) {
4407 return $dbr->selectRowCount( 'revision', '1',
4410 [ 'LIMIT' => $max +
1 ] // extra to detect truncation
4413 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__
);
4418 * Get the authors between the given revisions or revision IDs.
4419 * Used for diffs and other things that really need it.
4423 * @param int|Revision $old Old revision or rev ID (first before range by default)
4424 * @param int|Revision $new New revision or rev ID (first after range by default)
4425 * @param int $limit Maximum number of authors
4426 * @param string|array $options (Optional): Single option, or an array of options:
4427 * 'include_old' Include $old in the range; $new is excluded.
4428 * 'include_new' Include $new in the range; $old is excluded.
4429 * 'include_both' Include both $old and $new in the range.
4430 * Unknown option values are ignored.
4431 * @return array|null Names of revision authors in the range; null if not both revisions exist
4433 public function getAuthorsBetween( $old, $new, $limit, $options = [] ) {
4434 if ( !( $old instanceof Revision
) ) {
4435 $old = Revision
::newFromTitle( $this, (int)$old );
4437 if ( !( $new instanceof Revision
) ) {
4438 $new = Revision
::newFromTitle( $this, (int)$new );
4440 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4441 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4442 // in the sanity check below?
4443 if ( !$old ||
!$new ) {
4444 return null; // nothing to compare
4449 $options = (array)$options;
4450 if ( in_array( 'include_old', $options ) ) {
4453 if ( in_array( 'include_new', $options ) ) {
4456 if ( in_array( 'include_both', $options ) ) {
4460 // No DB query needed if $old and $new are the same or successive revisions:
4461 if ( $old->getId() === $new->getId() ) {
4462 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
4464 [ $old->getUserText( Revision
::RAW
) ];
4465 } elseif ( $old->getId() === $new->getParentId() ) {
4466 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4467 $authors[] = $old->getUserText( Revision
::RAW
);
4468 if ( $old->getUserText( Revision
::RAW
) != $new->getUserText( Revision
::RAW
) ) {
4469 $authors[] = $new->getUserText( Revision
::RAW
);
4471 } elseif ( $old_cmp === '>=' ) {
4472 $authors[] = $old->getUserText( Revision
::RAW
);
4473 } elseif ( $new_cmp === '<=' ) {
4474 $authors[] = $new->getUserText( Revision
::RAW
);
4478 $dbr = wfGetDB( DB_REPLICA
);
4479 $revQuery = Revision
::getQueryInfo();
4480 $authors = $dbr->selectFieldValues(
4481 $revQuery['tables'],
4482 $revQuery['fields']['rev_user_text'],
4484 'rev_page' => $this->getArticleID(),
4485 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4486 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4488 [ 'DISTINCT', 'LIMIT' => $limit +
1 ], // add one so caller knows it was truncated
4495 * Get the number of authors between the given revisions or revision IDs.
4496 * Used for diffs and other things that really need it.
4498 * @param int|Revision $old Old revision or rev ID (first before range by default)
4499 * @param int|Revision $new New revision or rev ID (first after range by default)
4500 * @param int $limit Maximum number of authors
4501 * @param string|array $options (Optional): Single option, or an array of options:
4502 * 'include_old' Include $old in the range; $new is excluded.
4503 * 'include_new' Include $new in the range; $old is excluded.
4504 * 'include_both' Include both $old and $new in the range.
4505 * Unknown option values are ignored.
4506 * @return int Number of revision authors in the range; zero if not both revisions exist
4508 public function countAuthorsBetween( $old, $new, $limit, $options = [] ) {
4509 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4510 return $authors ?
count( $authors ) : 0;
4514 * Compare with another title.
4516 * @param Title $title
4519 public function equals( Title
$title ) {
4520 // Note: === is necessary for proper matching of number-like titles.
4521 return $this->getInterwiki() === $title->getInterwiki()
4522 && $this->getNamespace() == $title->getNamespace()
4523 && $this->getDBkey() === $title->getDBkey();
4527 * Check if this title is a subpage of another title
4529 * @param Title $title
4532 public function isSubpageOf( Title
$title ) {
4533 return $this->getInterwiki() === $title->getInterwiki()
4534 && $this->getNamespace() == $title->getNamespace()
4535 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4539 * Check if page exists. For historical reasons, this function simply
4540 * checks for the existence of the title in the page table, and will
4541 * thus return false for interwiki links, special pages and the like.
4542 * If you want to know if a title can be meaningfully viewed, you should
4543 * probably call the isKnown() method instead.
4545 * @param int $flags An optional bit field; may be Title::GAID_FOR_UPDATE to check
4546 * from master/for update
4549 public function exists( $flags = 0 ) {
4550 $exists = $this->getArticleID( $flags ) != 0;
4551 Hooks
::run( 'TitleExists', [ $this, &$exists ] );
4556 * Should links to this title be shown as potentially viewable (i.e. as
4557 * "bluelinks"), even if there's no record by this title in the page
4560 * This function is semi-deprecated for public use, as well as somewhat
4561 * misleadingly named. You probably just want to call isKnown(), which
4562 * calls this function internally.
4564 * (ISSUE: Most of these checks are cheap, but the file existence check
4565 * can potentially be quite expensive. Including it here fixes a lot of
4566 * existing code, but we might want to add an optional parameter to skip
4567 * it and any other expensive checks.)
4571 public function isAlwaysKnown() {
4575 * Allows overriding default behavior for determining if a page exists.
4576 * If $isKnown is kept as null, regular checks happen. If it's
4577 * a boolean, this value is returned by the isKnown method.
4581 * @param Title $title
4582 * @param bool|null $isKnown
4584 Hooks
::run( 'TitleIsAlwaysKnown', [ $this, &$isKnown ] );
4586 if ( !is_null( $isKnown ) ) {
4590 if ( $this->isExternal() ) {
4591 return true; // any interwiki link might be viewable, for all we know
4594 switch ( $this->mNamespace
) {
4597 // file exists, possibly in a foreign repo
4598 return (bool)wfFindFile( $this );
4600 // valid special page
4601 return SpecialPageFactory
::exists( $this->getDBkey() );
4603 // selflink, possibly with fragment
4604 return $this->mDbkeyform
== '';
4606 // known system message
4607 return $this->hasSourceText() !== false;
4614 * Does this title refer to a page that can (or might) be meaningfully
4615 * viewed? In particular, this function may be used to determine if
4616 * links to the title should be rendered as "bluelinks" (as opposed to
4617 * "redlinks" to non-existent pages).
4618 * Adding something else to this function will cause inconsistency
4619 * since LinkHolderArray calls isAlwaysKnown() and does its own
4620 * page existence check.
4624 public function isKnown() {
4625 return $this->isAlwaysKnown() ||
$this->exists();
4629 * Does this page have source text?
4633 public function hasSourceText() {
4634 if ( $this->exists() ) {
4638 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4639 // If the page doesn't exist but is a known system message, default
4640 // message content will be displayed, same for language subpages-
4641 // Use always content language to avoid loading hundreds of languages
4642 // to get the link color.
4644 list( $name, ) = MessageCache
::singleton()->figureMessage(
4645 $wgContLang->lcfirst( $this->getText() )
4647 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4648 return $message->exists();
4655 * Get the default message text or false if the message doesn't exist
4657 * @return string|bool
4659 public function getDefaultMessageText() {
4662 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
4666 list( $name, $lang ) = MessageCache
::singleton()->figureMessage(
4667 $wgContLang->lcfirst( $this->getText() )
4669 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4671 if ( $message->exists() ) {
4672 return $message->plain();
4679 * Updates page_touched for this page; called from LinksUpdate.php
4681 * @param string $purgeTime [optional] TS_MW timestamp
4682 * @return bool True if the update succeeded
4684 public function invalidateCache( $purgeTime = null ) {
4685 if ( wfReadOnly() ) {
4687 } elseif ( $this->mArticleID
=== 0 ) {
4688 return true; // avoid gap locking if we know it's not there
4691 $dbw = wfGetDB( DB_MASTER
);
4692 $dbw->onTransactionPreCommitOrIdle(
4694 ResourceLoaderWikiModule
::invalidateModuleCache( $this, null, null, wfWikiID() );
4699 $conds = $this->pageCond();
4700 DeferredUpdates
::addUpdate(
4701 new AutoCommitUpdate(
4704 function ( IDatabase
$dbw, $fname ) use ( $conds, $purgeTime ) {
4705 $dbTimestamp = $dbw->timestamp( $purgeTime ?
: time() );
4708 [ 'page_touched' => $dbTimestamp ],
4709 $conds +
[ 'page_touched < ' . $dbw->addQuotes( $dbTimestamp ) ],
4712 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $this );
4715 DeferredUpdates
::PRESEND
4722 * Update page_touched timestamps and send CDN purge messages for
4723 * pages linking to this title. May be sent to the job queue depending
4724 * on the number of links. Typically called on create and delete.
4726 public function touchLinks() {
4727 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this, 'pagelinks', 'page-touch' ) );
4728 if ( $this->getNamespace() == NS_CATEGORY
) {
4729 DeferredUpdates
::addUpdate(
4730 new HTMLCacheUpdate( $this, 'categorylinks', 'category-touch' )
4736 * Get the last touched timestamp
4738 * @param IDatabase|null $db
4739 * @return string|false Last-touched timestamp
4741 public function getTouched( $db = null ) {
4742 if ( $db === null ) {
4743 $db = wfGetDB( DB_REPLICA
);
4745 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4750 * Get the timestamp when this page was updated since the user last saw it.
4753 * @return string|null
4755 public function getNotificationTimestamp( $user = null ) {
4758 // Assume current user if none given
4762 // Check cache first
4763 $uid = $user->getId();
4767 // avoid isset here, as it'll return false for null entries
4768 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4769 return $this->mNotificationTimestamp
[$uid];
4771 // Don't cache too much!
4772 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4773 $this->mNotificationTimestamp
= [];
4776 $store = MediaWikiServices
::getInstance()->getWatchedItemStore();
4777 $watchedItem = $store->getWatchedItem( $user, $this );
4778 if ( $watchedItem ) {
4779 $this->mNotificationTimestamp
[$uid] = $watchedItem->getNotificationTimestamp();
4781 $this->mNotificationTimestamp
[$uid] = false;
4784 return $this->mNotificationTimestamp
[$uid];
4788 * Generate strings used for xml 'id' names in monobook tabs
4790 * @param string $prepend Defaults to 'nstab-'
4791 * @return string XML 'id' name
4793 public function getNamespaceKey( $prepend = 'nstab-' ) {
4795 // Gets the subject namespace of this title
4796 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
4797 // Prefer canonical namespace name for HTML IDs
4798 $namespaceKey = MWNamespace
::getCanonicalName( $subjectNS );
4799 if ( $namespaceKey === false ) {
4800 // Fallback to localised text
4801 $namespaceKey = $this->getSubjectNsText();
4803 // Makes namespace key lowercase
4804 $namespaceKey = $wgContLang->lc( $namespaceKey );
4806 if ( $namespaceKey == '' ) {
4807 $namespaceKey = 'main';
4809 // Changes file to image for backwards compatibility
4810 if ( $namespaceKey == 'file' ) {
4811 $namespaceKey = 'image';
4813 return $prepend . $namespaceKey;
4817 * Get all extant redirects to this Title
4819 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4820 * @return Title[] Array of Title redirects to this title
4822 public function getRedirectsHere( $ns = null ) {
4825 $dbr = wfGetDB( DB_REPLICA
);
4827 'rd_namespace' => $this->getNamespace(),
4828 'rd_title' => $this->getDBkey(),
4831 if ( $this->isExternal() ) {
4832 $where['rd_interwiki'] = $this->getInterwiki();
4834 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4836 if ( !is_null( $ns ) ) {
4837 $where['page_namespace'] = $ns;
4840 $res = $dbr->select(
4841 [ 'redirect', 'page' ],
4842 [ 'page_namespace', 'page_title' ],
4847 foreach ( $res as $row ) {
4848 $redirs[] = self
::newFromRow( $row );
4854 * Check if this Title is a valid redirect target
4858 public function isValidRedirectTarget() {
4859 global $wgInvalidRedirectTargets;
4861 if ( $this->isSpecialPage() ) {
4862 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4863 if ( $this->isSpecial( 'Userlogout' ) ) {
4867 foreach ( $wgInvalidRedirectTargets as $target ) {
4868 if ( $this->isSpecial( $target ) ) {
4878 * Get a backlink cache object
4880 * @return BacklinkCache
4882 public function getBacklinkCache() {
4883 return BacklinkCache
::get( $this );
4887 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4891 public function canUseNoindex() {
4892 global $wgExemptFromUserRobotsControl;
4894 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4895 ? MWNamespace
::getContentNamespaces()
4896 : $wgExemptFromUserRobotsControl;
4898 return !in_array( $this->mNamespace
, $bannedNamespaces );
4902 * Returns the raw sort key to be used for categories, with the specified
4903 * prefix. This will be fed to Collation::getSortKey() to get a
4904 * binary sortkey that can be used for actual sorting.
4906 * @param string $prefix The prefix to be used, specified using
4907 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4911 public function getCategorySortkey( $prefix = '' ) {
4912 $unprefixed = $this->getText();
4914 // Anything that uses this hook should only depend
4915 // on the Title object passed in, and should probably
4916 // tell the users to run updateCollations.php --force
4917 // in order to re-sort existing category relations.
4918 Hooks
::run( 'GetDefaultSortkey', [ $this, &$unprefixed ] );
4919 if ( $prefix !== '' ) {
4920 # Separate with a line feed, so the unprefixed part is only used as
4921 # a tiebreaker when two pages have the exact same prefix.
4922 # In UCA, tab is the only character that can sort above LF
4923 # so we strip both of them from the original prefix.
4924 $prefix = strtr( $prefix, "\n\t", ' ' );
4925 return "$prefix\n$unprefixed";
4931 * Returns the page language code saved in the database, if $wgPageLanguageUseDB is set
4932 * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
4933 * the db, it will return NULL.
4935 * @return string|null|bool
4937 private function getDbPageLanguageCode() {
4938 global $wgPageLanguageUseDB;
4940 // check, if the page language could be saved in the database, and if so and
4941 // the value is not requested already, lookup the page language using LinkCache
4942 if ( $wgPageLanguageUseDB && $this->mDbPageLanguage
=== false ) {
4943 $linkCache = LinkCache
::singleton();
4944 $linkCache->addLinkObj( $this );
4945 $this->mDbPageLanguage
= $linkCache->getGoodLinkFieldObj( $this, 'lang' );
4948 return $this->mDbPageLanguage
;
4952 * Get the language in which the content of this page is written in
4953 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4954 * e.g. $wgLang (such as special pages, which are in the user language).
4959 public function getPageLanguage() {
4960 global $wgLang, $wgLanguageCode;
4961 if ( $this->isSpecialPage() ) {
4962 // special pages are in the user language
4966 // Checking if DB language is set
4967 $dbPageLanguage = $this->getDbPageLanguageCode();
4968 if ( $dbPageLanguage ) {
4969 return wfGetLangObj( $dbPageLanguage );
4972 if ( !$this->mPageLanguage ||
$this->mPageLanguage
[1] !== $wgLanguageCode ) {
4973 // Note that this may depend on user settings, so the cache should
4974 // be only per-request.
4975 // NOTE: ContentHandler::getPageLanguage() may need to load the
4976 // content to determine the page language!
4977 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4979 $contentHandler = ContentHandler
::getForTitle( $this );
4980 $langObj = $contentHandler->getPageLanguage( $this );
4981 $this->mPageLanguage
= [ $langObj->getCode(), $wgLanguageCode ];
4983 $langObj = Language
::factory( $this->mPageLanguage
[0] );
4990 * Get the language in which the content of this page is written when
4991 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4992 * e.g. $wgLang (such as special pages, which are in the user language).
4997 public function getPageViewLanguage() {
5000 if ( $this->isSpecialPage() ) {
5001 // If the user chooses a variant, the content is actually
5002 // in a language whose code is the variant code.
5003 $variant = $wgLang->getPreferredVariant();
5004 if ( $wgLang->getCode() !== $variant ) {
5005 return Language
::factory( $variant );
5011 // Checking if DB language is set
5012 $dbPageLanguage = $this->getDbPageLanguageCode();
5013 if ( $dbPageLanguage ) {
5014 $pageLang = wfGetLangObj( $dbPageLanguage );
5015 $variant = $pageLang->getPreferredVariant();
5016 if ( $pageLang->getCode() !== $variant ) {
5017 $pageLang = Language
::factory( $variant );
5023 // @note Can't be cached persistently, depends on user settings.
5024 // @note ContentHandler::getPageViewLanguage() may need to load the
5025 // content to determine the page language!
5026 $contentHandler = ContentHandler
::getForTitle( $this );
5027 $pageLang = $contentHandler->getPageViewLanguage( $this );
5032 * Get a list of rendered edit notices for this page.
5034 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
5035 * they will already be wrapped in paragraphs.
5038 * @param int $oldid Revision ID that's being edited
5041 public function getEditNotices( $oldid = 0 ) {
5044 // Optional notice for the entire namespace
5045 $editnotice_ns = 'editnotice-' . $this->getNamespace();
5046 $msg = wfMessage( $editnotice_ns );
5047 if ( $msg->exists() ) {
5048 $html = $msg->parseAsBlock();
5049 // Edit notices may have complex logic, but output nothing (T91715)
5050 if ( trim( $html ) !== '' ) {
5051 $notices[$editnotice_ns] = Html
::rawElement(
5055 'mw-editnotice-namespace',
5056 Sanitizer
::escapeClass( "mw-$editnotice_ns" )
5063 if ( MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
5064 // Optional notice for page itself and any parent page
5065 $parts = explode( '/', $this->getDBkey() );
5066 $editnotice_base = $editnotice_ns;
5067 while ( count( $parts ) > 0 ) {
5068 $editnotice_base .= '-' . array_shift( $parts );
5069 $msg = wfMessage( $editnotice_base );
5070 if ( $msg->exists() ) {
5071 $html = $msg->parseAsBlock();
5072 if ( trim( $html ) !== '' ) {
5073 $notices[$editnotice_base] = Html
::rawElement(
5077 'mw-editnotice-base',
5078 Sanitizer
::escapeClass( "mw-$editnotice_base" )
5086 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
5087 $editnoticeText = $editnotice_ns . '-' . strtr( $this->getDBkey(), '/', '-' );
5088 $msg = wfMessage( $editnoticeText );
5089 if ( $msg->exists() ) {
5090 $html = $msg->parseAsBlock();
5091 if ( trim( $html ) !== '' ) {
5092 $notices[$editnoticeText] = Html
::rawElement(
5096 'mw-editnotice-page',
5097 Sanitizer
::escapeClass( "mw-$editnoticeText" )
5105 Hooks
::run( 'TitleGetEditNotices', [ $this, $oldid, &$notices ] );
5112 public function __sleep() {
5120 'mDefaultNamespace',
5124 public function __wakeup() {
5125 $this->mArticleID
= ( $this->mNamespace
>= 0 ) ?
-1 : 0;
5126 $this->mUrlform
= wfUrlencode( $this->mDbkeyform
);
5127 $this->mTextform
= strtr( $this->mDbkeyform
, '_', ' ' );