Merge "Setup: Move MWDebug logic to MWDebug.php"
[lhc/web/wiklou.git] / includes / Title.php
1 <?php
2 /**
3 * Representation of a title within %MediaWiki.
4 *
5 * See title.txt
6 *
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.
11 *
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.
16 *
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
21 *
22 * @file
23 */
24
25 use MediaWiki\Permissions\PermissionManager;
26 use MediaWiki\Storage\RevisionRecord;
27 use Wikimedia\Assert\Assert;
28 use Wikimedia\Rdbms\Database;
29 use Wikimedia\Rdbms\IDatabase;
30 use MediaWiki\Linker\LinkTarget;
31 use MediaWiki\Interwiki\InterwikiLookup;
32 use MediaWiki\MediaWikiServices;
33
34 /**
35 * Represents a title within MediaWiki.
36 * Optionally may contain an interwiki designation or namespace.
37 * @note This class can fetch various kinds of data from the database;
38 * however, it does so inefficiently.
39 * @note Consider using a TitleValue object instead. TitleValue is more lightweight
40 * and does not rely on global state or the database.
41 */
42 class Title implements LinkTarget, IDBAccessObject {
43 /** @var MapCacheLRU|null */
44 private static $titleCache = null;
45
46 /**
47 * Title::newFromText maintains a cache to avoid expensive re-normalization of
48 * commonly used titles. On a batch operation this can become a memory leak
49 * if not bounded. After hitting this many titles reset the cache.
50 */
51 const CACHE_MAX = 1000;
52
53 /**
54 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
55 * to use the master DB
56 */
57 const GAID_FOR_UPDATE = 1;
58
59 /**
60 * Flag for use with factory methods like newFromLinkTarget() that have
61 * a $forceClone parameter. If set, the method must return a new instance.
62 * Without this flag, some factory methods may return existing instances.
63 *
64 * @since 1.33
65 */
66 const NEW_CLONE = 'clone';
67
68 /**
69 * @name Private member variables
70 * Please use the accessor functions instead.
71 * @private
72 */
73 // @{
74
75 /** @var string Text form (spaces not underscores) of the main part */
76 public $mTextform = '';
77
78 /** @var string URL-encoded form of the main part */
79 public $mUrlform = '';
80
81 /** @var string Main part with underscores */
82 public $mDbkeyform = '';
83
84 /** @var string Database key with the initial letter in the case specified by the user */
85 protected $mUserCaseDBKey;
86
87 /** @var int Namespace index, i.e. one of the NS_xxxx constants */
88 public $mNamespace = NS_MAIN;
89
90 /** @var string Interwiki prefix */
91 public $mInterwiki = '';
92
93 /** @var bool Was this Title created from a string with a local interwiki prefix? */
94 private $mLocalInterwiki = false;
95
96 /** @var string Title fragment (i.e. the bit after the #) */
97 public $mFragment = '';
98
99 /** @var int Article ID, fetched from the link cache on demand */
100 public $mArticleID = -1;
101
102 /** @var bool|int ID of most recent revision */
103 protected $mLatestID = false;
104
105 /**
106 * @var bool|string ID of the page's content model, i.e. one of the
107 * CONTENT_MODEL_XXX constants
108 */
109 private $mContentModel = false;
110
111 /**
112 * @var bool If a content model was forced via setContentModel()
113 * this will be true to avoid having other code paths reset it
114 */
115 private $mForcedContentModel = false;
116
117 /** @var int Estimated number of revisions; null of not loaded */
118 private $mEstimateRevisions;
119
120 /** @var array Array of groups allowed to edit this article */
121 public $mRestrictions = [];
122
123 /**
124 * @var string|bool Comma-separated set of permission keys
125 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
126 * Edit and move sections are separated by a colon
127 * Example: "edit=autoconfirmed,sysop:move=sysop"
128 */
129 protected $mOldRestrictions = false;
130
131 /** @var bool Cascade restrictions on this page to included templates and images? */
132 public $mCascadeRestriction;
133
134 /** Caching the results of getCascadeProtectionSources */
135 public $mCascadingRestrictions;
136
137 /** @var array When do the restrictions on this page expire? */
138 protected $mRestrictionsExpiry = [];
139
140 /** @var bool Are cascading restrictions in effect on this page? */
141 protected $mHasCascadingRestrictions;
142
143 /** @var array Where are the cascading restrictions coming from on this page? */
144 public $mCascadeSources;
145
146 /** @var bool Boolean for initialisation on demand */
147 public $mRestrictionsLoaded = false;
148
149 /**
150 * Text form including namespace/interwiki, initialised on demand
151 *
152 * Only public to share cache with TitleFormatter
153 *
154 * @private
155 * @var string|null
156 */
157 public $prefixedText = null;
158
159 /** @var mixed Cached value for getTitleProtection (create protection) */
160 public $mTitleProtection;
161
162 /**
163 * @var int Namespace index when there is no namespace. Don't change the
164 * following default, NS_MAIN is hardcoded in several places. See T2696.
165 * Zero except in {{transclusion}} tags.
166 */
167 public $mDefaultNamespace = NS_MAIN;
168
169 /** @var int The page length, 0 for special pages */
170 protected $mLength = -1;
171
172 /** @var null Is the article at this title a redirect? */
173 public $mRedirect = null;
174
175 /** @var array Associative array of user ID -> timestamp/false */
176 private $mNotificationTimestamp = [];
177
178 /** @var bool Whether a page has any subpages */
179 private $mHasSubpages;
180
181 /** @var array|null The (string) language code of the page's language and content code. */
182 private $mPageLanguage;
183
184 /** @var string|bool|null The page language code from the database, null if not saved in
185 * the database or false if not loaded, yet.
186 */
187 private $mDbPageLanguage = false;
188
189 /** @var TitleValue|null A corresponding TitleValue object */
190 private $mTitleValue = null;
191
192 /** @var bool|null Would deleting this page be a big deletion? */
193 private $mIsBigDeletion = null;
194 // @}
195
196 /**
197 * B/C kludge: provide a TitleParser for use by Title.
198 * Ideally, Title would have no methods that need this.
199 * Avoid usage of this singleton by using TitleValue
200 * and the associated services when possible.
201 *
202 * @return TitleFormatter
203 */
204 private static function getTitleFormatter() {
205 return MediaWikiServices::getInstance()->getTitleFormatter();
206 }
207
208 /**
209 * B/C kludge: provide an InterwikiLookup for use by Title.
210 * Ideally, Title would have no methods that need this.
211 * Avoid usage of this singleton by using TitleValue
212 * and the associated services when possible.
213 *
214 * @return InterwikiLookup
215 */
216 private static function getInterwikiLookup() {
217 return MediaWikiServices::getInstance()->getInterwikiLookup();
218 }
219
220 /**
221 * @protected
222 */
223 function __construct() {
224 }
225
226 /**
227 * Create a new Title from a prefixed DB key
228 *
229 * @param string $key The database key, which has underscores
230 * instead of spaces, possibly including namespace and
231 * interwiki prefixes
232 * @return Title|null Title, or null on an error
233 */
234 public static function newFromDBkey( $key ) {
235 $t = new self();
236 $t->mDbkeyform = $key;
237
238 try {
239 $t->secureAndSplit();
240 return $t;
241 } catch ( MalformedTitleException $ex ) {
242 return null;
243 }
244 }
245
246 /**
247 * Returns a Title given a TitleValue.
248 * If the given TitleValue is already a Title instance, that instance is returned,
249 * unless $forceClone is "clone". If $forceClone is "clone" and the given TitleValue
250 * is already a Title instance, that instance is copied using the clone operator.
251 *
252 * @deprecated since 1.34, use newFromLinkTarget or castFromLinkTarget
253 *
254 * @param TitleValue $titleValue Assumed to be safe.
255 * @param string $forceClone set to NEW_CLONE to ensure a fresh instance is returned.
256 *
257 * @return Title
258 */
259 public static function newFromTitleValue( TitleValue $titleValue, $forceClone = '' ) {
260 return self::newFromLinkTarget( $titleValue, $forceClone );
261 }
262
263 /**
264 * Returns a Title given a LinkTarget.
265 * If the given LinkTarget is already a Title instance, that instance is returned,
266 * unless $forceClone is "clone". If $forceClone is "clone" and the given LinkTarget
267 * is already a Title instance, that instance is copied using the clone operator.
268 *
269 * @param LinkTarget $linkTarget Assumed to be safe.
270 * @param string $forceClone set to NEW_CLONE to ensure a fresh instance is returned.
271 *
272 * @return Title
273 */
274 public static function newFromLinkTarget( LinkTarget $linkTarget, $forceClone = '' ) {
275 if ( $linkTarget instanceof Title ) {
276 // Special case if it's already a Title object
277 if ( $forceClone === self::NEW_CLONE ) {
278 return clone $linkTarget;
279 } else {
280 return $linkTarget;
281 }
282 }
283 return self::makeTitle(
284 $linkTarget->getNamespace(),
285 $linkTarget->getText(),
286 $linkTarget->getFragment(),
287 $linkTarget->getInterwiki()
288 );
289 }
290
291 /**
292 * Same as newFromLinkTarget, but if passed null, returns null.
293 *
294 * @param LinkTarget|null $linkTarget Assumed to be safe (if not null).
295 *
296 * @return Title|null
297 */
298 public static function castFromLinkTarget( $linkTarget ) {
299 return $linkTarget ? self::newFromLinkTarget( $linkTarget ) : null;
300 }
301
302 /**
303 * Create a new Title from text, such as what one would find in a link. De-
304 * codes any HTML entities in the text.
305 *
306 * Title objects returned by this method are guaranteed to be valid, and
307 * thus return true from the isValid() method.
308 *
309 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
310 * It may instead be a cached instance created previously, with references to it remaining
311 * elsewhere.
312 *
313 * @param string|int|null $text The link text; spaces, prefixes, and an
314 * initial ':' indicating the main namespace are accepted.
315 * @param int $defaultNamespace The namespace to use if none is specified
316 * by a prefix. If you want to force a specific namespace even if
317 * $text might begin with a namespace prefix, use makeTitle() or
318 * makeTitleSafe().
319 * @throws InvalidArgumentException
320 * @return Title|null Title or null on an error.
321 */
322 public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
323 // DWIM: Integers can be passed in here when page titles are used as array keys.
324 if ( $text !== null && !is_string( $text ) && !is_int( $text ) ) {
325 throw new InvalidArgumentException( '$text must be a string.' );
326 }
327 if ( $text === null ) {
328 return null;
329 }
330
331 try {
332 return self::newFromTextThrow( (string)$text, $defaultNamespace );
333 } catch ( MalformedTitleException $ex ) {
334 return null;
335 }
336 }
337
338 /**
339 * Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,
340 * rather than returning null.
341 *
342 * The exception subclasses encode detailed information about why the title is invalid.
343 *
344 * Title objects returned by this method are guaranteed to be valid, and
345 * thus return true from the isValid() method.
346 *
347 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
348 * It may instead be a cached instance created previously, with references to it remaining
349 * elsewhere.
350 *
351 * @see Title::newFromText
352 *
353 * @since 1.25
354 * @param string $text Title text to check
355 * @param int $defaultNamespace
356 * @throws MalformedTitleException If the title is invalid
357 * @return Title
358 */
359 public static function newFromTextThrow( $text, $defaultNamespace = NS_MAIN ) {
360 if ( is_object( $text ) ) {
361 throw new MWException( '$text must be a string, given an object' );
362 } elseif ( $text === null ) {
363 // Legacy code relies on MalformedTitleException being thrown in this case
364 // (happens when URL with no title in it is parsed). TODO fix
365 throw new MalformedTitleException( 'title-invalid-empty' );
366 }
367
368 $titleCache = self::getTitleCache();
369
370 // Wiki pages often contain multiple links to the same page.
371 // Title normalization and parsing can become expensive on pages with many
372 // links, so we can save a little time by caching them.
373 // In theory these are value objects and won't get changed...
374 if ( $defaultNamespace == NS_MAIN ) {
375 $t = $titleCache->get( $text );
376 if ( $t ) {
377 return $t;
378 }
379 }
380
381 // Convert things like &eacute; &#257; or &#x3017; into normalized (T16952) text
382 $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text );
383
384 $t = new Title();
385 $t->mDbkeyform = strtr( $filteredText, ' ', '_' );
386 $t->mDefaultNamespace = (int)$defaultNamespace;
387
388 $t->secureAndSplit();
389 if ( $defaultNamespace == NS_MAIN ) {
390 $titleCache->set( $text, $t );
391 }
392 return $t;
393 }
394
395 /**
396 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
397 *
398 * Example of wrong and broken code:
399 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
400 *
401 * Example of right code:
402 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
403 *
404 * Create a new Title from URL-encoded text. Ensures that
405 * the given title's length does not exceed the maximum.
406 *
407 * @param string $url The title, as might be taken from a URL
408 * @return Title|null The new object, or null on an error
409 */
410 public static function newFromURL( $url ) {
411 $t = new Title();
412
413 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
414 # but some URLs used it as a space replacement and they still come
415 # from some external search tools.
416 if ( strpos( self::legalChars(), '+' ) === false ) {
417 $url = strtr( $url, '+', ' ' );
418 }
419
420 $t->mDbkeyform = strtr( $url, ' ', '_' );
421
422 try {
423 $t->secureAndSplit();
424 return $t;
425 } catch ( MalformedTitleException $ex ) {
426 return null;
427 }
428 }
429
430 /**
431 * @return MapCacheLRU
432 */
433 private static function getTitleCache() {
434 if ( self::$titleCache === null ) {
435 self::$titleCache = new MapCacheLRU( self::CACHE_MAX );
436 }
437 return self::$titleCache;
438 }
439
440 /**
441 * Returns a list of fields that are to be selected for initializing Title
442 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
443 * whether to include page_content_model.
444 *
445 * @return array
446 */
447 protected static function getSelectFields() {
448 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
449
450 $fields = [
451 'page_namespace', 'page_title', 'page_id',
452 'page_len', 'page_is_redirect', 'page_latest',
453 ];
454
455 if ( $wgContentHandlerUseDB ) {
456 $fields[] = 'page_content_model';
457 }
458
459 if ( $wgPageLanguageUseDB ) {
460 $fields[] = 'page_lang';
461 }
462
463 return $fields;
464 }
465
466 /**
467 * Create a new Title from an article ID
468 *
469 * @param int $id The page_id corresponding to the Title to create
470 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
471 * @return Title|null The new object, or null on an error
472 */
473 public static function newFromID( $id, $flags = 0 ) {
474 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_REPLICA );
475 $row = $db->selectRow(
476 'page',
477 self::getSelectFields(),
478 [ 'page_id' => $id ],
479 __METHOD__
480 );
481 if ( $row !== false ) {
482 $title = self::newFromRow( $row );
483 } else {
484 $title = null;
485 }
486
487 return $title;
488 }
489
490 /**
491 * Make an array of titles from an array of IDs
492 *
493 * @param int[] $ids Array of IDs
494 * @return Title[] Array of Titles
495 */
496 public static function newFromIDs( $ids ) {
497 if ( !count( $ids ) ) {
498 return [];
499 }
500 $dbr = wfGetDB( DB_REPLICA );
501
502 $res = $dbr->select(
503 'page',
504 self::getSelectFields(),
505 [ 'page_id' => $ids ],
506 __METHOD__
507 );
508
509 $titles = [];
510 foreach ( $res as $row ) {
511 $titles[] = self::newFromRow( $row );
512 }
513 return $titles;
514 }
515
516 /**
517 * Make a Title object from a DB row
518 *
519 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
520 * @return Title Corresponding Title
521 */
522 public static function newFromRow( $row ) {
523 $t = self::makeTitle( $row->page_namespace, $row->page_title );
524 $t->loadFromRow( $row );
525 return $t;
526 }
527
528 /**
529 * Load Title object fields from a DB row.
530 * If false is given, the title will be treated as non-existing.
531 *
532 * @param stdClass|bool $row Database row
533 */
534 public function loadFromRow( $row ) {
535 if ( $row ) { // page found
536 if ( isset( $row->page_id ) ) {
537 $this->mArticleID = (int)$row->page_id;
538 }
539 if ( isset( $row->page_len ) ) {
540 $this->mLength = (int)$row->page_len;
541 }
542 if ( isset( $row->page_is_redirect ) ) {
543 $this->mRedirect = (bool)$row->page_is_redirect;
544 }
545 if ( isset( $row->page_latest ) ) {
546 $this->mLatestID = (int)$row->page_latest;
547 }
548 if ( !$this->mForcedContentModel && isset( $row->page_content_model ) ) {
549 $this->mContentModel = (string)$row->page_content_model;
550 } elseif ( !$this->mForcedContentModel ) {
551 $this->mContentModel = false; # initialized lazily in getContentModel()
552 }
553 if ( isset( $row->page_lang ) ) {
554 $this->mDbPageLanguage = (string)$row->page_lang;
555 }
556 if ( isset( $row->page_restrictions ) ) {
557 $this->mOldRestrictions = $row->page_restrictions;
558 }
559 } else { // page not found
560 $this->mArticleID = 0;
561 $this->mLength = 0;
562 $this->mRedirect = false;
563 $this->mLatestID = 0;
564 if ( !$this->mForcedContentModel ) {
565 $this->mContentModel = false; # initialized lazily in getContentModel()
566 }
567 }
568 }
569
570 /**
571 * Create a new Title from a namespace index and a DB key.
572 *
573 * It's assumed that $ns and $title are safe, for instance when
574 * they came directly from the database or a special page name,
575 * not from user input.
576 *
577 * No validation is applied. For convenience, spaces are normalized
578 * to underscores, so that e.g. user_text fields can be used directly.
579 *
580 * @note This method may return Title objects that are "invalid"
581 * according to the isValid() method. This is usually caused by
582 * configuration changes: e.g. a namespace that was once defined is
583 * no longer configured, or a character that was once allowed in
584 * titles is now forbidden.
585 *
586 * @param int $ns The namespace of the article
587 * @param string $title The unprefixed database key form
588 * @param string $fragment The link fragment (after the "#")
589 * @param string $interwiki The interwiki prefix
590 * @return Title The new object
591 */
592 public static function makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
593 $t = new Title();
594 $t->mInterwiki = $interwiki;
595 $t->mFragment = $fragment;
596 $t->mNamespace = $ns = (int)$ns;
597 $t->mDbkeyform = strtr( $title, ' ', '_' );
598 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
599 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
600 $t->mTextform = strtr( $title, '_', ' ' );
601 $t->mContentModel = false; # initialized lazily in getContentModel()
602 return $t;
603 }
604
605 /**
606 * Create a new Title from a namespace index and a DB key.
607 * The parameters will be checked for validity, which is a bit slower
608 * than makeTitle() but safer for user-provided data.
609 *
610 * Title objects returned by makeTitleSafe() are guaranteed to be valid,
611 * that is, they return true from the isValid() method. If no valid Title
612 * can be constructed from the input, this method returns null.
613 *
614 * @param int $ns The namespace of the article
615 * @param string $title Database key form
616 * @param string $fragment The link fragment (after the "#")
617 * @param string $interwiki Interwiki prefix
618 * @return Title|null The new object, or null on an error
619 */
620 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
621 // NOTE: ideally, this would just call makeTitle() and then isValid(),
622 // but presently, that means more overhead on a potential performance hotspot.
623
624 if ( !MediaWikiServices::getInstance()->getNamespaceInfo()->exists( $ns ) ) {
625 return null;
626 }
627
628 $t = new Title();
629 $t->mDbkeyform = self::makeName( $ns, $title, $fragment, $interwiki, true );
630
631 try {
632 $t->secureAndSplit();
633 return $t;
634 } catch ( MalformedTitleException $ex ) {
635 return null;
636 }
637 }
638
639 /**
640 * Create a new Title for the Main Page
641 *
642 * This uses the 'mainpage' interface message, which could be specified in
643 * `$wgForceUIMsgAsContentMsg`. If that is the case, then calling this method
644 * will use the user language, which would involve initialising the session
645 * via `RequestContext::getMain()->getLanguage()`. For session-less endpoints,
646 * be sure to pass in a MessageLocalizer (such as your own RequestContext,
647 * or ResourceloaderContext) to prevent an error.
648 *
649 * @note The Title instance returned by this method is not guaranteed to be a fresh instance.
650 * It may instead be a cached instance created previously, with references to it remaining
651 * elsewhere.
652 *
653 * @param MessageLocalizer|null $localizer An optional context to use (since 1.34)
654 * @return Title
655 */
656 public static function newMainPage( MessageLocalizer $localizer = null ) {
657 if ( $localizer ) {
658 $msg = $localizer->msg( 'mainpage' );
659 } else {
660 $msg = wfMessage( 'mainpage' );
661 }
662
663 $title = self::newFromText( $msg->inContentLanguage()->text() );
664
665 // Every page renders at least one link to the Main Page (e.g. sidebar).
666 // If the localised value is invalid, don't produce fatal errors that
667 // would make the wiki inaccessible (and hard to fix the invalid message).
668 // Gracefully fallback...
669 if ( !$title ) {
670 $title = self::newFromText( 'Main Page' );
671 }
672 return $title;
673 }
674
675 /**
676 * Get the prefixed DB key associated with an ID
677 *
678 * @param int $id The page_id of the article
679 * @return Title|null An object representing the article, or null if no such article was found
680 */
681 public static function nameOf( $id ) {
682 $dbr = wfGetDB( DB_REPLICA );
683
684 $s = $dbr->selectRow(
685 'page',
686 [ 'page_namespace', 'page_title' ],
687 [ 'page_id' => $id ],
688 __METHOD__
689 );
690 if ( $s === false ) {
691 return null;
692 }
693
694 $n = self::makeName( $s->page_namespace, $s->page_title );
695 return $n;
696 }
697
698 /**
699 * Get a regex character class describing the legal characters in a link
700 *
701 * @return string The list of characters, not delimited
702 */
703 public static function legalChars() {
704 global $wgLegalTitleChars;
705 return $wgLegalTitleChars;
706 }
707
708 /**
709 * Utility method for converting a character sequence from bytes to Unicode.
710 *
711 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
712 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
713 *
714 * @param string $byteClass
715 * @return string
716 */
717 public static function convertByteClassToUnicodeClass( $byteClass ) {
718 $length = strlen( $byteClass );
719 // Input token queue
720 $x0 = $x1 = $x2 = '';
721 // Decoded queue
722 $d0 = $d1 = $d2 = '';
723 // Decoded integer codepoints
724 $ord0 = $ord1 = $ord2 = 0;
725 // Re-encoded queue
726 $r0 = $r1 = $r2 = '';
727 // Output
728 $out = '';
729 // Flags
730 $allowUnicode = false;
731 for ( $pos = 0; $pos < $length; $pos++ ) {
732 // Shift the queues down
733 $x2 = $x1;
734 $x1 = $x0;
735 $d2 = $d1;
736 $d1 = $d0;
737 $ord2 = $ord1;
738 $ord1 = $ord0;
739 $r2 = $r1;
740 $r1 = $r0;
741 // Load the current input token and decoded values
742 $inChar = $byteClass[$pos];
743 if ( $inChar == '\\' ) {
744 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos + 1 ) ) {
745 $x0 = $inChar . $m[0];
746 $d0 = chr( hexdec( $m[1] ) );
747 $pos += strlen( $m[0] );
748 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos + 1 ) ) {
749 $x0 = $inChar . $m[0];
750 $d0 = chr( octdec( $m[0] ) );
751 $pos += strlen( $m[0] );
752 } elseif ( $pos + 1 >= $length ) {
753 $x0 = $d0 = '\\';
754 } else {
755 $d0 = $byteClass[$pos + 1];
756 $x0 = $inChar . $d0;
757 $pos += 1;
758 }
759 } else {
760 $x0 = $d0 = $inChar;
761 }
762 $ord0 = ord( $d0 );
763 // Load the current re-encoded value
764 if ( $ord0 < 32 || $ord0 == 0x7f ) {
765 $r0 = sprintf( '\x%02x', $ord0 );
766 } elseif ( $ord0 >= 0x80 ) {
767 // Allow unicode if a single high-bit character appears
768 $r0 = sprintf( '\x%02x', $ord0 );
769 $allowUnicode = true;
770 // @phan-suppress-next-line PhanParamSuspiciousOrder false positive
771 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
772 $r0 = '\\' . $d0;
773 } else {
774 $r0 = $d0;
775 }
776 // Do the output
777 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
778 // Range
779 if ( $ord2 > $ord0 ) {
780 // Empty range
781 } elseif ( $ord0 >= 0x80 ) {
782 // Unicode range
783 $allowUnicode = true;
784 if ( $ord2 < 0x80 ) {
785 // Keep the non-unicode section of the range
786 $out .= "$r2-\\x7F";
787 }
788 } else {
789 // Normal range
790 $out .= "$r2-$r0";
791 }
792 // Reset state to the initial value
793 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
794 } elseif ( $ord2 < 0x80 ) {
795 // ASCII character
796 $out .= $r2;
797 }
798 }
799 if ( $ord1 < 0x80 ) {
800 $out .= $r1;
801 }
802 if ( $ord0 < 0x80 ) {
803 $out .= $r0;
804 }
805 if ( $allowUnicode ) {
806 $out .= '\u0080-\uFFFF';
807 }
808 return $out;
809 }
810
811 /**
812 * Make a prefixed DB key from a DB key and a namespace index
813 *
814 * @param int $ns Numerical representation of the namespace
815 * @param string $title The DB key form the title
816 * @param string $fragment The link fragment (after the "#")
817 * @param string $interwiki The interwiki prefix
818 * @param bool $canonicalNamespace If true, use the canonical name for
819 * $ns instead of the localized version.
820 * @return string The prefixed form of the title
821 */
822 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
823 $canonicalNamespace = false
824 ) {
825 if ( $canonicalNamespace ) {
826 $namespace = MediaWikiServices::getInstance()->getNamespaceInfo()->
827 getCanonicalName( $ns );
828 } else {
829 $namespace = MediaWikiServices::getInstance()->getContentLanguage()->getNsText( $ns );
830 }
831 $name = $namespace == '' ? $title : "$namespace:$title";
832 if ( strval( $interwiki ) != '' ) {
833 $name = "$interwiki:$name";
834 }
835 if ( strval( $fragment ) != '' ) {
836 $name .= '#' . $fragment;
837 }
838 return $name;
839 }
840
841 /**
842 * Callback for usort() to do title sorts by (namespace, title)
843 *
844 * @param LinkTarget $a
845 * @param LinkTarget $b
846 *
847 * @return int Result of string comparison, or namespace comparison
848 */
849 public static function compare( LinkTarget $a, LinkTarget $b ) {
850 return $a->getNamespace() <=> $b->getNamespace()
851 ?: strcmp( $a->getText(), $b->getText() );
852 }
853
854 /**
855 * Returns true if the title is valid, false if it is invalid.
856 *
857 * Valid titles can be round-tripped via makeTitle() and newFromText().
858 * Their DB key can be used in the database, though it may not have the correct
859 * capitalization.
860 *
861 * Invalid titles may get returned from makeTitle(), and it may be useful to
862 * allow them to exist, e.g. in order to process log entries about pages in
863 * namespaces that belong to extensions that are no longer installed.
864 *
865 * @note This method is relatively expensive. When constructing Title
866 * objects that need to be valid, use an instantiator method that is guaranteed
867 * to return valid titles, such as makeTitleSafe() or newFromText().
868 *
869 * @return bool
870 */
871 public function isValid() {
872 $services = MediaWikiServices::getInstance();
873 if ( !$services->getNamespaceInfo()->exists( $this->mNamespace ) ) {
874 return false;
875 }
876
877 try {
878 $services->getTitleParser()->parseTitle( $this->mDbkeyform, $this->mNamespace );
879 } catch ( MalformedTitleException $ex ) {
880 return false;
881 }
882
883 try {
884 // Title value applies basic syntax checks. Should perhaps be moved elsewhere.
885 new TitleValue(
886 $this->mNamespace,
887 $this->mDbkeyform,
888 $this->mFragment,
889 $this->mInterwiki
890 );
891 } catch ( InvalidArgumentException $ex ) {
892 return false;
893 }
894
895 return true;
896 }
897
898 /**
899 * Determine whether the object refers to a page within
900 * this project (either this wiki or a wiki with a local
901 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
902 *
903 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
904 */
905 public function isLocal() {
906 if ( $this->isExternal() ) {
907 $iw = self::getInterwikiLookup()->fetch( $this->mInterwiki );
908 if ( $iw ) {
909 return $iw->isLocal();
910 }
911 }
912 return true;
913 }
914
915 /**
916 * Is this Title interwiki?
917 *
918 * @return bool
919 */
920 public function isExternal() {
921 return $this->mInterwiki !== '';
922 }
923
924 /**
925 * Get the interwiki prefix
926 *
927 * Use Title::isExternal to check if a interwiki is set
928 *
929 * @return string Interwiki prefix
930 */
931 public function getInterwiki() {
932 return $this->mInterwiki;
933 }
934
935 /**
936 * Was this a local interwiki link?
937 *
938 * @return bool
939 */
940 public function wasLocalInterwiki() {
941 return $this->mLocalInterwiki;
942 }
943
944 /**
945 * Determine whether the object refers to a page within
946 * this project and is transcludable.
947 *
948 * @return bool True if this is transcludable
949 */
950 public function isTrans() {
951 if ( !$this->isExternal() ) {
952 return false;
953 }
954
955 return self::getInterwikiLookup()->fetch( $this->mInterwiki )->isTranscludable();
956 }
957
958 /**
959 * Returns the DB name of the distant wiki which owns the object.
960 *
961 * @return string|false The DB name
962 */
963 public function getTransWikiID() {
964 if ( !$this->isExternal() ) {
965 return false;
966 }
967
968 return self::getInterwikiLookup()->fetch( $this->mInterwiki )->getWikiID();
969 }
970
971 /**
972 * Get a TitleValue object representing this Title.
973 *
974 * @note Not all valid Titles have a corresponding valid TitleValue
975 * (e.g. TitleValues cannot represent page-local links that have a
976 * fragment but no title text).
977 *
978 * @return TitleValue|null
979 */
980 public function getTitleValue() {
981 if ( $this->mTitleValue === null ) {
982 try {
983 $this->mTitleValue = new TitleValue(
984 $this->mNamespace,
985 $this->mDbkeyform,
986 $this->mFragment,
987 $this->mInterwiki
988 );
989 } catch ( InvalidArgumentException $ex ) {
990 wfDebug( __METHOD__ . ': Can\'t create a TitleValue for [[' .
991 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
992 }
993 }
994
995 return $this->mTitleValue;
996 }
997
998 /**
999 * Get the text form (spaces not underscores) of the main part
1000 *
1001 * @return string Main part of the title
1002 */
1003 public function getText() {
1004 return $this->mTextform;
1005 }
1006
1007 /**
1008 * Get the URL-encoded form of the main part
1009 *
1010 * @return string Main part of the title, URL-encoded
1011 */
1012 public function getPartialURL() {
1013 return $this->mUrlform;
1014 }
1015
1016 /**
1017 * Get the main part with underscores
1018 *
1019 * @return string Main part of the title, with underscores
1020 */
1021 public function getDBkey() {
1022 return $this->mDbkeyform;
1023 }
1024
1025 /**
1026 * Get the DB key with the initial letter case as specified by the user
1027 * @deprecated since 1.33; please use Title::getDBKey() instead
1028 *
1029 * @return string DB key
1030 */
1031 function getUserCaseDBKey() {
1032 if ( !is_null( $this->mUserCaseDBKey ) ) {
1033 return $this->mUserCaseDBKey;
1034 } else {
1035 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
1036 return $this->mDbkeyform;
1037 }
1038 }
1039
1040 /**
1041 * Get the namespace index, i.e. one of the NS_xxxx constants.
1042 *
1043 * @return int Namespace index
1044 */
1045 public function getNamespace() {
1046 return $this->mNamespace;
1047 }
1048
1049 /**
1050 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
1051 *
1052 * @todo Deprecate this in favor of SlotRecord::getModel()
1053 *
1054 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
1055 * @return string Content model id
1056 */
1057 public function getContentModel( $flags = 0 ) {
1058 if ( !$this->mForcedContentModel
1059 && ( !$this->mContentModel || $flags === self::GAID_FOR_UPDATE )
1060 && $this->getArticleID( $flags )
1061 ) {
1062 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
1063 $linkCache->addLinkObj( $this ); # in case we already had an article ID
1064 $this->mContentModel = $linkCache->getGoodLinkFieldObj( $this, 'model' );
1065 }
1066
1067 if ( !$this->mContentModel ) {
1068 $this->mContentModel = ContentHandler::getDefaultModelFor( $this );
1069 }
1070
1071 return $this->mContentModel;
1072 }
1073
1074 /**
1075 * Convenience method for checking a title's content model name
1076 *
1077 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
1078 * @return bool True if $this->getContentModel() == $id
1079 */
1080 public function hasContentModel( $id ) {
1081 return $this->getContentModel() == $id;
1082 }
1083
1084 /**
1085 * Set a proposed content model for the page for permissions
1086 * checking. This does not actually change the content model
1087 * of a title!
1088 *
1089 * Additionally, you should make sure you've checked
1090 * ContentHandler::canBeUsedOn() first.
1091 *
1092 * @since 1.28
1093 * @param string $model CONTENT_MODEL_XXX constant
1094 */
1095 public function setContentModel( $model ) {
1096 $this->mContentModel = $model;
1097 $this->mForcedContentModel = true;
1098 }
1099
1100 /**
1101 * Get the namespace text
1102 *
1103 * @return string|false Namespace text
1104 */
1105 public function getNsText() {
1106 if ( $this->isExternal() ) {
1107 // This probably shouldn't even happen, except for interwiki transclusion.
1108 // If possible, use the canonical name for the foreign namespace.
1109 $nsText = MediaWikiServices::getInstance()->getNamespaceInfo()->
1110 getCanonicalName( $this->mNamespace );
1111 if ( $nsText !== false ) {
1112 return $nsText;
1113 }
1114 }
1115
1116 try {
1117 $formatter = self::getTitleFormatter();
1118 return $formatter->getNamespaceName( $this->mNamespace, $this->mDbkeyform );
1119 } catch ( InvalidArgumentException $ex ) {
1120 wfDebug( __METHOD__ . ': ' . $ex->getMessage() . "\n" );
1121 return false;
1122 }
1123 }
1124
1125 /**
1126 * Get the namespace text of the subject (rather than talk) page
1127 *
1128 * @return string Namespace text
1129 */
1130 public function getSubjectNsText() {
1131 $services = MediaWikiServices::getInstance();
1132 return $services->getContentLanguage()->
1133 getNsText( $services->getNamespaceInfo()->getSubject( $this->mNamespace ) );
1134 }
1135
1136 /**
1137 * Get the namespace text of the talk page
1138 *
1139 * @return string Namespace text
1140 */
1141 public function getTalkNsText() {
1142 $services = MediaWikiServices::getInstance();
1143 return $services->getContentLanguage()->
1144 getNsText( $services->getNamespaceInfo()->getTalk( $this->mNamespace ) );
1145 }
1146
1147 /**
1148 * Can this title have a corresponding talk page?
1149 *
1150 * False for relative section links (with getText() === ''),
1151 * interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.
1152 *
1153 * @see NamespaceInfo::canHaveTalkPage
1154 * @since 1.30
1155 *
1156 * @return bool True if this title either is a talk page or can have a talk page associated.
1157 */
1158 public function canHaveTalkPage() {
1159 return MediaWikiServices::getInstance()->getNamespaceInfo()->canHaveTalkPage( $this );
1160 }
1161
1162 /**
1163 * Is this in a namespace that allows actual pages?
1164 *
1165 * @return bool
1166 */
1167 public function canExist() {
1168 return $this->mNamespace >= NS_MAIN;
1169 }
1170
1171 /**
1172 * Can this title be added to a user's watchlist?
1173 *
1174 * False for relative section links (with getText() === ''),
1175 * interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.
1176 *
1177 * @return bool
1178 */
1179 public function isWatchable() {
1180 $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
1181 return $this->getText() !== '' && !$this->isExternal() &&
1182 $nsInfo->isWatchable( $this->mNamespace );
1183 }
1184
1185 /**
1186 * Returns true if this is a special page.
1187 *
1188 * @return bool
1189 */
1190 public function isSpecialPage() {
1191 return $this->mNamespace == NS_SPECIAL;
1192 }
1193
1194 /**
1195 * Returns true if this title resolves to the named special page
1196 *
1197 * @param string $name The special page name
1198 * @return bool
1199 */
1200 public function isSpecial( $name ) {
1201 if ( $this->isSpecialPage() ) {
1202 list( $thisName, /* $subpage */ ) =
1203 MediaWikiServices::getInstance()->getSpecialPageFactory()->
1204 resolveAlias( $this->mDbkeyform );
1205 if ( $name == $thisName ) {
1206 return true;
1207 }
1208 }
1209 return false;
1210 }
1211
1212 /**
1213 * If the Title refers to a special page alias which is not the local default, resolve
1214 * the alias, and localise the name as necessary. Otherwise, return $this
1215 *
1216 * @return Title
1217 */
1218 public function fixSpecialName() {
1219 if ( $this->isSpecialPage() ) {
1220 $spFactory = MediaWikiServices::getInstance()->getSpecialPageFactory();
1221 list( $canonicalName, $par ) = $spFactory->resolveAlias( $this->mDbkeyform );
1222 if ( $canonicalName ) {
1223 $localName = $spFactory->getLocalNameFor( $canonicalName, $par );
1224 if ( $localName != $this->mDbkeyform ) {
1225 return self::makeTitle( NS_SPECIAL, $localName );
1226 }
1227 }
1228 }
1229 return $this;
1230 }
1231
1232 /**
1233 * Returns true if the title is inside the specified namespace.
1234 *
1235 * Please make use of this instead of comparing to getNamespace()
1236 * This function is much more resistant to changes we may make
1237 * to namespaces than code that makes direct comparisons.
1238 * @param int $ns The namespace
1239 * @return bool
1240 * @since 1.19
1241 */
1242 public function inNamespace( $ns ) {
1243 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1244 equals( $this->mNamespace, $ns );
1245 }
1246
1247 /**
1248 * Returns true if the title is inside one of the specified namespaces.
1249 *
1250 * @param int|int[] $namespaces,... The namespaces to check for
1251 * @return bool
1252 * @since 1.19
1253 * @suppress PhanCommentParamOnEmptyParamList Cannot make variadic due to HHVM bug, T191668#5263929
1254 */
1255 public function inNamespaces( /* ... */ ) {
1256 $namespaces = func_get_args();
1257 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1258 $namespaces = $namespaces[0];
1259 }
1260
1261 foreach ( $namespaces as $ns ) {
1262 if ( $this->inNamespace( $ns ) ) {
1263 return true;
1264 }
1265 }
1266
1267 return false;
1268 }
1269
1270 /**
1271 * Returns true if the title has the same subject namespace as the
1272 * namespace specified.
1273 * For example this method will take NS_USER and return true if namespace
1274 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1275 * as their subject namespace.
1276 *
1277 * This is MUCH simpler than individually testing for equivalence
1278 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1279 * @since 1.19
1280 * @param int $ns
1281 * @return bool
1282 */
1283 public function hasSubjectNamespace( $ns ) {
1284 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1285 subjectEquals( $this->mNamespace, $ns );
1286 }
1287
1288 /**
1289 * Is this Title in a namespace which contains content?
1290 * In other words, is this a content page, for the purposes of calculating
1291 * statistics, etc?
1292 *
1293 * @return bool
1294 */
1295 public function isContentPage() {
1296 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1297 isContent( $this->mNamespace );
1298 }
1299
1300 /**
1301 * Would anybody with sufficient privileges be able to move this page?
1302 * Some pages just aren't movable.
1303 *
1304 * @return bool
1305 */
1306 public function isMovable() {
1307 if (
1308 !MediaWikiServices::getInstance()->getNamespaceInfo()->
1309 isMovable( $this->mNamespace ) || $this->isExternal()
1310 ) {
1311 // Interwiki title or immovable namespace. Hooks don't get to override here
1312 return false;
1313 }
1314
1315 $result = true;
1316 Hooks::run( 'TitleIsMovable', [ $this, &$result ] );
1317 return $result;
1318 }
1319
1320 /**
1321 * Is this the mainpage?
1322 * @note Title::newFromText seems to be sufficiently optimized by the title
1323 * cache that we don't need to over-optimize by doing direct comparisons and
1324 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1325 * ends up reporting something differently than $title->isMainPage();
1326 *
1327 * @since 1.18
1328 * @return bool
1329 */
1330 public function isMainPage() {
1331 return $this->equals( self::newMainPage() );
1332 }
1333
1334 /**
1335 * Is this a subpage?
1336 *
1337 * @return bool
1338 */
1339 public function isSubpage() {
1340 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1341 hasSubpages( $this->mNamespace )
1342 ? strpos( $this->getText(), '/' ) !== false
1343 : false;
1344 }
1345
1346 /**
1347 * Is this a conversion table for the LanguageConverter?
1348 *
1349 * @return bool
1350 */
1351 public function isConversionTable() {
1352 // @todo ConversionTable should become a separate content model.
1353
1354 return $this->mNamespace == NS_MEDIAWIKI &&
1355 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1356 }
1357
1358 /**
1359 * Does that page contain wikitext, or it is JS, CSS or whatever?
1360 *
1361 * @return bool
1362 */
1363 public function isWikitextPage() {
1364 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT );
1365 }
1366
1367 /**
1368 * Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the
1369 * global UI. This is generally true for pages in the MediaWiki namespace having
1370 * CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
1371 *
1372 * This method does *not* return true for per-user JS/JSON/CSS. Use isUserConfigPage()
1373 * for that!
1374 *
1375 * Note that this method should not return true for pages that contain and show
1376 * "inactive" CSS, JSON, or JS.
1377 *
1378 * @return bool
1379 * @since 1.31
1380 */
1381 public function isSiteConfigPage() {
1382 return (
1383 $this->isSiteCssConfigPage()
1384 || $this->isSiteJsonConfigPage()
1385 || $this->isSiteJsConfigPage()
1386 );
1387 }
1388
1389 /**
1390 * Is this a "config" (.css, .json, or .js) sub-page of a user page?
1391 *
1392 * @return bool
1393 * @since 1.31
1394 */
1395 public function isUserConfigPage() {
1396 return (
1397 $this->isUserCssConfigPage()
1398 || $this->isUserJsonConfigPage()
1399 || $this->isUserJsConfigPage()
1400 );
1401 }
1402
1403 /**
1404 * Trim down a .css, .json, or .js subpage title to get the corresponding skin name
1405 *
1406 * @return string Containing skin name from .css, .json, or .js subpage title
1407 * @since 1.31
1408 */
1409 public function getSkinFromConfigSubpage() {
1410 $subpage = explode( '/', $this->mTextform );
1411 $subpage = $subpage[count( $subpage ) - 1];
1412 $lastdot = strrpos( $subpage, '.' );
1413 if ( $lastdot === false ) {
1414 return $subpage; # Never happens: only called for names ending in '.css'/'.json'/'.js'
1415 }
1416 return substr( $subpage, 0, $lastdot );
1417 }
1418
1419 /**
1420 * Is this a CSS "config" sub-page of a user page?
1421 *
1422 * @return bool
1423 * @since 1.31
1424 */
1425 public function isUserCssConfigPage() {
1426 return (
1427 NS_USER == $this->mNamespace
1428 && $this->isSubpage()
1429 && $this->hasContentModel( CONTENT_MODEL_CSS )
1430 );
1431 }
1432
1433 /**
1434 * Is this a JSON "config" sub-page of a user page?
1435 *
1436 * @return bool
1437 * @since 1.31
1438 */
1439 public function isUserJsonConfigPage() {
1440 return (
1441 NS_USER == $this->mNamespace
1442 && $this->isSubpage()
1443 && $this->hasContentModel( CONTENT_MODEL_JSON )
1444 );
1445 }
1446
1447 /**
1448 * Is this a JS "config" sub-page of a user page?
1449 *
1450 * @return bool
1451 * @since 1.31
1452 */
1453 public function isUserJsConfigPage() {
1454 return (
1455 NS_USER == $this->mNamespace
1456 && $this->isSubpage()
1457 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT )
1458 );
1459 }
1460
1461 /**
1462 * Is this a sitewide CSS "config" page?
1463 *
1464 * @return bool
1465 * @since 1.32
1466 */
1467 public function isSiteCssConfigPage() {
1468 return (
1469 NS_MEDIAWIKI == $this->mNamespace
1470 && (
1471 $this->hasContentModel( CONTENT_MODEL_CSS )
1472 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1473 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1474 || substr( $this->mDbkeyform, -4 ) === '.css'
1475 )
1476 );
1477 }
1478
1479 /**
1480 * Is this a sitewide JSON "config" page?
1481 *
1482 * @return bool
1483 * @since 1.32
1484 */
1485 public function isSiteJsonConfigPage() {
1486 return (
1487 NS_MEDIAWIKI == $this->mNamespace
1488 && (
1489 $this->hasContentModel( CONTENT_MODEL_JSON )
1490 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1491 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1492 || substr( $this->mDbkeyform, -5 ) === '.json'
1493 )
1494 );
1495 }
1496
1497 /**
1498 * Is this a sitewide JS "config" page?
1499 *
1500 * @return bool
1501 * @since 1.31
1502 */
1503 public function isSiteJsConfigPage() {
1504 return (
1505 NS_MEDIAWIKI == $this->mNamespace
1506 && (
1507 $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT )
1508 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1509 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1510 || substr( $this->mDbkeyform, -3 ) === '.js'
1511 )
1512 );
1513 }
1514
1515 /**
1516 * Is this a message which can contain raw HTML?
1517 *
1518 * @return bool
1519 * @since 1.32
1520 */
1521 public function isRawHtmlMessage() {
1522 global $wgRawHtmlMessages;
1523
1524 if ( !$this->inNamespace( NS_MEDIAWIKI ) ) {
1525 return false;
1526 }
1527 $message = lcfirst( $this->getRootTitle()->getDBkey() );
1528 return in_array( $message, $wgRawHtmlMessages, true );
1529 }
1530
1531 /**
1532 * Is this a talk page of some sort?
1533 *
1534 * @return bool
1535 */
1536 public function isTalkPage() {
1537 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1538 isTalk( $this->mNamespace );
1539 }
1540
1541 /**
1542 * Get a Title object associated with the talk page of this article
1543 *
1544 * @deprecated since 1.34, use getTalkPageIfDefined() or NamespaceInfo::getTalkPage()
1545 * with NamespaceInfo::canHaveTalkPage().
1546 * @return Title The object for the talk page
1547 * @throws MWException if $target doesn't have talk pages, e.g. because it's in NS_SPECIAL
1548 * or because it's a relative link, or an interwiki link.
1549 */
1550 public function getTalkPage() {
1551 return self::castFromLinkTarget(
1552 MediaWikiServices::getInstance()->getNamespaceInfo()->getTalkPage( $this ) );
1553 }
1554
1555 /**
1556 * Get a Title object associated with the talk page of this article,
1557 * if such a talk page can exist.
1558 *
1559 * @since 1.30
1560 *
1561 * @return Title|null The object for the talk page,
1562 * or null if no associated talk page can exist, according to canHaveTalkPage().
1563 */
1564 public function getTalkPageIfDefined() {
1565 if ( !$this->canHaveTalkPage() ) {
1566 return null;
1567 }
1568
1569 return $this->getTalkPage();
1570 }
1571
1572 /**
1573 * Get a title object associated with the subject page of this
1574 * talk page
1575 *
1576 * @deprecated since 1.34, use NamespaceInfo::getSubjectPage
1577 * @return Title The object for the subject page
1578 */
1579 public function getSubjectPage() {
1580 return self::castFromLinkTarget(
1581 MediaWikiServices::getInstance()->getNamespaceInfo()->getSubjectPage( $this ) );
1582 }
1583
1584 /**
1585 * Get the other title for this page, if this is a subject page
1586 * get the talk page, if it is a subject page get the talk page
1587 *
1588 * @deprecated since 1.34, use NamespaceInfo::getAssociatedPage
1589 * @since 1.25
1590 * @throws MWException If the page doesn't have an other page
1591 * @return Title
1592 */
1593 public function getOtherPage() {
1594 return self::castFromLinkTarget(
1595 MediaWikiServices::getInstance()->getNamespaceInfo()->getAssociatedPage( $this ) );
1596 }
1597
1598 /**
1599 * Get the default namespace index, for when there is no namespace
1600 *
1601 * @return int Default namespace index
1602 */
1603 public function getDefaultNamespace() {
1604 return $this->mDefaultNamespace;
1605 }
1606
1607 /**
1608 * Get the Title fragment (i.e.\ the bit after the #) in text form
1609 *
1610 * Use Title::hasFragment to check for a fragment
1611 *
1612 * @return string Title fragment
1613 */
1614 public function getFragment() {
1615 return $this->mFragment;
1616 }
1617
1618 /**
1619 * Check if a Title fragment is set
1620 *
1621 * @return bool
1622 * @since 1.23
1623 */
1624 public function hasFragment() {
1625 return $this->mFragment !== '';
1626 }
1627
1628 /**
1629 * Get the fragment in URL form, including the "#" character if there is one
1630 *
1631 * @return string Fragment in URL form
1632 */
1633 public function getFragmentForURL() {
1634 if ( !$this->hasFragment() ) {
1635 return '';
1636 } elseif ( $this->isExternal() ) {
1637 // Note: If the interwiki is unknown, it's treated as a namespace on the local wiki,
1638 // so we treat it like a local interwiki.
1639 $interwiki = self::getInterwikiLookup()->fetch( $this->mInterwiki );
1640 if ( $interwiki && !$interwiki->isLocal() ) {
1641 return '#' . Sanitizer::escapeIdForExternalInterwiki( $this->mFragment );
1642 }
1643 }
1644
1645 return '#' . Sanitizer::escapeIdForLink( $this->mFragment );
1646 }
1647
1648 /**
1649 * Set the fragment for this title. Removes the first character from the
1650 * specified fragment before setting, so it assumes you're passing it with
1651 * an initial "#".
1652 *
1653 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1654 * or Title::createFragmentTarget().
1655 * Still in active use privately.
1656 *
1657 * @private
1658 * @param string $fragment Text
1659 */
1660 public function setFragment( $fragment ) {
1661 $this->mFragment = strtr( substr( $fragment, 1 ), '_', ' ' );
1662 }
1663
1664 /**
1665 * Creates a new Title for a different fragment of the same page.
1666 *
1667 * @since 1.27
1668 * @param string $fragment
1669 * @return Title
1670 */
1671 public function createFragmentTarget( $fragment ) {
1672 return self::makeTitle(
1673 $this->mNamespace,
1674 $this->getText(),
1675 $fragment,
1676 $this->mInterwiki
1677 );
1678 }
1679
1680 /**
1681 * Prefix some arbitrary text with the namespace or interwiki prefix
1682 * of this object
1683 *
1684 * @param string $name The text
1685 * @return string The prefixed text
1686 */
1687 private function prefix( $name ) {
1688 $p = '';
1689 if ( $this->isExternal() ) {
1690 $p = $this->mInterwiki . ':';
1691 }
1692
1693 if ( $this->mNamespace != 0 ) {
1694 $nsText = $this->getNsText();
1695
1696 if ( $nsText === false ) {
1697 // See T165149. Awkward, but better than erroneously linking to the main namespace.
1698 $nsText = MediaWikiServices::getInstance()->getContentLanguage()->
1699 getNsText( NS_SPECIAL ) . ":Badtitle/NS{$this->mNamespace}";
1700 }
1701
1702 $p .= $nsText . ':';
1703 }
1704 return $p . $name;
1705 }
1706
1707 /**
1708 * Get the prefixed database key form
1709 *
1710 * @return string The prefixed title, with underscores and
1711 * any interwiki and namespace prefixes
1712 */
1713 public function getPrefixedDBkey() {
1714 $s = $this->prefix( $this->mDbkeyform );
1715 $s = strtr( $s, ' ', '_' );
1716 return $s;
1717 }
1718
1719 /**
1720 * Get the prefixed title with spaces.
1721 * This is the form usually used for display
1722 *
1723 * @return string The prefixed title, with spaces
1724 */
1725 public function getPrefixedText() {
1726 if ( $this->prefixedText === null ) {
1727 $s = $this->prefix( $this->mTextform );
1728 $s = strtr( $s, '_', ' ' );
1729 $this->prefixedText = $s;
1730 }
1731 return $this->prefixedText;
1732 }
1733
1734 /**
1735 * Return a string representation of this title
1736 *
1737 * @return string Representation of this title
1738 */
1739 public function __toString() {
1740 return $this->getPrefixedText();
1741 }
1742
1743 /**
1744 * Get the prefixed title with spaces, plus any fragment
1745 * (part beginning with '#')
1746 *
1747 * @return string The prefixed title, with spaces and the fragment, including '#'
1748 */
1749 public function getFullText() {
1750 $text = $this->getPrefixedText();
1751 if ( $this->hasFragment() ) {
1752 $text .= '#' . $this->mFragment;
1753 }
1754 return $text;
1755 }
1756
1757 /**
1758 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1759 *
1760 * @note the return value may contain trailing whitespace and is thus
1761 * not safe for use with makeTitle or TitleValue.
1762 *
1763 * @par Example:
1764 * @code
1765 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1766 * # returns: 'Foo'
1767 * @endcode
1768 *
1769 * @return string Root name
1770 * @since 1.20
1771 */
1772 public function getRootText() {
1773 if (
1774 !MediaWikiServices::getInstance()->getNamespaceInfo()->
1775 hasSubpages( $this->mNamespace )
1776 || strtok( $this->getText(), '/' ) === false
1777 ) {
1778 return $this->getText();
1779 }
1780
1781 return strtok( $this->getText(), '/' );
1782 }
1783
1784 /**
1785 * Get the root page name title, i.e. the leftmost part before any slashes
1786 *
1787 * @par Example:
1788 * @code
1789 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1790 * # returns: Title{User:Foo}
1791 * @endcode
1792 *
1793 * @return Title Root title
1794 * @since 1.20
1795 */
1796 public function getRootTitle() {
1797 $title = self::makeTitleSafe( $this->mNamespace, $this->getRootText() );
1798 Assert::postcondition(
1799 $title !== null,
1800 'makeTitleSafe() should always return a Title for the text returned by getRootText().'
1801 );
1802 return $title;
1803 }
1804
1805 /**
1806 * Get the base page name without a namespace, i.e. the part before the subpage name
1807 *
1808 * @note the return value may contain trailing whitespace and is thus
1809 * not safe for use with makeTitle or TitleValue.
1810 *
1811 * @par Example:
1812 * @code
1813 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1814 * # returns: 'Foo/Bar'
1815 * @endcode
1816 *
1817 * @return string Base name
1818 */
1819 public function getBaseText() {
1820 $text = $this->getText();
1821 if (
1822 !MediaWikiServices::getInstance()->getNamespaceInfo()->
1823 hasSubpages( $this->mNamespace )
1824 ) {
1825 return $text;
1826 }
1827
1828 $lastSlashPos = strrpos( $text, '/' );
1829 // Don't discard the real title if there's no subpage involved
1830 if ( $lastSlashPos === false ) {
1831 return $text;
1832 }
1833
1834 return substr( $text, 0, $lastSlashPos );
1835 }
1836
1837 /**
1838 * Get the base page name title, i.e. the part before the subpage name.
1839 *
1840 * @par Example:
1841 * @code
1842 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1843 * # returns: Title{User:Foo/Bar}
1844 * @endcode
1845 *
1846 * @return Title Base title
1847 * @since 1.20
1848 */
1849 public function getBaseTitle() {
1850 $title = self::makeTitleSafe( $this->mNamespace, $this->getBaseText() );
1851 Assert::postcondition(
1852 $title !== null,
1853 'makeTitleSafe() should always return a Title for the text returned by getBaseText().'
1854 );
1855 return $title;
1856 }
1857
1858 /**
1859 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1860 *
1861 * @par Example:
1862 * @code
1863 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1864 * # returns: "Baz"
1865 * @endcode
1866 *
1867 * @return string Subpage name
1868 */
1869 public function getSubpageText() {
1870 if (
1871 !MediaWikiServices::getInstance()->getNamespaceInfo()->
1872 hasSubpages( $this->mNamespace )
1873 ) {
1874 return $this->mTextform;
1875 }
1876 $parts = explode( '/', $this->mTextform );
1877 return $parts[count( $parts ) - 1];
1878 }
1879
1880 /**
1881 * Get the title for a subpage of the current page
1882 *
1883 * @par Example:
1884 * @code
1885 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1886 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1887 * @endcode
1888 *
1889 * @param string $text The subpage name to add to the title
1890 * @return Title|null Subpage title, or null on an error
1891 * @since 1.20
1892 */
1893 public function getSubpage( $text ) {
1894 return self::makeTitleSafe(
1895 $this->mNamespace,
1896 $this->getText() . '/' . $text,
1897 '',
1898 $this->mInterwiki
1899 );
1900 }
1901
1902 /**
1903 * Get a URL-encoded form of the subpage text
1904 *
1905 * @return string URL-encoded subpage name
1906 */
1907 public function getSubpageUrlForm() {
1908 $text = $this->getSubpageText();
1909 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1910 return $text;
1911 }
1912
1913 /**
1914 * Get a URL-encoded title (not an actual URL) including interwiki
1915 *
1916 * @return string The URL-encoded form
1917 */
1918 public function getPrefixedURL() {
1919 $s = $this->prefix( $this->mDbkeyform );
1920 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1921 return $s;
1922 }
1923
1924 /**
1925 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1926 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1927 * second argument named variant. This was deprecated in favor
1928 * of passing an array of option with a "variant" key
1929 * Once $query2 is removed for good, this helper can be dropped
1930 * and the wfArrayToCgi moved to getLocalURL();
1931 *
1932 * @since 1.19 (r105919)
1933 * @param array|string $query
1934 * @param string|string[]|bool $query2
1935 * @return string
1936 */
1937 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1938 if ( $query2 !== false ) {
1939 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1940 "method called with a second parameter is deprecated. Add your " .
1941 "parameter to an array passed as the first parameter.", "1.19" );
1942 }
1943 if ( is_array( $query ) ) {
1944 $query = wfArrayToCgi( $query );
1945 }
1946 if ( $query2 ) {
1947 if ( is_string( $query2 ) ) {
1948 // $query2 is a string, we will consider this to be
1949 // a deprecated $variant argument and add it to the query
1950 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1951 } else {
1952 $query2 = wfArrayToCgi( $query2 );
1953 }
1954 // If we have $query content add a & to it first
1955 if ( $query ) {
1956 $query .= '&';
1957 }
1958 // Now append the queries together
1959 $query .= $query2;
1960 }
1961 return $query;
1962 }
1963
1964 /**
1965 * Get a real URL referring to this title, with interwiki link and
1966 * fragment
1967 *
1968 * @see self::getLocalURL for the arguments.
1969 * @see wfExpandUrl
1970 * @param string|string[] $query
1971 * @param string|string[]|bool $query2
1972 * @param string|int|null $proto Protocol type to use in URL
1973 * @return string The URL
1974 */
1975 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1976 $query = self::fixUrlQueryArgs( $query, $query2 );
1977
1978 # Hand off all the decisions on urls to getLocalURL
1979 $url = $this->getLocalURL( $query );
1980
1981 # Expand the url to make it a full url. Note that getLocalURL has the
1982 # potential to output full urls for a variety of reasons, so we use
1983 # wfExpandUrl instead of simply prepending $wgServer
1984 $url = wfExpandUrl( $url, $proto );
1985
1986 # Finally, add the fragment.
1987 $url .= $this->getFragmentForURL();
1988 // Avoid PHP 7.1 warning from passing $this by reference
1989 $titleRef = $this;
1990 Hooks::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
1991 return $url;
1992 }
1993
1994 /**
1995 * Get a url appropriate for making redirects based on an untrusted url arg
1996 *
1997 * This is basically the same as getFullUrl(), but in the case of external
1998 * interwikis, we send the user to a landing page, to prevent possible
1999 * phishing attacks and the like.
2000 *
2001 * @note Uses current protocol by default, since technically relative urls
2002 * aren't allowed in redirects per HTTP spec, so this is not suitable for
2003 * places where the url gets cached, as might pollute between
2004 * https and non-https users.
2005 * @see self::getLocalURL for the arguments.
2006 * @param array|string $query
2007 * @param string $proto Protocol type to use in URL
2008 * @return string A url suitable to use in an HTTP location header.
2009 */
2010 public function getFullUrlForRedirect( $query = '', $proto = PROTO_CURRENT ) {
2011 $target = $this;
2012 if ( $this->isExternal() ) {
2013 $target = SpecialPage::getTitleFor(
2014 'GoToInterwiki',
2015 $this->getPrefixedDBkey()
2016 );
2017 }
2018 return $target->getFullURL( $query, false, $proto );
2019 }
2020
2021 /**
2022 * Get a URL with no fragment or server name (relative URL) from a Title object.
2023 * If this page is generated with action=render, however,
2024 * $wgServer is prepended to make an absolute URL.
2025 *
2026 * @see self::getFullURL to always get an absolute URL.
2027 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
2028 * valid to link, locally, to the current Title.
2029 * @see self::newFromText to produce a Title object.
2030 *
2031 * @param string|string[] $query An optional query string,
2032 * not used for interwiki links. Can be specified as an associative array as well,
2033 * e.g., [ 'action' => 'edit' ] (keys and values will be URL-escaped).
2034 * Some query patterns will trigger various shorturl path replacements.
2035 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
2036 * be an array. If a string is passed it will be interpreted as a deprecated
2037 * variant argument and urlencoded into a variant= argument.
2038 * This second query argument will be added to the $query
2039 * The second parameter is deprecated since 1.19. Pass it as a key,value
2040 * pair in the first parameter array instead.
2041 *
2042 * @return string String of the URL.
2043 */
2044 public function getLocalURL( $query = '', $query2 = false ) {
2045 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
2046
2047 $query = self::fixUrlQueryArgs( $query, $query2 );
2048
2049 $interwiki = self::getInterwikiLookup()->fetch( $this->mInterwiki );
2050 if ( $interwiki ) {
2051 $namespace = $this->getNsText();
2052 if ( $namespace != '' ) {
2053 # Can this actually happen? Interwikis shouldn't be parsed.
2054 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
2055 $namespace .= ':';
2056 }
2057 $url = $interwiki->getURL( $namespace . $this->mDbkeyform );
2058 $url = wfAppendQuery( $url, $query );
2059 } else {
2060 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
2061 if ( $query == '' ) {
2062 $url = str_replace( '$1', $dbkey, $wgArticlePath );
2063 // Avoid PHP 7.1 warning from passing $this by reference
2064 $titleRef = $this;
2065 Hooks::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
2066 } else {
2067 global $wgVariantArticlePath, $wgActionPaths;
2068 $url = false;
2069 $matches = [];
2070
2071 if ( !empty( $wgActionPaths )
2072 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
2073 ) {
2074 $action = urldecode( $matches[2] );
2075 if ( isset( $wgActionPaths[$action] ) ) {
2076 $query = $matches[1];
2077 if ( isset( $matches[4] ) ) {
2078 $query .= $matches[4];
2079 }
2080 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
2081 if ( $query != '' ) {
2082 $url = wfAppendQuery( $url, $query );
2083 }
2084 }
2085 }
2086
2087 if ( $url === false
2088 && $wgVariantArticlePath
2089 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
2090 && $this->getPageLanguage()->equals(
2091 MediaWikiServices::getInstance()->getContentLanguage() )
2092 && $this->getPageLanguage()->hasVariants()
2093 ) {
2094 $variant = urldecode( $matches[1] );
2095 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
2096 // Only do the variant replacement if the given variant is a valid
2097 // variant for the page's language.
2098 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
2099 $url = str_replace( '$1', $dbkey, $url );
2100 }
2101 }
2102
2103 if ( $url === false ) {
2104 if ( $query == '-' ) {
2105 $query = '';
2106 }
2107 $url = "{$wgScript}?title={$dbkey}&{$query}";
2108 }
2109 }
2110 // Avoid PHP 7.1 warning from passing $this by reference
2111 $titleRef = $this;
2112 Hooks::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
2113
2114 // @todo FIXME: This causes breakage in various places when we
2115 // actually expected a local URL and end up with dupe prefixes.
2116 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
2117 $url = $wgServer . $url;
2118 }
2119 }
2120 // Avoid PHP 7.1 warning from passing $this by reference
2121 $titleRef = $this;
2122 Hooks::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
2123 return $url;
2124 }
2125
2126 /**
2127 * Get a URL that's the simplest URL that will be valid to link, locally,
2128 * to the current Title. It includes the fragment, but does not include
2129 * the server unless action=render is used (or the link is external). If
2130 * there's a fragment but the prefixed text is empty, we just return a link
2131 * to the fragment.
2132 *
2133 * The result obviously should not be URL-escaped, but does need to be
2134 * HTML-escaped if it's being output in HTML.
2135 *
2136 * @param string|string[] $query
2137 * @param bool $query2
2138 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
2139 * or false (default) for no expansion
2140 * @see self::getLocalURL for the arguments.
2141 * @return string The URL
2142 */
2143 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
2144 if ( $this->isExternal() || $proto !== false ) {
2145 $ret = $this->getFullURL( $query, $query2, $proto );
2146 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
2147 $ret = $this->getFragmentForURL();
2148 } else {
2149 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
2150 }
2151 return $ret;
2152 }
2153
2154 /**
2155 * Get the URL form for an internal link.
2156 * - Used in various CDN-related code, in case we have a different
2157 * internal hostname for the server from the exposed one.
2158 *
2159 * This uses $wgInternalServer to qualify the path, or $wgServer
2160 * if $wgInternalServer is not set. If the server variable used is
2161 * protocol-relative, the URL will be expanded to http://
2162 *
2163 * @see self::getLocalURL for the arguments.
2164 * @param string|string[] $query
2165 * @param string|bool $query2 Deprecated
2166 * @return string The URL
2167 */
2168 public function getInternalURL( $query = '', $query2 = false ) {
2169 global $wgInternalServer, $wgServer;
2170 $query = self::fixUrlQueryArgs( $query, $query2 );
2171 $server = $wgInternalServer !== false ? $wgInternalServer : $wgServer;
2172 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP );
2173 // Avoid PHP 7.1 warning from passing $this by reference
2174 $titleRef = $this;
2175 Hooks::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
2176 return $url;
2177 }
2178
2179 /**
2180 * Get the URL for a canonical link, for use in things like IRC and
2181 * e-mail notifications. Uses $wgCanonicalServer and the
2182 * GetCanonicalURL hook.
2183 *
2184 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
2185 *
2186 * @see self::getLocalURL for the arguments.
2187 * @param string|string[] $query
2188 * @param string|bool $query2 Deprecated
2189 * @return string The URL
2190 * @since 1.18
2191 */
2192 public function getCanonicalURL( $query = '', $query2 = false ) {
2193 $query = self::fixUrlQueryArgs( $query, $query2 );
2194 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL );
2195 // Avoid PHP 7.1 warning from passing $this by reference
2196 $titleRef = $this;
2197 Hooks::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
2198 return $url;
2199 }
2200
2201 /**
2202 * Get the edit URL for this Title
2203 *
2204 * @return string The URL, or a null string if this is an interwiki link
2205 */
2206 public function getEditURL() {
2207 if ( $this->isExternal() ) {
2208 return '';
2209 }
2210 $s = $this->getLocalURL( 'action=edit' );
2211
2212 return $s;
2213 }
2214
2215 /**
2216 * Can $user perform $action on this page?
2217 * This skips potentially expensive cascading permission checks
2218 * as well as avoids expensive error formatting
2219 *
2220 * Suitable for use for nonessential UI controls in common cases, but
2221 * _not_ for functional access control.
2222 *
2223 * May provide false positives, but should never provide a false negative.
2224 *
2225 * @param string $action Action that permission needs to be checked for
2226 * @param User|null $user User to check (since 1.19); $wgUser will be used if not provided.
2227 *
2228 * @return bool
2229 * @throws Exception
2230 *
2231 * @deprecated since 1.33,
2232 * use MediaWikiServices::getInstance()->getPermissionManager()->quickUserCan(..) instead
2233 *
2234 */
2235 public function quickUserCan( $action, $user = null ) {
2236 return $this->userCan( $action, $user, false );
2237 }
2238
2239 /**
2240 * Can $user perform $action on this page?
2241 *
2242 * @param string $action Action that permission needs to be checked for
2243 * @param User|null $user User to check (since 1.19); $wgUser will be used if not
2244 * provided.
2245 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2246 *
2247 * @return bool
2248 * @throws Exception
2249 *
2250 * @deprecated since 1.33,
2251 * use MediaWikiServices::getInstance()->getPermissionManager()->userCan(..) instead
2252 *
2253 */
2254 public function userCan( $action, $user = null, $rigor = PermissionManager::RIGOR_SECURE ) {
2255 if ( !$user instanceof User ) {
2256 global $wgUser;
2257 $user = $wgUser;
2258 }
2259
2260 // TODO: this is for b/c, eventually will be removed
2261 if ( $rigor === true ) {
2262 $rigor = PermissionManager::RIGOR_SECURE; // b/c
2263 } elseif ( $rigor === false ) {
2264 $rigor = PermissionManager::RIGOR_QUICK; // b/c
2265 }
2266
2267 return MediaWikiServices::getInstance()->getPermissionManager()
2268 ->userCan( $action, $user, $this, $rigor );
2269 }
2270
2271 /**
2272 * Can $user perform $action on this page?
2273 *
2274 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
2275 *
2276 * @param string $action Action that permission needs to be checked for
2277 * @param User $user User to check
2278 * @param string $rigor One of (quick,full,secure)
2279 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2280 * - full : does cheap and expensive checks possibly from a replica DB
2281 * - secure : does cheap and expensive checks, using the master as needed
2282 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
2283 * whose corresponding errors may be ignored.
2284 *
2285 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2286 * @throws Exception
2287 *
2288 * @deprecated since 1.33,
2289 * use MediaWikiServices::getInstance()->getPermissionManager()->getPermissionErrors()
2290 *
2291 */
2292 public function getUserPermissionsErrors(
2293 $action, $user, $rigor = PermissionManager::RIGOR_SECURE, $ignoreErrors = []
2294 ) {
2295 // TODO: this is for b/c, eventually will be removed
2296 if ( $rigor === true ) {
2297 $rigor = PermissionManager::RIGOR_SECURE; // b/c
2298 } elseif ( $rigor === false ) {
2299 $rigor = PermissionManager::RIGOR_QUICK; // b/c
2300 }
2301
2302 return MediaWikiServices::getInstance()->getPermissionManager()
2303 ->getPermissionErrors( $action, $user, $this, $rigor, $ignoreErrors );
2304 }
2305
2306 /**
2307 * Get a filtered list of all restriction types supported by this wiki.
2308 * @param bool $exists True to get all restriction types that apply to
2309 * titles that do exist, False for all restriction types that apply to
2310 * titles that do not exist
2311 * @return array
2312 */
2313 public static function getFilteredRestrictionTypes( $exists = true ) {
2314 global $wgRestrictionTypes;
2315 $types = $wgRestrictionTypes;
2316 if ( $exists ) {
2317 # Remove the create restriction for existing titles
2318 $types = array_diff( $types, [ 'create' ] );
2319 } else {
2320 # Only the create and upload restrictions apply to non-existing titles
2321 $types = array_intersect( $types, [ 'create', 'upload' ] );
2322 }
2323 return $types;
2324 }
2325
2326 /**
2327 * Returns restriction types for the current Title
2328 *
2329 * @return array Applicable restriction types
2330 */
2331 public function getRestrictionTypes() {
2332 if ( $this->isSpecialPage() ) {
2333 return [];
2334 }
2335
2336 $types = self::getFilteredRestrictionTypes( $this->exists() );
2337
2338 if ( $this->mNamespace != NS_FILE ) {
2339 # Remove the upload restriction for non-file titles
2340 $types = array_diff( $types, [ 'upload' ] );
2341 }
2342
2343 Hooks::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2344
2345 wfDebug( __METHOD__ . ': applicable restrictions to [[' .
2346 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2347
2348 return $types;
2349 }
2350
2351 /**
2352 * Is this title subject to title protection?
2353 * Title protection is the one applied against creation of such title.
2354 *
2355 * @return array|bool An associative array representing any existent title
2356 * protection, or false if there's none.
2357 */
2358 public function getTitleProtection() {
2359 $protection = $this->getTitleProtectionInternal();
2360 if ( $protection ) {
2361 if ( $protection['permission'] == 'sysop' ) {
2362 $protection['permission'] = 'editprotected'; // B/C
2363 }
2364 if ( $protection['permission'] == 'autoconfirmed' ) {
2365 $protection['permission'] = 'editsemiprotected'; // B/C
2366 }
2367 }
2368 return $protection;
2369 }
2370
2371 /**
2372 * Fetch title protection settings
2373 *
2374 * To work correctly, $this->loadRestrictions() needs to have access to the
2375 * actual protections in the database without munging 'sysop' =>
2376 * 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other
2377 * callers probably want $this->getTitleProtection() instead.
2378 *
2379 * @return array|bool
2380 */
2381 protected function getTitleProtectionInternal() {
2382 // Can't protect pages in special namespaces
2383 if ( $this->mNamespace < 0 ) {
2384 return false;
2385 }
2386
2387 // Can't protect pages that exist.
2388 if ( $this->exists() ) {
2389 return false;
2390 }
2391
2392 if ( $this->mTitleProtection === null ) {
2393 $dbr = wfGetDB( DB_REPLICA );
2394 $commentStore = CommentStore::getStore();
2395 $commentQuery = $commentStore->getJoin( 'pt_reason' );
2396 $res = $dbr->select(
2397 [ 'protected_titles' ] + $commentQuery['tables'],
2398 [
2399 'user' => 'pt_user',
2400 'expiry' => 'pt_expiry',
2401 'permission' => 'pt_create_perm'
2402 ] + $commentQuery['fields'],
2403 [ 'pt_namespace' => $this->mNamespace, 'pt_title' => $this->mDbkeyform ],
2404 __METHOD__,
2405 [],
2406 $commentQuery['joins']
2407 );
2408
2409 // fetchRow returns false if there are no rows.
2410 $row = $dbr->fetchRow( $res );
2411 if ( $row ) {
2412 $this->mTitleProtection = [
2413 'user' => $row['user'],
2414 'expiry' => $dbr->decodeExpiry( $row['expiry'] ),
2415 'permission' => $row['permission'],
2416 'reason' => $commentStore->getComment( 'pt_reason', $row )->text,
2417 ];
2418 } else {
2419 $this->mTitleProtection = false;
2420 }
2421 }
2422 return $this->mTitleProtection;
2423 }
2424
2425 /**
2426 * Remove any title protection due to page existing
2427 */
2428 public function deleteTitleProtection() {
2429 $dbw = wfGetDB( DB_MASTER );
2430
2431 $dbw->delete(
2432 'protected_titles',
2433 [ 'pt_namespace' => $this->mNamespace, 'pt_title' => $this->mDbkeyform ],
2434 __METHOD__
2435 );
2436 $this->mTitleProtection = false;
2437 }
2438
2439 /**
2440 * Is this page "semi-protected" - the *only* protection levels are listed
2441 * in $wgSemiprotectedRestrictionLevels?
2442 *
2443 * @param string $action Action to check (default: edit)
2444 * @return bool
2445 */
2446 public function isSemiProtected( $action = 'edit' ) {
2447 global $wgSemiprotectedRestrictionLevels;
2448
2449 $restrictions = $this->getRestrictions( $action );
2450 $semi = $wgSemiprotectedRestrictionLevels;
2451 if ( !$restrictions || !$semi ) {
2452 // Not protected, or all protection is full protection
2453 return false;
2454 }
2455
2456 // Remap autoconfirmed to editsemiprotected for BC
2457 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2458 $semi[$key] = 'editsemiprotected';
2459 }
2460 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2461 $restrictions[$key] = 'editsemiprotected';
2462 }
2463
2464 return !array_diff( $restrictions, $semi );
2465 }
2466
2467 /**
2468 * Does the title correspond to a protected article?
2469 *
2470 * @param string $action The action the page is protected from,
2471 * by default checks all actions.
2472 * @return bool
2473 */
2474 public function isProtected( $action = '' ) {
2475 global $wgRestrictionLevels;
2476
2477 $restrictionTypes = $this->getRestrictionTypes();
2478
2479 # Special pages have inherent protection
2480 if ( $this->isSpecialPage() ) {
2481 return true;
2482 }
2483
2484 # Check regular protection levels
2485 foreach ( $restrictionTypes as $type ) {
2486 if ( $action == $type || $action == '' ) {
2487 $r = $this->getRestrictions( $type );
2488 foreach ( $wgRestrictionLevels as $level ) {
2489 if ( in_array( $level, $r ) && $level != '' ) {
2490 return true;
2491 }
2492 }
2493 }
2494 }
2495
2496 return false;
2497 }
2498
2499 /**
2500 * Determines if $user is unable to edit this page because it has been protected
2501 * by $wgNamespaceProtection.
2502 *
2503 * @deprecated since 1.34 Don't use this function in new code.
2504 * @param User $user User object to check permissions
2505 * @return bool
2506 */
2507 public function isNamespaceProtected( User $user ) {
2508 global $wgNamespaceProtection;
2509
2510 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
2511 $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
2512 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
2513 if ( !$permissionManager->userHasRight( $user, $right ) ) {
2514 return true;
2515 }
2516 }
2517 }
2518 return false;
2519 }
2520
2521 /**
2522 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2523 *
2524 * @return bool If the page is subject to cascading restrictions.
2525 */
2526 public function isCascadeProtected() {
2527 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2528 return ( $sources > 0 );
2529 }
2530
2531 /**
2532 * Determines whether cascading protection sources have already been loaded from
2533 * the database.
2534 *
2535 * @param bool $getPages True to check if the pages are loaded, or false to check
2536 * if the status is loaded.
2537 * @return bool Whether or not the specified information has been loaded
2538 * @since 1.23
2539 */
2540 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2541 return $getPages ? $this->mCascadeSources !== null : $this->mHasCascadingRestrictions !== null;
2542 }
2543
2544 /**
2545 * Cascading protection: Get the source of any cascading restrictions on this page.
2546 *
2547 * @param bool $getPages Whether or not to retrieve the actual pages
2548 * that the restrictions have come from and the actual restrictions
2549 * themselves.
2550 * @return array Two elements: First is an array of Title objects of the
2551 * pages from which cascading restrictions have come, false for
2552 * none, or true if such restrictions exist but $getPages was not
2553 * set. Second is an array like that returned by
2554 * Title::getAllRestrictions(), or an empty array if $getPages is
2555 * false.
2556 */
2557 public function getCascadeProtectionSources( $getPages = true ) {
2558 $pagerestrictions = [];
2559
2560 if ( $this->mCascadeSources !== null && $getPages ) {
2561 return [ $this->mCascadeSources, $this->mCascadingRestrictions ];
2562 } elseif ( $this->mHasCascadingRestrictions !== null && !$getPages ) {
2563 return [ $this->mHasCascadingRestrictions, $pagerestrictions ];
2564 }
2565
2566 $dbr = wfGetDB( DB_REPLICA );
2567
2568 if ( $this->mNamespace == NS_FILE ) {
2569 $tables = [ 'imagelinks', 'page_restrictions' ];
2570 $where_clauses = [
2571 'il_to' => $this->mDbkeyform,
2572 'il_from=pr_page',
2573 'pr_cascade' => 1
2574 ];
2575 } else {
2576 $tables = [ 'templatelinks', 'page_restrictions' ];
2577 $where_clauses = [
2578 'tl_namespace' => $this->mNamespace,
2579 'tl_title' => $this->mDbkeyform,
2580 'tl_from=pr_page',
2581 'pr_cascade' => 1
2582 ];
2583 }
2584
2585 if ( $getPages ) {
2586 $cols = [ 'pr_page', 'page_namespace', 'page_title',
2587 'pr_expiry', 'pr_type', 'pr_level' ];
2588 $where_clauses[] = 'page_id=pr_page';
2589 $tables[] = 'page';
2590 } else {
2591 $cols = [ 'pr_expiry' ];
2592 }
2593
2594 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2595
2596 $sources = $getPages ? [] : false;
2597 $now = wfTimestampNow();
2598
2599 foreach ( $res as $row ) {
2600 $expiry = $dbr->decodeExpiry( $row->pr_expiry );
2601 if ( $expiry > $now ) {
2602 if ( $getPages ) {
2603 $page_id = $row->pr_page;
2604 $page_ns = $row->page_namespace;
2605 $page_title = $row->page_title;
2606 $sources[$page_id] = self::makeTitle( $page_ns, $page_title );
2607 # Add groups needed for each restriction type if its not already there
2608 # Make sure this restriction type still exists
2609
2610 if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2611 $pagerestrictions[$row->pr_type] = [];
2612 }
2613
2614 if (
2615 isset( $pagerestrictions[$row->pr_type] )
2616 && !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] )
2617 ) {
2618 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2619 }
2620 } else {
2621 $sources = true;
2622 }
2623 }
2624 }
2625
2626 if ( $getPages ) {
2627 $this->mCascadeSources = $sources;
2628 $this->mCascadingRestrictions = $pagerestrictions;
2629 } else {
2630 $this->mHasCascadingRestrictions = $sources;
2631 }
2632
2633 return [ $sources, $pagerestrictions ];
2634 }
2635
2636 /**
2637 * Accessor for mRestrictionsLoaded
2638 *
2639 * @return bool Whether or not the page's restrictions have already been
2640 * loaded from the database
2641 * @since 1.23
2642 */
2643 public function areRestrictionsLoaded() {
2644 return $this->mRestrictionsLoaded;
2645 }
2646
2647 /**
2648 * Accessor/initialisation for mRestrictions
2649 *
2650 * @param string $action Action that permission needs to be checked for
2651 * @return array Restriction levels needed to take the action. All levels are
2652 * required. Note that restriction levels are normally user rights, but 'sysop'
2653 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
2654 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
2655 */
2656 public function getRestrictions( $action ) {
2657 if ( !$this->mRestrictionsLoaded ) {
2658 $this->loadRestrictions();
2659 }
2660 return $this->mRestrictions[$action] ?? [];
2661 }
2662
2663 /**
2664 * Accessor/initialisation for mRestrictions
2665 *
2666 * @return array Keys are actions, values are arrays as returned by
2667 * Title::getRestrictions()
2668 * @since 1.23
2669 */
2670 public function getAllRestrictions() {
2671 if ( !$this->mRestrictionsLoaded ) {
2672 $this->loadRestrictions();
2673 }
2674 return $this->mRestrictions;
2675 }
2676
2677 /**
2678 * Get the expiry time for the restriction against a given action
2679 *
2680 * @param string $action
2681 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2682 * or not protected at all, or false if the action is not recognised.
2683 */
2684 public function getRestrictionExpiry( $action ) {
2685 if ( !$this->mRestrictionsLoaded ) {
2686 $this->loadRestrictions();
2687 }
2688 return $this->mRestrictionsExpiry[$action] ?? false;
2689 }
2690
2691 /**
2692 * Returns cascading restrictions for the current article
2693 *
2694 * @return bool
2695 */
2696 function areRestrictionsCascading() {
2697 if ( !$this->mRestrictionsLoaded ) {
2698 $this->loadRestrictions();
2699 }
2700
2701 return $this->mCascadeRestriction;
2702 }
2703
2704 /**
2705 * Compiles list of active page restrictions from both page table (pre 1.10)
2706 * and page_restrictions table for this existing page.
2707 * Public for usage by LiquidThreads.
2708 *
2709 * @param array $rows Array of db result objects
2710 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
2711 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
2712 * Edit and move sections are separated by a colon
2713 * Example: "edit=autoconfirmed,sysop:move=sysop"
2714 */
2715 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2716 // This function will only read rows from a table that we migrated away
2717 // from before adding READ_LATEST support to loadRestrictions, so we
2718 // don't need to support reading from DB_MASTER here.
2719 $dbr = wfGetDB( DB_REPLICA );
2720
2721 $restrictionTypes = $this->getRestrictionTypes();
2722
2723 foreach ( $restrictionTypes as $type ) {
2724 $this->mRestrictions[$type] = [];
2725 $this->mRestrictionsExpiry[$type] = 'infinity';
2726 }
2727
2728 $this->mCascadeRestriction = false;
2729
2730 # Backwards-compatibility: also load the restrictions from the page record (old format).
2731 if ( $oldFashionedRestrictions !== null ) {
2732 $this->mOldRestrictions = $oldFashionedRestrictions;
2733 }
2734
2735 if ( $this->mOldRestrictions === false ) {
2736 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
2737 $linkCache->addLinkObj( $this ); # in case we already had an article ID
2738 $this->mOldRestrictions = $linkCache->getGoodLinkFieldObj( $this, 'restrictions' );
2739 }
2740
2741 if ( $this->mOldRestrictions != '' ) {
2742 foreach ( explode( ':', trim( $this->mOldRestrictions ) ) as $restrict ) {
2743 $temp = explode( '=', trim( $restrict ) );
2744 if ( count( $temp ) == 1 ) {
2745 // old old format should be treated as edit/move restriction
2746 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
2747 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
2748 } else {
2749 $restriction = trim( $temp[1] );
2750 if ( $restriction != '' ) { // some old entries are empty
2751 $this->mRestrictions[$temp[0]] = explode( ',', $restriction );
2752 }
2753 }
2754 }
2755 }
2756
2757 if ( count( $rows ) ) {
2758 # Current system - load second to make them override.
2759 $now = wfTimestampNow();
2760
2761 # Cycle through all the restrictions.
2762 foreach ( $rows as $row ) {
2763 // Don't take care of restrictions types that aren't allowed
2764 if ( !in_array( $row->pr_type, $restrictionTypes ) ) {
2765 continue;
2766 }
2767
2768 $expiry = $dbr->decodeExpiry( $row->pr_expiry );
2769
2770 // Only apply the restrictions if they haven't expired!
2771 if ( !$expiry || $expiry > $now ) {
2772 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
2773 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
2774
2775 $this->mCascadeRestriction |= $row->pr_cascade;
2776 }
2777 }
2778 }
2779
2780 $this->mRestrictionsLoaded = true;
2781 }
2782
2783 /**
2784 * Load restrictions from the page_restrictions table
2785 *
2786 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
2787 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
2788 * Edit and move sections are separated by a colon
2789 * Example: "edit=autoconfirmed,sysop:move=sysop"
2790 * @param int $flags A bit field. If self::READ_LATEST is set, skip replicas and read
2791 * from the master DB.
2792 */
2793 public function loadRestrictions( $oldFashionedRestrictions = null, $flags = 0 ) {
2794 $readLatest = DBAccessObjectUtils::hasFlags( $flags, self::READ_LATEST );
2795 if ( $this->mRestrictionsLoaded && !$readLatest ) {
2796 return;
2797 }
2798
2799 // TODO: should probably pass $flags into getArticleID, but it seems hacky
2800 // to mix READ_LATEST and GAID_FOR_UPDATE, even if they have the same value.
2801 // Maybe deprecate GAID_FOR_UPDATE now that we implement IDBAccessObject?
2802 $id = $this->getArticleID();
2803 if ( $id ) {
2804 $fname = __METHOD__;
2805 $loadRestrictionsFromDb = function ( IDatabase $dbr ) use ( $fname, $id ) {
2806 return iterator_to_array(
2807 $dbr->select(
2808 'page_restrictions',
2809 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
2810 [ 'pr_page' => $id ],
2811 $fname
2812 )
2813 );
2814 };
2815
2816 if ( $readLatest ) {
2817 $dbr = wfGetDB( DB_MASTER );
2818 $rows = $loadRestrictionsFromDb( $dbr );
2819 } else {
2820 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
2821 $rows = $cache->getWithSetCallback(
2822 // Page protections always leave a new null revision
2823 $cache->makeKey( 'page-restrictions', 'v1', $id, $this->getLatestRevID() ),
2824 $cache::TTL_DAY,
2825 function ( $curValue, &$ttl, array &$setOpts ) use ( $loadRestrictionsFromDb ) {
2826 $dbr = wfGetDB( DB_REPLICA );
2827
2828 $setOpts += Database::getCacheSetOptions( $dbr );
2829 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
2830 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2831 // @TODO: cleanup Title cache and caller assumption mess in general
2832 $ttl = WANObjectCache::TTL_UNCACHEABLE;
2833 }
2834
2835 return $loadRestrictionsFromDb( $dbr );
2836 }
2837 );
2838 }
2839
2840 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2841 } else {
2842 $title_protection = $this->getTitleProtectionInternal();
2843
2844 if ( $title_protection ) {
2845 $now = wfTimestampNow();
2846 $expiry = wfGetDB( DB_REPLICA )->decodeExpiry( $title_protection['expiry'] );
2847
2848 if ( !$expiry || $expiry > $now ) {
2849 // Apply the restrictions
2850 $this->mRestrictionsExpiry['create'] = $expiry;
2851 $this->mRestrictions['create'] =
2852 explode( ',', trim( $title_protection['permission'] ) );
2853 } else { // Get rid of the old restrictions
2854 $this->mTitleProtection = false;
2855 }
2856 } else {
2857 $this->mRestrictionsExpiry['create'] = 'infinity';
2858 }
2859 $this->mRestrictionsLoaded = true;
2860 }
2861 }
2862
2863 /**
2864 * Flush the protection cache in this object and force reload from the database.
2865 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2866 */
2867 public function flushRestrictions() {
2868 $this->mRestrictionsLoaded = false;
2869 $this->mTitleProtection = null;
2870 }
2871
2872 /**
2873 * Purge expired restrictions from the page_restrictions table
2874 *
2875 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
2876 */
2877 static function purgeExpiredRestrictions() {
2878 if ( wfReadOnly() ) {
2879 return;
2880 }
2881
2882 DeferredUpdates::addUpdate( new AtomicSectionUpdate(
2883 wfGetDB( DB_MASTER ),
2884 __METHOD__,
2885 function ( IDatabase $dbw, $fname ) {
2886 $config = MediaWikiServices::getInstance()->getMainConfig();
2887 $ids = $dbw->selectFieldValues(
2888 'page_restrictions',
2889 'pr_id',
2890 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
2891 $fname,
2892 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
2893 );
2894 if ( $ids ) {
2895 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
2896 }
2897 }
2898 ) );
2899
2900 DeferredUpdates::addUpdate( new AtomicSectionUpdate(
2901 wfGetDB( DB_MASTER ),
2902 __METHOD__,
2903 function ( IDatabase $dbw, $fname ) {
2904 $dbw->delete(
2905 'protected_titles',
2906 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
2907 $fname
2908 );
2909 }
2910 ) );
2911 }
2912
2913 /**
2914 * Does this have subpages? (Warning, usually requires an extra DB query.)
2915 *
2916 * @return bool
2917 */
2918 public function hasSubpages() {
2919 if (
2920 !MediaWikiServices::getInstance()->getNamespaceInfo()->
2921 hasSubpages( $this->mNamespace )
2922 ) {
2923 # Duh
2924 return false;
2925 }
2926
2927 # We dynamically add a member variable for the purpose of this method
2928 # alone to cache the result. There's no point in having it hanging
2929 # around uninitialized in every Title object; therefore we only add it
2930 # if needed and don't declare it statically.
2931 if ( $this->mHasSubpages === null ) {
2932 $this->mHasSubpages = false;
2933 $subpages = $this->getSubpages( 1 );
2934 if ( $subpages instanceof TitleArray ) {
2935 $this->mHasSubpages = (bool)$subpages->current();
2936 }
2937 }
2938
2939 return $this->mHasSubpages;
2940 }
2941
2942 /**
2943 * Get all subpages of this page.
2944 *
2945 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
2946 * @return TitleArray|array TitleArray, or empty array if this page's namespace
2947 * doesn't allow subpages
2948 */
2949 public function getSubpages( $limit = -1 ) {
2950 if (
2951 !MediaWikiServices::getInstance()->getNamespaceInfo()->
2952 hasSubpages( $this->mNamespace )
2953 ) {
2954 return [];
2955 }
2956
2957 $dbr = wfGetDB( DB_REPLICA );
2958 $conds = [ 'page_namespace' => $this->mNamespace ];
2959 $conds[] = 'page_title ' . $dbr->buildLike( $this->mDbkeyform . '/', $dbr->anyString() );
2960 $options = [];
2961 if ( $limit > -1 ) {
2962 $options['LIMIT'] = $limit;
2963 }
2964 return TitleArray::newFromResult(
2965 $dbr->select( 'page',
2966 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
2967 $conds,
2968 __METHOD__,
2969 $options
2970 )
2971 );
2972 }
2973
2974 /**
2975 * Is there a version of this page in the deletion archive?
2976 *
2977 * @return int The number of archived revisions
2978 */
2979 public function isDeleted() {
2980 if ( $this->mNamespace < 0 ) {
2981 $n = 0;
2982 } else {
2983 $dbr = wfGetDB( DB_REPLICA );
2984
2985 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2986 [ 'ar_namespace' => $this->mNamespace, 'ar_title' => $this->mDbkeyform ],
2987 __METHOD__
2988 );
2989 if ( $this->mNamespace == NS_FILE ) {
2990 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
2991 [ 'fa_name' => $this->mDbkeyform ],
2992 __METHOD__
2993 );
2994 }
2995 }
2996 return (int)$n;
2997 }
2998
2999 /**
3000 * Is there a version of this page in the deletion archive?
3001 *
3002 * @return bool
3003 */
3004 public function isDeletedQuick() {
3005 if ( $this->mNamespace < 0 ) {
3006 return false;
3007 }
3008 $dbr = wfGetDB( DB_REPLICA );
3009 $deleted = (bool)$dbr->selectField( 'archive', '1',
3010 [ 'ar_namespace' => $this->mNamespace, 'ar_title' => $this->mDbkeyform ],
3011 __METHOD__
3012 );
3013 if ( !$deleted && $this->mNamespace == NS_FILE ) {
3014 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3015 [ 'fa_name' => $this->mDbkeyform ],
3016 __METHOD__
3017 );
3018 }
3019 return $deleted;
3020 }
3021
3022 /**
3023 * Get the article ID for this Title from the link cache,
3024 * adding it if necessary
3025 *
3026 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3027 * for update
3028 * @return int The ID
3029 */
3030 public function getArticleID( $flags = 0 ) {
3031 if ( $this->mNamespace < 0 ) {
3032 $this->mArticleID = 0;
3033 return $this->mArticleID;
3034 }
3035 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3036 if ( $flags & self::GAID_FOR_UPDATE ) {
3037 $oldUpdate = $linkCache->forUpdate( true );
3038 $linkCache->clearLink( $this );
3039 $this->mArticleID = $linkCache->addLinkObj( $this );
3040 $linkCache->forUpdate( $oldUpdate );
3041 } elseif ( $this->mArticleID == -1 ) {
3042 $this->mArticleID = $linkCache->addLinkObj( $this );
3043 }
3044 return $this->mArticleID;
3045 }
3046
3047 /**
3048 * Is this an article that is a redirect page?
3049 * Uses link cache, adding it if necessary
3050 *
3051 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3052 * @return bool
3053 */
3054 public function isRedirect( $flags = 0 ) {
3055 if ( !is_null( $this->mRedirect ) ) {
3056 return $this->mRedirect;
3057 }
3058 if ( !$this->getArticleID( $flags ) ) {
3059 $this->mRedirect = false;
3060 return $this->mRedirect;
3061 }
3062
3063 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3064 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3065 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3066 if ( $cached === null ) {
3067 # Trust LinkCache's state over our own
3068 # LinkCache is telling us that the page doesn't exist, despite there being cached
3069 # data relating to an existing page in $this->mArticleID. Updaters should clear
3070 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3071 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3072 # LinkCache to refresh its data from the master.
3073 $this->mRedirect = false;
3074 return $this->mRedirect;
3075 }
3076
3077 $this->mRedirect = (bool)$cached;
3078
3079 return $this->mRedirect;
3080 }
3081
3082 /**
3083 * What is the length of this page?
3084 * Uses link cache, adding it if necessary
3085 *
3086 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3087 * @return int
3088 */
3089 public function getLength( $flags = 0 ) {
3090 if ( $this->mLength != -1 ) {
3091 return $this->mLength;
3092 }
3093 if ( !$this->getArticleID( $flags ) ) {
3094 $this->mLength = 0;
3095 return $this->mLength;
3096 }
3097 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3098 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3099 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3100 if ( $cached === null ) {
3101 # Trust LinkCache's state over our own, as for isRedirect()
3102 $this->mLength = 0;
3103 return $this->mLength;
3104 }
3105
3106 $this->mLength = intval( $cached );
3107
3108 return $this->mLength;
3109 }
3110
3111 /**
3112 * What is the page_latest field for this page?
3113 *
3114 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3115 * @return int Int or 0 if the page doesn't exist
3116 */
3117 public function getLatestRevID( $flags = 0 ) {
3118 if ( !( $flags & self::GAID_FOR_UPDATE ) && $this->mLatestID !== false ) {
3119 return intval( $this->mLatestID );
3120 }
3121 if ( !$this->getArticleID( $flags ) ) {
3122 $this->mLatestID = 0;
3123 return $this->mLatestID;
3124 }
3125 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3126 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3127 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3128 if ( $cached === null ) {
3129 # Trust LinkCache's state over our own, as for isRedirect()
3130 $this->mLatestID = 0;
3131 return $this->mLatestID;
3132 }
3133
3134 $this->mLatestID = intval( $cached );
3135
3136 return $this->mLatestID;
3137 }
3138
3139 /**
3140 * This clears some fields in this object, and clears any associated
3141 * keys in the "bad links" section of the link cache.
3142 *
3143 * - This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow
3144 * loading of the new page_id. It's also called from
3145 * WikiPage::doDeleteArticleReal()
3146 *
3147 * @param int $newid The new Article ID
3148 */
3149 public function resetArticleID( $newid ) {
3150 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3151 $linkCache->clearLink( $this );
3152
3153 if ( $newid === false ) {
3154 $this->mArticleID = -1;
3155 } else {
3156 $this->mArticleID = intval( $newid );
3157 }
3158 $this->mRestrictionsLoaded = false;
3159 $this->mRestrictions = [];
3160 $this->mOldRestrictions = false;
3161 $this->mRedirect = null;
3162 $this->mLength = -1;
3163 $this->mLatestID = false;
3164 $this->mContentModel = false;
3165 $this->mEstimateRevisions = null;
3166 $this->mPageLanguage = null;
3167 $this->mDbPageLanguage = false;
3168 $this->mIsBigDeletion = null;
3169 }
3170
3171 public static function clearCaches() {
3172 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3173 $linkCache->clear();
3174
3175 $titleCache = self::getTitleCache();
3176 $titleCache->clear();
3177 }
3178
3179 /**
3180 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3181 *
3182 * @param string $text Containing title to capitalize
3183 * @param int $ns Namespace index, defaults to NS_MAIN
3184 * @return string Containing capitalized title
3185 */
3186 public static function capitalize( $text, $ns = NS_MAIN ) {
3187 $services = MediaWikiServices::getInstance();
3188 if ( $services->getNamespaceInfo()->isCapitalized( $ns ) ) {
3189 return $services->getContentLanguage()->ucfirst( $text );
3190 } else {
3191 return $text;
3192 }
3193 }
3194
3195 /**
3196 * Secure and split - main initialisation function for this object
3197 *
3198 * Assumes that mDbkeyform has been set, and is urldecoded
3199 * and uses underscores, but not otherwise munged. This function
3200 * removes illegal characters, splits off the interwiki and
3201 * namespace prefixes, sets the other forms, and canonicalizes
3202 * everything.
3203 *
3204 * @throws MalformedTitleException On invalid titles
3205 * @return bool True on success
3206 */
3207 private function secureAndSplit() {
3208 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3209 // the parsing code with Title, while avoiding massive refactoring.
3210 // @todo: get rid of secureAndSplit, refactor parsing code.
3211 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3212 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3213 /** @var MediaWikiTitleCodec $titleCodec */
3214 $titleCodec = MediaWikiServices::getInstance()->getTitleParser();
3215 '@phan-var MediaWikiTitleCodec $titleCodec';
3216 // MalformedTitleException can be thrown here
3217 $parts = $titleCodec->splitTitleString( $this->mDbkeyform, $this->mDefaultNamespace );
3218
3219 # Fill fields
3220 $this->setFragment( '#' . $parts['fragment'] );
3221 $this->mInterwiki = $parts['interwiki'];
3222 $this->mLocalInterwiki = $parts['local_interwiki'];
3223 $this->mNamespace = $parts['namespace'];
3224 $this->mUserCaseDBKey = $parts['user_case_dbkey'];
3225
3226 $this->mDbkeyform = $parts['dbkey'];
3227 $this->mUrlform = wfUrlencode( $this->mDbkeyform );
3228 $this->mTextform = strtr( $this->mDbkeyform, '_', ' ' );
3229
3230 # We already know that some pages won't be in the database!
3231 if ( $this->isExternal() || $this->isSpecialPage() ) {
3232 $this->mArticleID = 0;
3233 }
3234
3235 return true;
3236 }
3237
3238 /**
3239 * Get an array of Title objects linking to this Title
3240 * Also stores the IDs in the link cache.
3241 *
3242 * WARNING: do not use this function on arbitrary user-supplied titles!
3243 * On heavily-used templates it will max out the memory.
3244 *
3245 * @param array $options May be FOR UPDATE
3246 * @param string $table Table name
3247 * @param string $prefix Fields prefix
3248 * @return Title[] Array of Title objects linking here
3249 */
3250 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3251 if ( count( $options ) > 0 ) {
3252 $db = wfGetDB( DB_MASTER );
3253 } else {
3254 $db = wfGetDB( DB_REPLICA );
3255 }
3256
3257 $res = $db->select(
3258 [ 'page', $table ],
3259 self::getSelectFields(),
3260 [
3261 "{$prefix}_from=page_id",
3262 "{$prefix}_namespace" => $this->mNamespace,
3263 "{$prefix}_title" => $this->mDbkeyform ],
3264 __METHOD__,
3265 $options
3266 );
3267
3268 $retVal = [];
3269 if ( $res->numRows() ) {
3270 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3271 foreach ( $res as $row ) {
3272 $titleObj = self::makeTitle( $row->page_namespace, $row->page_title );
3273 if ( $titleObj ) {
3274 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3275 $retVal[] = $titleObj;
3276 }
3277 }
3278 }
3279 return $retVal;
3280 }
3281
3282 /**
3283 * Get an array of Title objects using this Title as a template
3284 * Also stores the IDs in the link cache.
3285 *
3286 * WARNING: do not use this function on arbitrary user-supplied titles!
3287 * On heavily-used templates it will max out the memory.
3288 *
3289 * @param array $options Query option to Database::select()
3290 * @return Title[] Array of Title the Title objects linking here
3291 */
3292 public function getTemplateLinksTo( $options = [] ) {
3293 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3294 }
3295
3296 /**
3297 * Get an array of Title objects linked from this Title
3298 * Also stores the IDs in the link cache.
3299 *
3300 * WARNING: do not use this function on arbitrary user-supplied titles!
3301 * On heavily-used templates it will max out the memory.
3302 *
3303 * @param array $options Query option to Database::select()
3304 * @param string $table Table name
3305 * @param string $prefix Fields prefix
3306 * @return array Array of Title objects linking here
3307 */
3308 public function getLinksFrom( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3309 $id = $this->getArticleID();
3310
3311 # If the page doesn't exist; there can't be any link from this page
3312 if ( !$id ) {
3313 return [];
3314 }
3315
3316 $db = wfGetDB( DB_REPLICA );
3317
3318 $blNamespace = "{$prefix}_namespace";
3319 $blTitle = "{$prefix}_title";
3320
3321 $pageQuery = WikiPage::getQueryInfo();
3322 $res = $db->select(
3323 [ $table, 'nestpage' => $pageQuery['tables'] ],
3324 array_merge(
3325 [ $blNamespace, $blTitle ],
3326 $pageQuery['fields']
3327 ),
3328 [ "{$prefix}_from" => $id ],
3329 __METHOD__,
3330 $options,
3331 [ 'nestpage' => [
3332 'LEFT JOIN',
3333 [ "page_namespace=$blNamespace", "page_title=$blTitle" ]
3334 ] ] + $pageQuery['joins']
3335 );
3336
3337 $retVal = [];
3338 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3339 foreach ( $res as $row ) {
3340 if ( $row->page_id ) {
3341 $titleObj = self::newFromRow( $row );
3342 } else {
3343 $titleObj = self::makeTitle( $row->$blNamespace, $row->$blTitle );
3344 $linkCache->addBadLinkObj( $titleObj );
3345 }
3346 $retVal[] = $titleObj;
3347 }
3348
3349 return $retVal;
3350 }
3351
3352 /**
3353 * Get an array of Title objects used on this Title as a template
3354 * Also stores the IDs in the link cache.
3355 *
3356 * WARNING: do not use this function on arbitrary user-supplied titles!
3357 * On heavily-used templates it will max out the memory.
3358 *
3359 * @param array $options May be FOR UPDATE
3360 * @return Title[] Array of Title the Title objects used here
3361 */
3362 public function getTemplateLinksFrom( $options = [] ) {
3363 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3364 }
3365
3366 /**
3367 * Get an array of Title objects referring to non-existent articles linked
3368 * from this page.
3369 *
3370 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3371 * should use redirect table in this case).
3372 * @return Title[] Array of Title the Title objects
3373 */
3374 public function getBrokenLinksFrom() {
3375 if ( $this->getArticleID() == 0 ) {
3376 # All links from article ID 0 are false positives
3377 return [];
3378 }
3379
3380 $dbr = wfGetDB( DB_REPLICA );
3381 $res = $dbr->select(
3382 [ 'page', 'pagelinks' ],
3383 [ 'pl_namespace', 'pl_title' ],
3384 [
3385 'pl_from' => $this->getArticleID(),
3386 'page_namespace IS NULL'
3387 ],
3388 __METHOD__, [],
3389 [
3390 'page' => [
3391 'LEFT JOIN',
3392 [ 'pl_namespace=page_namespace', 'pl_title=page_title' ]
3393 ]
3394 ]
3395 );
3396
3397 $retVal = [];
3398 foreach ( $res as $row ) {
3399 $retVal[] = self::makeTitle( $row->pl_namespace, $row->pl_title );
3400 }
3401 return $retVal;
3402 }
3403
3404 /**
3405 * Get a list of URLs to purge from the CDN cache when this
3406 * page changes
3407 *
3408 * @return string[] Array of String the URLs
3409 */
3410 public function getCdnUrls() {
3411 $urls = [
3412 $this->getInternalURL(),
3413 $this->getInternalURL( 'action=history' )
3414 ];
3415
3416 $pageLang = $this->getPageLanguage();
3417 if ( $pageLang->hasVariants() ) {
3418 $variants = $pageLang->getVariants();
3419 foreach ( $variants as $vCode ) {
3420 $urls[] = $this->getInternalURL( $vCode );
3421 }
3422 }
3423
3424 // If we are looking at a css/js user subpage, purge the action=raw.
3425 if ( $this->isUserJsConfigPage() ) {
3426 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/javascript' );
3427 } elseif ( $this->isUserJsonConfigPage() ) {
3428 $urls[] = $this->getInternalURL( 'action=raw&ctype=application/json' );
3429 } elseif ( $this->isUserCssConfigPage() ) {
3430 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/css' );
3431 }
3432
3433 Hooks::run( 'TitleSquidURLs', [ $this, &$urls ] );
3434 return $urls;
3435 }
3436
3437 /**
3438 * Purge all applicable CDN URLs
3439 */
3440 public function purgeSquid() {
3441 DeferredUpdates::addUpdate(
3442 new CdnCacheUpdate( $this->getCdnUrls() ),
3443 DeferredUpdates::PRESEND
3444 );
3445 }
3446
3447 /**
3448 * Check whether a given move operation would be valid.
3449 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3450 *
3451 * @deprecated since 1.25, use MovePage's methods instead
3452 * @param Title &$nt The new title
3453 * @param bool $auth Whether to check user permissions (uses $wgUser)
3454 * @param string $reason Is the log summary of the move, used for spam checking
3455 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3456 */
3457 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3458 wfDeprecated( __METHOD__, '1.25' );
3459
3460 global $wgUser;
3461
3462 if ( !( $nt instanceof Title ) ) {
3463 // Normally we'd add this to $errors, but we'll get
3464 // lots of syntax errors if $nt is not an object
3465 return [ [ 'badtitletext' ] ];
3466 }
3467
3468 $mp = MediaWikiServices::getInstance()->getMovePageFactory()->newMovePage( $this, $nt );
3469 $errors = $mp->isValidMove()->getErrorsArray();
3470 if ( $auth ) {
3471 $errors = wfMergeErrorArrays(
3472 $errors,
3473 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
3474 );
3475 }
3476
3477 return $errors ?: true;
3478 }
3479
3480 /**
3481 * Move a title to a new location
3482 *
3483 * @deprecated since 1.25, use the MovePage class instead
3484 * @param Title &$nt The new title
3485 * @param bool $auth Indicates whether $wgUser's permissions
3486 * should be checked
3487 * @param string $reason The reason for the move
3488 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3489 * Ignored if the user doesn't have the suppressredirect right.
3490 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3491 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3492 */
3493 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true,
3494 array $changeTags = []
3495 ) {
3496 wfDeprecated( __METHOD__, '1.25' );
3497
3498 global $wgUser;
3499
3500 $mp = MediaWikiServices::getInstance()->getMovePageFactory()->newMovePage( $this, $nt );
3501 $method = $auth ? 'moveIfAllowed' : 'move';
3502 $status = $mp->$method( $wgUser, $reason, $createRedirect, $changeTags );
3503 if ( $status->isOK() ) {
3504 return true;
3505 } else {
3506 return $status->getErrorsArray();
3507 }
3508 }
3509
3510 /**
3511 * Move this page's subpages to be subpages of $nt
3512 *
3513 * @deprecated since 1.34, use MovePage instead
3514 * @param Title $nt Move target
3515 * @param bool $auth Whether $wgUser's permissions should be checked
3516 * @param string $reason The reason for the move
3517 * @param bool $createRedirect Whether to create redirects from the old subpages to
3518 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3519 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3520 * @return array Array with old page titles as keys, and strings (new page titles) or
3521 * getUserPermissionsErrors()-like arrays (errors) as values, or a
3522 * getUserPermissionsErrors()-like error array with numeric indices if
3523 * no pages were moved
3524 */
3525 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true,
3526 array $changeTags = []
3527 ) {
3528 wfDeprecated( __METHOD__, '1.34' );
3529
3530 global $wgUser;
3531
3532 $mp = new MovePage( $this, $nt );
3533 $method = $auth ? 'moveSubpagesIfAllowed' : 'moveSubpages';
3534 $result = $mp->$method( $wgUser, $reason, $createRedirect, $changeTags );
3535
3536 if ( !$result->isOK() ) {
3537 return $result->getErrorsArray();
3538 }
3539
3540 $retval = [];
3541 foreach ( $result->getValue() as $key => $status ) {
3542 if ( $status->isOK() ) {
3543 $retval[$key] = $status->getValue();
3544 } else {
3545 $retval[$key] = $status->getErrorsArray();
3546 }
3547 }
3548 return $retval;
3549 }
3550
3551 /**
3552 * Checks if this page is just a one-rev redirect.
3553 * Adds lock, so don't use just for light purposes.
3554 *
3555 * @return bool
3556 */
3557 public function isSingleRevRedirect() {
3558 global $wgContentHandlerUseDB;
3559
3560 $dbw = wfGetDB( DB_MASTER );
3561
3562 # Is it a redirect?
3563 $fields = [ 'page_is_redirect', 'page_latest', 'page_id' ];
3564 if ( $wgContentHandlerUseDB ) {
3565 $fields[] = 'page_content_model';
3566 }
3567
3568 $row = $dbw->selectRow( 'page',
3569 $fields,
3570 $this->pageCond(),
3571 __METHOD__,
3572 [ 'FOR UPDATE' ]
3573 );
3574 # Cache some fields we may want
3575 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
3576 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
3577 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
3578 $this->mContentModel = $row && isset( $row->page_content_model )
3579 ? strval( $row->page_content_model )
3580 : false;
3581
3582 if ( !$this->mRedirect ) {
3583 return false;
3584 }
3585 # Does the article have a history?
3586 $row = $dbw->selectField( [ 'page', 'revision' ],
3587 'rev_id',
3588 [ 'page_namespace' => $this->mNamespace,
3589 'page_title' => $this->mDbkeyform,
3590 'page_id=rev_page',
3591 'page_latest != rev_id'
3592 ],
3593 __METHOD__,
3594 [ 'FOR UPDATE' ]
3595 );
3596 # Return true if there was no history
3597 return ( $row === false );
3598 }
3599
3600 /**
3601 * Checks if $this can be moved to a given Title
3602 * - Selects for update, so don't call it unless you mean business
3603 *
3604 * @deprecated since 1.25, use MovePage's methods instead
3605 * @param Title $nt The new title to check
3606 * @return bool
3607 */
3608 public function isValidMoveTarget( $nt ) {
3609 wfDeprecated( __METHOD__, '1.25' );
3610
3611 # Is it an existing file?
3612 if ( $nt->getNamespace() == NS_FILE ) {
3613 $file = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()
3614 ->newFile( $nt );
3615 $file->load( File::READ_LATEST );
3616 if ( $file->exists() ) {
3617 wfDebug( __METHOD__ . ": file exists\n" );
3618 return false;
3619 }
3620 }
3621 # Is it a redirect with no history?
3622 if ( !$nt->isSingleRevRedirect() ) {
3623 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
3624 return false;
3625 }
3626 # Get the article text
3627 $rev = Revision::newFromTitle( $nt, false, Revision::READ_LATEST );
3628 if ( !is_object( $rev ) ) {
3629 return false;
3630 }
3631 $content = $rev->getContent();
3632 # Does the redirect point to the source?
3633 # Or is it a broken self-redirect, usually caused by namespace collisions?
3634 $redirTitle = $content ? $content->getRedirectTarget() : null;
3635
3636 if ( $redirTitle ) {
3637 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3638 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3639 wfDebug( __METHOD__ . ": redirect points to other page\n" );
3640 return false;
3641 } else {
3642 return true;
3643 }
3644 } else {
3645 # Fail safe (not a redirect after all. strange.)
3646 wfDebug( __METHOD__ . ": failsafe: database sais " . $nt->getPrefixedDBkey() .
3647 " is a redirect, but it doesn't contain a valid redirect.\n" );
3648 return false;
3649 }
3650 }
3651
3652 /**
3653 * Get categories to which this Title belongs and return an array of
3654 * categories' names.
3655 *
3656 * @return array Array of parents in the form:
3657 * $parent => $currentarticle
3658 */
3659 public function getParentCategories() {
3660 $data = [];
3661
3662 $titleKey = $this->getArticleID();
3663
3664 if ( $titleKey === 0 ) {
3665 return $data;
3666 }
3667
3668 $dbr = wfGetDB( DB_REPLICA );
3669
3670 $res = $dbr->select(
3671 'categorylinks',
3672 'cl_to',
3673 [ 'cl_from' => $titleKey ],
3674 __METHOD__
3675 );
3676
3677 if ( $res->numRows() > 0 ) {
3678 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
3679 foreach ( $res as $row ) {
3680 // $data[] = Title::newFromText( $contLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
3681 $data[$contLang->getNsText( NS_CATEGORY ) . ':' . $row->cl_to] =
3682 $this->getFullText();
3683 }
3684 }
3685 return $data;
3686 }
3687
3688 /**
3689 * Get a tree of parent categories
3690 *
3691 * @param array $children Array with the children in the keys, to check for circular refs
3692 * @return array Tree of parent categories
3693 */
3694 public function getParentCategoryTree( $children = [] ) {
3695 $stack = [];
3696 $parents = $this->getParentCategories();
3697
3698 if ( $parents ) {
3699 foreach ( $parents as $parent => $current ) {
3700 if ( array_key_exists( $parent, $children ) ) {
3701 # Circular reference
3702 $stack[$parent] = [];
3703 } else {
3704 $nt = self::newFromText( $parent );
3705 if ( $nt ) {
3706 $stack[$parent] = $nt->getParentCategoryTree( $children + [ $parent => 1 ] );
3707 }
3708 }
3709 }
3710 }
3711
3712 return $stack;
3713 }
3714
3715 /**
3716 * Get an associative array for selecting this title from
3717 * the "page" table
3718 *
3719 * @return array Array suitable for the $where parameter of DB::select()
3720 */
3721 public function pageCond() {
3722 if ( $this->mArticleID > 0 ) {
3723 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3724 return [ 'page_id' => $this->mArticleID ];
3725 } else {
3726 return [ 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform ];
3727 }
3728 }
3729
3730 /**
3731 * Get next/previous revision ID relative to another revision ID
3732 * @param int $revId Revision ID. Get the revision that was before this one.
3733 * @param int $flags Title::GAID_FOR_UPDATE
3734 * @param string $dir 'next' or 'prev'
3735 * @return int|bool New revision ID, or false if none exists
3736 */
3737 private function getRelativeRevisionID( $revId, $flags, $dir ) {
3738 $rl = MediaWikiServices::getInstance()->getRevisionLookup();
3739 $rlFlags = $flags === self::GAID_FOR_UPDATE ? IDBAccessObject::READ_LATEST : 0;
3740 $rev = $rl->getRevisionById( $revId, $rlFlags );
3741 if ( !$rev ) {
3742 return false;
3743 }
3744 $oldRev = $dir === 'next'
3745 ? $rl->getNextRevision( $rev, $rlFlags )
3746 : $rl->getPreviousRevision( $rev, $rlFlags );
3747 if ( !$oldRev ) {
3748 return false;
3749 }
3750 return $oldRev->getId();
3751 }
3752
3753 /**
3754 * Get the revision ID of the previous revision
3755 *
3756 * @deprecated since 1.34, use RevisionLookup::getPreviousRevision
3757 * @param int $revId Revision ID. Get the revision that was before this one.
3758 * @param int $flags Title::GAID_FOR_UPDATE
3759 * @return int|bool Old revision ID, or false if none exists
3760 */
3761 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3762 return $this->getRelativeRevisionID( $revId, $flags, 'prev' );
3763 }
3764
3765 /**
3766 * Get the revision ID of the next revision
3767 *
3768 * @deprecated since 1.34, use RevisionLookup::getNextRevision
3769 * @param int $revId Revision ID. Get the revision that was after this one.
3770 * @param int $flags Title::GAID_FOR_UPDATE
3771 * @return int|bool Next revision ID, or false if none exists
3772 */
3773 public function getNextRevisionID( $revId, $flags = 0 ) {
3774 return $this->getRelativeRevisionID( $revId, $flags, 'next' );
3775 }
3776
3777 /**
3778 * Get the first revision of the page
3779 *
3780 * @param int $flags Title::GAID_FOR_UPDATE
3781 * @return Revision|null If page doesn't exist
3782 */
3783 public function getFirstRevision( $flags = 0 ) {
3784 $pageId = $this->getArticleID( $flags );
3785 if ( $pageId ) {
3786 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_REPLICA );
3787 $revQuery = Revision::getQueryInfo();
3788 $row = $db->selectRow( $revQuery['tables'], $revQuery['fields'],
3789 [ 'rev_page' => $pageId ],
3790 __METHOD__,
3791 [
3792 'ORDER BY' => 'rev_timestamp ASC, rev_id ASC',
3793 'IGNORE INDEX' => [ 'revision' => 'rev_timestamp' ], // See T159319
3794 ],
3795 $revQuery['joins']
3796 );
3797 if ( $row ) {
3798 return new Revision( $row, 0, $this );
3799 }
3800 }
3801 return null;
3802 }
3803
3804 /**
3805 * Get the oldest revision timestamp of this page
3806 *
3807 * @param int $flags Title::GAID_FOR_UPDATE
3808 * @return string|null MW timestamp
3809 */
3810 public function getEarliestRevTime( $flags = 0 ) {
3811 $rev = $this->getFirstRevision( $flags );
3812 return $rev ? $rev->getTimestamp() : null;
3813 }
3814
3815 /**
3816 * Check if this is a new page
3817 *
3818 * @return bool
3819 */
3820 public function isNewPage() {
3821 $dbr = wfGetDB( DB_REPLICA );
3822 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
3823 }
3824
3825 /**
3826 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
3827 *
3828 * @return bool
3829 */
3830 public function isBigDeletion() {
3831 global $wgDeleteRevisionsLimit;
3832
3833 if ( !$wgDeleteRevisionsLimit ) {
3834 return false;
3835 }
3836
3837 if ( $this->mIsBigDeletion === null ) {
3838 $dbr = wfGetDB( DB_REPLICA );
3839
3840 $revCount = $dbr->selectRowCount(
3841 'revision',
3842 '1',
3843 [ 'rev_page' => $this->getArticleID() ],
3844 __METHOD__,
3845 [ 'LIMIT' => $wgDeleteRevisionsLimit + 1 ]
3846 );
3847
3848 $this->mIsBigDeletion = $revCount > $wgDeleteRevisionsLimit;
3849 }
3850
3851 return $this->mIsBigDeletion;
3852 }
3853
3854 /**
3855 * Get the approximate revision count of this page.
3856 *
3857 * @return int
3858 */
3859 public function estimateRevisionCount() {
3860 if ( !$this->exists() ) {
3861 return 0;
3862 }
3863
3864 if ( $this->mEstimateRevisions === null ) {
3865 $dbr = wfGetDB( DB_REPLICA );
3866 $this->mEstimateRevisions = $dbr->estimateRowCount( 'revision', '*',
3867 [ 'rev_page' => $this->getArticleID() ], __METHOD__ );
3868 }
3869
3870 return $this->mEstimateRevisions;
3871 }
3872
3873 /**
3874 * Get the number of revisions between the given revision.
3875 * Used for diffs and other things that really need it.
3876 *
3877 * @param int|Revision $old Old revision or rev ID (first before range)
3878 * @param int|Revision $new New revision or rev ID (first after range)
3879 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
3880 * @return int Number of revisions between these revisions.
3881 */
3882 public function countRevisionsBetween( $old, $new, $max = null ) {
3883 if ( !( $old instanceof Revision ) ) {
3884 $old = Revision::newFromTitle( $this, (int)$old );
3885 }
3886 if ( !( $new instanceof Revision ) ) {
3887 $new = Revision::newFromTitle( $this, (int)$new );
3888 }
3889 if ( !$old || !$new ) {
3890 return 0; // nothing to compare
3891 }
3892 $dbr = wfGetDB( DB_REPLICA );
3893 $conds = [
3894 'rev_page' => $this->getArticleID(),
3895 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3896 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3897 ];
3898 if ( $max !== null ) {
3899 return $dbr->selectRowCount( 'revision', '1',
3900 $conds,
3901 __METHOD__,
3902 [ 'LIMIT' => $max + 1 ] // extra to detect truncation
3903 );
3904 } else {
3905 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__ );
3906 }
3907 }
3908
3909 /**
3910 * Get the authors between the given revisions or revision IDs.
3911 * Used for diffs and other things that really need it.
3912 *
3913 * @since 1.23
3914 *
3915 * @param int|Revision $old Old revision or rev ID (first before range by default)
3916 * @param int|Revision $new New revision or rev ID (first after range by default)
3917 * @param int $limit Maximum number of authors
3918 * @param string|array $options (Optional): Single option, or an array of options:
3919 * 'include_old' Include $old in the range; $new is excluded.
3920 * 'include_new' Include $new in the range; $old is excluded.
3921 * 'include_both' Include both $old and $new in the range.
3922 * Unknown option values are ignored.
3923 * @return array|null Names of revision authors in the range; null if not both revisions exist
3924 */
3925 public function getAuthorsBetween( $old, $new, $limit, $options = [] ) {
3926 if ( !( $old instanceof Revision ) ) {
3927 $old = Revision::newFromTitle( $this, (int)$old );
3928 }
3929 if ( !( $new instanceof Revision ) ) {
3930 $new = Revision::newFromTitle( $this, (int)$new );
3931 }
3932 // XXX: what if Revision objects are passed in, but they don't refer to this title?
3933 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
3934 // in the sanity check below?
3935 if ( !$old || !$new ) {
3936 return null; // nothing to compare
3937 }
3938 $authors = [];
3939 $old_cmp = '>';
3940 $new_cmp = '<';
3941 $options = (array)$options;
3942 if ( in_array( 'include_old', $options ) ) {
3943 $old_cmp = '>=';
3944 }
3945 if ( in_array( 'include_new', $options ) ) {
3946 $new_cmp = '<=';
3947 }
3948 if ( in_array( 'include_both', $options ) ) {
3949 $old_cmp = '>=';
3950 $new_cmp = '<=';
3951 }
3952 // No DB query needed if $old and $new are the same or successive revisions:
3953 if ( $old->getId() === $new->getId() ) {
3954 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
3955 [] :
3956 [ $old->getUserText( RevisionRecord::RAW ) ];
3957 } elseif ( $old->getId() === $new->getParentId() ) {
3958 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
3959 $authors[] = $oldUserText = $old->getUserText( RevisionRecord::RAW );
3960 $newUserText = $new->getUserText( RevisionRecord::RAW );
3961 if ( $oldUserText != $newUserText ) {
3962 $authors[] = $newUserText;
3963 }
3964 } elseif ( $old_cmp === '>=' ) {
3965 $authors[] = $old->getUserText( RevisionRecord::RAW );
3966 } elseif ( $new_cmp === '<=' ) {
3967 $authors[] = $new->getUserText( RevisionRecord::RAW );
3968 }
3969 return $authors;
3970 }
3971 $dbr = wfGetDB( DB_REPLICA );
3972 $revQuery = Revision::getQueryInfo();
3973 $authors = $dbr->selectFieldValues(
3974 $revQuery['tables'],
3975 $revQuery['fields']['rev_user_text'],
3976 [
3977 'rev_page' => $this->getArticleID(),
3978 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3979 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3980 ], __METHOD__,
3981 [ 'DISTINCT', 'LIMIT' => $limit + 1 ], // add one so caller knows it was truncated
3982 $revQuery['joins']
3983 );
3984 return $authors;
3985 }
3986
3987 /**
3988 * Get the number of authors between the given revisions or revision IDs.
3989 * Used for diffs and other things that really need it.
3990 *
3991 * @param int|Revision $old Old revision or rev ID (first before range by default)
3992 * @param int|Revision $new New revision or rev ID (first after range by default)
3993 * @param int $limit Maximum number of authors
3994 * @param string|array $options (Optional): Single option, or an array of options:
3995 * 'include_old' Include $old in the range; $new is excluded.
3996 * 'include_new' Include $new in the range; $old is excluded.
3997 * 'include_both' Include both $old and $new in the range.
3998 * Unknown option values are ignored.
3999 * @return int Number of revision authors in the range; zero if not both revisions exist
4000 */
4001 public function countAuthorsBetween( $old, $new, $limit, $options = [] ) {
4002 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4003 return $authors ? count( $authors ) : 0;
4004 }
4005
4006 /**
4007 * Compare with another title.
4008 *
4009 * @param LinkTarget $title
4010 * @return bool
4011 */
4012 public function equals( LinkTarget $title ) {
4013 // Note: === is necessary for proper matching of number-like titles.
4014 return $this->mInterwiki === $title->getInterwiki()
4015 && $this->mNamespace == $title->getNamespace()
4016 && $this->mDbkeyform === $title->getDBkey();
4017 }
4018
4019 /**
4020 * Check if this title is a subpage of another title
4021 *
4022 * @param Title $title
4023 * @return bool
4024 */
4025 public function isSubpageOf( Title $title ) {
4026 return $this->mInterwiki === $title->mInterwiki
4027 && $this->mNamespace == $title->mNamespace
4028 && strpos( $this->mDbkeyform, $title->mDbkeyform . '/' ) === 0;
4029 }
4030
4031 /**
4032 * Check if page exists. For historical reasons, this function simply
4033 * checks for the existence of the title in the page table, and will
4034 * thus return false for interwiki links, special pages and the like.
4035 * If you want to know if a title can be meaningfully viewed, you should
4036 * probably call the isKnown() method instead.
4037 *
4038 * @param int $flags An optional bit field; may be Title::GAID_FOR_UPDATE to check
4039 * from master/for update
4040 * @return bool
4041 */
4042 public function exists( $flags = 0 ) {
4043 $exists = $this->getArticleID( $flags ) != 0;
4044 Hooks::run( 'TitleExists', [ $this, &$exists ] );
4045 return $exists;
4046 }
4047
4048 /**
4049 * Should links to this title be shown as potentially viewable (i.e. as
4050 * "bluelinks"), even if there's no record by this title in the page
4051 * table?
4052 *
4053 * This function is semi-deprecated for public use, as well as somewhat
4054 * misleadingly named. You probably just want to call isKnown(), which
4055 * calls this function internally.
4056 *
4057 * (ISSUE: Most of these checks are cheap, but the file existence check
4058 * can potentially be quite expensive. Including it here fixes a lot of
4059 * existing code, but we might want to add an optional parameter to skip
4060 * it and any other expensive checks.)
4061 *
4062 * @return bool
4063 */
4064 public function isAlwaysKnown() {
4065 $isKnown = null;
4066
4067 /**
4068 * Allows overriding default behavior for determining if a page exists.
4069 * If $isKnown is kept as null, regular checks happen. If it's
4070 * a boolean, this value is returned by the isKnown method.
4071 *
4072 * @since 1.20
4073 *
4074 * @param Title $title
4075 * @param bool|null $isKnown
4076 */
4077 Hooks::run( 'TitleIsAlwaysKnown', [ $this, &$isKnown ] );
4078
4079 if ( !is_null( $isKnown ) ) {
4080 return $isKnown;
4081 }
4082
4083 if ( $this->isExternal() ) {
4084 return true; // any interwiki link might be viewable, for all we know
4085 }
4086
4087 $services = MediaWikiServices::getInstance();
4088 switch ( $this->mNamespace ) {
4089 case NS_MEDIA:
4090 case NS_FILE:
4091 // file exists, possibly in a foreign repo
4092 return (bool)$services->getRepoGroup()->findFile( $this );
4093 case NS_SPECIAL:
4094 // valid special page
4095 return $services->getSpecialPageFactory()->exists( $this->mDbkeyform );
4096 case NS_MAIN:
4097 // selflink, possibly with fragment
4098 return $this->mDbkeyform == '';
4099 case NS_MEDIAWIKI:
4100 // known system message
4101 return $this->hasSourceText() !== false;
4102 default:
4103 return false;
4104 }
4105 }
4106
4107 /**
4108 * Does this title refer to a page that can (or might) be meaningfully
4109 * viewed? In particular, this function may be used to determine if
4110 * links to the title should be rendered as "bluelinks" (as opposed to
4111 * "redlinks" to non-existent pages).
4112 * Adding something else to this function will cause inconsistency
4113 * since LinkHolderArray calls isAlwaysKnown() and does its own
4114 * page existence check.
4115 *
4116 * @return bool
4117 */
4118 public function isKnown() {
4119 return $this->isAlwaysKnown() || $this->exists();
4120 }
4121
4122 /**
4123 * Does this page have source text?
4124 *
4125 * @return bool
4126 */
4127 public function hasSourceText() {
4128 if ( $this->exists() ) {
4129 return true;
4130 }
4131
4132 if ( $this->mNamespace == NS_MEDIAWIKI ) {
4133 // If the page doesn't exist but is a known system message, default
4134 // message content will be displayed, same for language subpages-
4135 // Use always content language to avoid loading hundreds of languages
4136 // to get the link color.
4137 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
4138 list( $name, ) = MessageCache::singleton()->figureMessage(
4139 $contLang->lcfirst( $this->getText() )
4140 );
4141 $message = wfMessage( $name )->inLanguage( $contLang )->useDatabase( false );
4142 return $message->exists();
4143 }
4144
4145 return false;
4146 }
4147
4148 /**
4149 * Get the default (plain) message contents for an page that overrides an
4150 * interface message key.
4151 *
4152 * Primary use cases:
4153 *
4154 * - Article:
4155 * - Show default when viewing the page. The Article::getSubstituteContent
4156 * method displays the default message content, instead of the
4157 * 'noarticletext' placeholder message normally used.
4158 *
4159 * - EditPage:
4160 * - Title of edit page. When creating an interface message override,
4161 * the editor is told they are "Editing the page", instead of
4162 * "Creating the page". (EditPage::setHeaders)
4163 * - Edit notice. The 'translateinterface' edit notice is shown when creating
4164 * or editing a an interface message override. (EditPage::showIntro)
4165 * - Opening the editor. The contents of the localisation message are used
4166 * as contents of the editor when creating a new page in the MediaWiki
4167 * namespace. This simplifies the process for editors when "changing"
4168 * an interface message by creating an override. (EditPage::getContentObject)
4169 * - Showing a diff. The left-hand side of a diff when an editor is
4170 * previewing their changes before saving the creation of a page in the
4171 * MediaWiki namespace. (EditPage::showDiff)
4172 * - Disallowing a save. When attempting to create a a MediaWiki-namespace
4173 * page with the proposed content matching the interface message default,
4174 * the save is rejected, the same way we disallow blank pages from being
4175 * created. (EditPage::internalAttemptSave)
4176 *
4177 * - ApiEditPage:
4178 * - Default content, when using the 'prepend' or 'append' feature.
4179 *
4180 * - SkinTemplate:
4181 * - Label the create action as "Edit", if the page can be an override.
4182 *
4183 * @return string|bool
4184 */
4185 public function getDefaultMessageText() {
4186 if ( $this->mNamespace != NS_MEDIAWIKI ) { // Just in case
4187 return false;
4188 }
4189
4190 list( $name, $lang ) = MessageCache::singleton()->figureMessage(
4191 MediaWikiServices::getInstance()->getContentLanguage()->lcfirst( $this->getText() )
4192 );
4193 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4194
4195 if ( $message->exists() ) {
4196 return $message->plain();
4197 } else {
4198 return false;
4199 }
4200 }
4201
4202 /**
4203 * Updates page_touched for this page; called from LinksUpdate.php
4204 *
4205 * @param string|null $purgeTime [optional] TS_MW timestamp
4206 * @return bool True if the update succeeded
4207 */
4208 public function invalidateCache( $purgeTime = null ) {
4209 if ( wfReadOnly() ) {
4210 return false;
4211 } elseif ( $this->mArticleID === 0 ) {
4212 return true; // avoid gap locking if we know it's not there
4213 }
4214
4215 $dbw = wfGetDB( DB_MASTER );
4216 $dbw->onTransactionPreCommitOrIdle(
4217 function () use ( $dbw ) {
4218 ResourceLoaderWikiModule::invalidateModuleCache(
4219 $this, null, null, $dbw->getDomainID() );
4220 },
4221 __METHOD__
4222 );
4223
4224 $conds = $this->pageCond();
4225 DeferredUpdates::addUpdate(
4226 new AutoCommitUpdate(
4227 $dbw,
4228 __METHOD__,
4229 function ( IDatabase $dbw, $fname ) use ( $conds, $purgeTime ) {
4230 $dbTimestamp = $dbw->timestamp( $purgeTime ?: time() );
4231 $dbw->update(
4232 'page',
4233 [ 'page_touched' => $dbTimestamp ],
4234 $conds + [ 'page_touched < ' . $dbw->addQuotes( $dbTimestamp ) ],
4235 $fname
4236 );
4237 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $this );
4238 }
4239 ),
4240 DeferredUpdates::PRESEND
4241 );
4242
4243 return true;
4244 }
4245
4246 /**
4247 * Update page_touched timestamps and send CDN purge messages for
4248 * pages linking to this title. May be sent to the job queue depending
4249 * on the number of links. Typically called on create and delete.
4250 */
4251 public function touchLinks() {
4252 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this, 'pagelinks', 'page-touch' ) );
4253 if ( $this->mNamespace == NS_CATEGORY ) {
4254 DeferredUpdates::addUpdate(
4255 new HTMLCacheUpdate( $this, 'categorylinks', 'category-touch' )
4256 );
4257 }
4258 }
4259
4260 /**
4261 * Get the last touched timestamp
4262 *
4263 * @param IDatabase|null $db
4264 * @return string|false Last-touched timestamp
4265 */
4266 public function getTouched( $db = null ) {
4267 if ( $db === null ) {
4268 $db = wfGetDB( DB_REPLICA );
4269 }
4270 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
4271 return $touched;
4272 }
4273
4274 /**
4275 * Get the timestamp when this page was updated since the user last saw it.
4276 *
4277 * @param User|null $user
4278 * @return string|bool|null String timestamp, false if not watched, null if nothing is unseen
4279 */
4280 public function getNotificationTimestamp( $user = null ) {
4281 global $wgUser;
4282
4283 // Assume current user if none given
4284 if ( !$user ) {
4285 $user = $wgUser;
4286 }
4287 // Check cache first
4288 $uid = $user->getId();
4289 if ( !$uid ) {
4290 return false;
4291 }
4292 // avoid isset here, as it'll return false for null entries
4293 if ( array_key_exists( $uid, $this->mNotificationTimestamp ) ) {
4294 return $this->mNotificationTimestamp[$uid];
4295 }
4296 // Don't cache too much!
4297 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
4298 $this->mNotificationTimestamp = [];
4299 }
4300
4301 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
4302 $watchedItem = $store->getWatchedItem( $user, $this );
4303 if ( $watchedItem ) {
4304 $this->mNotificationTimestamp[$uid] = $watchedItem->getNotificationTimestamp();
4305 } else {
4306 $this->mNotificationTimestamp[$uid] = false;
4307 }
4308
4309 return $this->mNotificationTimestamp[$uid];
4310 }
4311
4312 /**
4313 * Generate strings used for xml 'id' names in monobook tabs
4314 *
4315 * @param string $prepend Defaults to 'nstab-'
4316 * @return string XML 'id' name
4317 */
4318 public function getNamespaceKey( $prepend = 'nstab-' ) {
4319 // Gets the subject namespace of this title
4320 $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
4321 $subjectNS = $nsInfo->getSubject( $this->mNamespace );
4322 // Prefer canonical namespace name for HTML IDs
4323 $namespaceKey = $nsInfo->getCanonicalName( $subjectNS );
4324 if ( $namespaceKey === false ) {
4325 // Fallback to localised text
4326 $namespaceKey = $this->getSubjectNsText();
4327 }
4328 // Makes namespace key lowercase
4329 $namespaceKey = MediaWikiServices::getInstance()->getContentLanguage()->lc( $namespaceKey );
4330 // Uses main
4331 if ( $namespaceKey == '' ) {
4332 $namespaceKey = 'main';
4333 }
4334 // Changes file to image for backwards compatibility
4335 if ( $namespaceKey == 'file' ) {
4336 $namespaceKey = 'image';
4337 }
4338 return $prepend . $namespaceKey;
4339 }
4340
4341 /**
4342 * Get all extant redirects to this Title
4343 *
4344 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4345 * @return Title[] Array of Title redirects to this title
4346 */
4347 public function getRedirectsHere( $ns = null ) {
4348 $redirs = [];
4349
4350 $dbr = wfGetDB( DB_REPLICA );
4351 $where = [
4352 'rd_namespace' => $this->mNamespace,
4353 'rd_title' => $this->mDbkeyform,
4354 'rd_from = page_id'
4355 ];
4356 if ( $this->isExternal() ) {
4357 $where['rd_interwiki'] = $this->mInterwiki;
4358 } else {
4359 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4360 }
4361 if ( !is_null( $ns ) ) {
4362 $where['page_namespace'] = $ns;
4363 }
4364
4365 $res = $dbr->select(
4366 [ 'redirect', 'page' ],
4367 [ 'page_namespace', 'page_title' ],
4368 $where,
4369 __METHOD__
4370 );
4371
4372 foreach ( $res as $row ) {
4373 $redirs[] = self::newFromRow( $row );
4374 }
4375 return $redirs;
4376 }
4377
4378 /**
4379 * Check if this Title is a valid redirect target
4380 *
4381 * @return bool
4382 */
4383 public function isValidRedirectTarget() {
4384 global $wgInvalidRedirectTargets;
4385
4386 if ( $this->isSpecialPage() ) {
4387 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4388 if ( $this->isSpecial( 'Userlogout' ) ) {
4389 return false;
4390 }
4391
4392 foreach ( $wgInvalidRedirectTargets as $target ) {
4393 if ( $this->isSpecial( $target ) ) {
4394 return false;
4395 }
4396 }
4397 }
4398
4399 return true;
4400 }
4401
4402 /**
4403 * Get a backlink cache object
4404 *
4405 * @return BacklinkCache
4406 */
4407 public function getBacklinkCache() {
4408 return BacklinkCache::get( $this );
4409 }
4410
4411 /**
4412 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4413 *
4414 * @return bool
4415 */
4416 public function canUseNoindex() {
4417 global $wgExemptFromUserRobotsControl;
4418
4419 $bannedNamespaces = $wgExemptFromUserRobotsControl ??
4420 MediaWikiServices::getInstance()->getNamespaceInfo()->getContentNamespaces();
4421
4422 return !in_array( $this->mNamespace, $bannedNamespaces );
4423 }
4424
4425 /**
4426 * Returns the raw sort key to be used for categories, with the specified
4427 * prefix. This will be fed to Collation::getSortKey() to get a
4428 * binary sortkey that can be used for actual sorting.
4429 *
4430 * @param string $prefix The prefix to be used, specified using
4431 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4432 * prefix.
4433 * @return string
4434 */
4435 public function getCategorySortkey( $prefix = '' ) {
4436 $unprefixed = $this->getText();
4437
4438 // Anything that uses this hook should only depend
4439 // on the Title object passed in, and should probably
4440 // tell the users to run updateCollations.php --force
4441 // in order to re-sort existing category relations.
4442 Hooks::run( 'GetDefaultSortkey', [ $this, &$unprefixed ] );
4443 if ( $prefix !== '' ) {
4444 # Separate with a line feed, so the unprefixed part is only used as
4445 # a tiebreaker when two pages have the exact same prefix.
4446 # In UCA, tab is the only character that can sort above LF
4447 # so we strip both of them from the original prefix.
4448 $prefix = strtr( $prefix, "\n\t", ' ' );
4449 return "$prefix\n$unprefixed";
4450 }
4451 return $unprefixed;
4452 }
4453
4454 /**
4455 * Returns the page language code saved in the database, if $wgPageLanguageUseDB is set
4456 * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
4457 * the db, it will return NULL.
4458 *
4459 * @return string|null|bool
4460 */
4461 private function getDbPageLanguageCode() {
4462 global $wgPageLanguageUseDB;
4463
4464 // check, if the page language could be saved in the database, and if so and
4465 // the value is not requested already, lookup the page language using LinkCache
4466 if ( $wgPageLanguageUseDB && $this->mDbPageLanguage === false ) {
4467 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
4468 $linkCache->addLinkObj( $this );
4469 $this->mDbPageLanguage = $linkCache->getGoodLinkFieldObj( $this, 'lang' );
4470 }
4471
4472 return $this->mDbPageLanguage;
4473 }
4474
4475 /**
4476 * Get the language in which the content of this page is written in
4477 * wikitext. Defaults to content language, but in certain cases it can be
4478 * e.g. $wgLang (such as special pages, which are in the user language).
4479 *
4480 * @since 1.18
4481 * @return Language
4482 */
4483 public function getPageLanguage() {
4484 global $wgLang, $wgLanguageCode;
4485 if ( $this->isSpecialPage() ) {
4486 // special pages are in the user language
4487 return $wgLang;
4488 }
4489
4490 // Checking if DB language is set
4491 $dbPageLanguage = $this->getDbPageLanguageCode();
4492 if ( $dbPageLanguage ) {
4493 return wfGetLangObj( $dbPageLanguage );
4494 }
4495
4496 if ( !$this->mPageLanguage || $this->mPageLanguage[1] !== $wgLanguageCode ) {
4497 // Note that this may depend on user settings, so the cache should
4498 // be only per-request.
4499 // NOTE: ContentHandler::getPageLanguage() may need to load the
4500 // content to determine the page language!
4501 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4502 // tests.
4503 $contentHandler = ContentHandler::getForTitle( $this );
4504 $langObj = $contentHandler->getPageLanguage( $this );
4505 $this->mPageLanguage = [ $langObj->getCode(), $wgLanguageCode ];
4506 } else {
4507 $langObj = Language::factory( $this->mPageLanguage[0] );
4508 }
4509
4510 return $langObj;
4511 }
4512
4513 /**
4514 * Get the language in which the content of this page is written when
4515 * viewed by user. Defaults to content language, but in certain cases it can be
4516 * e.g. $wgLang (such as special pages, which are in the user language).
4517 *
4518 * @since 1.20
4519 * @return Language
4520 */
4521 public function getPageViewLanguage() {
4522 global $wgLang;
4523
4524 if ( $this->isSpecialPage() ) {
4525 // If the user chooses a variant, the content is actually
4526 // in a language whose code is the variant code.
4527 $variant = $wgLang->getPreferredVariant();
4528 if ( $wgLang->getCode() !== $variant ) {
4529 return Language::factory( $variant );
4530 }
4531
4532 return $wgLang;
4533 }
4534
4535 // Checking if DB language is set
4536 $dbPageLanguage = $this->getDbPageLanguageCode();
4537 if ( $dbPageLanguage ) {
4538 $pageLang = wfGetLangObj( $dbPageLanguage );
4539 $variant = $pageLang->getPreferredVariant();
4540 if ( $pageLang->getCode() !== $variant ) {
4541 $pageLang = Language::factory( $variant );
4542 }
4543
4544 return $pageLang;
4545 }
4546
4547 // @note Can't be cached persistently, depends on user settings.
4548 // @note ContentHandler::getPageViewLanguage() may need to load the
4549 // content to determine the page language!
4550 $contentHandler = ContentHandler::getForTitle( $this );
4551 $pageLang = $contentHandler->getPageViewLanguage( $this );
4552 return $pageLang;
4553 }
4554
4555 /**
4556 * Get a list of rendered edit notices for this page.
4557 *
4558 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4559 * they will already be wrapped in paragraphs.
4560 *
4561 * @since 1.21
4562 * @param int $oldid Revision ID that's being edited
4563 * @return array
4564 */
4565 public function getEditNotices( $oldid = 0 ) {
4566 $notices = [];
4567
4568 // Optional notice for the entire namespace
4569 $editnotice_ns = 'editnotice-' . $this->mNamespace;
4570 $msg = wfMessage( $editnotice_ns );
4571 if ( $msg->exists() ) {
4572 $html = $msg->parseAsBlock();
4573 // Edit notices may have complex logic, but output nothing (T91715)
4574 if ( trim( $html ) !== '' ) {
4575 $notices[$editnotice_ns] = Html::rawElement(
4576 'div',
4577 [ 'class' => [
4578 'mw-editnotice',
4579 'mw-editnotice-namespace',
4580 Sanitizer::escapeClass( "mw-$editnotice_ns" )
4581 ] ],
4582 $html
4583 );
4584 }
4585 }
4586
4587 if (
4588 MediaWikiServices::getInstance()->getNamespaceInfo()->
4589 hasSubpages( $this->mNamespace )
4590 ) {
4591 // Optional notice for page itself and any parent page
4592 $editnotice_base = $editnotice_ns;
4593 foreach ( explode( '/', $this->mDbkeyform ) as $part ) {
4594 $editnotice_base .= '-' . $part;
4595 $msg = wfMessage( $editnotice_base );
4596 if ( $msg->exists() ) {
4597 $html = $msg->parseAsBlock();
4598 if ( trim( $html ) !== '' ) {
4599 $notices[$editnotice_base] = Html::rawElement(
4600 'div',
4601 [ 'class' => [
4602 'mw-editnotice',
4603 'mw-editnotice-base',
4604 Sanitizer::escapeClass( "mw-$editnotice_base" )
4605 ] ],
4606 $html
4607 );
4608 }
4609 }
4610 }
4611 } else {
4612 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
4613 $editnoticeText = $editnotice_ns . '-' . strtr( $this->mDbkeyform, '/', '-' );
4614 $msg = wfMessage( $editnoticeText );
4615 if ( $msg->exists() ) {
4616 $html = $msg->parseAsBlock();
4617 if ( trim( $html ) !== '' ) {
4618 $notices[$editnoticeText] = Html::rawElement(
4619 'div',
4620 [ 'class' => [
4621 'mw-editnotice',
4622 'mw-editnotice-page',
4623 Sanitizer::escapeClass( "mw-$editnoticeText" )
4624 ] ],
4625 $html
4626 );
4627 }
4628 }
4629 }
4630
4631 Hooks::run( 'TitleGetEditNotices', [ $this, $oldid, &$notices ] );
4632 return $notices;
4633 }
4634
4635 /**
4636 * @return array
4637 */
4638 public function __sleep() {
4639 return [
4640 'mNamespace',
4641 'mDbkeyform',
4642 'mFragment',
4643 'mInterwiki',
4644 'mLocalInterwiki',
4645 'mUserCaseDBKey',
4646 'mDefaultNamespace',
4647 ];
4648 }
4649
4650 public function __wakeup() {
4651 $this->mArticleID = ( $this->mNamespace >= 0 ) ? -1 : 0;
4652 $this->mUrlform = wfUrlencode( $this->mDbkeyform );
4653 $this->mTextform = strtr( $this->mDbkeyform, '_', ' ' );
4654 }
4655
4656 }