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