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