Clean up spacing of doc comments
[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 bool The (string) language code of the page's language and content code. */
182 private $mPageLanguage = false;
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 */
1254 public function inNamespaces( /* ... */ ) {
1255 $namespaces = func_get_args();
1256 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1257 $namespaces = $namespaces[0];
1258 }
1259
1260 foreach ( $namespaces as $ns ) {
1261 if ( $this->inNamespace( $ns ) ) {
1262 return true;
1263 }
1264 }
1265
1266 return false;
1267 }
1268
1269 /**
1270 * Returns true if the title has the same subject namespace as the
1271 * namespace specified.
1272 * For example this method will take NS_USER and return true if namespace
1273 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1274 * as their subject namespace.
1275 *
1276 * This is MUCH simpler than individually testing for equivalence
1277 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1278 * @since 1.19
1279 * @param int $ns
1280 * @return bool
1281 */
1282 public function hasSubjectNamespace( $ns ) {
1283 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1284 subjectEquals( $this->mNamespace, $ns );
1285 }
1286
1287 /**
1288 * Is this Title in a namespace which contains content?
1289 * In other words, is this a content page, for the purposes of calculating
1290 * statistics, etc?
1291 *
1292 * @return bool
1293 */
1294 public function isContentPage() {
1295 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1296 isContent( $this->mNamespace );
1297 }
1298
1299 /**
1300 * Would anybody with sufficient privileges be able to move this page?
1301 * Some pages just aren't movable.
1302 *
1303 * @return bool
1304 */
1305 public function isMovable() {
1306 if (
1307 !MediaWikiServices::getInstance()->getNamespaceInfo()->
1308 isMovable( $this->mNamespace ) || $this->isExternal()
1309 ) {
1310 // Interwiki title or immovable namespace. Hooks don't get to override here
1311 return false;
1312 }
1313
1314 $result = true;
1315 Hooks::run( 'TitleIsMovable', [ $this, &$result ] );
1316 return $result;
1317 }
1318
1319 /**
1320 * Is this the mainpage?
1321 * @note Title::newFromText seems to be sufficiently optimized by the title
1322 * cache that we don't need to over-optimize by doing direct comparisons and
1323 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1324 * ends up reporting something differently than $title->isMainPage();
1325 *
1326 * @since 1.18
1327 * @return bool
1328 */
1329 public function isMainPage() {
1330 return $this->equals( self::newMainPage() );
1331 }
1332
1333 /**
1334 * Is this a subpage?
1335 *
1336 * @return bool
1337 */
1338 public function isSubpage() {
1339 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1340 hasSubpages( $this->mNamespace )
1341 ? strpos( $this->getText(), '/' ) !== false
1342 : false;
1343 }
1344
1345 /**
1346 * Is this a conversion table for the LanguageConverter?
1347 *
1348 * @return bool
1349 */
1350 public function isConversionTable() {
1351 // @todo ConversionTable should become a separate content model.
1352
1353 return $this->mNamespace == NS_MEDIAWIKI &&
1354 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1355 }
1356
1357 /**
1358 * Does that page contain wikitext, or it is JS, CSS or whatever?
1359 *
1360 * @return bool
1361 */
1362 public function isWikitextPage() {
1363 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT );
1364 }
1365
1366 /**
1367 * Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the
1368 * global UI. This is generally true for pages in the MediaWiki namespace having
1369 * CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
1370 *
1371 * This method does *not* return true for per-user JS/JSON/CSS. Use isUserConfigPage()
1372 * for that!
1373 *
1374 * Note that this method should not return true for pages that contain and show
1375 * "inactive" CSS, JSON, or JS.
1376 *
1377 * @return bool
1378 * @since 1.31
1379 */
1380 public function isSiteConfigPage() {
1381 return (
1382 $this->isSiteCssConfigPage()
1383 || $this->isSiteJsonConfigPage()
1384 || $this->isSiteJsConfigPage()
1385 );
1386 }
1387
1388 /**
1389 * Is this a "config" (.css, .json, or .js) sub-page of a user page?
1390 *
1391 * @return bool
1392 * @since 1.31
1393 */
1394 public function isUserConfigPage() {
1395 return (
1396 $this->isUserCssConfigPage()
1397 || $this->isUserJsonConfigPage()
1398 || $this->isUserJsConfigPage()
1399 );
1400 }
1401
1402 /**
1403 * Trim down a .css, .json, or .js subpage title to get the corresponding skin name
1404 *
1405 * @return string Containing skin name from .css, .json, or .js subpage title
1406 * @since 1.31
1407 */
1408 public function getSkinFromConfigSubpage() {
1409 $subpage = explode( '/', $this->mTextform );
1410 $subpage = $subpage[count( $subpage ) - 1];
1411 $lastdot = strrpos( $subpage, '.' );
1412 if ( $lastdot === false ) {
1413 return $subpage; # Never happens: only called for names ending in '.css'/'.json'/'.js'
1414 }
1415 return substr( $subpage, 0, $lastdot );
1416 }
1417
1418 /**
1419 * Is this a CSS "config" sub-page of a user page?
1420 *
1421 * @return bool
1422 * @since 1.31
1423 */
1424 public function isUserCssConfigPage() {
1425 return (
1426 NS_USER == $this->mNamespace
1427 && $this->isSubpage()
1428 && $this->hasContentModel( CONTENT_MODEL_CSS )
1429 );
1430 }
1431
1432 /**
1433 * Is this a JSON "config" sub-page of a user page?
1434 *
1435 * @return bool
1436 * @since 1.31
1437 */
1438 public function isUserJsonConfigPage() {
1439 return (
1440 NS_USER == $this->mNamespace
1441 && $this->isSubpage()
1442 && $this->hasContentModel( CONTENT_MODEL_JSON )
1443 );
1444 }
1445
1446 /**
1447 * Is this a JS "config" sub-page of a user page?
1448 *
1449 * @return bool
1450 * @since 1.31
1451 */
1452 public function isUserJsConfigPage() {
1453 return (
1454 NS_USER == $this->mNamespace
1455 && $this->isSubpage()
1456 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT )
1457 );
1458 }
1459
1460 /**
1461 * Is this a sitewide CSS "config" page?
1462 *
1463 * @return bool
1464 * @since 1.32
1465 */
1466 public function isSiteCssConfigPage() {
1467 return (
1468 NS_MEDIAWIKI == $this->mNamespace
1469 && (
1470 $this->hasContentModel( CONTENT_MODEL_CSS )
1471 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1472 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1473 || substr( $this->mDbkeyform, -4 ) === '.css'
1474 )
1475 );
1476 }
1477
1478 /**
1479 * Is this a sitewide JSON "config" page?
1480 *
1481 * @return bool
1482 * @since 1.32
1483 */
1484 public function isSiteJsonConfigPage() {
1485 return (
1486 NS_MEDIAWIKI == $this->mNamespace
1487 && (
1488 $this->hasContentModel( CONTENT_MODEL_JSON )
1489 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1490 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1491 || substr( $this->mDbkeyform, -5 ) === '.json'
1492 )
1493 );
1494 }
1495
1496 /**
1497 * Is this a sitewide JS "config" page?
1498 *
1499 * @return bool
1500 * @since 1.31
1501 */
1502 public function isSiteJsConfigPage() {
1503 return (
1504 NS_MEDIAWIKI == $this->mNamespace
1505 && (
1506 $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT )
1507 // paranoia - a MediaWiki: namespace page with mismatching extension and content
1508 // model is probably by mistake and might get handled incorrectly (see e.g. T112937)
1509 || substr( $this->mDbkeyform, -3 ) === '.js'
1510 )
1511 );
1512 }
1513
1514 /**
1515 * Is this a message which can contain raw HTML?
1516 *
1517 * @return bool
1518 * @since 1.32
1519 */
1520 public function isRawHtmlMessage() {
1521 global $wgRawHtmlMessages;
1522
1523 if ( !$this->inNamespace( NS_MEDIAWIKI ) ) {
1524 return false;
1525 }
1526 $message = lcfirst( $this->getRootTitle()->getDBkey() );
1527 return in_array( $message, $wgRawHtmlMessages, true );
1528 }
1529
1530 /**
1531 * Is this a talk page of some sort?
1532 *
1533 * @return bool
1534 */
1535 public function isTalkPage() {
1536 return MediaWikiServices::getInstance()->getNamespaceInfo()->
1537 isTalk( $this->mNamespace );
1538 }
1539
1540 /**
1541 * Get a Title object associated with the talk page of this article
1542 *
1543 * @deprecated since 1.34, use getTalkPageIfDefined() or NamespaceInfo::getTalkPage()
1544 * with NamespaceInfo::canHaveTalkPage().
1545 * @return Title The object for the talk page
1546 * @throws MWException if $target doesn't have talk pages, e.g. because it's in NS_SPECIAL
1547 * or because it's a relative link, or an interwiki link.
1548 */
1549 public function getTalkPage() {
1550 return self::castFromLinkTarget(
1551 MediaWikiServices::getInstance()->getNamespaceInfo()->getTalkPage( $this ) );
1552 }
1553
1554 /**
1555 * Get a Title object associated with the talk page of this article,
1556 * if such a talk page can exist.
1557 *
1558 * @since 1.30
1559 *
1560 * @return Title|null The object for the talk page,
1561 * or null if no associated talk page can exist, according to canHaveTalkPage().
1562 */
1563 public function getTalkPageIfDefined() {
1564 if ( !$this->canHaveTalkPage() ) {
1565 return null;
1566 }
1567
1568 return $this->getTalkPage();
1569 }
1570
1571 /**
1572 * Get a title object associated with the subject page of this
1573 * talk page
1574 *
1575 * @deprecated since 1.34, use NamespaceInfo::getSubjectPage
1576 * @return Title The object for the subject page
1577 */
1578 public function getSubjectPage() {
1579 return self::castFromLinkTarget(
1580 MediaWikiServices::getInstance()->getNamespaceInfo()->getSubjectPage( $this ) );
1581 }
1582
1583 /**
1584 * Get the other title for this page, if this is a subject page
1585 * get the talk page, if it is a subject page get the talk page
1586 *
1587 * @deprecated since 1.34, use NamespaceInfo::getAssociatedPage
1588 * @since 1.25
1589 * @throws MWException If the page doesn't have an other page
1590 * @return Title
1591 */
1592 public function getOtherPage() {
1593 return self::castFromLinkTarget(
1594 MediaWikiServices::getInstance()->getNamespaceInfo()->getAssociatedPage( $this ) );
1595 }
1596
1597 /**
1598 * Get the default namespace index, for when there is no namespace
1599 *
1600 * @return int Default namespace index
1601 */
1602 public function getDefaultNamespace() {
1603 return $this->mDefaultNamespace;
1604 }
1605
1606 /**
1607 * Get the Title fragment (i.e.\ the bit after the #) in text form
1608 *
1609 * Use Title::hasFragment to check for a fragment
1610 *
1611 * @return string Title fragment
1612 */
1613 public function getFragment() {
1614 return $this->mFragment;
1615 }
1616
1617 /**
1618 * Check if a Title fragment is set
1619 *
1620 * @return bool
1621 * @since 1.23
1622 */
1623 public function hasFragment() {
1624 return $this->mFragment !== '';
1625 }
1626
1627 /**
1628 * Get the fragment in URL form, including the "#" character if there is one
1629 *
1630 * @return string Fragment in URL form
1631 */
1632 public function getFragmentForURL() {
1633 if ( !$this->hasFragment() ) {
1634 return '';
1635 } elseif ( $this->isExternal() ) {
1636 // Note: If the interwiki is unknown, it's treated as a namespace on the local wiki,
1637 // so we treat it like a local interwiki.
1638 $interwiki = self::getInterwikiLookup()->fetch( $this->mInterwiki );
1639 if ( $interwiki && !$interwiki->isLocal() ) {
1640 return '#' . Sanitizer::escapeIdForExternalInterwiki( $this->mFragment );
1641 }
1642 }
1643
1644 return '#' . Sanitizer::escapeIdForLink( $this->mFragment );
1645 }
1646
1647 /**
1648 * Set the fragment for this title. Removes the first character from the
1649 * specified fragment before setting, so it assumes you're passing it with
1650 * an initial "#".
1651 *
1652 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1653 * or Title::createFragmentTarget().
1654 * Still in active use privately.
1655 *
1656 * @private
1657 * @param string $fragment Text
1658 */
1659 public function setFragment( $fragment ) {
1660 $this->mFragment = strtr( substr( $fragment, 1 ), '_', ' ' );
1661 }
1662
1663 /**
1664 * Creates a new Title for a different fragment of the same page.
1665 *
1666 * @since 1.27
1667 * @param string $fragment
1668 * @return Title
1669 */
1670 public function createFragmentTarget( $fragment ) {
1671 return self::makeTitle(
1672 $this->mNamespace,
1673 $this->getText(),
1674 $fragment,
1675 $this->mInterwiki
1676 );
1677 }
1678
1679 /**
1680 * Prefix some arbitrary text with the namespace or interwiki prefix
1681 * of this object
1682 *
1683 * @param string $name The text
1684 * @return string The prefixed text
1685 */
1686 private function prefix( $name ) {
1687 $p = '';
1688 if ( $this->isExternal() ) {
1689 $p = $this->mInterwiki . ':';
1690 }
1691
1692 if ( $this->mNamespace != 0 ) {
1693 $nsText = $this->getNsText();
1694
1695 if ( $nsText === false ) {
1696 // See T165149. Awkward, but better than erroneously linking to the main namespace.
1697 $nsText = MediaWikiServices::getInstance()->getContentLanguage()->
1698 getNsText( NS_SPECIAL ) . ":Badtitle/NS{$this->mNamespace}";
1699 }
1700
1701 $p .= $nsText . ':';
1702 }
1703 return $p . $name;
1704 }
1705
1706 /**
1707 * Get the prefixed database key form
1708 *
1709 * @return string The prefixed title, with underscores and
1710 * any interwiki and namespace prefixes
1711 */
1712 public function getPrefixedDBkey() {
1713 $s = $this->prefix( $this->mDbkeyform );
1714 $s = strtr( $s, ' ', '_' );
1715 return $s;
1716 }
1717
1718 /**
1719 * Get the prefixed title with spaces.
1720 * This is the form usually used for display
1721 *
1722 * @return string The prefixed title, with spaces
1723 */
1724 public function getPrefixedText() {
1725 if ( $this->prefixedText === null ) {
1726 $s = $this->prefix( $this->mTextform );
1727 $s = strtr( $s, '_', ' ' );
1728 $this->prefixedText = $s;
1729 }
1730 return $this->prefixedText;
1731 }
1732
1733 /**
1734 * Return a string representation of this title
1735 *
1736 * @return string Representation of this title
1737 */
1738 public function __toString() {
1739 return $this->getPrefixedText();
1740 }
1741
1742 /**
1743 * Get the prefixed title with spaces, plus any fragment
1744 * (part beginning with '#')
1745 *
1746 * @return string The prefixed title, with spaces and the fragment, including '#'
1747 */
1748 public function getFullText() {
1749 $text = $this->getPrefixedText();
1750 if ( $this->hasFragment() ) {
1751 $text .= '#' . $this->mFragment;
1752 }
1753 return $text;
1754 }
1755
1756 /**
1757 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1758 *
1759 * @note the return value may contain trailing whitespace and is thus
1760 * not safe for use with makeTitle or TitleValue.
1761 *
1762 * @par Example:
1763 * @code
1764 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1765 * # returns: 'Foo'
1766 * @endcode
1767 *
1768 * @return string Root name
1769 * @since 1.20
1770 */
1771 public function getRootText() {
1772 if (
1773 !MediaWikiServices::getInstance()->getNamespaceInfo()->
1774 hasSubpages( $this->mNamespace )
1775 || strtok( $this->getText(), '/' ) === false
1776 ) {
1777 return $this->getText();
1778 }
1779
1780 return strtok( $this->getText(), '/' );
1781 }
1782
1783 /**
1784 * Get the root page name title, i.e. the leftmost part before any slashes
1785 *
1786 * @par Example:
1787 * @code
1788 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1789 * # returns: Title{User:Foo}
1790 * @endcode
1791 *
1792 * @return Title Root title
1793 * @since 1.20
1794 */
1795 public function getRootTitle() {
1796 $title = self::makeTitleSafe( $this->mNamespace, $this->getRootText() );
1797 Assert::postcondition(
1798 $title !== null,
1799 'makeTitleSafe() should always return a Title for the text returned by getRootText().'
1800 );
1801 return $title;
1802 }
1803
1804 /**
1805 * Get the base page name without a namespace, i.e. the part before the subpage name
1806 *
1807 * @note the return value may contain trailing whitespace and is thus
1808 * not safe for use with makeTitle or TitleValue.
1809 *
1810 * @par Example:
1811 * @code
1812 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1813 * # returns: 'Foo/Bar'
1814 * @endcode
1815 *
1816 * @return string Base name
1817 */
1818 public function getBaseText() {
1819 $text = $this->getText();
1820 if (
1821 !MediaWikiServices::getInstance()->getNamespaceInfo()->
1822 hasSubpages( $this->mNamespace )
1823 ) {
1824 return $text;
1825 }
1826
1827 $lastSlashPos = strrpos( $text, '/' );
1828 // Don't discard the real title if there's no subpage involved
1829 if ( $lastSlashPos === false ) {
1830 return $text;
1831 }
1832
1833 return substr( $text, 0, $lastSlashPos );
1834 }
1835
1836 /**
1837 * Get the base page name title, i.e. the part before the subpage name.
1838 *
1839 * @par Example:
1840 * @code
1841 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1842 * # returns: Title{User:Foo/Bar}
1843 * @endcode
1844 *
1845 * @return Title Base title
1846 * @since 1.20
1847 */
1848 public function getBaseTitle() {
1849 $title = self::makeTitleSafe( $this->mNamespace, $this->getBaseText() );
1850 Assert::postcondition(
1851 $title !== null,
1852 'makeTitleSafe() should always return a Title for the text returned by getBaseText().'
1853 );
1854 return $title;
1855 }
1856
1857 /**
1858 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1859 *
1860 * @par Example:
1861 * @code
1862 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1863 * # returns: "Baz"
1864 * @endcode
1865 *
1866 * @return string Subpage name
1867 */
1868 public function getSubpageText() {
1869 if (
1870 !MediaWikiServices::getInstance()->getNamespaceInfo()->
1871 hasSubpages( $this->mNamespace )
1872 ) {
1873 return $this->mTextform;
1874 }
1875 $parts = explode( '/', $this->mTextform );
1876 return $parts[count( $parts ) - 1];
1877 }
1878
1879 /**
1880 * Get the title for a subpage of the current page
1881 *
1882 * @par Example:
1883 * @code
1884 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1885 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1886 * @endcode
1887 *
1888 * @param string $text The subpage name to add to the title
1889 * @return Title|null Subpage title, or null on an error
1890 * @since 1.20
1891 */
1892 public function getSubpage( $text ) {
1893 return self::makeTitleSafe(
1894 $this->mNamespace,
1895 $this->getText() . '/' . $text,
1896 '',
1897 $this->mInterwiki
1898 );
1899 }
1900
1901 /**
1902 * Get a URL-encoded form of the subpage text
1903 *
1904 * @return string URL-encoded subpage name
1905 */
1906 public function getSubpageUrlForm() {
1907 $text = $this->getSubpageText();
1908 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1909 return $text;
1910 }
1911
1912 /**
1913 * Get a URL-encoded title (not an actual URL) including interwiki
1914 *
1915 * @return string The URL-encoded form
1916 */
1917 public function getPrefixedURL() {
1918 $s = $this->prefix( $this->mDbkeyform );
1919 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1920 return $s;
1921 }
1922
1923 /**
1924 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1925 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1926 * second argument named variant. This was deprecated in favor
1927 * of passing an array of option with a "variant" key
1928 * Once $query2 is removed for good, this helper can be dropped
1929 * and the wfArrayToCgi moved to getLocalURL();
1930 *
1931 * @since 1.19 (r105919)
1932 * @param array|string $query
1933 * @param string|string[]|bool $query2
1934 * @return string
1935 */
1936 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1937 if ( $query2 !== false ) {
1938 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1939 "method called with a second parameter is deprecated. Add your " .
1940 "parameter to an array passed as the first parameter.", "1.19" );
1941 }
1942 if ( is_array( $query ) ) {
1943 $query = wfArrayToCgi( $query );
1944 }
1945 if ( $query2 ) {
1946 if ( is_string( $query2 ) ) {
1947 // $query2 is a string, we will consider this to be
1948 // a deprecated $variant argument and add it to the query
1949 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1950 } else {
1951 $query2 = wfArrayToCgi( $query2 );
1952 }
1953 // If we have $query content add a & to it first
1954 if ( $query ) {
1955 $query .= '&';
1956 }
1957 // Now append the queries together
1958 $query .= $query2;
1959 }
1960 return $query;
1961 }
1962
1963 /**
1964 * Get a real URL referring to this title, with interwiki link and
1965 * fragment
1966 *
1967 * @see self::getLocalURL for the arguments.
1968 * @see wfExpandUrl
1969 * @param string|string[] $query
1970 * @param string|string[]|bool $query2
1971 * @param string|int|null $proto Protocol type to use in URL
1972 * @return string The URL
1973 */
1974 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1975 $query = self::fixUrlQueryArgs( $query, $query2 );
1976
1977 # Hand off all the decisions on urls to getLocalURL
1978 $url = $this->getLocalURL( $query );
1979
1980 # Expand the url to make it a full url. Note that getLocalURL has the
1981 # potential to output full urls for a variety of reasons, so we use
1982 # wfExpandUrl instead of simply prepending $wgServer
1983 $url = wfExpandUrl( $url, $proto );
1984
1985 # Finally, add the fragment.
1986 $url .= $this->getFragmentForURL();
1987 // Avoid PHP 7.1 warning from passing $this by reference
1988 $titleRef = $this;
1989 Hooks::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
1990 return $url;
1991 }
1992
1993 /**
1994 * Get a url appropriate for making redirects based on an untrusted url arg
1995 *
1996 * This is basically the same as getFullUrl(), but in the case of external
1997 * interwikis, we send the user to a landing page, to prevent possible
1998 * phishing attacks and the like.
1999 *
2000 * @note Uses current protocol by default, since technically relative urls
2001 * aren't allowed in redirects per HTTP spec, so this is not suitable for
2002 * places where the url gets cached, as might pollute between
2003 * https and non-https users.
2004 * @see self::getLocalURL for the arguments.
2005 * @param array|string $query
2006 * @param string $proto Protocol type to use in URL
2007 * @return string A url suitable to use in an HTTP location header.
2008 */
2009 public function getFullUrlForRedirect( $query = '', $proto = PROTO_CURRENT ) {
2010 $target = $this;
2011 if ( $this->isExternal() ) {
2012 $target = SpecialPage::getTitleFor(
2013 'GoToInterwiki',
2014 $this->getPrefixedDBkey()
2015 );
2016 }
2017 return $target->getFullURL( $query, false, $proto );
2018 }
2019
2020 /**
2021 * Get a URL with no fragment or server name (relative URL) from a Title object.
2022 * If this page is generated with action=render, however,
2023 * $wgServer is prepended to make an absolute URL.
2024 *
2025 * @see self::getFullURL to always get an absolute URL.
2026 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
2027 * valid to link, locally, to the current Title.
2028 * @see self::newFromText to produce a Title object.
2029 *
2030 * @param string|string[] $query An optional query string,
2031 * not used for interwiki links. Can be specified as an associative array as well,
2032 * e.g., [ 'action' => 'edit' ] (keys and values will be URL-escaped).
2033 * Some query patterns will trigger various shorturl path replacements.
2034 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
2035 * be an array. If a string is passed it will be interpreted as a deprecated
2036 * variant argument and urlencoded into a variant= argument.
2037 * This second query argument will be added to the $query
2038 * The second parameter is deprecated since 1.19. Pass it as a key,value
2039 * pair in the first parameter array instead.
2040 *
2041 * @return string String of the URL.
2042 */
2043 public function getLocalURL( $query = '', $query2 = false ) {
2044 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
2045
2046 $query = self::fixUrlQueryArgs( $query, $query2 );
2047
2048 $interwiki = self::getInterwikiLookup()->fetch( $this->mInterwiki );
2049 if ( $interwiki ) {
2050 $namespace = $this->getNsText();
2051 if ( $namespace != '' ) {
2052 # Can this actually happen? Interwikis shouldn't be parsed.
2053 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
2054 $namespace .= ':';
2055 }
2056 $url = $interwiki->getURL( $namespace . $this->mDbkeyform );
2057 $url = wfAppendQuery( $url, $query );
2058 } else {
2059 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
2060 if ( $query == '' ) {
2061 $url = str_replace( '$1', $dbkey, $wgArticlePath );
2062 // Avoid PHP 7.1 warning from passing $this by reference
2063 $titleRef = $this;
2064 Hooks::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
2065 } else {
2066 global $wgVariantArticlePath, $wgActionPaths;
2067 $url = false;
2068 $matches = [];
2069
2070 if ( !empty( $wgActionPaths )
2071 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
2072 ) {
2073 $action = urldecode( $matches[2] );
2074 if ( isset( $wgActionPaths[$action] ) ) {
2075 $query = $matches[1];
2076 if ( isset( $matches[4] ) ) {
2077 $query .= $matches[4];
2078 }
2079 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
2080 if ( $query != '' ) {
2081 $url = wfAppendQuery( $url, $query );
2082 }
2083 }
2084 }
2085
2086 if ( $url === false
2087 && $wgVariantArticlePath
2088 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
2089 && $this->getPageLanguage()->equals(
2090 MediaWikiServices::getInstance()->getContentLanguage() )
2091 && $this->getPageLanguage()->hasVariants()
2092 ) {
2093 $variant = urldecode( $matches[1] );
2094 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
2095 // Only do the variant replacement if the given variant is a valid
2096 // variant for the page's language.
2097 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
2098 $url = str_replace( '$1', $dbkey, $url );
2099 }
2100 }
2101
2102 if ( $url === false ) {
2103 if ( $query == '-' ) {
2104 $query = '';
2105 }
2106 $url = "{$wgScript}?title={$dbkey}&{$query}";
2107 }
2108 }
2109 // Avoid PHP 7.1 warning from passing $this by reference
2110 $titleRef = $this;
2111 Hooks::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
2112
2113 // @todo FIXME: This causes breakage in various places when we
2114 // actually expected a local URL and end up with dupe prefixes.
2115 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
2116 $url = $wgServer . $url;
2117 }
2118 }
2119 // Avoid PHP 7.1 warning from passing $this by reference
2120 $titleRef = $this;
2121 Hooks::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
2122 return $url;
2123 }
2124
2125 /**
2126 * Get a URL that's the simplest URL that will be valid to link, locally,
2127 * to the current Title. It includes the fragment, but does not include
2128 * the server unless action=render is used (or the link is external). If
2129 * there's a fragment but the prefixed text is empty, we just return a link
2130 * to the fragment.
2131 *
2132 * The result obviously should not be URL-escaped, but does need to be
2133 * HTML-escaped if it's being output in HTML.
2134 *
2135 * @param string|string[] $query
2136 * @param bool $query2
2137 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
2138 * or false (default) for no expansion
2139 * @see self::getLocalURL for the arguments.
2140 * @return string The URL
2141 */
2142 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
2143 if ( $this->isExternal() || $proto !== false ) {
2144 $ret = $this->getFullURL( $query, $query2, $proto );
2145 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
2146 $ret = $this->getFragmentForURL();
2147 } else {
2148 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
2149 }
2150 return $ret;
2151 }
2152
2153 /**
2154 * Get the URL form for an internal link.
2155 * - Used in various CDN-related code, in case we have a different
2156 * internal hostname for the server from the exposed one.
2157 *
2158 * This uses $wgInternalServer to qualify the path, or $wgServer
2159 * if $wgInternalServer is not set. If the server variable used is
2160 * protocol-relative, the URL will be expanded to http://
2161 *
2162 * @see self::getLocalURL for the arguments.
2163 * @param string|string[] $query
2164 * @param string|bool $query2 Deprecated
2165 * @return string The URL
2166 */
2167 public function getInternalURL( $query = '', $query2 = false ) {
2168 global $wgInternalServer, $wgServer;
2169 $query = self::fixUrlQueryArgs( $query, $query2 );
2170 $server = $wgInternalServer !== false ? $wgInternalServer : $wgServer;
2171 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP );
2172 // Avoid PHP 7.1 warning from passing $this by reference
2173 $titleRef = $this;
2174 Hooks::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
2175 return $url;
2176 }
2177
2178 /**
2179 * Get the URL for a canonical link, for use in things like IRC and
2180 * e-mail notifications. Uses $wgCanonicalServer and the
2181 * GetCanonicalURL hook.
2182 *
2183 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
2184 *
2185 * @see self::getLocalURL for the arguments.
2186 * @param string|string[] $query
2187 * @param string|bool $query2 Deprecated
2188 * @return string The URL
2189 * @since 1.18
2190 */
2191 public function getCanonicalURL( $query = '', $query2 = false ) {
2192 $query = self::fixUrlQueryArgs( $query, $query2 );
2193 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL );
2194 // Avoid PHP 7.1 warning from passing $this by reference
2195 $titleRef = $this;
2196 Hooks::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
2197 return $url;
2198 }
2199
2200 /**
2201 * Get the edit URL for this Title
2202 *
2203 * @return string The URL, or a null string if this is an interwiki link
2204 */
2205 public function getEditURL() {
2206 if ( $this->isExternal() ) {
2207 return '';
2208 }
2209 $s = $this->getLocalURL( 'action=edit' );
2210
2211 return $s;
2212 }
2213
2214 /**
2215 * Can $user perform $action on this page?
2216 * This skips potentially expensive cascading permission checks
2217 * as well as avoids expensive error formatting
2218 *
2219 * Suitable for use for nonessential UI controls in common cases, but
2220 * _not_ for functional access control.
2221 *
2222 * May provide false positives, but should never provide a false negative.
2223 *
2224 * @param string $action Action that permission needs to be checked for
2225 * @param User|null $user User to check (since 1.19); $wgUser will be used if not provided.
2226 *
2227 * @return bool
2228 * @throws Exception
2229 *
2230 * @deprecated since 1.33,
2231 * use MediaWikiServices::getInstance()->getPermissionManager()->quickUserCan(..) instead
2232 *
2233 */
2234 public function quickUserCan( $action, $user = null ) {
2235 return $this->userCan( $action, $user, false );
2236 }
2237
2238 /**
2239 * Can $user perform $action on this page?
2240 *
2241 * @param string $action Action that permission needs to be checked for
2242 * @param User|null $user User to check (since 1.19); $wgUser will be used if not
2243 * provided.
2244 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2245 *
2246 * @return bool
2247 * @throws Exception
2248 *
2249 * @deprecated since 1.33,
2250 * use MediaWikiServices::getInstance()->getPermissionManager()->userCan(..) instead
2251 *
2252 */
2253 public function userCan( $action, $user = null, $rigor = PermissionManager::RIGOR_SECURE ) {
2254 if ( !$user instanceof User ) {
2255 global $wgUser;
2256 $user = $wgUser;
2257 }
2258
2259 // TODO: this is for b/c, eventually will be removed
2260 if ( $rigor === true ) {
2261 $rigor = PermissionManager::RIGOR_SECURE; // b/c
2262 } elseif ( $rigor === false ) {
2263 $rigor = PermissionManager::RIGOR_QUICK; // b/c
2264 }
2265
2266 return MediaWikiServices::getInstance()->getPermissionManager()
2267 ->userCan( $action, $user, $this, $rigor );
2268 }
2269
2270 /**
2271 * Can $user perform $action on this page?
2272 *
2273 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
2274 *
2275 * @param string $action Action that permission needs to be checked for
2276 * @param User $user User to check
2277 * @param string $rigor One of (quick,full,secure)
2278 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2279 * - full : does cheap and expensive checks possibly from a replica DB
2280 * - secure : does cheap and expensive checks, using the master as needed
2281 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
2282 * whose corresponding errors may be ignored.
2283 *
2284 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2285 * @throws Exception
2286 *
2287 * @deprecated since 1.33,
2288 * use MediaWikiServices::getInstance()->getPermissionManager()->getPermissionErrors()
2289 *
2290 */
2291 public function getUserPermissionsErrors(
2292 $action, $user, $rigor = PermissionManager::RIGOR_SECURE, $ignoreErrors = []
2293 ) {
2294 // TODO: this is for b/c, eventually will be removed
2295 if ( $rigor === true ) {
2296 $rigor = PermissionManager::RIGOR_SECURE; // b/c
2297 } elseif ( $rigor === false ) {
2298 $rigor = PermissionManager::RIGOR_QUICK; // b/c
2299 }
2300
2301 return MediaWikiServices::getInstance()->getPermissionManager()
2302 ->getPermissionErrors( $action, $user, $this, $rigor, $ignoreErrors );
2303 }
2304
2305 /**
2306 * Get a filtered list of all restriction types supported by this wiki.
2307 * @param bool $exists True to get all restriction types that apply to
2308 * titles that do exist, False for all restriction types that apply to
2309 * titles that do not exist
2310 * @return array
2311 */
2312 public static function getFilteredRestrictionTypes( $exists = true ) {
2313 global $wgRestrictionTypes;
2314 $types = $wgRestrictionTypes;
2315 if ( $exists ) {
2316 # Remove the create restriction for existing titles
2317 $types = array_diff( $types, [ 'create' ] );
2318 } else {
2319 # Only the create and upload restrictions apply to non-existing titles
2320 $types = array_intersect( $types, [ 'create', 'upload' ] );
2321 }
2322 return $types;
2323 }
2324
2325 /**
2326 * Returns restriction types for the current Title
2327 *
2328 * @return array Applicable restriction types
2329 */
2330 public function getRestrictionTypes() {
2331 if ( $this->isSpecialPage() ) {
2332 return [];
2333 }
2334
2335 $types = self::getFilteredRestrictionTypes( $this->exists() );
2336
2337 if ( $this->mNamespace != NS_FILE ) {
2338 # Remove the upload restriction for non-file titles
2339 $types = array_diff( $types, [ 'upload' ] );
2340 }
2341
2342 Hooks::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2343
2344 wfDebug( __METHOD__ . ': applicable restrictions to [[' .
2345 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2346
2347 return $types;
2348 }
2349
2350 /**
2351 * Is this title subject to title protection?
2352 * Title protection is the one applied against creation of such title.
2353 *
2354 * @return array|bool An associative array representing any existent title
2355 * protection, or false if there's none.
2356 */
2357 public function getTitleProtection() {
2358 $protection = $this->getTitleProtectionInternal();
2359 if ( $protection ) {
2360 if ( $protection['permission'] == 'sysop' ) {
2361 $protection['permission'] = 'editprotected'; // B/C
2362 }
2363 if ( $protection['permission'] == 'autoconfirmed' ) {
2364 $protection['permission'] = 'editsemiprotected'; // B/C
2365 }
2366 }
2367 return $protection;
2368 }
2369
2370 /**
2371 * Fetch title protection settings
2372 *
2373 * To work correctly, $this->loadRestrictions() needs to have access to the
2374 * actual protections in the database without munging 'sysop' =>
2375 * 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other
2376 * callers probably want $this->getTitleProtection() instead.
2377 *
2378 * @return array|bool
2379 */
2380 protected function getTitleProtectionInternal() {
2381 // Can't protect pages in special namespaces
2382 if ( $this->mNamespace < 0 ) {
2383 return false;
2384 }
2385
2386 // Can't protect pages that exist.
2387 if ( $this->exists() ) {
2388 return false;
2389 }
2390
2391 if ( $this->mTitleProtection === null ) {
2392 $dbr = wfGetDB( DB_REPLICA );
2393 $commentStore = CommentStore::getStore();
2394 $commentQuery = $commentStore->getJoin( 'pt_reason' );
2395 $res = $dbr->select(
2396 [ 'protected_titles' ] + $commentQuery['tables'],
2397 [
2398 'user' => 'pt_user',
2399 'expiry' => 'pt_expiry',
2400 'permission' => 'pt_create_perm'
2401 ] + $commentQuery['fields'],
2402 [ 'pt_namespace' => $this->mNamespace, 'pt_title' => $this->mDbkeyform ],
2403 __METHOD__,
2404 [],
2405 $commentQuery['joins']
2406 );
2407
2408 // fetchRow returns false if there are no rows.
2409 $row = $dbr->fetchRow( $res );
2410 if ( $row ) {
2411 $this->mTitleProtection = [
2412 'user' => $row['user'],
2413 'expiry' => $dbr->decodeExpiry( $row['expiry'] ),
2414 'permission' => $row['permission'],
2415 'reason' => $commentStore->getComment( 'pt_reason', $row )->text,
2416 ];
2417 } else {
2418 $this->mTitleProtection = false;
2419 }
2420 }
2421 return $this->mTitleProtection;
2422 }
2423
2424 /**
2425 * Remove any title protection due to page existing
2426 */
2427 public function deleteTitleProtection() {
2428 $dbw = wfGetDB( DB_MASTER );
2429
2430 $dbw->delete(
2431 'protected_titles',
2432 [ 'pt_namespace' => $this->mNamespace, 'pt_title' => $this->mDbkeyform ],
2433 __METHOD__
2434 );
2435 $this->mTitleProtection = false;
2436 }
2437
2438 /**
2439 * Is this page "semi-protected" - the *only* protection levels are listed
2440 * in $wgSemiprotectedRestrictionLevels?
2441 *
2442 * @param string $action Action to check (default: edit)
2443 * @return bool
2444 */
2445 public function isSemiProtected( $action = 'edit' ) {
2446 global $wgSemiprotectedRestrictionLevels;
2447
2448 $restrictions = $this->getRestrictions( $action );
2449 $semi = $wgSemiprotectedRestrictionLevels;
2450 if ( !$restrictions || !$semi ) {
2451 // Not protected, or all protection is full protection
2452 return false;
2453 }
2454
2455 // Remap autoconfirmed to editsemiprotected for BC
2456 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2457 $semi[$key] = 'editsemiprotected';
2458 }
2459 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2460 $restrictions[$key] = 'editsemiprotected';
2461 }
2462
2463 return !array_diff( $restrictions, $semi );
2464 }
2465
2466 /**
2467 * Does the title correspond to a protected article?
2468 *
2469 * @param string $action The action the page is protected from,
2470 * by default checks all actions.
2471 * @return bool
2472 */
2473 public function isProtected( $action = '' ) {
2474 global $wgRestrictionLevels;
2475
2476 $restrictionTypes = $this->getRestrictionTypes();
2477
2478 # Special pages have inherent protection
2479 if ( $this->isSpecialPage() ) {
2480 return true;
2481 }
2482
2483 # Check regular protection levels
2484 foreach ( $restrictionTypes as $type ) {
2485 if ( $action == $type || $action == '' ) {
2486 $r = $this->getRestrictions( $type );
2487 foreach ( $wgRestrictionLevels as $level ) {
2488 if ( in_array( $level, $r ) && $level != '' ) {
2489 return true;
2490 }
2491 }
2492 }
2493 }
2494
2495 return false;
2496 }
2497
2498 /**
2499 * Determines if $user is unable to edit this page because it has been protected
2500 * by $wgNamespaceProtection.
2501 *
2502 * @param User $user User object to check permissions
2503 * @return bool
2504 */
2505 public function isNamespaceProtected( User $user ) {
2506 global $wgNamespaceProtection;
2507
2508 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
2509 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
2510 if ( $right != '' && !$user->isAllowed( $right ) ) {
2511 return true;
2512 }
2513 }
2514 }
2515 return false;
2516 }
2517
2518 /**
2519 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2520 *
2521 * @return bool If the page is subject to cascading restrictions.
2522 */
2523 public function isCascadeProtected() {
2524 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2525 return ( $sources > 0 );
2526 }
2527
2528 /**
2529 * Determines whether cascading protection sources have already been loaded from
2530 * the database.
2531 *
2532 * @param bool $getPages True to check if the pages are loaded, or false to check
2533 * if the status is loaded.
2534 * @return bool Whether or not the specified information has been loaded
2535 * @since 1.23
2536 */
2537 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2538 return $getPages ? $this->mCascadeSources !== null : $this->mHasCascadingRestrictions !== null;
2539 }
2540
2541 /**
2542 * Cascading protection: Get the source of any cascading restrictions on this page.
2543 *
2544 * @param bool $getPages Whether or not to retrieve the actual pages
2545 * that the restrictions have come from and the actual restrictions
2546 * themselves.
2547 * @return array Two elements: First is an array of Title objects of the
2548 * pages from which cascading restrictions have come, false for
2549 * none, or true if such restrictions exist but $getPages was not
2550 * set. Second is an array like that returned by
2551 * Title::getAllRestrictions(), or an empty array if $getPages is
2552 * false.
2553 */
2554 public function getCascadeProtectionSources( $getPages = true ) {
2555 $pagerestrictions = [];
2556
2557 if ( $this->mCascadeSources !== null && $getPages ) {
2558 return [ $this->mCascadeSources, $this->mCascadingRestrictions ];
2559 } elseif ( $this->mHasCascadingRestrictions !== null && !$getPages ) {
2560 return [ $this->mHasCascadingRestrictions, $pagerestrictions ];
2561 }
2562
2563 $dbr = wfGetDB( DB_REPLICA );
2564
2565 if ( $this->mNamespace == NS_FILE ) {
2566 $tables = [ 'imagelinks', 'page_restrictions' ];
2567 $where_clauses = [
2568 'il_to' => $this->mDbkeyform,
2569 'il_from=pr_page',
2570 'pr_cascade' => 1
2571 ];
2572 } else {
2573 $tables = [ 'templatelinks', 'page_restrictions' ];
2574 $where_clauses = [
2575 'tl_namespace' => $this->mNamespace,
2576 'tl_title' => $this->mDbkeyform,
2577 'tl_from=pr_page',
2578 'pr_cascade' => 1
2579 ];
2580 }
2581
2582 if ( $getPages ) {
2583 $cols = [ 'pr_page', 'page_namespace', 'page_title',
2584 'pr_expiry', 'pr_type', 'pr_level' ];
2585 $where_clauses[] = 'page_id=pr_page';
2586 $tables[] = 'page';
2587 } else {
2588 $cols = [ 'pr_expiry' ];
2589 }
2590
2591 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2592
2593 $sources = $getPages ? [] : false;
2594 $now = wfTimestampNow();
2595
2596 foreach ( $res as $row ) {
2597 $expiry = $dbr->decodeExpiry( $row->pr_expiry );
2598 if ( $expiry > $now ) {
2599 if ( $getPages ) {
2600 $page_id = $row->pr_page;
2601 $page_ns = $row->page_namespace;
2602 $page_title = $row->page_title;
2603 $sources[$page_id] = self::makeTitle( $page_ns, $page_title );
2604 # Add groups needed for each restriction type if its not already there
2605 # Make sure this restriction type still exists
2606
2607 if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2608 $pagerestrictions[$row->pr_type] = [];
2609 }
2610
2611 if (
2612 isset( $pagerestrictions[$row->pr_type] )
2613 && !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] )
2614 ) {
2615 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2616 }
2617 } else {
2618 $sources = true;
2619 }
2620 }
2621 }
2622
2623 if ( $getPages ) {
2624 $this->mCascadeSources = $sources;
2625 $this->mCascadingRestrictions = $pagerestrictions;
2626 } else {
2627 $this->mHasCascadingRestrictions = $sources;
2628 }
2629
2630 return [ $sources, $pagerestrictions ];
2631 }
2632
2633 /**
2634 * Accessor for mRestrictionsLoaded
2635 *
2636 * @return bool Whether or not the page's restrictions have already been
2637 * loaded from the database
2638 * @since 1.23
2639 */
2640 public function areRestrictionsLoaded() {
2641 return $this->mRestrictionsLoaded;
2642 }
2643
2644 /**
2645 * Accessor/initialisation for mRestrictions
2646 *
2647 * @param string $action Action that permission needs to be checked for
2648 * @return array Restriction levels needed to take the action. All levels are
2649 * required. Note that restriction levels are normally user rights, but 'sysop'
2650 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
2651 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
2652 */
2653 public function getRestrictions( $action ) {
2654 if ( !$this->mRestrictionsLoaded ) {
2655 $this->loadRestrictions();
2656 }
2657 return $this->mRestrictions[$action] ?? [];
2658 }
2659
2660 /**
2661 * Accessor/initialisation for mRestrictions
2662 *
2663 * @return array Keys are actions, values are arrays as returned by
2664 * Title::getRestrictions()
2665 * @since 1.23
2666 */
2667 public function getAllRestrictions() {
2668 if ( !$this->mRestrictionsLoaded ) {
2669 $this->loadRestrictions();
2670 }
2671 return $this->mRestrictions;
2672 }
2673
2674 /**
2675 * Get the expiry time for the restriction against a given action
2676 *
2677 * @param string $action
2678 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2679 * or not protected at all, or false if the action is not recognised.
2680 */
2681 public function getRestrictionExpiry( $action ) {
2682 if ( !$this->mRestrictionsLoaded ) {
2683 $this->loadRestrictions();
2684 }
2685 return $this->mRestrictionsExpiry[$action] ?? false;
2686 }
2687
2688 /**
2689 * Returns cascading restrictions for the current article
2690 *
2691 * @return bool
2692 */
2693 function areRestrictionsCascading() {
2694 if ( !$this->mRestrictionsLoaded ) {
2695 $this->loadRestrictions();
2696 }
2697
2698 return $this->mCascadeRestriction;
2699 }
2700
2701 /**
2702 * Compiles list of active page restrictions from both page table (pre 1.10)
2703 * and page_restrictions table for this existing page.
2704 * Public for usage by LiquidThreads.
2705 *
2706 * @param array $rows Array of db result objects
2707 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
2708 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
2709 * Edit and move sections are separated by a colon
2710 * Example: "edit=autoconfirmed,sysop:move=sysop"
2711 */
2712 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2713 // This function will only read rows from a table that we migrated away
2714 // from before adding READ_LATEST support to loadRestrictions, so we
2715 // don't need to support reading from DB_MASTER here.
2716 $dbr = wfGetDB( DB_REPLICA );
2717
2718 $restrictionTypes = $this->getRestrictionTypes();
2719
2720 foreach ( $restrictionTypes as $type ) {
2721 $this->mRestrictions[$type] = [];
2722 $this->mRestrictionsExpiry[$type] = 'infinity';
2723 }
2724
2725 $this->mCascadeRestriction = false;
2726
2727 # Backwards-compatibility: also load the restrictions from the page record (old format).
2728 if ( $oldFashionedRestrictions !== null ) {
2729 $this->mOldRestrictions = $oldFashionedRestrictions;
2730 }
2731
2732 if ( $this->mOldRestrictions === false ) {
2733 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
2734 $linkCache->addLinkObj( $this ); # in case we already had an article ID
2735 $this->mOldRestrictions = $linkCache->getGoodLinkFieldObj( $this, 'restrictions' );
2736 }
2737
2738 if ( $this->mOldRestrictions != '' ) {
2739 foreach ( explode( ':', trim( $this->mOldRestrictions ) ) as $restrict ) {
2740 $temp = explode( '=', trim( $restrict ) );
2741 if ( count( $temp ) == 1 ) {
2742 // old old format should be treated as edit/move restriction
2743 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
2744 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
2745 } else {
2746 $restriction = trim( $temp[1] );
2747 if ( $restriction != '' ) { // some old entries are empty
2748 $this->mRestrictions[$temp[0]] = explode( ',', $restriction );
2749 }
2750 }
2751 }
2752 }
2753
2754 if ( count( $rows ) ) {
2755 # Current system - load second to make them override.
2756 $now = wfTimestampNow();
2757
2758 # Cycle through all the restrictions.
2759 foreach ( $rows as $row ) {
2760 // Don't take care of restrictions types that aren't allowed
2761 if ( !in_array( $row->pr_type, $restrictionTypes ) ) {
2762 continue;
2763 }
2764
2765 $expiry = $dbr->decodeExpiry( $row->pr_expiry );
2766
2767 // Only apply the restrictions if they haven't expired!
2768 if ( !$expiry || $expiry > $now ) {
2769 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
2770 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
2771
2772 $this->mCascadeRestriction |= $row->pr_cascade;
2773 }
2774 }
2775 }
2776
2777 $this->mRestrictionsLoaded = true;
2778 }
2779
2780 /**
2781 * Load restrictions from the page_restrictions table
2782 *
2783 * @param string|null $oldFashionedRestrictions Comma-separated set of permission keys
2784 * indicating who can move or edit the page from the page table, (pre 1.10) rows.
2785 * Edit and move sections are separated by a colon
2786 * Example: "edit=autoconfirmed,sysop:move=sysop"
2787 * @param int $flags A bit field. If self::READ_LATEST is set, skip replicas and read
2788 * from the master DB.
2789 */
2790 public function loadRestrictions( $oldFashionedRestrictions = null, $flags = 0 ) {
2791 $readLatest = DBAccessObjectUtils::hasFlags( $flags, self::READ_LATEST );
2792 if ( $this->mRestrictionsLoaded && !$readLatest ) {
2793 return;
2794 }
2795
2796 // TODO: should probably pass $flags into getArticleID, but it seems hacky
2797 // to mix READ_LATEST and GAID_FOR_UPDATE, even if they have the same value.
2798 // Maybe deprecate GAID_FOR_UPDATE now that we implement IDBAccessObject?
2799 $id = $this->getArticleID();
2800 if ( $id ) {
2801 $fname = __METHOD__;
2802 $loadRestrictionsFromDb = function ( IDatabase $dbr ) use ( $fname, $id ) {
2803 return iterator_to_array(
2804 $dbr->select(
2805 'page_restrictions',
2806 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
2807 [ 'pr_page' => $id ],
2808 $fname
2809 )
2810 );
2811 };
2812
2813 if ( $readLatest ) {
2814 $dbr = wfGetDB( DB_MASTER );
2815 $rows = $loadRestrictionsFromDb( $dbr );
2816 } else {
2817 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
2818 $rows = $cache->getWithSetCallback(
2819 // Page protections always leave a new null revision
2820 $cache->makeKey( 'page-restrictions', 'v1', $id, $this->getLatestRevID() ),
2821 $cache::TTL_DAY,
2822 function ( $curValue, &$ttl, array &$setOpts ) use ( $loadRestrictionsFromDb ) {
2823 $dbr = wfGetDB( DB_REPLICA );
2824
2825 $setOpts += Database::getCacheSetOptions( $dbr );
2826 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
2827 if ( $lb->hasOrMadeRecentMasterChanges() ) {
2828 // @TODO: cleanup Title cache and caller assumption mess in general
2829 $ttl = WANObjectCache::TTL_UNCACHEABLE;
2830 }
2831
2832 return $loadRestrictionsFromDb( $dbr );
2833 }
2834 );
2835 }
2836
2837 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2838 } else {
2839 $title_protection = $this->getTitleProtectionInternal();
2840
2841 if ( $title_protection ) {
2842 $now = wfTimestampNow();
2843 $expiry = wfGetDB( DB_REPLICA )->decodeExpiry( $title_protection['expiry'] );
2844
2845 if ( !$expiry || $expiry > $now ) {
2846 // Apply the restrictions
2847 $this->mRestrictionsExpiry['create'] = $expiry;
2848 $this->mRestrictions['create'] =
2849 explode( ',', trim( $title_protection['permission'] ) );
2850 } else { // Get rid of the old restrictions
2851 $this->mTitleProtection = false;
2852 }
2853 } else {
2854 $this->mRestrictionsExpiry['create'] = 'infinity';
2855 }
2856 $this->mRestrictionsLoaded = true;
2857 }
2858 }
2859
2860 /**
2861 * Flush the protection cache in this object and force reload from the database.
2862 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2863 */
2864 public function flushRestrictions() {
2865 $this->mRestrictionsLoaded = false;
2866 $this->mTitleProtection = null;
2867 }
2868
2869 /**
2870 * Purge expired restrictions from the page_restrictions table
2871 *
2872 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
2873 */
2874 static function purgeExpiredRestrictions() {
2875 if ( wfReadOnly() ) {
2876 return;
2877 }
2878
2879 DeferredUpdates::addUpdate( new AtomicSectionUpdate(
2880 wfGetDB( DB_MASTER ),
2881 __METHOD__,
2882 function ( IDatabase $dbw, $fname ) {
2883 $config = MediaWikiServices::getInstance()->getMainConfig();
2884 $ids = $dbw->selectFieldValues(
2885 'page_restrictions',
2886 'pr_id',
2887 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
2888 $fname,
2889 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
2890 );
2891 if ( $ids ) {
2892 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
2893 }
2894 }
2895 ) );
2896
2897 DeferredUpdates::addUpdate( new AtomicSectionUpdate(
2898 wfGetDB( DB_MASTER ),
2899 __METHOD__,
2900 function ( IDatabase $dbw, $fname ) {
2901 $dbw->delete(
2902 'protected_titles',
2903 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
2904 $fname
2905 );
2906 }
2907 ) );
2908 }
2909
2910 /**
2911 * Does this have subpages? (Warning, usually requires an extra DB query.)
2912 *
2913 * @return bool
2914 */
2915 public function hasSubpages() {
2916 if (
2917 !MediaWikiServices::getInstance()->getNamespaceInfo()->
2918 hasSubpages( $this->mNamespace )
2919 ) {
2920 # Duh
2921 return false;
2922 }
2923
2924 # We dynamically add a member variable for the purpose of this method
2925 # alone to cache the result. There's no point in having it hanging
2926 # around uninitialized in every Title object; therefore we only add it
2927 # if needed and don't declare it statically.
2928 if ( $this->mHasSubpages === null ) {
2929 $this->mHasSubpages = false;
2930 $subpages = $this->getSubpages( 1 );
2931 if ( $subpages instanceof TitleArray ) {
2932 $this->mHasSubpages = (bool)$subpages->current();
2933 }
2934 }
2935
2936 return $this->mHasSubpages;
2937 }
2938
2939 /**
2940 * Get all subpages of this page.
2941 *
2942 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
2943 * @return TitleArray|array TitleArray, or empty array if this page's namespace
2944 * doesn't allow subpages
2945 */
2946 public function getSubpages( $limit = -1 ) {
2947 if (
2948 !MediaWikiServices::getInstance()->getNamespaceInfo()->
2949 hasSubpages( $this->mNamespace )
2950 ) {
2951 return [];
2952 }
2953
2954 $dbr = wfGetDB( DB_REPLICA );
2955 $conds['page_namespace'] = $this->mNamespace;
2956 $conds[] = 'page_title ' . $dbr->buildLike( $this->mDbkeyform . '/', $dbr->anyString() );
2957 $options = [];
2958 if ( $limit > -1 ) {
2959 $options['LIMIT'] = $limit;
2960 }
2961 return TitleArray::newFromResult(
2962 $dbr->select( 'page',
2963 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
2964 $conds,
2965 __METHOD__,
2966 $options
2967 )
2968 );
2969 }
2970
2971 /**
2972 * Is there a version of this page in the deletion archive?
2973 *
2974 * @return int The number of archived revisions
2975 */
2976 public function isDeleted() {
2977 if ( $this->mNamespace < 0 ) {
2978 $n = 0;
2979 } else {
2980 $dbr = wfGetDB( DB_REPLICA );
2981
2982 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2983 [ 'ar_namespace' => $this->mNamespace, 'ar_title' => $this->mDbkeyform ],
2984 __METHOD__
2985 );
2986 if ( $this->mNamespace == NS_FILE ) {
2987 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
2988 [ 'fa_name' => $this->mDbkeyform ],
2989 __METHOD__
2990 );
2991 }
2992 }
2993 return (int)$n;
2994 }
2995
2996 /**
2997 * Is there a version of this page in the deletion archive?
2998 *
2999 * @return bool
3000 */
3001 public function isDeletedQuick() {
3002 if ( $this->mNamespace < 0 ) {
3003 return false;
3004 }
3005 $dbr = wfGetDB( DB_REPLICA );
3006 $deleted = (bool)$dbr->selectField( 'archive', '1',
3007 [ 'ar_namespace' => $this->mNamespace, 'ar_title' => $this->mDbkeyform ],
3008 __METHOD__
3009 );
3010 if ( !$deleted && $this->mNamespace == NS_FILE ) {
3011 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3012 [ 'fa_name' => $this->mDbkeyform ],
3013 __METHOD__
3014 );
3015 }
3016 return $deleted;
3017 }
3018
3019 /**
3020 * Get the article ID for this Title from the link cache,
3021 * adding it if necessary
3022 *
3023 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3024 * for update
3025 * @return int The ID
3026 */
3027 public function getArticleID( $flags = 0 ) {
3028 if ( $this->mNamespace < 0 ) {
3029 $this->mArticleID = 0;
3030 return $this->mArticleID;
3031 }
3032 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3033 if ( $flags & self::GAID_FOR_UPDATE ) {
3034 $oldUpdate = $linkCache->forUpdate( true );
3035 $linkCache->clearLink( $this );
3036 $this->mArticleID = $linkCache->addLinkObj( $this );
3037 $linkCache->forUpdate( $oldUpdate );
3038 } elseif ( $this->mArticleID == -1 ) {
3039 $this->mArticleID = $linkCache->addLinkObj( $this );
3040 }
3041 return $this->mArticleID;
3042 }
3043
3044 /**
3045 * Is this an article that is a redirect page?
3046 * Uses link cache, adding it if necessary
3047 *
3048 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3049 * @return bool
3050 */
3051 public function isRedirect( $flags = 0 ) {
3052 if ( !is_null( $this->mRedirect ) ) {
3053 return $this->mRedirect;
3054 }
3055 if ( !$this->getArticleID( $flags ) ) {
3056 $this->mRedirect = false;
3057 return $this->mRedirect;
3058 }
3059
3060 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3061 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3062 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3063 if ( $cached === null ) {
3064 # Trust LinkCache's state over our own
3065 # LinkCache is telling us that the page doesn't exist, despite there being cached
3066 # data relating to an existing page in $this->mArticleID. Updaters should clear
3067 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3068 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3069 # LinkCache to refresh its data from the master.
3070 $this->mRedirect = false;
3071 return $this->mRedirect;
3072 }
3073
3074 $this->mRedirect = (bool)$cached;
3075
3076 return $this->mRedirect;
3077 }
3078
3079 /**
3080 * What is the length of this page?
3081 * Uses link cache, adding it if necessary
3082 *
3083 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3084 * @return int
3085 */
3086 public function getLength( $flags = 0 ) {
3087 if ( $this->mLength != -1 ) {
3088 return $this->mLength;
3089 }
3090 if ( !$this->getArticleID( $flags ) ) {
3091 $this->mLength = 0;
3092 return $this->mLength;
3093 }
3094 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3095 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3096 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3097 if ( $cached === null ) {
3098 # Trust LinkCache's state over our own, as for isRedirect()
3099 $this->mLength = 0;
3100 return $this->mLength;
3101 }
3102
3103 $this->mLength = intval( $cached );
3104
3105 return $this->mLength;
3106 }
3107
3108 /**
3109 * What is the page_latest field for this page?
3110 *
3111 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3112 * @return int Int or 0 if the page doesn't exist
3113 */
3114 public function getLatestRevID( $flags = 0 ) {
3115 if ( !( $flags & self::GAID_FOR_UPDATE ) && $this->mLatestID !== false ) {
3116 return intval( $this->mLatestID );
3117 }
3118 if ( !$this->getArticleID( $flags ) ) {
3119 $this->mLatestID = 0;
3120 return $this->mLatestID;
3121 }
3122 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3123 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3124 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3125 if ( $cached === null ) {
3126 # Trust LinkCache's state over our own, as for isRedirect()
3127 $this->mLatestID = 0;
3128 return $this->mLatestID;
3129 }
3130
3131 $this->mLatestID = intval( $cached );
3132
3133 return $this->mLatestID;
3134 }
3135
3136 /**
3137 * This clears some fields in this object, and clears any associated
3138 * keys in the "bad links" section of the link cache.
3139 *
3140 * - This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow
3141 * loading of the new page_id. It's also called from
3142 * WikiPage::doDeleteArticleReal()
3143 *
3144 * @param int $newid The new Article ID
3145 */
3146 public function resetArticleID( $newid ) {
3147 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3148 $linkCache->clearLink( $this );
3149
3150 if ( $newid === false ) {
3151 $this->mArticleID = -1;
3152 } else {
3153 $this->mArticleID = intval( $newid );
3154 }
3155 $this->mRestrictionsLoaded = false;
3156 $this->mRestrictions = [];
3157 $this->mOldRestrictions = false;
3158 $this->mRedirect = null;
3159 $this->mLength = -1;
3160 $this->mLatestID = false;
3161 $this->mContentModel = false;
3162 $this->mEstimateRevisions = null;
3163 $this->mPageLanguage = false;
3164 $this->mDbPageLanguage = false;
3165 $this->mIsBigDeletion = null;
3166 }
3167
3168 public static function clearCaches() {
3169 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3170 $linkCache->clear();
3171
3172 $titleCache = self::getTitleCache();
3173 $titleCache->clear();
3174 }
3175
3176 /**
3177 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3178 *
3179 * @param string $text Containing title to capitalize
3180 * @param int $ns Namespace index, defaults to NS_MAIN
3181 * @return string Containing capitalized title
3182 */
3183 public static function capitalize( $text, $ns = NS_MAIN ) {
3184 $services = MediaWikiServices::getInstance();
3185 if ( $services->getNamespaceInfo()->isCapitalized( $ns ) ) {
3186 return MediaWikiServices::getInstance()->getContentLanguage()->ucfirst( $text );
3187 } else {
3188 return $text;
3189 }
3190 }
3191
3192 /**
3193 * Secure and split - main initialisation function for this object
3194 *
3195 * Assumes that mDbkeyform has been set, and is urldecoded
3196 * and uses underscores, but not otherwise munged. This function
3197 * removes illegal characters, splits off the interwiki and
3198 * namespace prefixes, sets the other forms, and canonicalizes
3199 * everything.
3200 *
3201 * @throws MalformedTitleException On invalid titles
3202 * @return bool True on success
3203 */
3204 private function secureAndSplit() {
3205 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3206 // the parsing code with Title, while avoiding massive refactoring.
3207 // @todo: get rid of secureAndSplit, refactor parsing code.
3208 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3209 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3210 /** @var MediaWikiTitleCodec $titleCodec */
3211 $titleCodec = MediaWikiServices::getInstance()->getTitleParser();
3212 // MalformedTitleException can be thrown here
3213 $parts = $titleCodec->splitTitleString( $this->mDbkeyform, $this->mDefaultNamespace );
3214
3215 # Fill fields
3216 $this->setFragment( '#' . $parts['fragment'] );
3217 $this->mInterwiki = $parts['interwiki'];
3218 $this->mLocalInterwiki = $parts['local_interwiki'];
3219 $this->mNamespace = $parts['namespace'];
3220 $this->mUserCaseDBKey = $parts['user_case_dbkey'];
3221
3222 $this->mDbkeyform = $parts['dbkey'];
3223 $this->mUrlform = wfUrlencode( $this->mDbkeyform );
3224 $this->mTextform = strtr( $this->mDbkeyform, '_', ' ' );
3225
3226 # We already know that some pages won't be in the database!
3227 if ( $this->isExternal() || $this->isSpecialPage() ) {
3228 $this->mArticleID = 0;
3229 }
3230
3231 return true;
3232 }
3233
3234 /**
3235 * Get an array of Title objects linking to this Title
3236 * Also stores the IDs in the link cache.
3237 *
3238 * WARNING: do not use this function on arbitrary user-supplied titles!
3239 * On heavily-used templates it will max out the memory.
3240 *
3241 * @param array $options May be FOR UPDATE
3242 * @param string $table Table name
3243 * @param string $prefix Fields prefix
3244 * @return Title[] Array of Title objects linking here
3245 */
3246 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3247 if ( count( $options ) > 0 ) {
3248 $db = wfGetDB( DB_MASTER );
3249 } else {
3250 $db = wfGetDB( DB_REPLICA );
3251 }
3252
3253 $res = $db->select(
3254 [ 'page', $table ],
3255 self::getSelectFields(),
3256 [
3257 "{$prefix}_from=page_id",
3258 "{$prefix}_namespace" => $this->mNamespace,
3259 "{$prefix}_title" => $this->mDbkeyform ],
3260 __METHOD__,
3261 $options
3262 );
3263
3264 $retVal = [];
3265 if ( $res->numRows() ) {
3266 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3267 foreach ( $res as $row ) {
3268 $titleObj = self::makeTitle( $row->page_namespace, $row->page_title );
3269 if ( $titleObj ) {
3270 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3271 $retVal[] = $titleObj;
3272 }
3273 }
3274 }
3275 return $retVal;
3276 }
3277
3278 /**
3279 * Get an array of Title objects using this Title as a template
3280 * Also stores the IDs in the link cache.
3281 *
3282 * WARNING: do not use this function on arbitrary user-supplied titles!
3283 * On heavily-used templates it will max out the memory.
3284 *
3285 * @param array $options Query option to Database::select()
3286 * @return Title[] Array of Title the Title objects linking here
3287 */
3288 public function getTemplateLinksTo( $options = [] ) {
3289 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3290 }
3291
3292 /**
3293 * Get an array of Title objects linked from this Title
3294 * Also stores the IDs in the link cache.
3295 *
3296 * WARNING: do not use this function on arbitrary user-supplied titles!
3297 * On heavily-used templates it will max out the memory.
3298 *
3299 * @param array $options Query option to Database::select()
3300 * @param string $table Table name
3301 * @param string $prefix Fields prefix
3302 * @return array Array of Title objects linking here
3303 */
3304 public function getLinksFrom( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3305 $id = $this->getArticleID();
3306
3307 # If the page doesn't exist; there can't be any link from this page
3308 if ( !$id ) {
3309 return [];
3310 }
3311
3312 $db = wfGetDB( DB_REPLICA );
3313
3314 $blNamespace = "{$prefix}_namespace";
3315 $blTitle = "{$prefix}_title";
3316
3317 $pageQuery = WikiPage::getQueryInfo();
3318 $res = $db->select(
3319 [ $table, 'nestpage' => $pageQuery['tables'] ],
3320 array_merge(
3321 [ $blNamespace, $blTitle ],
3322 $pageQuery['fields']
3323 ),
3324 [ "{$prefix}_from" => $id ],
3325 __METHOD__,
3326 $options,
3327 [ 'nestpage' => [
3328 'LEFT JOIN',
3329 [ "page_namespace=$blNamespace", "page_title=$blTitle" ]
3330 ] ] + $pageQuery['joins']
3331 );
3332
3333 $retVal = [];
3334 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3335 foreach ( $res as $row ) {
3336 if ( $row->page_id ) {
3337 $titleObj = self::newFromRow( $row );
3338 } else {
3339 $titleObj = self::makeTitle( $row->$blNamespace, $row->$blTitle );
3340 $linkCache->addBadLinkObj( $titleObj );
3341 }
3342 $retVal[] = $titleObj;
3343 }
3344
3345 return $retVal;
3346 }
3347
3348 /**
3349 * Get an array of Title objects used on this Title as a template
3350 * Also stores the IDs in the link cache.
3351 *
3352 * WARNING: do not use this function on arbitrary user-supplied titles!
3353 * On heavily-used templates it will max out the memory.
3354 *
3355 * @param array $options May be FOR UPDATE
3356 * @return Title[] Array of Title the Title objects used here
3357 */
3358 public function getTemplateLinksFrom( $options = [] ) {
3359 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3360 }
3361
3362 /**
3363 * Get an array of Title objects referring to non-existent articles linked
3364 * from this page.
3365 *
3366 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3367 * should use redirect table in this case).
3368 * @return Title[] Array of Title the Title objects
3369 */
3370 public function getBrokenLinksFrom() {
3371 if ( $this->getArticleID() == 0 ) {
3372 # All links from article ID 0 are false positives
3373 return [];
3374 }
3375
3376 $dbr = wfGetDB( DB_REPLICA );
3377 $res = $dbr->select(
3378 [ 'page', 'pagelinks' ],
3379 [ 'pl_namespace', 'pl_title' ],
3380 [
3381 'pl_from' => $this->getArticleID(),
3382 'page_namespace IS NULL'
3383 ],
3384 __METHOD__, [],
3385 [
3386 'page' => [
3387 'LEFT JOIN',
3388 [ 'pl_namespace=page_namespace', 'pl_title=page_title' ]
3389 ]
3390 ]
3391 );
3392
3393 $retVal = [];
3394 foreach ( $res as $row ) {
3395 $retVal[] = self::makeTitle( $row->pl_namespace, $row->pl_title );
3396 }
3397 return $retVal;
3398 }
3399
3400 /**
3401 * Get a list of URLs to purge from the CDN cache when this
3402 * page changes
3403 *
3404 * @return string[] Array of String the URLs
3405 */
3406 public function getCdnUrls() {
3407 $urls = [
3408 $this->getInternalURL(),
3409 $this->getInternalURL( 'action=history' )
3410 ];
3411
3412 $pageLang = $this->getPageLanguage();
3413 if ( $pageLang->hasVariants() ) {
3414 $variants = $pageLang->getVariants();
3415 foreach ( $variants as $vCode ) {
3416 $urls[] = $this->getInternalURL( $vCode );
3417 }
3418 }
3419
3420 // If we are looking at a css/js user subpage, purge the action=raw.
3421 if ( $this->isUserJsConfigPage() ) {
3422 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/javascript' );
3423 } elseif ( $this->isUserJsonConfigPage() ) {
3424 $urls[] = $this->getInternalURL( 'action=raw&ctype=application/json' );
3425 } elseif ( $this->isUserCssConfigPage() ) {
3426 $urls[] = $this->getInternalURL( 'action=raw&ctype=text/css' );
3427 }
3428
3429 Hooks::run( 'TitleSquidURLs', [ $this, &$urls ] );
3430 return $urls;
3431 }
3432
3433 /**
3434 * Purge all applicable CDN URLs
3435 */
3436 public function purgeSquid() {
3437 DeferredUpdates::addUpdate(
3438 new CdnCacheUpdate( $this->getCdnUrls() ),
3439 DeferredUpdates::PRESEND
3440 );
3441 }
3442
3443 /**
3444 * Check whether a given move operation would be valid.
3445 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3446 *
3447 * @deprecated since 1.25, use MovePage's methods instead
3448 * @param Title &$nt The new title
3449 * @param bool $auth Whether to check user permissions (uses $wgUser)
3450 * @param string $reason Is the log summary of the move, used for spam checking
3451 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3452 */
3453 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3454 wfDeprecated( __METHOD__, '1.25' );
3455
3456 global $wgUser;
3457
3458 if ( !( $nt instanceof Title ) ) {
3459 // Normally we'd add this to $errors, but we'll get
3460 // lots of syntax errors if $nt is not an object
3461 return [ [ 'badtitletext' ] ];
3462 }
3463
3464 $mp = new MovePage( $this, $nt );
3465 $errors = $mp->isValidMove()->getErrorsArray();
3466 if ( $auth ) {
3467 $errors = wfMergeErrorArrays(
3468 $errors,
3469 $mp->checkPermissions( $wgUser, $reason )->getErrorsArray()
3470 );
3471 }
3472
3473 return $errors ?: true;
3474 }
3475
3476 /**
3477 * Move a title to a new location
3478 *
3479 * @deprecated since 1.25, use the MovePage class instead
3480 * @param Title &$nt The new title
3481 * @param bool $auth Indicates whether $wgUser's permissions
3482 * should be checked
3483 * @param string $reason The reason for the move
3484 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3485 * Ignored if the user doesn't have the suppressredirect right.
3486 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3487 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3488 */
3489 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true,
3490 array $changeTags = []
3491 ) {
3492 wfDeprecated( __METHOD__, '1.25' );
3493
3494 global $wgUser;
3495
3496 $mp = new MovePage( $this, $nt );
3497 $method = $auth ? 'moveIfAllowed' : 'move';
3498 $status = $mp->$method( $wgUser, $reason, $createRedirect, $changeTags );
3499 if ( $status->isOK() ) {
3500 return true;
3501 } else {
3502 return $status->getErrorsArray();
3503 }
3504 }
3505
3506 /**
3507 * Move this page's subpages to be subpages of $nt
3508 *
3509 * @deprecated since 1.34, use MovePage instead
3510 * @param Title $nt Move target
3511 * @param bool $auth Whether $wgUser's permissions should be checked
3512 * @param string $reason The reason for the move
3513 * @param bool $createRedirect Whether to create redirects from the old subpages to
3514 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3515 * @param array $changeTags Applied to the entry in the move log and redirect page revision
3516 * @return array Array with old page titles as keys, and strings (new page titles) or
3517 * getUserPermissionsErrors()-like arrays (errors) as values, or a
3518 * getUserPermissionsErrors()-like error array with numeric indices if
3519 * no pages were moved
3520 */
3521 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true,
3522 array $changeTags = []
3523 ) {
3524 wfDeprecated( __METHOD__, '1.34' );
3525
3526 global $wgUser;
3527
3528 $mp = new MovePage( $this, $nt );
3529 $method = $auth ? 'moveSubpagesIfAllowed' : 'moveSubpages';
3530 $result = $mp->$method( $wgUser, $reason, $createRedirect, $changeTags );
3531
3532 if ( !$result->isOk() ) {
3533 return $result->getErrorsArray();
3534 }
3535
3536 $retval = [];
3537 foreach ( $result->getValue() as $key => $status ) {
3538 if ( $status->isOK() ) {
3539 $retval[$key] = $status->getValue();
3540 } else {
3541 $retval[$key] = $status->getErrorsArray();
3542 }
3543 }
3544 return $retval;
3545 }
3546
3547 /**
3548 * Checks if this page is just a one-rev redirect.
3549 * Adds lock, so don't use just for light purposes.
3550 *
3551 * @return bool
3552 */
3553 public function isSingleRevRedirect() {
3554 global $wgContentHandlerUseDB;
3555
3556 $dbw = wfGetDB( DB_MASTER );
3557
3558 # Is it a redirect?
3559 $fields = [ 'page_is_redirect', 'page_latest', 'page_id' ];
3560 if ( $wgContentHandlerUseDB ) {
3561 $fields[] = 'page_content_model';
3562 }
3563
3564 $row = $dbw->selectRow( 'page',
3565 $fields,
3566 $this->pageCond(),
3567 __METHOD__,
3568 [ 'FOR UPDATE' ]
3569 );
3570 # Cache some fields we may want
3571 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
3572 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
3573 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
3574 $this->mContentModel = $row && isset( $row->page_content_model )
3575 ? strval( $row->page_content_model )
3576 : false;
3577
3578 if ( !$this->mRedirect ) {
3579 return false;
3580 }
3581 # Does the article have a history?
3582 $row = $dbw->selectField( [ 'page', 'revision' ],
3583 'rev_id',
3584 [ 'page_namespace' => $this->mNamespace,
3585 'page_title' => $this->mDbkeyform,
3586 'page_id=rev_page',
3587 'page_latest != rev_id'
3588 ],
3589 __METHOD__,
3590 [ 'FOR UPDATE' ]
3591 );
3592 # Return true if there was no history
3593 return ( $row === false );
3594 }
3595
3596 /**
3597 * Checks if $this can be moved to a given Title
3598 * - Selects for update, so don't call it unless you mean business
3599 *
3600 * @deprecated since 1.25, use MovePage's methods instead
3601 * @param Title $nt The new title to check
3602 * @return bool
3603 */
3604 public function isValidMoveTarget( $nt ) {
3605 wfDeprecated( __METHOD__, '1.25' );
3606
3607 # Is it an existing file?
3608 if ( $nt->getNamespace() == NS_FILE ) {
3609 $file = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()
3610 ->newFile( $nt );
3611 $file->load( File::READ_LATEST );
3612 if ( $file->exists() ) {
3613 wfDebug( __METHOD__ . ": file exists\n" );
3614 return false;
3615 }
3616 }
3617 # Is it a redirect with no history?
3618 if ( !$nt->isSingleRevRedirect() ) {
3619 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
3620 return false;
3621 }
3622 # Get the article text
3623 $rev = Revision::newFromTitle( $nt, false, Revision::READ_LATEST );
3624 if ( !is_object( $rev ) ) {
3625 return false;
3626 }
3627 $content = $rev->getContent();
3628 # Does the redirect point to the source?
3629 # Or is it a broken self-redirect, usually caused by namespace collisions?
3630 $redirTitle = $content ? $content->getRedirectTarget() : null;
3631
3632 if ( $redirTitle ) {
3633 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3634 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3635 wfDebug( __METHOD__ . ": redirect points to other page\n" );
3636 return false;
3637 } else {
3638 return true;
3639 }
3640 } else {
3641 # Fail safe (not a redirect after all. strange.)
3642 wfDebug( __METHOD__ . ": failsafe: database sais " . $nt->getPrefixedDBkey() .
3643 " is a redirect, but it doesn't contain a valid redirect.\n" );
3644 return false;
3645 }
3646 }
3647
3648 /**
3649 * Get categories to which this Title belongs and return an array of
3650 * categories' names.
3651 *
3652 * @return array Array of parents in the form:
3653 * $parent => $currentarticle
3654 */
3655 public function getParentCategories() {
3656 $data = [];
3657
3658 $titleKey = $this->getArticleID();
3659
3660 if ( $titleKey === 0 ) {
3661 return $data;
3662 }
3663
3664 $dbr = wfGetDB( DB_REPLICA );
3665
3666 $res = $dbr->select(
3667 'categorylinks',
3668 'cl_to',
3669 [ 'cl_from' => $titleKey ],
3670 __METHOD__
3671 );
3672
3673 if ( $res->numRows() > 0 ) {
3674 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
3675 foreach ( $res as $row ) {
3676 // $data[] = Title::newFromText( $contLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
3677 $data[$contLang->getNsText( NS_CATEGORY ) . ':' . $row->cl_to] =
3678 $this->getFullText();
3679 }
3680 }
3681 return $data;
3682 }
3683
3684 /**
3685 * Get a tree of parent categories
3686 *
3687 * @param array $children Array with the children in the keys, to check for circular refs
3688 * @return array Tree of parent categories
3689 */
3690 public function getParentCategoryTree( $children = [] ) {
3691 $stack = [];
3692 $parents = $this->getParentCategories();
3693
3694 if ( $parents ) {
3695 foreach ( $parents as $parent => $current ) {
3696 if ( array_key_exists( $parent, $children ) ) {
3697 # Circular reference
3698 $stack[$parent] = [];
3699 } else {
3700 $nt = self::newFromText( $parent );
3701 if ( $nt ) {
3702 $stack[$parent] = $nt->getParentCategoryTree( $children + [ $parent => 1 ] );
3703 }
3704 }
3705 }
3706 }
3707
3708 return $stack;
3709 }
3710
3711 /**
3712 * Get an associative array for selecting this title from
3713 * the "page" table
3714 *
3715 * @return array Array suitable for the $where parameter of DB::select()
3716 */
3717 public function pageCond() {
3718 if ( $this->mArticleID > 0 ) {
3719 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3720 return [ 'page_id' => $this->mArticleID ];
3721 } else {
3722 return [ 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform ];
3723 }
3724 }
3725
3726 /**
3727 * Get next/previous revision ID relative to another revision ID
3728 * @param int $revId Revision ID. Get the revision that was before this one.
3729 * @param int $flags Title::GAID_FOR_UPDATE
3730 * @param string $dir 'next' or 'prev'
3731 * @return int|bool New revision ID, or false if none exists
3732 */
3733 private function getRelativeRevisionID( $revId, $flags, $dir ) {
3734 $rl = MediaWikiServices::getInstance()->getRevisionLookup();
3735 $rlFlags = $flags === self::GAID_FOR_UPDATE ? IDBAccessObject::READ_LATEST : 0;
3736 $rev = $rl->getRevisionById( $revId, $rlFlags );
3737 if ( !$rev ) {
3738 return false;
3739 }
3740 $oldRev = $dir === 'next'
3741 ? $rl->getNextRevision( $rev, $rlFlags )
3742 : $rl->getPreviousRevision( $rev, $rlFlags );
3743 if ( !$oldRev ) {
3744 return false;
3745 }
3746 return $oldRev->getId();
3747 }
3748
3749 /**
3750 * Get the revision ID of the previous revision
3751 *
3752 * @deprecated since 1.34, use RevisionLookup::getPreviousRevision
3753 * @param int $revId Revision ID. Get the revision that was before this one.
3754 * @param int $flags Title::GAID_FOR_UPDATE
3755 * @return int|bool Old revision ID, or false if none exists
3756 */
3757 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3758 return $this->getRelativeRevisionID( $revId, $flags, 'prev' );
3759 }
3760
3761 /**
3762 * Get the revision ID of the next revision
3763 *
3764 * @deprecated since 1.34, use RevisionLookup::getNextRevision
3765 * @param int $revId Revision ID. Get the revision that was after this one.
3766 * @param int $flags Title::GAID_FOR_UPDATE
3767 * @return int|bool Next revision ID, or false if none exists
3768 */
3769 public function getNextRevisionID( $revId, $flags = 0 ) {
3770 return $this->getRelativeRevisionID( $revId, $flags, 'next' );
3771 }
3772
3773 /**
3774 * Get the first revision of the page
3775 *
3776 * @param int $flags Title::GAID_FOR_UPDATE
3777 * @return Revision|null If page doesn't exist
3778 */
3779 public function getFirstRevision( $flags = 0 ) {
3780 $pageId = $this->getArticleID( $flags );
3781 if ( $pageId ) {
3782 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_REPLICA );
3783 $revQuery = Revision::getQueryInfo();
3784 $row = $db->selectRow( $revQuery['tables'], $revQuery['fields'],
3785 [ 'rev_page' => $pageId ],
3786 __METHOD__,
3787 [
3788 'ORDER BY' => 'rev_timestamp ASC, rev_id ASC',
3789 'IGNORE INDEX' => [ 'revision' => 'rev_timestamp' ], // See T159319
3790 ],
3791 $revQuery['joins']
3792 );
3793 if ( $row ) {
3794 return new Revision( $row, 0, $this );
3795 }
3796 }
3797 return null;
3798 }
3799
3800 /**
3801 * Get the oldest revision timestamp of this page
3802 *
3803 * @param int $flags Title::GAID_FOR_UPDATE
3804 * @return string|null MW timestamp
3805 */
3806 public function getEarliestRevTime( $flags = 0 ) {
3807 $rev = $this->getFirstRevision( $flags );
3808 return $rev ? $rev->getTimestamp() : null;
3809 }
3810
3811 /**
3812 * Check if this is a new page
3813 *
3814 * @return bool
3815 */
3816 public function isNewPage() {
3817 $dbr = wfGetDB( DB_REPLICA );
3818 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
3819 }
3820
3821 /**
3822 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
3823 *
3824 * @return bool
3825 */
3826 public function isBigDeletion() {
3827 global $wgDeleteRevisionsLimit;
3828
3829 if ( !$wgDeleteRevisionsLimit ) {
3830 return false;
3831 }
3832
3833 if ( $this->mIsBigDeletion === null ) {
3834 $dbr = wfGetDB( DB_REPLICA );
3835
3836 $revCount = $dbr->selectRowCount(
3837 'revision',
3838 '1',
3839 [ 'rev_page' => $this->getArticleID() ],
3840 __METHOD__,
3841 [ 'LIMIT' => $wgDeleteRevisionsLimit + 1 ]
3842 );
3843
3844 $this->mIsBigDeletion = $revCount > $wgDeleteRevisionsLimit;
3845 }
3846
3847 return $this->mIsBigDeletion;
3848 }
3849
3850 /**
3851 * Get the approximate revision count of this page.
3852 *
3853 * @return int
3854 */
3855 public function estimateRevisionCount() {
3856 if ( !$this->exists() ) {
3857 return 0;
3858 }
3859
3860 if ( $this->mEstimateRevisions === null ) {
3861 $dbr = wfGetDB( DB_REPLICA );
3862 $this->mEstimateRevisions = $dbr->estimateRowCount( 'revision', '*',
3863 [ 'rev_page' => $this->getArticleID() ], __METHOD__ );
3864 }
3865
3866 return $this->mEstimateRevisions;
3867 }
3868
3869 /**
3870 * Get the number of revisions between the given revision.
3871 * Used for diffs and other things that really need it.
3872 *
3873 * @param int|Revision $old Old revision or rev ID (first before range)
3874 * @param int|Revision $new New revision or rev ID (first after range)
3875 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
3876 * @return int Number of revisions between these revisions.
3877 */
3878 public function countRevisionsBetween( $old, $new, $max = null ) {
3879 if ( !( $old instanceof Revision ) ) {
3880 $old = Revision::newFromTitle( $this, (int)$old );
3881 }
3882 if ( !( $new instanceof Revision ) ) {
3883 $new = Revision::newFromTitle( $this, (int)$new );
3884 }
3885 if ( !$old || !$new ) {
3886 return 0; // nothing to compare
3887 }
3888 $dbr = wfGetDB( DB_REPLICA );
3889 $conds = [
3890 'rev_page' => $this->getArticleID(),
3891 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3892 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3893 ];
3894 if ( $max !== null ) {
3895 return $dbr->selectRowCount( 'revision', '1',
3896 $conds,
3897 __METHOD__,
3898 [ 'LIMIT' => $max + 1 ] // extra to detect truncation
3899 );
3900 } else {
3901 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__ );
3902 }
3903 }
3904
3905 /**
3906 * Get the authors between the given revisions or revision IDs.
3907 * Used for diffs and other things that really need it.
3908 *
3909 * @since 1.23
3910 *
3911 * @param int|Revision $old Old revision or rev ID (first before range by default)
3912 * @param int|Revision $new New revision or rev ID (first after range by default)
3913 * @param int $limit Maximum number of authors
3914 * @param string|array $options (Optional): Single option, or an array of options:
3915 * 'include_old' Include $old in the range; $new is excluded.
3916 * 'include_new' Include $new in the range; $old is excluded.
3917 * 'include_both' Include both $old and $new in the range.
3918 * Unknown option values are ignored.
3919 * @return array|null Names of revision authors in the range; null if not both revisions exist
3920 */
3921 public function getAuthorsBetween( $old, $new, $limit, $options = [] ) {
3922 if ( !( $old instanceof Revision ) ) {
3923 $old = Revision::newFromTitle( $this, (int)$old );
3924 }
3925 if ( !( $new instanceof Revision ) ) {
3926 $new = Revision::newFromTitle( $this, (int)$new );
3927 }
3928 // XXX: what if Revision objects are passed in, but they don't refer to this title?
3929 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
3930 // in the sanity check below?
3931 if ( !$old || !$new ) {
3932 return null; // nothing to compare
3933 }
3934 $authors = [];
3935 $old_cmp = '>';
3936 $new_cmp = '<';
3937 $options = (array)$options;
3938 if ( in_array( 'include_old', $options ) ) {
3939 $old_cmp = '>=';
3940 }
3941 if ( in_array( 'include_new', $options ) ) {
3942 $new_cmp = '<=';
3943 }
3944 if ( in_array( 'include_both', $options ) ) {
3945 $old_cmp = '>=';
3946 $new_cmp = '<=';
3947 }
3948 // No DB query needed if $old and $new are the same or successive revisions:
3949 if ( $old->getId() === $new->getId() ) {
3950 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
3951 [] :
3952 [ $old->getUserText( RevisionRecord::RAW ) ];
3953 } elseif ( $old->getId() === $new->getParentId() ) {
3954 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
3955 $authors[] = $oldUserText = $old->getUserText( RevisionRecord::RAW );
3956 $newUserText = $new->getUserText( RevisionRecord::RAW );
3957 if ( $oldUserText != $newUserText ) {
3958 $authors[] = $newUserText;
3959 }
3960 } elseif ( $old_cmp === '>=' ) {
3961 $authors[] = $old->getUserText( RevisionRecord::RAW );
3962 } elseif ( $new_cmp === '<=' ) {
3963 $authors[] = $new->getUserText( RevisionRecord::RAW );
3964 }
3965 return $authors;
3966 }
3967 $dbr = wfGetDB( DB_REPLICA );
3968 $revQuery = Revision::getQueryInfo();
3969 $authors = $dbr->selectFieldValues(
3970 $revQuery['tables'],
3971 $revQuery['fields']['rev_user_text'],
3972 [
3973 'rev_page' => $this->getArticleID(),
3974 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
3975 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
3976 ], __METHOD__,
3977 [ 'DISTINCT', 'LIMIT' => $limit + 1 ], // add one so caller knows it was truncated
3978 $revQuery['joins']
3979 );
3980 return $authors;
3981 }
3982
3983 /**
3984 * Get the number of authors between the given revisions or revision IDs.
3985 * Used for diffs and other things that really need it.
3986 *
3987 * @param int|Revision $old Old revision or rev ID (first before range by default)
3988 * @param int|Revision $new New revision or rev ID (first after range by default)
3989 * @param int $limit Maximum number of authors
3990 * @param string|array $options (Optional): Single option, or an array of options:
3991 * 'include_old' Include $old in the range; $new is excluded.
3992 * 'include_new' Include $new in the range; $old is excluded.
3993 * 'include_both' Include both $old and $new in the range.
3994 * Unknown option values are ignored.
3995 * @return int Number of revision authors in the range; zero if not both revisions exist
3996 */
3997 public function countAuthorsBetween( $old, $new, $limit, $options = [] ) {
3998 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
3999 return $authors ? count( $authors ) : 0;
4000 }
4001
4002 /**
4003 * Compare with another title.
4004 *
4005 * @param LinkTarget $title
4006 * @return bool
4007 */
4008 public function equals( LinkTarget $title ) {
4009 // Note: === is necessary for proper matching of number-like titles.
4010 return $this->mInterwiki === $title->getInterwiki()
4011 && $this->mNamespace == $title->getNamespace()
4012 && $this->mDbkeyform === $title->getDBkey();
4013 }
4014
4015 /**
4016 * Check if this title is a subpage of another title
4017 *
4018 * @param Title $title
4019 * @return bool
4020 */
4021 public function isSubpageOf( Title $title ) {
4022 return $this->mInterwiki === $title->mInterwiki
4023 && $this->mNamespace == $title->mNamespace
4024 && strpos( $this->mDbkeyform, $title->mDbkeyform . '/' ) === 0;
4025 }
4026
4027 /**
4028 * Check if page exists. For historical reasons, this function simply
4029 * checks for the existence of the title in the page table, and will
4030 * thus return false for interwiki links, special pages and the like.
4031 * If you want to know if a title can be meaningfully viewed, you should
4032 * probably call the isKnown() method instead.
4033 *
4034 * @param int $flags An optional bit field; may be Title::GAID_FOR_UPDATE to check
4035 * from master/for update
4036 * @return bool
4037 */
4038 public function exists( $flags = 0 ) {
4039 $exists = $this->getArticleID( $flags ) != 0;
4040 Hooks::run( 'TitleExists', [ $this, &$exists ] );
4041 return $exists;
4042 }
4043
4044 /**
4045 * Should links to this title be shown as potentially viewable (i.e. as
4046 * "bluelinks"), even if there's no record by this title in the page
4047 * table?
4048 *
4049 * This function is semi-deprecated for public use, as well as somewhat
4050 * misleadingly named. You probably just want to call isKnown(), which
4051 * calls this function internally.
4052 *
4053 * (ISSUE: Most of these checks are cheap, but the file existence check
4054 * can potentially be quite expensive. Including it here fixes a lot of
4055 * existing code, but we might want to add an optional parameter to skip
4056 * it and any other expensive checks.)
4057 *
4058 * @return bool
4059 */
4060 public function isAlwaysKnown() {
4061 $isKnown = null;
4062
4063 /**
4064 * Allows overriding default behavior for determining if a page exists.
4065 * If $isKnown is kept as null, regular checks happen. If it's
4066 * a boolean, this value is returned by the isKnown method.
4067 *
4068 * @since 1.20
4069 *
4070 * @param Title $title
4071 * @param bool|null $isKnown
4072 */
4073 Hooks::run( 'TitleIsAlwaysKnown', [ $this, &$isKnown ] );
4074
4075 if ( !is_null( $isKnown ) ) {
4076 return $isKnown;
4077 }
4078
4079 if ( $this->isExternal() ) {
4080 return true; // any interwiki link might be viewable, for all we know
4081 }
4082
4083 $services = MediaWikiServices::getInstance();
4084 switch ( $this->mNamespace ) {
4085 case NS_MEDIA:
4086 case NS_FILE:
4087 // file exists, possibly in a foreign repo
4088 return (bool)$services->getRepoGroup()->findFile( $this );
4089 case NS_SPECIAL:
4090 // valid special page
4091 return $services->getSpecialPageFactory()->exists( $this->mDbkeyform );
4092 case NS_MAIN:
4093 // selflink, possibly with fragment
4094 return $this->mDbkeyform == '';
4095 case NS_MEDIAWIKI:
4096 // known system message
4097 return $this->hasSourceText() !== false;
4098 default:
4099 return false;
4100 }
4101 }
4102
4103 /**
4104 * Does this title refer to a page that can (or might) be meaningfully
4105 * viewed? In particular, this function may be used to determine if
4106 * links to the title should be rendered as "bluelinks" (as opposed to
4107 * "redlinks" to non-existent pages).
4108 * Adding something else to this function will cause inconsistency
4109 * since LinkHolderArray calls isAlwaysKnown() and does its own
4110 * page existence check.
4111 *
4112 * @return bool
4113 */
4114 public function isKnown() {
4115 return $this->isAlwaysKnown() || $this->exists();
4116 }
4117
4118 /**
4119 * Does this page have source text?
4120 *
4121 * @return bool
4122 */
4123 public function hasSourceText() {
4124 if ( $this->exists() ) {
4125 return true;
4126 }
4127
4128 if ( $this->mNamespace == NS_MEDIAWIKI ) {
4129 // If the page doesn't exist but is a known system message, default
4130 // message content will be displayed, same for language subpages-
4131 // Use always content language to avoid loading hundreds of languages
4132 // to get the link color.
4133 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
4134 list( $name, ) = MessageCache::singleton()->figureMessage(
4135 $contLang->lcfirst( $this->getText() )
4136 );
4137 $message = wfMessage( $name )->inLanguage( $contLang )->useDatabase( false );
4138 return $message->exists();
4139 }
4140
4141 return false;
4142 }
4143
4144 /**
4145 * Get the default (plain) message contents for an page that overrides an
4146 * interface message key.
4147 *
4148 * Primary use cases:
4149 *
4150 * - Article:
4151 * - Show default when viewing the page. The Article::getSubstituteContent
4152 * method displays the default message content, instead of the
4153 * 'noarticletext' placeholder message normally used.
4154 *
4155 * - EditPage:
4156 * - Title of edit page. When creating an interface message override,
4157 * the editor is told they are "Editing the page", instead of
4158 * "Creating the page". (EditPage::setHeaders)
4159 * - Edit notice. The 'translateinterface' edit notice is shown when creating
4160 * or editing a an interface message override. (EditPage::showIntro)
4161 * - Opening the editor. The contents of the localisation message are used
4162 * as contents of the editor when creating a new page in the MediaWiki
4163 * namespace. This simplifies the process for editors when "changing"
4164 * an interface message by creating an override. (EditPage::getContentObject)
4165 * - Showing a diff. The left-hand side of a diff when an editor is
4166 * previewing their changes before saving the creation of a page in the
4167 * MediaWiki namespace. (EditPage::showDiff)
4168 * - Disallowing a save. When attempting to create a a MediaWiki-namespace
4169 * page with the proposed content matching the interface message default,
4170 * the save is rejected, the same way we disallow blank pages from being
4171 * created. (EditPage::internalAttemptSave)
4172 *
4173 * - ApiEditPage:
4174 * - Default content, when using the 'prepend' or 'append' feature.
4175 *
4176 * - SkinTemplate:
4177 * - Label the create action as "Edit", if the page can be an override.
4178 *
4179 * @return string|bool
4180 */
4181 public function getDefaultMessageText() {
4182 if ( $this->mNamespace != NS_MEDIAWIKI ) { // Just in case
4183 return false;
4184 }
4185
4186 list( $name, $lang ) = MessageCache::singleton()->figureMessage(
4187 MediaWikiServices::getInstance()->getContentLanguage()->lcfirst( $this->getText() )
4188 );
4189 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4190
4191 if ( $message->exists() ) {
4192 return $message->plain();
4193 } else {
4194 return false;
4195 }
4196 }
4197
4198 /**
4199 * Updates page_touched for this page; called from LinksUpdate.php
4200 *
4201 * @param string|null $purgeTime [optional] TS_MW timestamp
4202 * @return bool True if the update succeeded
4203 */
4204 public function invalidateCache( $purgeTime = null ) {
4205 if ( wfReadOnly() ) {
4206 return false;
4207 } elseif ( $this->mArticleID === 0 ) {
4208 return true; // avoid gap locking if we know it's not there
4209 }
4210
4211 $dbw = wfGetDB( DB_MASTER );
4212 $dbw->onTransactionPreCommitOrIdle(
4213 function () use ( $dbw ) {
4214 ResourceLoaderWikiModule::invalidateModuleCache(
4215 $this, null, null, $dbw->getDomainID() );
4216 },
4217 __METHOD__
4218 );
4219
4220 $conds = $this->pageCond();
4221 DeferredUpdates::addUpdate(
4222 new AutoCommitUpdate(
4223 $dbw,
4224 __METHOD__,
4225 function ( IDatabase $dbw, $fname ) use ( $conds, $purgeTime ) {
4226 $dbTimestamp = $dbw->timestamp( $purgeTime ?: time() );
4227 $dbw->update(
4228 'page',
4229 [ 'page_touched' => $dbTimestamp ],
4230 $conds + [ 'page_touched < ' . $dbw->addQuotes( $dbTimestamp ) ],
4231 $fname
4232 );
4233 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $this );
4234 }
4235 ),
4236 DeferredUpdates::PRESEND
4237 );
4238
4239 return true;
4240 }
4241
4242 /**
4243 * Update page_touched timestamps and send CDN purge messages for
4244 * pages linking to this title. May be sent to the job queue depending
4245 * on the number of links. Typically called on create and delete.
4246 */
4247 public function touchLinks() {
4248 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this, 'pagelinks', 'page-touch' ) );
4249 if ( $this->mNamespace == NS_CATEGORY ) {
4250 DeferredUpdates::addUpdate(
4251 new HTMLCacheUpdate( $this, 'categorylinks', 'category-touch' )
4252 );
4253 }
4254 }
4255
4256 /**
4257 * Get the last touched timestamp
4258 *
4259 * @param IDatabase|null $db
4260 * @return string|false Last-touched timestamp
4261 */
4262 public function getTouched( $db = null ) {
4263 if ( $db === null ) {
4264 $db = wfGetDB( DB_REPLICA );
4265 }
4266 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
4267 return $touched;
4268 }
4269
4270 /**
4271 * Get the timestamp when this page was updated since the user last saw it.
4272 *
4273 * @param User|null $user
4274 * @return string|bool|null String timestamp, false if not watched, null if nothing is unseen
4275 */
4276 public function getNotificationTimestamp( $user = null ) {
4277 global $wgUser;
4278
4279 // Assume current user if none given
4280 if ( !$user ) {
4281 $user = $wgUser;
4282 }
4283 // Check cache first
4284 $uid = $user->getId();
4285 if ( !$uid ) {
4286 return false;
4287 }
4288 // avoid isset here, as it'll return false for null entries
4289 if ( array_key_exists( $uid, $this->mNotificationTimestamp ) ) {
4290 return $this->mNotificationTimestamp[$uid];
4291 }
4292 // Don't cache too much!
4293 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
4294 $this->mNotificationTimestamp = [];
4295 }
4296
4297 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
4298 $watchedItem = $store->getWatchedItem( $user, $this );
4299 if ( $watchedItem ) {
4300 $this->mNotificationTimestamp[$uid] = $watchedItem->getNotificationTimestamp();
4301 } else {
4302 $this->mNotificationTimestamp[$uid] = false;
4303 }
4304
4305 return $this->mNotificationTimestamp[$uid];
4306 }
4307
4308 /**
4309 * Generate strings used for xml 'id' names in monobook tabs
4310 *
4311 * @param string $prepend Defaults to 'nstab-'
4312 * @return string XML 'id' name
4313 */
4314 public function getNamespaceKey( $prepend = 'nstab-' ) {
4315 // Gets the subject namespace of this title
4316 $nsInfo = MediaWikiServices::getInstance()->getNamespaceInfo();
4317 $subjectNS = $nsInfo->getSubject( $this->mNamespace );
4318 // Prefer canonical namespace name for HTML IDs
4319 $namespaceKey = $nsInfo->getCanonicalName( $subjectNS );
4320 if ( $namespaceKey === false ) {
4321 // Fallback to localised text
4322 $namespaceKey = $this->getSubjectNsText();
4323 }
4324 // Makes namespace key lowercase
4325 $namespaceKey = MediaWikiServices::getInstance()->getContentLanguage()->lc( $namespaceKey );
4326 // Uses main
4327 if ( $namespaceKey == '' ) {
4328 $namespaceKey = 'main';
4329 }
4330 // Changes file to image for backwards compatibility
4331 if ( $namespaceKey == 'file' ) {
4332 $namespaceKey = 'image';
4333 }
4334 return $prepend . $namespaceKey;
4335 }
4336
4337 /**
4338 * Get all extant redirects to this Title
4339 *
4340 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4341 * @return Title[] Array of Title redirects to this title
4342 */
4343 public function getRedirectsHere( $ns = null ) {
4344 $redirs = [];
4345
4346 $dbr = wfGetDB( DB_REPLICA );
4347 $where = [
4348 'rd_namespace' => $this->mNamespace,
4349 'rd_title' => $this->mDbkeyform,
4350 'rd_from = page_id'
4351 ];
4352 if ( $this->isExternal() ) {
4353 $where['rd_interwiki'] = $this->mInterwiki;
4354 } else {
4355 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4356 }
4357 if ( !is_null( $ns ) ) {
4358 $where['page_namespace'] = $ns;
4359 }
4360
4361 $res = $dbr->select(
4362 [ 'redirect', 'page' ],
4363 [ 'page_namespace', 'page_title' ],
4364 $where,
4365 __METHOD__
4366 );
4367
4368 foreach ( $res as $row ) {
4369 $redirs[] = self::newFromRow( $row );
4370 }
4371 return $redirs;
4372 }
4373
4374 /**
4375 * Check if this Title is a valid redirect target
4376 *
4377 * @return bool
4378 */
4379 public function isValidRedirectTarget() {
4380 global $wgInvalidRedirectTargets;
4381
4382 if ( $this->isSpecialPage() ) {
4383 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4384 if ( $this->isSpecial( 'Userlogout' ) ) {
4385 return false;
4386 }
4387
4388 foreach ( $wgInvalidRedirectTargets as $target ) {
4389 if ( $this->isSpecial( $target ) ) {
4390 return false;
4391 }
4392 }
4393 }
4394
4395 return true;
4396 }
4397
4398 /**
4399 * Get a backlink cache object
4400 *
4401 * @return BacklinkCache
4402 */
4403 public function getBacklinkCache() {
4404 return BacklinkCache::get( $this );
4405 }
4406
4407 /**
4408 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4409 *
4410 * @return bool
4411 */
4412 public function canUseNoindex() {
4413 global $wgExemptFromUserRobotsControl;
4414
4415 $bannedNamespaces = $wgExemptFromUserRobotsControl ??
4416 MediaWikiServices::getInstance()->getNamespaceInfo()->getContentNamespaces();
4417
4418 return !in_array( $this->mNamespace, $bannedNamespaces );
4419 }
4420
4421 /**
4422 * Returns the raw sort key to be used for categories, with the specified
4423 * prefix. This will be fed to Collation::getSortKey() to get a
4424 * binary sortkey that can be used for actual sorting.
4425 *
4426 * @param string $prefix The prefix to be used, specified using
4427 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4428 * prefix.
4429 * @return string
4430 */
4431 public function getCategorySortkey( $prefix = '' ) {
4432 $unprefixed = $this->getText();
4433
4434 // Anything that uses this hook should only depend
4435 // on the Title object passed in, and should probably
4436 // tell the users to run updateCollations.php --force
4437 // in order to re-sort existing category relations.
4438 Hooks::run( 'GetDefaultSortkey', [ $this, &$unprefixed ] );
4439 if ( $prefix !== '' ) {
4440 # Separate with a line feed, so the unprefixed part is only used as
4441 # a tiebreaker when two pages have the exact same prefix.
4442 # In UCA, tab is the only character that can sort above LF
4443 # so we strip both of them from the original prefix.
4444 $prefix = strtr( $prefix, "\n\t", ' ' );
4445 return "$prefix\n$unprefixed";
4446 }
4447 return $unprefixed;
4448 }
4449
4450 /**
4451 * Returns the page language code saved in the database, if $wgPageLanguageUseDB is set
4452 * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
4453 * the db, it will return NULL.
4454 *
4455 * @return string|null|bool
4456 */
4457 private function getDbPageLanguageCode() {
4458 global $wgPageLanguageUseDB;
4459
4460 // check, if the page language could be saved in the database, and if so and
4461 // the value is not requested already, lookup the page language using LinkCache
4462 if ( $wgPageLanguageUseDB && $this->mDbPageLanguage === false ) {
4463 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
4464 $linkCache->addLinkObj( $this );
4465 $this->mDbPageLanguage = $linkCache->getGoodLinkFieldObj( $this, 'lang' );
4466 }
4467
4468 return $this->mDbPageLanguage;
4469 }
4470
4471 /**
4472 * Get the language in which the content of this page is written in
4473 * wikitext. Defaults to content language, but in certain cases it can be
4474 * e.g. $wgLang (such as special pages, which are in the user language).
4475 *
4476 * @since 1.18
4477 * @return Language
4478 */
4479 public function getPageLanguage() {
4480 global $wgLang, $wgLanguageCode;
4481 if ( $this->isSpecialPage() ) {
4482 // special pages are in the user language
4483 return $wgLang;
4484 }
4485
4486 // Checking if DB language is set
4487 $dbPageLanguage = $this->getDbPageLanguageCode();
4488 if ( $dbPageLanguage ) {
4489 return wfGetLangObj( $dbPageLanguage );
4490 }
4491
4492 if ( !$this->mPageLanguage || $this->mPageLanguage[1] !== $wgLanguageCode ) {
4493 // Note that this may depend on user settings, so the cache should
4494 // be only per-request.
4495 // NOTE: ContentHandler::getPageLanguage() may need to load the
4496 // content to determine the page language!
4497 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4498 // tests.
4499 $contentHandler = ContentHandler::getForTitle( $this );
4500 $langObj = $contentHandler->getPageLanguage( $this );
4501 $this->mPageLanguage = [ $langObj->getCode(), $wgLanguageCode ];
4502 } else {
4503 $langObj = Language::factory( $this->mPageLanguage[0] );
4504 }
4505
4506 return $langObj;
4507 }
4508
4509 /**
4510 * Get the language in which the content of this page is written when
4511 * viewed by user. Defaults to content language, but in certain cases it can be
4512 * e.g. $wgLang (such as special pages, which are in the user language).
4513 *
4514 * @since 1.20
4515 * @return Language
4516 */
4517 public function getPageViewLanguage() {
4518 global $wgLang;
4519
4520 if ( $this->isSpecialPage() ) {
4521 // If the user chooses a variant, the content is actually
4522 // in a language whose code is the variant code.
4523 $variant = $wgLang->getPreferredVariant();
4524 if ( $wgLang->getCode() !== $variant ) {
4525 return Language::factory( $variant );
4526 }
4527
4528 return $wgLang;
4529 }
4530
4531 // Checking if DB language is set
4532 $dbPageLanguage = $this->getDbPageLanguageCode();
4533 if ( $dbPageLanguage ) {
4534 $pageLang = wfGetLangObj( $dbPageLanguage );
4535 $variant = $pageLang->getPreferredVariant();
4536 if ( $pageLang->getCode() !== $variant ) {
4537 $pageLang = Language::factory( $variant );
4538 }
4539
4540 return $pageLang;
4541 }
4542
4543 // @note Can't be cached persistently, depends on user settings.
4544 // @note ContentHandler::getPageViewLanguage() may need to load the
4545 // content to determine the page language!
4546 $contentHandler = ContentHandler::getForTitle( $this );
4547 $pageLang = $contentHandler->getPageViewLanguage( $this );
4548 return $pageLang;
4549 }
4550
4551 /**
4552 * Get a list of rendered edit notices for this page.
4553 *
4554 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4555 * they will already be wrapped in paragraphs.
4556 *
4557 * @since 1.21
4558 * @param int $oldid Revision ID that's being edited
4559 * @return array
4560 */
4561 public function getEditNotices( $oldid = 0 ) {
4562 $notices = [];
4563
4564 // Optional notice for the entire namespace
4565 $editnotice_ns = 'editnotice-' . $this->mNamespace;
4566 $msg = wfMessage( $editnotice_ns );
4567 if ( $msg->exists() ) {
4568 $html = $msg->parseAsBlock();
4569 // Edit notices may have complex logic, but output nothing (T91715)
4570 if ( trim( $html ) !== '' ) {
4571 $notices[$editnotice_ns] = Html::rawElement(
4572 'div',
4573 [ 'class' => [
4574 'mw-editnotice',
4575 'mw-editnotice-namespace',
4576 Sanitizer::escapeClass( "mw-$editnotice_ns" )
4577 ] ],
4578 $html
4579 );
4580 }
4581 }
4582
4583 if (
4584 MediaWikiServices::getInstance()->getNamespaceInfo()->
4585 hasSubpages( $this->mNamespace )
4586 ) {
4587 // Optional notice for page itself and any parent page
4588 $editnotice_base = $editnotice_ns;
4589 foreach ( explode( '/', $this->mDbkeyform ) as $part ) {
4590 $editnotice_base .= '-' . $part;
4591 $msg = wfMessage( $editnotice_base );
4592 if ( $msg->exists() ) {
4593 $html = $msg->parseAsBlock();
4594 if ( trim( $html ) !== '' ) {
4595 $notices[$editnotice_base] = Html::rawElement(
4596 'div',
4597 [ 'class' => [
4598 'mw-editnotice',
4599 'mw-editnotice-base',
4600 Sanitizer::escapeClass( "mw-$editnotice_base" )
4601 ] ],
4602 $html
4603 );
4604 }
4605 }
4606 }
4607 } else {
4608 // Even if there are no subpages in namespace, we still don't want "/" in MediaWiki message keys
4609 $editnoticeText = $editnotice_ns . '-' . strtr( $this->mDbkeyform, '/', '-' );
4610 $msg = wfMessage( $editnoticeText );
4611 if ( $msg->exists() ) {
4612 $html = $msg->parseAsBlock();
4613 if ( trim( $html ) !== '' ) {
4614 $notices[$editnoticeText] = Html::rawElement(
4615 'div',
4616 [ 'class' => [
4617 'mw-editnotice',
4618 'mw-editnotice-page',
4619 Sanitizer::escapeClass( "mw-$editnoticeText" )
4620 ] ],
4621 $html
4622 );
4623 }
4624 }
4625 }
4626
4627 Hooks::run( 'TitleGetEditNotices', [ $this, $oldid, &$notices ] );
4628 return $notices;
4629 }
4630
4631 /**
4632 * @return array
4633 */
4634 public function __sleep() {
4635 return [
4636 'mNamespace',
4637 'mDbkeyform',
4638 'mFragment',
4639 'mInterwiki',
4640 'mLocalInterwiki',
4641 'mUserCaseDBKey',
4642 'mDefaultNamespace',
4643 ];
4644 }
4645
4646 public function __wakeup() {
4647 $this->mArticleID = ( $this->mNamespace >= 0 ) ? -1 : 0;
4648 $this->mUrlform = wfUrlencode( $this->mDbkeyform );
4649 $this->mTextform = strtr( $this->mDbkeyform, '_', ' ' );
4650 }
4651
4652 }