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