d0d77e371ea8350f6e0f2d1d7f2da5a0d3163a4c
[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 HashBagOStuff */
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 /** @var string|bool */
112 protected $mOldRestrictions = false;
113
114 /** @var bool Cascade restrictions on this page to included templates and images? */
115 public $mCascadeRestriction;
116
117 /** Caching the results of getCascadeProtectionSources */
118 public $mCascadingRestrictions;
119
120 /** @var array When do the restrictions on this page expire? */
121 protected $mRestrictionsExpiry = [];
122
123 /** @var bool Are cascading restrictions in effect on this page? */
124 protected $mHasCascadingRestrictions;
125
126 /** @var array Where are the cascading restrictions coming from on this page? */
127 public $mCascadeSources;
128
129 /** @var bool Boolean for initialisation on demand */
130 public $mRestrictionsLoaded = false;
131
132 /** @var string Text form including namespace/interwiki, initialised on demand */
133 protected $mPrefixedText = null;
134
135 /** @var mixed Cached value for getTitleProtection (create protection) */
136 public $mTitleProtection;
137
138 /**
139 * @var int Namespace index when there is no namespace. Don't change the
140 * following default, NS_MAIN is hardcoded in several places. See T2696.
141 * Zero except in {{transclusion}} tags.
142 */
143 public $mDefaultNamespace = NS_MAIN;
144
145 /** @var int The page length, 0 for special pages */
146 protected $mLength = -1;
147
148 /** @var null Is the article at this title a redirect? */
149 public $mRedirect = null;
150
151 /** @var array Associative array of user ID -> timestamp/false */
152 private $mNotificationTimestamp = [];
153
154 /** @var bool Whether a page has any subpages */
155 private $mHasSubpages;
156
157 /** @var bool The (string) language code of the page's language and content code. */
158 private $mPageLanguage = false;
159
160 /** @var string|bool|null The page language code from the database, null if not saved in
161 * the database or false if not loaded, yet. */
162 private $mDbPageLanguage = false;
163
164 /** @var TitleValue A corresponding TitleValue object */
165 private $mTitleValue = null;
166
167 /** @var bool Would deleting this page be a big deletion? */
168 private $mIsBigDeletion = null;
169 // @}
170
171 /**
172 * B/C kludge: provide a TitleParser for use by Title.
173 * Ideally, Title would have no methods that need this.
174 * Avoid usage of this singleton by using TitleValue
175 * and the associated services when possible.
176 *
177 * @return TitleFormatter
178 */
179 private static function getTitleFormatter() {
180 return MediaWikiServices::getInstance()->getTitleFormatter();
181 }
182
183 /**
184 * B/C kludge: provide an InterwikiLookup for use by Title.
185 * Ideally, Title would have no methods that need this.
186 * Avoid usage of this singleton by using TitleValue
187 * and the associated services when possible.
188 *
189 * @return InterwikiLookup
190 */
191 private static function getInterwikiLookup() {
192 return MediaWikiServices::getInstance()->getInterwikiLookup();
193 }
194
195 /**
196 * @access protected
197 */
198 function __construct() {
199 }
200
201 /**
202 * Create a new Title from a prefixed DB key
203 *
204 * @param string $key The database key, which has underscores
205 * instead of spaces, possibly including namespace and
206 * interwiki prefixes
207 * @return Title|null Title, or null on an error
208 */
209 public static function newFromDBkey( $key ) {
210 $t = new Title();
211 $t->mDbkeyform = $key;
212
213 try {
214 $t->secureAndSplit();
215 return $t;
216 } catch ( MalformedTitleException $ex ) {
217 return null;
218 }
219 }
220
221 /**
222 * Create a new Title from a TitleValue
223 *
224 * @param TitleValue $titleValue Assumed to be safe.
225 *
226 * @return Title
227 */
228 public static function newFromTitleValue( TitleValue $titleValue ) {
229 return self::newFromLinkTarget( $titleValue );
230 }
231
232 /**
233 * Create a new Title from a LinkTarget
234 *
235 * @param LinkTarget $linkTarget Assumed to be safe.
236 *
237 * @return Title
238 */
239 public static function newFromLinkTarget( LinkTarget $linkTarget ) {
240 if ( $linkTarget instanceof Title ) {
241 // Special case if it's already a Title object
242 return $linkTarget;
243 }
244 return self::makeTitle(
245 $linkTarget->getNamespace(),
246 $linkTarget->getText(),
247 $linkTarget->getFragment(),
248 $linkTarget->getInterwiki()
249 );
250 }
251
252 /**
253 * Create a new Title from text, such as what one would find in a link. De-
254 * codes any HTML entities in the text.
255 *
256 * Title objects returned by this method are guaranteed to be valid, and
257 * thus return true from the isValid() method.
258 *
259 * @param string|int|null $text The link text; spaces, prefixes, and an
260 * initial ':' indicating the main namespace are accepted.
261 * @param int $defaultNamespace The namespace to use if none is specified
262 * by a prefix. If you want to force a specific namespace even if
263 * $text might begin with a namespace prefix, use makeTitle() or
264 * makeTitleSafe().
265 * @throws InvalidArgumentException
266 * @return Title|null Title or null on an error.
267 */
268 public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
269 // DWIM: Integers can be passed in here when page titles are used as array keys.
270 if ( $text !== null && !is_string( $text ) && !is_int( $text ) ) {
271 throw new InvalidArgumentException( '$text must be a string.' );
272 }
273 if ( $text === null ) {
274 return null;
275 }
276
277 try {
278 return self::newFromTextThrow( strval( $text ), $defaultNamespace );
279 } catch ( MalformedTitleException $ex ) {
280 return null;
281 }
282 }
283
284 /**
285 * Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,
286 * rather than returning null.
287 *
288 * The exception subclasses encode detailed information about why the title is invalid.
289 *
290 * Title objects returned by this method are guaranteed to be valid, and
291 * thus return true from the isValid() method.
292 *
293 * @see Title::newFromText
294 *
295 * @since 1.25
296 * @param string $text Title text to check
297 * @param int $defaultNamespace
298 * @throws MalformedTitleException If the title is invalid
299 * @return Title
300 */
301 public static function newFromTextThrow( $text, $defaultNamespace = NS_MAIN ) {
302 if ( is_object( $text ) ) {
303 throw new MWException( '$text must be a string, given an object' );
304 }
305
306 $titleCache = self::getTitleCache();
307
308 // Wiki pages often contain multiple links to the same page.
309 // Title normalization and parsing can become expensive on pages with many
310 // links, so we can save a little time by caching them.
311 // In theory these are value objects and won't get changed...
312 if ( $defaultNamespace == NS_MAIN ) {
313 $t = $titleCache->get( $text );
314 if ( $t ) {
315 return $t;
316 }
317 }
318
319 // Convert things like &eacute; &#257; or &#x3017; into normalized (T16952) text
320 $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text );
321
322 $t = new Title();
323 $t->mDbkeyform = strtr( $filteredText, ' ', '_' );
324 $t->mDefaultNamespace = intval( $defaultNamespace );
325
326 $t->secureAndSplit();
327 if ( $defaultNamespace == NS_MAIN ) {
328 $titleCache->set( $text, $t );
329 }
330 return $t;
331 }
332
333 /**
334 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
335 *
336 * Example of wrong and broken code:
337 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
338 *
339 * Example of right code:
340 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
341 *
342 * Create a new Title from URL-encoded text. Ensures that
343 * the given title's length does not exceed the maximum.
344 *
345 * @param string $url The title, as might be taken from a URL
346 * @return Title|null The new object, or null on an error
347 */
348 public static function newFromURL( $url ) {
349 $t = new Title();
350
351 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
352 # but some URLs used it as a space replacement and they still come
353 # from some external search tools.
354 if ( strpos( self::legalChars(), '+' ) === false ) {
355 $url = strtr( $url, '+', ' ' );
356 }
357
358 $t->mDbkeyform = strtr( $url, ' ', '_' );
359
360 try {
361 $t->secureAndSplit();
362 return $t;
363 } catch ( MalformedTitleException $ex ) {
364 return null;
365 }
366 }
367
368 /**
369 * @return HashBagOStuff
370 */
371 private static function getTitleCache() {
372 if ( self::$titleCache == null ) {
373 self::$titleCache = new HashBagOStuff( [ 'maxKeys' => self::CACHE_MAX ] );
374 }
375 return self::$titleCache;
376 }
377
378 /**
379 * Returns a list of fields that are to be selected for initializing Title
380 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
381 * whether to include page_content_model.
382 *
383 * @return array
384 */
385 protected static function getSelectFields() {
386 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
387
388 $fields = [
389 'page_namespace', 'page_title', 'page_id',
390 'page_len', 'page_is_redirect', 'page_latest',
391 ];
392
393 if ( $wgContentHandlerUseDB ) {
394 $fields[] = 'page_content_model';
395 }
396
397 if ( $wgPageLanguageUseDB ) {
398 $fields[] = 'page_lang';
399 }
400
401 return $fields;
402 }
403
404 /**
405 * Create a new Title from an article ID
406 *
407 * @param int $id The page_id corresponding to the Title to create
408 * @param int $flags Use Title::GAID_FOR_UPDATE to use master
409 * @return Title|null The new object, or null on an error
410 */
411 public static function newFromID( $id, $flags = 0 ) {
412 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_REPLICA );
413 $row = $db->selectRow(
414 'page',
415 self::getSelectFields(),
416 [ 'page_id' => $id ],
417 __METHOD__
418 );
419 if ( $row !== false ) {
420 $title = self::newFromRow( $row );
421 } else {
422 $title = null;
423 }
424 return $title;
425 }
426
427 /**
428 * Make an array of titles from an array of IDs
429 *
430 * @param int[] $ids Array of IDs
431 * @return Title[] Array of Titles
432 */
433 public static function newFromIDs( $ids ) {
434 if ( !count( $ids ) ) {
435 return [];
436 }
437 $dbr = wfGetDB( DB_REPLICA );
438
439 $res = $dbr->select(
440 'page',
441 self::getSelectFields(),
442 [ 'page_id' => $ids ],
443 __METHOD__
444 );
445
446 $titles = [];
447 foreach ( $res as $row ) {
448 $titles[] = self::newFromRow( $row );
449 }
450 return $titles;
451 }
452
453 /**
454 * Make a Title object from a DB row
455 *
456 * @param stdClass $row Object database row (needs at least page_title,page_namespace)
457 * @return Title Corresponding Title
458 */
459 public static function newFromRow( $row ) {
460 $t = self::makeTitle( $row->page_namespace, $row->page_title );
461 $t->loadFromRow( $row );
462 return $t;
463 }
464
465 /**
466 * Load Title object fields from a DB row.
467 * If false is given, the title will be treated as non-existing.
468 *
469 * @param stdClass|bool $row Database row
470 */
471 public function loadFromRow( $row ) {
472 if ( $row ) { // page found
473 if ( isset( $row->page_id ) ) {
474 $this->mArticleID = (int)$row->page_id;
475 }
476 if ( isset( $row->page_len ) ) {
477 $this->mLength = (int)$row->page_len;
478 }
479 if ( isset( $row->page_is_redirect ) ) {
480 $this->mRedirect = (bool)$row->page_is_redirect;
481 }
482 if ( isset( $row->page_latest ) ) {
483 $this->mLatestID = (int)$row->page_latest;
484 }
485 if ( !$this->mForcedContentModel && isset( $row->page_content_model ) ) {
486 $this->mContentModel = strval( $row->page_content_model );
487 } elseif ( !$this->mForcedContentModel ) {
488 $this->mContentModel = false; # initialized lazily in getContentModel()
489 }
490 if ( isset( $row->page_lang ) ) {
491 $this->mDbPageLanguage = (string)$row->page_lang;
492 }
493 if ( isset( $row->page_restrictions ) ) {
494 $this->mOldRestrictions = $row->page_restrictions;
495 }
496 } else { // page not found
497 $this->mArticleID = 0;
498 $this->mLength = 0;
499 $this->mRedirect = false;
500 $this->mLatestID = 0;
501 if ( !$this->mForcedContentModel ) {
502 $this->mContentModel = false; # initialized lazily in getContentModel()
503 }
504 }
505 }
506
507 /**
508 * Create a new Title from a namespace index and a DB key.
509 *
510 * It's assumed that $ns and $title are safe, for instance when
511 * they came directly from the database or a special page name,
512 * not from user input.
513 *
514 * No validation is applied. For convenience, spaces are normalized
515 * to underscores, so that e.g. user_text fields can be used directly.
516 *
517 * @note This method may return Title objects that are "invalid"
518 * according to the isValid() method. This is usually caused by
519 * configuration changes: e.g. a namespace that was once defined is
520 * no longer configured, or a character that was once allowed in
521 * titles is now forbidden.
522 *
523 * @param int $ns The namespace of the article
524 * @param string $title The unprefixed database key form
525 * @param string $fragment The link fragment (after the "#")
526 * @param string $interwiki The interwiki prefix
527 * @return Title The new object
528 */
529 public static function makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
530 $t = new Title();
531 $t->mInterwiki = $interwiki;
532 $t->mFragment = $fragment;
533 $t->mNamespace = $ns = intval( $ns );
534 $t->mDbkeyform = strtr( $title, ' ', '_' );
535 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
536 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
537 $t->mTextform = strtr( $title, '_', ' ' );
538 $t->mContentModel = false; # initialized lazily in getContentModel()
539 return $t;
540 }
541
542 /**
543 * Create a new Title from a namespace index and a DB key.
544 * The parameters will be checked for validity, which is a bit slower
545 * than makeTitle() but safer for user-provided data.
546 *
547 * Title objects returned by makeTitleSafe() are guaranteed to be valid,
548 * that is, they return true from the isValid() method. If no valid Title
549 * can be constructed from the input, this method returns null.
550 *
551 * @param int $ns The namespace of the article
552 * @param string $title Database key form
553 * @param string $fragment The link fragment (after the "#")
554 * @param string $interwiki Interwiki prefix
555 * @return Title|null The new object, or null on an error
556 */
557 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
558 // NOTE: ideally, this would just call makeTitle() and then isValid(),
559 // but presently, that means more overhead on a potential performance hotspot.
560
561 if ( !MWNamespace::exists( $ns ) ) {
562 return null;
563 }
564
565 $t = new Title();
566 $t->mDbkeyform = self::makeName( $ns, $title, $fragment, $interwiki, true );
567
568 try {
569 $t->secureAndSplit();
570 return $t;
571 } catch ( MalformedTitleException $ex ) {
572 return null;
573 }
574 }
575
576 /**
577 * Create a new Title for the Main Page
578 *
579 * @return Title The new object
580 */
581 public static function newMainPage() {
582 $title = self::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
583 // Don't give fatal errors if the message is broken
584 if ( !$title ) {
585 $title = self::newFromText( 'Main Page' );
586 }
587 return $title;
588 }
589
590 /**
591 * Get the prefixed DB key associated with an ID
592 *
593 * @param int $id The page_id of the article
594 * @return Title|null An object representing the article, or null if no such article was found
595 */
596 public static function nameOf( $id ) {
597 $dbr = wfGetDB( DB_REPLICA );
598
599 $s = $dbr->selectRow(
600 'page',
601 [ 'page_namespace', 'page_title' ],
602 [ 'page_id' => $id ],
603 __METHOD__
604 );
605 if ( $s === false ) {
606 return null;
607 }
608
609 $n = self::makeName( $s->page_namespace, $s->page_title );
610 return $n;
611 }
612
613 /**
614 * Get a regex character class describing the legal characters in a link
615 *
616 * @return string The list of characters, not delimited
617 */
618 public static function legalChars() {
619 global $wgLegalTitleChars;
620 return $wgLegalTitleChars;
621 }
622
623 /**
624 * Returns a simple regex that will match on characters and sequences invalid in titles.
625 * Note that this doesn't pick up many things that could be wrong with titles, but that
626 * replacing this regex with something valid will make many titles valid.
627 *
628 * @deprecated since 1.25, use MediaWikiTitleCodec::getTitleInvalidRegex() instead
629 *
630 * @return string Regex string
631 */
632 static function getTitleInvalidRegex() {
633 wfDeprecated( __METHOD__, '1.25' );
634 return MediaWikiTitleCodec::getTitleInvalidRegex();
635 }
636
637 /**
638 * Utility method for converting a character sequence from bytes to Unicode.
639 *
640 * Primary usecase being converting $wgLegalTitleChars to a sequence usable in
641 * javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
642 *
643 * @param string $byteClass
644 * @return string
645 */
646 public static function convertByteClassToUnicodeClass( $byteClass ) {
647 $length = strlen( $byteClass );
648 // Input token queue
649 $x0 = $x1 = $x2 = '';
650 // Decoded queue
651 $d0 = $d1 = $d2 = '';
652 // Decoded integer codepoints
653 $ord0 = $ord1 = $ord2 = 0;
654 // Re-encoded queue
655 $r0 = $r1 = $r2 = '';
656 // Output
657 $out = '';
658 // Flags
659 $allowUnicode = false;
660 for ( $pos = 0; $pos < $length; $pos++ ) {
661 // Shift the queues down
662 $x2 = $x1;
663 $x1 = $x0;
664 $d2 = $d1;
665 $d1 = $d0;
666 $ord2 = $ord1;
667 $ord1 = $ord0;
668 $r2 = $r1;
669 $r1 = $r0;
670 // Load the current input token and decoded values
671 $inChar = $byteClass[$pos];
672 if ( $inChar == '\\' ) {
673 if ( preg_match( '/x([0-9a-fA-F]{2})/A', $byteClass, $m, 0, $pos + 1 ) ) {
674 $x0 = $inChar . $m[0];
675 $d0 = chr( hexdec( $m[1] ) );
676 $pos += strlen( $m[0] );
677 } elseif ( preg_match( '/[0-7]{3}/A', $byteClass, $m, 0, $pos + 1 ) ) {
678 $x0 = $inChar . $m[0];
679 $d0 = chr( octdec( $m[0] ) );
680 $pos += strlen( $m[0] );
681 } elseif ( $pos + 1 >= $length ) {
682 $x0 = $d0 = '\\';
683 } else {
684 $d0 = $byteClass[$pos + 1];
685 $x0 = $inChar . $d0;
686 $pos += 1;
687 }
688 } else {
689 $x0 = $d0 = $inChar;
690 }
691 $ord0 = ord( $d0 );
692 // Load the current re-encoded value
693 if ( $ord0 < 32 || $ord0 == 0x7f ) {
694 $r0 = sprintf( '\x%02x', $ord0 );
695 } elseif ( $ord0 >= 0x80 ) {
696 // Allow unicode if a single high-bit character appears
697 $r0 = sprintf( '\x%02x', $ord0 );
698 $allowUnicode = true;
699 } elseif ( strpos( '-\\[]^', $d0 ) !== false ) {
700 $r0 = '\\' . $d0;
701 } else {
702 $r0 = $d0;
703 }
704 // Do the output
705 if ( $x0 !== '' && $x1 === '-' && $x2 !== '' ) {
706 // Range
707 if ( $ord2 > $ord0 ) {
708 // Empty range
709 } elseif ( $ord0 >= 0x80 ) {
710 // Unicode range
711 $allowUnicode = true;
712 if ( $ord2 < 0x80 ) {
713 // Keep the non-unicode section of the range
714 $out .= "$r2-\\x7F";
715 }
716 } else {
717 // Normal range
718 $out .= "$r2-$r0";
719 }
720 // Reset state to the initial value
721 $x0 = $x1 = $d0 = $d1 = $r0 = $r1 = '';
722 } elseif ( $ord2 < 0x80 ) {
723 // ASCII character
724 $out .= $r2;
725 }
726 }
727 if ( $ord1 < 0x80 ) {
728 $out .= $r1;
729 }
730 if ( $ord0 < 0x80 ) {
731 $out .= $r0;
732 }
733 if ( $allowUnicode ) {
734 $out .= '\u0080-\uFFFF';
735 }
736 return $out;
737 }
738
739 /**
740 * Make a prefixed DB key from a DB key and a namespace index
741 *
742 * @param int $ns Numerical representation of the namespace
743 * @param string $title The DB key form the title
744 * @param string $fragment The link fragment (after the "#")
745 * @param string $interwiki The interwiki prefix
746 * @param bool $canonicalNamespace If true, use the canonical name for
747 * $ns instead of the localized version.
748 * @return string The prefixed form of the title
749 */
750 public static function makeName( $ns, $title, $fragment = '', $interwiki = '',
751 $canonicalNamespace = false
752 ) {
753 global $wgContLang;
754
755 if ( $canonicalNamespace ) {
756 $namespace = MWNamespace::getCanonicalName( $ns );
757 } else {
758 $namespace = $wgContLang->getNsText( $ns );
759 }
760 $name = $namespace == '' ? $title : "$namespace:$title";
761 if ( strval( $interwiki ) != '' ) {
762 $name = "$interwiki:$name";
763 }
764 if ( strval( $fragment ) != '' ) {
765 $name .= '#' . $fragment;
766 }
767 return $name;
768 }
769
770 /**
771 * Escape a text fragment, say from a link, for a URL
772 *
773 * @deprecated since 1.30, use Sanitizer::escapeIdForLink() or escapeIdForExternalInterwiki()
774 *
775 * @param string $fragment Containing a URL or link fragment (after the "#")
776 * @return string Escaped string
777 */
778 static function escapeFragmentForURL( $fragment ) {
779 wfDeprecated( __METHOD__, '1.30' );
780 # Note that we don't urlencode the fragment. urlencoded Unicode
781 # fragments appear not to work in IE (at least up to 7) or in at least
782 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
783 # to care if they aren't encoded.
784 return Sanitizer::escapeId( $fragment, 'noninitial' );
785 }
786
787 /**
788 * Callback for usort() to do title sorts by (namespace, title)
789 *
790 * @param LinkTarget $a
791 * @param LinkTarget $b
792 *
793 * @return int Result of string comparison, or namespace comparison
794 */
795 public static function compare( LinkTarget $a, LinkTarget $b ) {
796 if ( $a->getNamespace() == $b->getNamespace() ) {
797 return strcmp( $a->getText(), $b->getText() );
798 } else {
799 return $a->getNamespace() - $b->getNamespace();
800 }
801 }
802
803 /**
804 * Returns true if the title is valid, false if it is invalid.
805 *
806 * Valid titles can be round-tripped via makeTitleSafe() and newFromText().
807 * Invalid titles may get returned from makeTitle(), and it may be useful to
808 * allow them to exist, e.g. in order to process log entries about pages in
809 * namespaces that belong to extensions that are no longer installed.
810 *
811 * @note This method is relatively expensive. When constructing Title
812 * objects that need to be valid, use an instantiator method that is guaranteed
813 * to return valid titles, such as makeTitleSafe() or newFromText().
814 *
815 * @return bool
816 */
817 public function isValid() {
818 $ns = $this->getNamespace();
819
820 if ( !MWNamespace::exists( $ns ) ) {
821 return false;
822 }
823
824 try {
825 $parser = MediaWikiServices::getInstance()->getTitleParser();
826 $parser->parseTitle( $this->getDBkey(), $ns );
827 return true;
828 } catch ( MalformedTitleException $ex ) {
829 return false;
830 }
831 }
832
833 /**
834 * Determine whether the object refers to a page within
835 * this project (either this wiki or a wiki with a local
836 * interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
837 *
838 * @return bool True if this is an in-project interwiki link or a wikilink, false otherwise
839 */
840 public function isLocal() {
841 if ( $this->isExternal() ) {
842 $iw = self::getInterwikiLookup()->fetch( $this->mInterwiki );
843 if ( $iw ) {
844 return $iw->isLocal();
845 }
846 }
847 return true;
848 }
849
850 /**
851 * Is this Title interwiki?
852 *
853 * @return bool
854 */
855 public function isExternal() {
856 return $this->mInterwiki !== '';
857 }
858
859 /**
860 * Get the interwiki prefix
861 *
862 * Use Title::isExternal to check if a interwiki is set
863 *
864 * @return string Interwiki prefix
865 */
866 public function getInterwiki() {
867 return $this->mInterwiki;
868 }
869
870 /**
871 * Was this a local interwiki link?
872 *
873 * @return bool
874 */
875 public function wasLocalInterwiki() {
876 return $this->mLocalInterwiki;
877 }
878
879 /**
880 * Determine whether the object refers to a page within
881 * this project and is transcludable.
882 *
883 * @return bool True if this is transcludable
884 */
885 public function isTrans() {
886 if ( !$this->isExternal() ) {
887 return false;
888 }
889
890 return self::getInterwikiLookup()->fetch( $this->mInterwiki )->isTranscludable();
891 }
892
893 /**
894 * Returns the DB name of the distant wiki which owns the object.
895 *
896 * @return string|false The DB name
897 */
898 public function getTransWikiID() {
899 if ( !$this->isExternal() ) {
900 return false;
901 }
902
903 return self::getInterwikiLookup()->fetch( $this->mInterwiki )->getWikiID();
904 }
905
906 /**
907 * Get a TitleValue object representing this Title.
908 *
909 * @note Not all valid Titles have a corresponding valid TitleValue
910 * (e.g. TitleValues cannot represent page-local links that have a
911 * fragment but no title text).
912 *
913 * @return TitleValue|null
914 */
915 public function getTitleValue() {
916 if ( $this->mTitleValue === null ) {
917 try {
918 $this->mTitleValue = new TitleValue(
919 $this->getNamespace(),
920 $this->getDBkey(),
921 $this->getFragment(),
922 $this->getInterwiki()
923 );
924 } catch ( InvalidArgumentException $ex ) {
925 wfDebug( __METHOD__ . ': Can\'t create a TitleValue for [[' .
926 $this->getPrefixedText() . ']]: ' . $ex->getMessage() . "\n" );
927 }
928 }
929
930 return $this->mTitleValue;
931 }
932
933 /**
934 * Get the text form (spaces not underscores) of the main part
935 *
936 * @return string Main part of the title
937 */
938 public function getText() {
939 return $this->mTextform;
940 }
941
942 /**
943 * Get the URL-encoded form of the main part
944 *
945 * @return string Main part of the title, URL-encoded
946 */
947 public function getPartialURL() {
948 return $this->mUrlform;
949 }
950
951 /**
952 * Get the main part with underscores
953 *
954 * @return string Main part of the title, with underscores
955 */
956 public function getDBkey() {
957 return $this->mDbkeyform;
958 }
959
960 /**
961 * Get the DB key with the initial letter case as specified by the user
962 *
963 * @return string DB key
964 */
965 function getUserCaseDBKey() {
966 if ( !is_null( $this->mUserCaseDBKey ) ) {
967 return $this->mUserCaseDBKey;
968 } else {
969 // If created via makeTitle(), $this->mUserCaseDBKey is not set.
970 return $this->mDbkeyform;
971 }
972 }
973
974 /**
975 * Get the namespace index, i.e. one of the NS_xxxx constants.
976 *
977 * @return int Namespace index
978 */
979 public function getNamespace() {
980 return $this->mNamespace;
981 }
982
983 /**
984 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
985 *
986 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
987 * @return string Content model id
988 */
989 public function getContentModel( $flags = 0 ) {
990 if ( !$this->mForcedContentModel
991 && ( !$this->mContentModel || $flags === self::GAID_FOR_UPDATE )
992 && $this->getArticleID( $flags )
993 ) {
994 $linkCache = LinkCache::singleton();
995 $linkCache->addLinkObj( $this ); # in case we already had an article ID
996 $this->mContentModel = $linkCache->getGoodLinkFieldObj( $this, 'model' );
997 }
998
999 if ( !$this->mContentModel ) {
1000 $this->mContentModel = ContentHandler::getDefaultModelFor( $this );
1001 }
1002
1003 return $this->mContentModel;
1004 }
1005
1006 /**
1007 * Convenience method for checking a title's content model name
1008 *
1009 * @param string $id The content model ID (use the CONTENT_MODEL_XXX constants).
1010 * @return bool True if $this->getContentModel() == $id
1011 */
1012 public function hasContentModel( $id ) {
1013 return $this->getContentModel() == $id;
1014 }
1015
1016 /**
1017 * Set a proposed content model for the page for permissions
1018 * checking. This does not actually change the content model
1019 * of a title!
1020 *
1021 * Additionally, you should make sure you've checked
1022 * ContentHandler::canBeUsedOn() first.
1023 *
1024 * @since 1.28
1025 * @param string $model CONTENT_MODEL_XXX constant
1026 */
1027 public function setContentModel( $model ) {
1028 $this->mContentModel = $model;
1029 $this->mForcedContentModel = true;
1030 }
1031
1032 /**
1033 * Get the namespace text
1034 *
1035 * @return string|false Namespace text
1036 */
1037 public function getNsText() {
1038 if ( $this->isExternal() ) {
1039 // This probably shouldn't even happen,
1040 // but for interwiki transclusion it sometimes does.
1041 // Use the canonical namespaces if possible to try to
1042 // resolve a foreign namespace.
1043 if ( MWNamespace::exists( $this->mNamespace ) ) {
1044 return MWNamespace::getCanonicalName( $this->mNamespace );
1045 }
1046 }
1047
1048 try {
1049 $formatter = self::getTitleFormatter();
1050 return $formatter->getNamespaceName( $this->mNamespace, $this->mDbkeyform );
1051 } catch ( InvalidArgumentException $ex ) {
1052 wfDebug( __METHOD__ . ': ' . $ex->getMessage() . "\n" );
1053 return false;
1054 }
1055 }
1056
1057 /**
1058 * Get the namespace text of the subject (rather than talk) page
1059 *
1060 * @return string Namespace text
1061 */
1062 public function getSubjectNsText() {
1063 global $wgContLang;
1064 return $wgContLang->getNsText( MWNamespace::getSubject( $this->mNamespace ) );
1065 }
1066
1067 /**
1068 * Get the namespace text of the talk page
1069 *
1070 * @return string Namespace text
1071 */
1072 public function getTalkNsText() {
1073 global $wgContLang;
1074 return $wgContLang->getNsText( MWNamespace::getTalk( $this->mNamespace ) );
1075 }
1076
1077 /**
1078 * Can this title have a corresponding talk page?
1079 *
1080 * @deprecated since 1.30, use canHaveTalkPage() instead.
1081 *
1082 * @return bool True if this title either is a talk page or can have a talk page associated.
1083 */
1084 public function canTalk() {
1085 return $this->canHaveTalkPage();
1086 }
1087
1088 /**
1089 * Can this title have a corresponding talk page?
1090 *
1091 * @see MWNamespace::hasTalkNamespace
1092 * @since 1.30
1093 *
1094 * @return bool True if this title either is a talk page or can have a talk page associated.
1095 */
1096 public function canHaveTalkPage() {
1097 return MWNamespace::hasTalkNamespace( $this->mNamespace );
1098 }
1099
1100 /**
1101 * Is this in a namespace that allows actual pages?
1102 *
1103 * @return bool
1104 */
1105 public function canExist() {
1106 return $this->mNamespace >= NS_MAIN;
1107 }
1108
1109 /**
1110 * Can this title be added to a user's watchlist?
1111 *
1112 * @return bool
1113 */
1114 public function isWatchable() {
1115 return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() );
1116 }
1117
1118 /**
1119 * Returns true if this is a special page.
1120 *
1121 * @return bool
1122 */
1123 public function isSpecialPage() {
1124 return $this->getNamespace() == NS_SPECIAL;
1125 }
1126
1127 /**
1128 * Returns true if this title resolves to the named special page
1129 *
1130 * @param string $name The special page name
1131 * @return bool
1132 */
1133 public function isSpecial( $name ) {
1134 if ( $this->isSpecialPage() ) {
1135 list( $thisName, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $this->getDBkey() );
1136 if ( $name == $thisName ) {
1137 return true;
1138 }
1139 }
1140 return false;
1141 }
1142
1143 /**
1144 * If the Title refers to a special page alias which is not the local default, resolve
1145 * the alias, and localise the name as necessary. Otherwise, return $this
1146 *
1147 * @return Title
1148 */
1149 public function fixSpecialName() {
1150 if ( $this->isSpecialPage() ) {
1151 list( $canonicalName, $par ) = SpecialPageFactory::resolveAlias( $this->mDbkeyform );
1152 if ( $canonicalName ) {
1153 $localName = SpecialPageFactory::getLocalNameFor( $canonicalName, $par );
1154 if ( $localName != $this->mDbkeyform ) {
1155 return self::makeTitle( NS_SPECIAL, $localName );
1156 }
1157 }
1158 }
1159 return $this;
1160 }
1161
1162 /**
1163 * Returns true if the title is inside the specified namespace.
1164 *
1165 * Please make use of this instead of comparing to getNamespace()
1166 * This function is much more resistant to changes we may make
1167 * to namespaces than code that makes direct comparisons.
1168 * @param int $ns The namespace
1169 * @return bool
1170 * @since 1.19
1171 */
1172 public function inNamespace( $ns ) {
1173 return MWNamespace::equals( $this->getNamespace(), $ns );
1174 }
1175
1176 /**
1177 * Returns true if the title is inside one of the specified namespaces.
1178 *
1179 * @param int|int[] $namespaces,... The namespaces to check for
1180 * @return bool
1181 * @since 1.19
1182 */
1183 public function inNamespaces( /* ... */ ) {
1184 $namespaces = func_get_args();
1185 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
1186 $namespaces = $namespaces[0];
1187 }
1188
1189 foreach ( $namespaces as $ns ) {
1190 if ( $this->inNamespace( $ns ) ) {
1191 return true;
1192 }
1193 }
1194
1195 return false;
1196 }
1197
1198 /**
1199 * Returns true if the title has the same subject namespace as the
1200 * namespace specified.
1201 * For example this method will take NS_USER and return true if namespace
1202 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
1203 * as their subject namespace.
1204 *
1205 * This is MUCH simpler than individually testing for equivalence
1206 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
1207 * @since 1.19
1208 * @param int $ns
1209 * @return bool
1210 */
1211 public function hasSubjectNamespace( $ns ) {
1212 return MWNamespace::subjectEquals( $this->getNamespace(), $ns );
1213 }
1214
1215 /**
1216 * Is this Title in a namespace which contains content?
1217 * In other words, is this a content page, for the purposes of calculating
1218 * statistics, etc?
1219 *
1220 * @return bool
1221 */
1222 public function isContentPage() {
1223 return MWNamespace::isContent( $this->getNamespace() );
1224 }
1225
1226 /**
1227 * Would anybody with sufficient privileges be able to move this page?
1228 * Some pages just aren't movable.
1229 *
1230 * @return bool
1231 */
1232 public function isMovable() {
1233 if ( !MWNamespace::isMovable( $this->getNamespace() ) || $this->isExternal() ) {
1234 // Interwiki title or immovable namespace. Hooks don't get to override here
1235 return false;
1236 }
1237
1238 $result = true;
1239 Hooks::run( 'TitleIsMovable', [ $this, &$result ] );
1240 return $result;
1241 }
1242
1243 /**
1244 * Is this the mainpage?
1245 * @note Title::newFromText seems to be sufficiently optimized by the title
1246 * cache that we don't need to over-optimize by doing direct comparisons and
1247 * accidentally creating new bugs where $title->equals( Title::newFromText() )
1248 * ends up reporting something differently than $title->isMainPage();
1249 *
1250 * @since 1.18
1251 * @return bool
1252 */
1253 public function isMainPage() {
1254 return $this->equals( self::newMainPage() );
1255 }
1256
1257 /**
1258 * Is this a subpage?
1259 *
1260 * @return bool
1261 */
1262 public function isSubpage() {
1263 return MWNamespace::hasSubpages( $this->mNamespace )
1264 ? strpos( $this->getText(), '/' ) !== false
1265 : false;
1266 }
1267
1268 /**
1269 * Is this a conversion table for the LanguageConverter?
1270 *
1271 * @return bool
1272 */
1273 public function isConversionTable() {
1274 // @todo ConversionTable should become a separate content model.
1275
1276 return $this->getNamespace() == NS_MEDIAWIKI &&
1277 strpos( $this->getText(), 'Conversiontable/' ) === 0;
1278 }
1279
1280 /**
1281 * Does that page contain wikitext, or it is JS, CSS or whatever?
1282 *
1283 * @return bool
1284 */
1285 public function isWikitextPage() {
1286 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT );
1287 }
1288
1289 /**
1290 * Could this page contain custom CSS or JavaScript for the global UI.
1291 * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
1292 * or CONTENT_MODEL_JAVASCRIPT.
1293 *
1294 * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage()
1295 * for that!
1296 *
1297 * Note that this method should not return true for pages that contain and
1298 * show "inactive" CSS or JS.
1299 *
1300 * @return bool
1301 * @todo FIXME: Rename to isSiteConfigPage() and remove deprecated hook
1302 */
1303 public function isCssOrJsPage() {
1304 $isCssOrJsPage = NS_MEDIAWIKI == $this->mNamespace
1305 && ( $this->hasContentModel( CONTENT_MODEL_CSS )
1306 || $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) );
1307
1308 return $isCssOrJsPage;
1309 }
1310
1311 /**
1312 * Is this a .css or .js subpage of a user page?
1313 * @return bool
1314 * @todo FIXME: Rename to isUserConfigPage()
1315 */
1316 public function isCssJsSubpage() {
1317 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1318 && ( $this->hasContentModel( CONTENT_MODEL_CSS )
1319 || $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) ) );
1320 }
1321
1322 /**
1323 * Trim down a .css or .js subpage title to get the corresponding skin name
1324 *
1325 * @return string Containing skin name from .css or .js subpage title
1326 */
1327 public function getSkinFromCssJsSubpage() {
1328 $subpage = explode( '/', $this->mTextform );
1329 $subpage = $subpage[count( $subpage ) - 1];
1330 $lastdot = strrpos( $subpage, '.' );
1331 if ( $lastdot === false ) {
1332 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
1333 }
1334 return substr( $subpage, 0, $lastdot );
1335 }
1336
1337 /**
1338 * Is this a .css subpage of a user page?
1339 *
1340 * @return bool
1341 */
1342 public function isCssSubpage() {
1343 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1344 && $this->hasContentModel( CONTENT_MODEL_CSS ) );
1345 }
1346
1347 /**
1348 * Is this a .js subpage of a user page?
1349 *
1350 * @return bool
1351 */
1352 public function isJsSubpage() {
1353 return ( NS_USER == $this->mNamespace && $this->isSubpage()
1354 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT ) );
1355 }
1356
1357 /**
1358 * Is this a talk page of some sort?
1359 *
1360 * @return bool
1361 */
1362 public function isTalkPage() {
1363 return MWNamespace::isTalk( $this->getNamespace() );
1364 }
1365
1366 /**
1367 * Get a Title object associated with the talk page of this article
1368 *
1369 * @return Title The object for the talk page
1370 */
1371 public function getTalkPage() {
1372 return self::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1373 }
1374
1375 /**
1376 * Get a Title object associated with the talk page of this article,
1377 * if such a talk page can exist.
1378 *
1379 * @since 1.30
1380 *
1381 * @return Title|null The object for the talk page,
1382 * or null if no associated talk page can exist, according to canHaveTalkPage().
1383 */
1384 public function getTalkPageIfDefined() {
1385 if ( !$this->canHaveTalkPage() ) {
1386 return null;
1387 }
1388
1389 return $this->getTalkPage();
1390 }
1391
1392 /**
1393 * Get a title object associated with the subject page of this
1394 * talk page
1395 *
1396 * @return Title The object for the subject page
1397 */
1398 public function getSubjectPage() {
1399 // Is this the same title?
1400 $subjectNS = MWNamespace::getSubject( $this->getNamespace() );
1401 if ( $this->getNamespace() == $subjectNS ) {
1402 return $this;
1403 }
1404 return self::makeTitle( $subjectNS, $this->getDBkey() );
1405 }
1406
1407 /**
1408 * Get the other title for this page, if this is a subject page
1409 * get the talk page, if it is a subject page get the talk page
1410 *
1411 * @since 1.25
1412 * @throws MWException If the page doesn't have an other page
1413 * @return Title
1414 */
1415 public function getOtherPage() {
1416 if ( $this->isSpecialPage() ) {
1417 throw new MWException( 'Special pages cannot have other pages' );
1418 }
1419 if ( $this->isTalkPage() ) {
1420 return $this->getSubjectPage();
1421 } else {
1422 if ( !$this->canHaveTalkPage() ) {
1423 throw new MWException( "{$this->getPrefixedText()} does not have an other page" );
1424 }
1425 return $this->getTalkPage();
1426 }
1427 }
1428
1429 /**
1430 * Get the default namespace index, for when there is no namespace
1431 *
1432 * @return int Default namespace index
1433 */
1434 public function getDefaultNamespace() {
1435 return $this->mDefaultNamespace;
1436 }
1437
1438 /**
1439 * Get the Title fragment (i.e.\ the bit after the #) in text form
1440 *
1441 * Use Title::hasFragment to check for a fragment
1442 *
1443 * @return string Title fragment
1444 */
1445 public function getFragment() {
1446 return $this->mFragment;
1447 }
1448
1449 /**
1450 * Check if a Title fragment is set
1451 *
1452 * @return bool
1453 * @since 1.23
1454 */
1455 public function hasFragment() {
1456 return $this->mFragment !== '';
1457 }
1458
1459 /**
1460 * Get the fragment in URL form, including the "#" character if there is one
1461 *
1462 * @return string Fragment in URL form
1463 */
1464 public function getFragmentForURL() {
1465 if ( !$this->hasFragment() ) {
1466 return '';
1467 } elseif ( $this->isExternal()
1468 && !self::getInterwikiLookup()->fetch( $this->mInterwiki )->isLocal()
1469 ) {
1470 return '#' . Sanitizer::escapeIdForExternalInterwiki( $this->getFragment() );
1471 }
1472 return '#' . Sanitizer::escapeIdForLink( $this->getFragment() );
1473 }
1474
1475 /**
1476 * Set the fragment for this title. Removes the first character from the
1477 * specified fragment before setting, so it assumes you're passing it with
1478 * an initial "#".
1479 *
1480 * Deprecated for public use, use Title::makeTitle() with fragment parameter,
1481 * or Title::createFragmentTarget().
1482 * Still in active use privately.
1483 *
1484 * @private
1485 * @param string $fragment Text
1486 */
1487 public function setFragment( $fragment ) {
1488 $this->mFragment = strtr( substr( $fragment, 1 ), '_', ' ' );
1489 }
1490
1491 /**
1492 * Creates a new Title for a different fragment of the same page.
1493 *
1494 * @since 1.27
1495 * @param string $fragment
1496 * @return Title
1497 */
1498 public function createFragmentTarget( $fragment ) {
1499 return self::makeTitle(
1500 $this->getNamespace(),
1501 $this->getText(),
1502 $fragment,
1503 $this->getInterwiki()
1504 );
1505 }
1506
1507 /**
1508 * Prefix some arbitrary text with the namespace or interwiki prefix
1509 * of this object
1510 *
1511 * @param string $name The text
1512 * @return string The prefixed text
1513 */
1514 private function prefix( $name ) {
1515 global $wgContLang;
1516
1517 $p = '';
1518 if ( $this->isExternal() ) {
1519 $p = $this->mInterwiki . ':';
1520 }
1521
1522 if ( 0 != $this->mNamespace ) {
1523 $nsText = $this->getNsText();
1524
1525 if ( $nsText === false ) {
1526 // See T165149. Awkward, but better than erroneously linking to the main namespace.
1527 $nsText = $wgContLang->getNsText( NS_SPECIAL ) . ":Badtitle/NS{$this->mNamespace}";
1528 }
1529
1530 $p .= $nsText . ':';
1531 }
1532 return $p . $name;
1533 }
1534
1535 /**
1536 * Get the prefixed database key form
1537 *
1538 * @return string The prefixed title, with underscores and
1539 * any interwiki and namespace prefixes
1540 */
1541 public function getPrefixedDBkey() {
1542 $s = $this->prefix( $this->mDbkeyform );
1543 $s = strtr( $s, ' ', '_' );
1544 return $s;
1545 }
1546
1547 /**
1548 * Get the prefixed title with spaces.
1549 * This is the form usually used for display
1550 *
1551 * @return string The prefixed title, with spaces
1552 */
1553 public function getPrefixedText() {
1554 if ( $this->mPrefixedText === null ) {
1555 $s = $this->prefix( $this->mTextform );
1556 $s = strtr( $s, '_', ' ' );
1557 $this->mPrefixedText = $s;
1558 }
1559 return $this->mPrefixedText;
1560 }
1561
1562 /**
1563 * Return a string representation of this title
1564 *
1565 * @return string Representation of this title
1566 */
1567 public function __toString() {
1568 return $this->getPrefixedText();
1569 }
1570
1571 /**
1572 * Get the prefixed title with spaces, plus any fragment
1573 * (part beginning with '#')
1574 *
1575 * @return string The prefixed title, with spaces and the fragment, including '#'
1576 */
1577 public function getFullText() {
1578 $text = $this->getPrefixedText();
1579 if ( $this->hasFragment() ) {
1580 $text .= '#' . $this->getFragment();
1581 }
1582 return $text;
1583 }
1584
1585 /**
1586 * Get the root page name text without a namespace, i.e. the leftmost part before any slashes
1587 *
1588 * @par Example:
1589 * @code
1590 * Title::newFromText('User:Foo/Bar/Baz')->getRootText();
1591 * # returns: 'Foo'
1592 * @endcode
1593 *
1594 * @return string Root name
1595 * @since 1.20
1596 */
1597 public function getRootText() {
1598 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1599 return $this->getText();
1600 }
1601
1602 return strtok( $this->getText(), '/' );
1603 }
1604
1605 /**
1606 * Get the root page name title, i.e. the leftmost part before any slashes
1607 *
1608 * @par Example:
1609 * @code
1610 * Title::newFromText('User:Foo/Bar/Baz')->getRootTitle();
1611 * # returns: Title{User:Foo}
1612 * @endcode
1613 *
1614 * @return Title Root title
1615 * @since 1.20
1616 */
1617 public function getRootTitle() {
1618 return self::makeTitle( $this->getNamespace(), $this->getRootText() );
1619 }
1620
1621 /**
1622 * Get the base page name without a namespace, i.e. the part before the subpage name
1623 *
1624 * @par Example:
1625 * @code
1626 * Title::newFromText('User:Foo/Bar/Baz')->getBaseText();
1627 * # returns: 'Foo/Bar'
1628 * @endcode
1629 *
1630 * @return string Base name
1631 */
1632 public function getBaseText() {
1633 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1634 return $this->getText();
1635 }
1636
1637 $parts = explode( '/', $this->getText() );
1638 # Don't discard the real title if there's no subpage involved
1639 if ( count( $parts ) > 1 ) {
1640 unset( $parts[count( $parts ) - 1] );
1641 }
1642 return implode( '/', $parts );
1643 }
1644
1645 /**
1646 * Get the base page name title, i.e. the part before the subpage name
1647 *
1648 * @par Example:
1649 * @code
1650 * Title::newFromText('User:Foo/Bar/Baz')->getBaseTitle();
1651 * # returns: Title{User:Foo/Bar}
1652 * @endcode
1653 *
1654 * @return Title Base title
1655 * @since 1.20
1656 */
1657 public function getBaseTitle() {
1658 return self::makeTitle( $this->getNamespace(), $this->getBaseText() );
1659 }
1660
1661 /**
1662 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1663 *
1664 * @par Example:
1665 * @code
1666 * Title::newFromText('User:Foo/Bar/Baz')->getSubpageText();
1667 * # returns: "Baz"
1668 * @endcode
1669 *
1670 * @return string Subpage name
1671 */
1672 public function getSubpageText() {
1673 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1674 return $this->mTextform;
1675 }
1676 $parts = explode( '/', $this->mTextform );
1677 return $parts[count( $parts ) - 1];
1678 }
1679
1680 /**
1681 * Get the title for a subpage of the current page
1682 *
1683 * @par Example:
1684 * @code
1685 * Title::newFromText('User:Foo/Bar/Baz')->getSubpage("Asdf");
1686 * # returns: Title{User:Foo/Bar/Baz/Asdf}
1687 * @endcode
1688 *
1689 * @param string $text The subpage name to add to the title
1690 * @return Title Subpage title
1691 * @since 1.20
1692 */
1693 public function getSubpage( $text ) {
1694 return self::makeTitleSafe( $this->getNamespace(), $this->getText() . '/' . $text );
1695 }
1696
1697 /**
1698 * Get a URL-encoded form of the subpage text
1699 *
1700 * @return string URL-encoded subpage name
1701 */
1702 public function getSubpageUrlForm() {
1703 $text = $this->getSubpageText();
1704 $text = wfUrlencode( strtr( $text, ' ', '_' ) );
1705 return $text;
1706 }
1707
1708 /**
1709 * Get a URL-encoded title (not an actual URL) including interwiki
1710 *
1711 * @return string The URL-encoded form
1712 */
1713 public function getPrefixedURL() {
1714 $s = $this->prefix( $this->mDbkeyform );
1715 $s = wfUrlencode( strtr( $s, ' ', '_' ) );
1716 return $s;
1717 }
1718
1719 /**
1720 * Helper to fix up the get{Canonical,Full,Link,Local,Internal}URL args
1721 * get{Canonical,Full,Link,Local,Internal}URL methods accepted an optional
1722 * second argument named variant. This was deprecated in favor
1723 * of passing an array of option with a "variant" key
1724 * Once $query2 is removed for good, this helper can be dropped
1725 * and the wfArrayToCgi moved to getLocalURL();
1726 *
1727 * @since 1.19 (r105919)
1728 * @param array|string $query
1729 * @param string|string[]|bool $query2
1730 * @return string
1731 */
1732 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1733 if ( $query2 !== false ) {
1734 wfDeprecated( "Title::get{Canonical,Full,Link,Local,Internal}URL " .
1735 "method called with a second parameter is deprecated. Add your " .
1736 "parameter to an array passed as the first parameter.", "1.19" );
1737 }
1738 if ( is_array( $query ) ) {
1739 $query = wfArrayToCgi( $query );
1740 }
1741 if ( $query2 ) {
1742 if ( is_string( $query2 ) ) {
1743 // $query2 is a string, we will consider this to be
1744 // a deprecated $variant argument and add it to the query
1745 $query2 = wfArrayToCgi( [ 'variant' => $query2 ] );
1746 } else {
1747 $query2 = wfArrayToCgi( $query2 );
1748 }
1749 // If we have $query content add a & to it first
1750 if ( $query ) {
1751 $query .= '&';
1752 }
1753 // Now append the queries together
1754 $query .= $query2;
1755 }
1756 return $query;
1757 }
1758
1759 /**
1760 * Get a real URL referring to this title, with interwiki link and
1761 * fragment
1762 *
1763 * @see self::getLocalURL for the arguments.
1764 * @see wfExpandUrl
1765 * @param string|string[] $query
1766 * @param string|string[]|bool $query2
1767 * @param string $proto Protocol type to use in URL
1768 * @return string The URL
1769 */
1770 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1771 $query = self::fixUrlQueryArgs( $query, $query2 );
1772
1773 # Hand off all the decisions on urls to getLocalURL
1774 $url = $this->getLocalURL( $query );
1775
1776 # Expand the url to make it a full url. Note that getLocalURL has the
1777 # potential to output full urls for a variety of reasons, so we use
1778 # wfExpandUrl instead of simply prepending $wgServer
1779 $url = wfExpandUrl( $url, $proto );
1780
1781 # Finally, add the fragment.
1782 $url .= $this->getFragmentForURL();
1783 // Avoid PHP 7.1 warning from passing $this by reference
1784 $titleRef = $this;
1785 Hooks::run( 'GetFullURL', [ &$titleRef, &$url, $query ] );
1786 return $url;
1787 }
1788
1789 /**
1790 * Get a url appropriate for making redirects based on an untrusted url arg
1791 *
1792 * This is basically the same as getFullUrl(), but in the case of external
1793 * interwikis, we send the user to a landing page, to prevent possible
1794 * phishing attacks and the like.
1795 *
1796 * @note Uses current protocol by default, since technically relative urls
1797 * aren't allowed in redirects per HTTP spec, so this is not suitable for
1798 * places where the url gets cached, as might pollute between
1799 * https and non-https users.
1800 * @see self::getLocalURL for the arguments.
1801 * @param array|string $query
1802 * @param string $proto Protocol type to use in URL
1803 * @return string A url suitable to use in an HTTP location header.
1804 */
1805 public function getFullUrlForRedirect( $query = '', $proto = PROTO_CURRENT ) {
1806 $target = $this;
1807 if ( $this->isExternal() ) {
1808 $target = SpecialPage::getTitleFor(
1809 'GoToInterwiki',
1810 $this->getPrefixedDBKey()
1811 );
1812 }
1813 return $target->getFullUrl( $query, false, $proto );
1814 }
1815
1816 /**
1817 * Get a URL with no fragment or server name (relative URL) from a Title object.
1818 * If this page is generated with action=render, however,
1819 * $wgServer is prepended to make an absolute URL.
1820 *
1821 * @see self::getFullURL to always get an absolute URL.
1822 * @see self::getLinkURL to always get a URL that's the simplest URL that will be
1823 * valid to link, locally, to the current Title.
1824 * @see self::newFromText to produce a Title object.
1825 *
1826 * @param string|string[] $query An optional query string,
1827 * not used for interwiki links. Can be specified as an associative array as well,
1828 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1829 * Some query patterns will trigger various shorturl path replacements.
1830 * @param string|string[]|bool $query2 An optional secondary query array. This one MUST
1831 * be an array. If a string is passed it will be interpreted as a deprecated
1832 * variant argument and urlencoded into a variant= argument.
1833 * This second query argument will be added to the $query
1834 * The second parameter is deprecated since 1.19. Pass it as a key,value
1835 * pair in the first parameter array instead.
1836 *
1837 * @return string String of the URL.
1838 */
1839 public function getLocalURL( $query = '', $query2 = false ) {
1840 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1841
1842 $query = self::fixUrlQueryArgs( $query, $query2 );
1843
1844 $interwiki = self::getInterwikiLookup()->fetch( $this->mInterwiki );
1845 if ( $interwiki ) {
1846 $namespace = $this->getNsText();
1847 if ( $namespace != '' ) {
1848 # Can this actually happen? Interwikis shouldn't be parsed.
1849 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1850 $namespace .= ':';
1851 }
1852 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1853 $url = wfAppendQuery( $url, $query );
1854 } else {
1855 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1856 if ( $query == '' ) {
1857 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1858 // Avoid PHP 7.1 warning from passing $this by reference
1859 $titleRef = $this;
1860 Hooks::run( 'GetLocalURL::Article', [ &$titleRef, &$url ] );
1861 } else {
1862 global $wgVariantArticlePath, $wgActionPaths, $wgContLang;
1863 $url = false;
1864 $matches = [];
1865
1866 if ( !empty( $wgActionPaths )
1867 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1868 ) {
1869 $action = urldecode( $matches[2] );
1870 if ( isset( $wgActionPaths[$action] ) ) {
1871 $query = $matches[1];
1872 if ( isset( $matches[4] ) ) {
1873 $query .= $matches[4];
1874 }
1875 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1876 if ( $query != '' ) {
1877 $url = wfAppendQuery( $url, $query );
1878 }
1879 }
1880 }
1881
1882 if ( $url === false
1883 && $wgVariantArticlePath
1884 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1885 && $this->getPageLanguage()->equals( $wgContLang )
1886 && $this->getPageLanguage()->hasVariants()
1887 ) {
1888 $variant = urldecode( $matches[1] );
1889 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1890 // Only do the variant replacement if the given variant is a valid
1891 // variant for the page's language.
1892 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1893 $url = str_replace( '$1', $dbkey, $url );
1894 }
1895 }
1896
1897 if ( $url === false ) {
1898 if ( $query == '-' ) {
1899 $query = '';
1900 }
1901 $url = "{$wgScript}?title={$dbkey}&{$query}";
1902 }
1903 }
1904 // Avoid PHP 7.1 warning from passing $this by reference
1905 $titleRef = $this;
1906 Hooks::run( 'GetLocalURL::Internal', [ &$titleRef, &$url, $query ] );
1907
1908 // @todo FIXME: This causes breakage in various places when we
1909 // actually expected a local URL and end up with dupe prefixes.
1910 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1911 $url = $wgServer . $url;
1912 }
1913 }
1914 // Avoid PHP 7.1 warning from passing $this by reference
1915 $titleRef = $this;
1916 Hooks::run( 'GetLocalURL', [ &$titleRef, &$url, $query ] );
1917 return $url;
1918 }
1919
1920 /**
1921 * Get a URL that's the simplest URL that will be valid to link, locally,
1922 * to the current Title. It includes the fragment, but does not include
1923 * the server unless action=render is used (or the link is external). If
1924 * there's a fragment but the prefixed text is empty, we just return a link
1925 * to the fragment.
1926 *
1927 * The result obviously should not be URL-escaped, but does need to be
1928 * HTML-escaped if it's being output in HTML.
1929 *
1930 * @param string|string[] $query
1931 * @param bool $query2
1932 * @param string|int|bool $proto A PROTO_* constant on how the URL should be expanded,
1933 * or false (default) for no expansion
1934 * @see self::getLocalURL for the arguments.
1935 * @return string The URL
1936 */
1937 public function getLinkURL( $query = '', $query2 = false, $proto = false ) {
1938 if ( $this->isExternal() || $proto !== false ) {
1939 $ret = $this->getFullURL( $query, $query2, $proto );
1940 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
1941 $ret = $this->getFragmentForURL();
1942 } else {
1943 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1944 }
1945 return $ret;
1946 }
1947
1948 /**
1949 * Get the URL form for an internal link.
1950 * - Used in various CDN-related code, in case we have a different
1951 * internal hostname for the server from the exposed one.
1952 *
1953 * This uses $wgInternalServer to qualify the path, or $wgServer
1954 * if $wgInternalServer is not set. If the server variable used is
1955 * protocol-relative, the URL will be expanded to http://
1956 *
1957 * @see self::getLocalURL for the arguments.
1958 * @param string $query
1959 * @param string|bool $query2
1960 * @return string The URL
1961 */
1962 public function getInternalURL( $query = '', $query2 = false ) {
1963 global $wgInternalServer, $wgServer;
1964 $query = self::fixUrlQueryArgs( $query, $query2 );
1965 $server = $wgInternalServer !== false ? $wgInternalServer : $wgServer;
1966 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP );
1967 // Avoid PHP 7.1 warning from passing $this by reference
1968 $titleRef = $this;
1969 Hooks::run( 'GetInternalURL', [ &$titleRef, &$url, $query ] );
1970 return $url;
1971 }
1972
1973 /**
1974 * Get the URL for a canonical link, for use in things like IRC and
1975 * e-mail notifications. Uses $wgCanonicalServer and the
1976 * GetCanonicalURL hook.
1977 *
1978 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1979 *
1980 * @see self::getLocalURL for the arguments.
1981 * @param string $query
1982 * @param string|bool $query2
1983 * @return string The URL
1984 * @since 1.18
1985 */
1986 public function getCanonicalURL( $query = '', $query2 = false ) {
1987 $query = self::fixUrlQueryArgs( $query, $query2 );
1988 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL );
1989 // Avoid PHP 7.1 warning from passing $this by reference
1990 $titleRef = $this;
1991 Hooks::run( 'GetCanonicalURL', [ &$titleRef, &$url, $query ] );
1992 return $url;
1993 }
1994
1995 /**
1996 * Get the edit URL for this Title
1997 *
1998 * @return string The URL, or a null string if this is an interwiki link
1999 */
2000 public function getEditURL() {
2001 if ( $this->isExternal() ) {
2002 return '';
2003 }
2004 $s = $this->getLocalURL( 'action=edit' );
2005
2006 return $s;
2007 }
2008
2009 /**
2010 * Can $user perform $action on this page?
2011 * This skips potentially expensive cascading permission checks
2012 * as well as avoids expensive error formatting
2013 *
2014 * Suitable for use for nonessential UI controls in common cases, but
2015 * _not_ for functional access control.
2016 *
2017 * May provide false positives, but should never provide a false negative.
2018 *
2019 * @param string $action Action that permission needs to be checked for
2020 * @param User $user User to check (since 1.19); $wgUser will be used if not provided.
2021 * @return bool
2022 */
2023 public function quickUserCan( $action, $user = null ) {
2024 return $this->userCan( $action, $user, false );
2025 }
2026
2027 /**
2028 * Can $user perform $action on this page?
2029 *
2030 * @param string $action Action that permission needs to be checked for
2031 * @param User $user User to check (since 1.19); $wgUser will be used if not
2032 * provided.
2033 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2034 * @return bool
2035 */
2036 public function userCan( $action, $user = null, $rigor = 'secure' ) {
2037 if ( !$user instanceof User ) {
2038 global $wgUser;
2039 $user = $wgUser;
2040 }
2041
2042 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $rigor, true ) );
2043 }
2044
2045 /**
2046 * Can $user perform $action on this page?
2047 *
2048 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
2049 *
2050 * @param string $action Action that permission needs to be checked for
2051 * @param User $user User to check
2052 * @param string $rigor One of (quick,full,secure)
2053 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2054 * - full : does cheap and expensive checks possibly from a replica DB
2055 * - secure : does cheap and expensive checks, using the master as needed
2056 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
2057 * whose corresponding errors may be ignored.
2058 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2059 */
2060 public function getUserPermissionsErrors(
2061 $action, $user, $rigor = 'secure', $ignoreErrors = []
2062 ) {
2063 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $rigor );
2064
2065 // Remove the errors being ignored.
2066 foreach ( $errors as $index => $error ) {
2067 $errKey = is_array( $error ) ? $error[0] : $error;
2068
2069 if ( in_array( $errKey, $ignoreErrors ) ) {
2070 unset( $errors[$index] );
2071 }
2072 if ( $errKey instanceof MessageSpecifier && in_array( $errKey->getKey(), $ignoreErrors ) ) {
2073 unset( $errors[$index] );
2074 }
2075 }
2076
2077 return $errors;
2078 }
2079
2080 /**
2081 * Permissions checks that fail most often, and which are easiest to test.
2082 *
2083 * @param string $action The action to check
2084 * @param User $user User to check
2085 * @param array $errors List of current errors
2086 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2087 * @param bool $short Short circuit on first error
2088 *
2089 * @return array List of errors
2090 */
2091 private function checkQuickPermissions( $action, $user, $errors, $rigor, $short ) {
2092 if ( !Hooks::run( 'TitleQuickPermissions',
2093 [ $this, $user, $action, &$errors, ( $rigor !== 'quick' ), $short ] )
2094 ) {
2095 return $errors;
2096 }
2097
2098 if ( $action == 'create' ) {
2099 if (
2100 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
2101 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
2102 ) {
2103 $errors[] = $user->isAnon() ? [ 'nocreatetext' ] : [ 'nocreate-loggedin' ];
2104 }
2105 } elseif ( $action == 'move' ) {
2106 if ( !$user->isAllowed( 'move-rootuserpages' )
2107 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
2108 // Show user page-specific message only if the user can move other pages
2109 $errors[] = [ 'cant-move-user-page' ];
2110 }
2111
2112 // Check if user is allowed to move files if it's a file
2113 if ( $this->mNamespace == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
2114 $errors[] = [ 'movenotallowedfile' ];
2115 }
2116
2117 // Check if user is allowed to move category pages if it's a category page
2118 if ( $this->mNamespace == NS_CATEGORY && !$user->isAllowed( 'move-categorypages' ) ) {
2119 $errors[] = [ 'cant-move-category-page' ];
2120 }
2121
2122 if ( !$user->isAllowed( 'move' ) ) {
2123 // User can't move anything
2124 $userCanMove = User::groupHasPermission( 'user', 'move' );
2125 $autoconfirmedCanMove = User::groupHasPermission( 'autoconfirmed', 'move' );
2126 if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) {
2127 // custom message if logged-in users without any special rights can move
2128 $errors[] = [ 'movenologintext' ];
2129 } else {
2130 $errors[] = [ 'movenotallowed' ];
2131 }
2132 }
2133 } elseif ( $action == 'move-target' ) {
2134 if ( !$user->isAllowed( 'move' ) ) {
2135 // User can't move anything
2136 $errors[] = [ 'movenotallowed' ];
2137 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
2138 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
2139 // Show user page-specific message only if the user can move other pages
2140 $errors[] = [ 'cant-move-to-user-page' ];
2141 } elseif ( !$user->isAllowed( 'move-categorypages' )
2142 && $this->mNamespace == NS_CATEGORY ) {
2143 // Show category page-specific message only if the user can move other pages
2144 $errors[] = [ 'cant-move-to-category-page' ];
2145 }
2146 } elseif ( !$user->isAllowed( $action ) ) {
2147 $errors[] = $this->missingPermissionError( $action, $short );
2148 }
2149
2150 return $errors;
2151 }
2152
2153 /**
2154 * Add the resulting error code to the errors array
2155 *
2156 * @param array $errors List of current errors
2157 * @param array $result Result of errors
2158 *
2159 * @return array List of errors
2160 */
2161 private function resultToError( $errors, $result ) {
2162 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
2163 // A single array representing an error
2164 $errors[] = $result;
2165 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
2166 // A nested array representing multiple errors
2167 $errors = array_merge( $errors, $result );
2168 } elseif ( $result !== '' && is_string( $result ) ) {
2169 // A string representing a message-id
2170 $errors[] = [ $result ];
2171 } elseif ( $result instanceof MessageSpecifier ) {
2172 // A message specifier representing an error
2173 $errors[] = [ $result ];
2174 } elseif ( $result === false ) {
2175 // a generic "We don't want them to do that"
2176 $errors[] = [ 'badaccess-group0' ];
2177 }
2178 return $errors;
2179 }
2180
2181 /**
2182 * Check various permission hooks
2183 *
2184 * @param string $action The action to check
2185 * @param User $user User to check
2186 * @param array $errors List of current errors
2187 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2188 * @param bool $short Short circuit on first error
2189 *
2190 * @return array List of errors
2191 */
2192 private function checkPermissionHooks( $action, $user, $errors, $rigor, $short ) {
2193 // Use getUserPermissionsErrors instead
2194 $result = '';
2195 // Avoid PHP 7.1 warning from passing $this by reference
2196 $titleRef = $this;
2197 if ( !Hooks::run( 'userCan', [ &$titleRef, &$user, $action, &$result ] ) ) {
2198 return $result ? [] : [ [ 'badaccess-group0' ] ];
2199 }
2200 // Check getUserPermissionsErrors hook
2201 // Avoid PHP 7.1 warning from passing $this by reference
2202 $titleRef = $this;
2203 if ( !Hooks::run( 'getUserPermissionsErrors', [ &$titleRef, &$user, $action, &$result ] ) ) {
2204 $errors = $this->resultToError( $errors, $result );
2205 }
2206 // Check getUserPermissionsErrorsExpensive hook
2207 if (
2208 $rigor !== 'quick'
2209 && !( $short && count( $errors ) > 0 )
2210 && !Hooks::run( 'getUserPermissionsErrorsExpensive', [ &$titleRef, &$user, $action, &$result ] )
2211 ) {
2212 $errors = $this->resultToError( $errors, $result );
2213 }
2214
2215 return $errors;
2216 }
2217
2218 /**
2219 * Check permissions on special pages & namespaces
2220 *
2221 * @param string $action The action to check
2222 * @param User $user User to check
2223 * @param array $errors List of current errors
2224 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2225 * @param bool $short Short circuit on first error
2226 *
2227 * @return array List of errors
2228 */
2229 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $rigor, $short ) {
2230 # Only 'createaccount' can be performed on special pages,
2231 # which don't actually exist in the DB.
2232 if ( $this->isSpecialPage() && $action !== 'createaccount' ) {
2233 $errors[] = [ 'ns-specialprotected' ];
2234 }
2235
2236 # Check $wgNamespaceProtection for restricted namespaces
2237 if ( $this->isNamespaceProtected( $user ) ) {
2238 $ns = $this->mNamespace == NS_MAIN ?
2239 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2240 $errors[] = $this->mNamespace == NS_MEDIAWIKI ?
2241 [ 'protectedinterface', $action ] : [ 'namespaceprotected', $ns, $action ];
2242 }
2243
2244 return $errors;
2245 }
2246
2247 /**
2248 * Check CSS/JS sub-page permissions
2249 *
2250 * @param string $action The action to check
2251 * @param User $user User to check
2252 * @param array $errors List of current errors
2253 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2254 * @param bool $short Short circuit on first error
2255 *
2256 * @return array List of errors
2257 */
2258 private function checkCSSandJSPermissions( $action, $user, $errors, $rigor, $short ) {
2259 # Protect css/js subpages of user pages
2260 # XXX: this might be better using restrictions
2261 if ( $action != 'patrol' ) {
2262 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform ) ) {
2263 if ( $this->isCssSubpage() && !$user->isAllowedAny( 'editmyusercss', 'editusercss' ) ) {
2264 $errors[] = [ 'mycustomcssprotected', $action ];
2265 } elseif ( $this->isJsSubpage() && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' ) ) {
2266 $errors[] = [ 'mycustomjsprotected', $action ];
2267 }
2268 } else {
2269 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
2270 $errors[] = [ 'customcssprotected', $action ];
2271 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
2272 $errors[] = [ 'customjsprotected', $action ];
2273 }
2274 }
2275 }
2276
2277 return $errors;
2278 }
2279
2280 /**
2281 * Check against page_restrictions table requirements on this
2282 * page. The user must possess all required rights for this
2283 * action.
2284 *
2285 * @param string $action The action to check
2286 * @param User $user User to check
2287 * @param array $errors List of current errors
2288 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2289 * @param bool $short Short circuit on first error
2290 *
2291 * @return array List of errors
2292 */
2293 private function checkPageRestrictions( $action, $user, $errors, $rigor, $short ) {
2294 foreach ( $this->getRestrictions( $action ) as $right ) {
2295 // Backwards compatibility, rewrite sysop -> editprotected
2296 if ( $right == 'sysop' ) {
2297 $right = 'editprotected';
2298 }
2299 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2300 if ( $right == 'autoconfirmed' ) {
2301 $right = 'editsemiprotected';
2302 }
2303 if ( $right == '' ) {
2304 continue;
2305 }
2306 if ( !$user->isAllowed( $right ) ) {
2307 $errors[] = [ 'protectedpagetext', $right, $action ];
2308 } elseif ( $this->mCascadeRestriction && !$user->isAllowed( 'protect' ) ) {
2309 $errors[] = [ 'protectedpagetext', 'protect', $action ];
2310 }
2311 }
2312
2313 return $errors;
2314 }
2315
2316 /**
2317 * Check restrictions on cascading pages.
2318 *
2319 * @param string $action The action to check
2320 * @param User $user User to check
2321 * @param array $errors List of current errors
2322 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2323 * @param bool $short Short circuit on first error
2324 *
2325 * @return array List of errors
2326 */
2327 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $rigor, $short ) {
2328 if ( $rigor !== 'quick' && !$this->isCssJsSubpage() ) {
2329 # We /could/ use the protection level on the source page, but it's
2330 # fairly ugly as we have to establish a precedence hierarchy for pages
2331 # included by multiple cascade-protected pages. So just restrict
2332 # it to people with 'protect' permission, as they could remove the
2333 # protection anyway.
2334 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2335 # Cascading protection depends on more than this page...
2336 # Several cascading protected pages may include this page...
2337 # Check each cascading level
2338 # This is only for protection restrictions, not for all actions
2339 if ( isset( $restrictions[$action] ) ) {
2340 foreach ( $restrictions[$action] as $right ) {
2341 // Backwards compatibility, rewrite sysop -> editprotected
2342 if ( $right == 'sysop' ) {
2343 $right = 'editprotected';
2344 }
2345 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2346 if ( $right == 'autoconfirmed' ) {
2347 $right = 'editsemiprotected';
2348 }
2349 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2350 $pages = '';
2351 foreach ( $cascadingSources as $page ) {
2352 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2353 }
2354 $errors[] = [ 'cascadeprotected', count( $cascadingSources ), $pages, $action ];
2355 }
2356 }
2357 }
2358 }
2359
2360 return $errors;
2361 }
2362
2363 /**
2364 * Check action permissions not already checked in checkQuickPermissions
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 checkActionPermissions( $action, $user, $errors, $rigor, $short ) {
2375 global $wgDeleteRevisionsLimit, $wgLang;
2376
2377 if ( $action == 'protect' ) {
2378 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2379 // If they can't edit, they shouldn't protect.
2380 $errors[] = [ 'protect-cantedit' ];
2381 }
2382 } elseif ( $action == 'create' ) {
2383 $title_protection = $this->getTitleProtection();
2384 if ( $title_protection ) {
2385 if ( $title_protection['permission'] == ''
2386 || !$user->isAllowed( $title_protection['permission'] )
2387 ) {
2388 $errors[] = [
2389 'titleprotected',
2390 User::whoIs( $title_protection['user'] ),
2391 $title_protection['reason']
2392 ];
2393 }
2394 }
2395 } elseif ( $action == 'move' ) {
2396 // Check for immobile pages
2397 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2398 // Specific message for this case
2399 $errors[] = [ 'immobile-source-namespace', $this->getNsText() ];
2400 } elseif ( !$this->isMovable() ) {
2401 // Less specific message for rarer cases
2402 $errors[] = [ 'immobile-source-page' ];
2403 }
2404 } elseif ( $action == 'move-target' ) {
2405 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2406 $errors[] = [ 'immobile-target-namespace', $this->getNsText() ];
2407 } elseif ( !$this->isMovable() ) {
2408 $errors[] = [ 'immobile-target-page' ];
2409 }
2410 } elseif ( $action == 'delete' ) {
2411 $tempErrors = $this->checkPageRestrictions( 'edit', $user, [], $rigor, true );
2412 if ( !$tempErrors ) {
2413 $tempErrors = $this->checkCascadingSourcesRestrictions( 'edit',
2414 $user, $tempErrors, $rigor, true );
2415 }
2416 if ( $tempErrors ) {
2417 // If protection keeps them from editing, they shouldn't be able to delete.
2418 $errors[] = [ 'deleteprotected' ];
2419 }
2420 if ( $rigor !== 'quick' && $wgDeleteRevisionsLimit
2421 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2422 ) {
2423 $errors[] = [ 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ];
2424 }
2425 } elseif ( $action === 'undelete' ) {
2426 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $rigor, true ) ) ) {
2427 // Undeleting implies editing
2428 $errors[] = [ 'undelete-cantedit' ];
2429 }
2430 if ( !$this->exists()
2431 && count( $this->getUserPermissionsErrorsInternal( 'create', $user, $rigor, true ) )
2432 ) {
2433 // Undeleting where nothing currently exists implies creating
2434 $errors[] = [ 'undelete-cantcreate' ];
2435 }
2436 }
2437 return $errors;
2438 }
2439
2440 /**
2441 * Check that the user isn't blocked from editing.
2442 *
2443 * @param string $action The action to check
2444 * @param User $user User to check
2445 * @param array $errors List of current errors
2446 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2447 * @param bool $short Short circuit on first error
2448 *
2449 * @return array List of errors
2450 */
2451 private function checkUserBlock( $action, $user, $errors, $rigor, $short ) {
2452 global $wgEmailConfirmToEdit, $wgBlockDisablesLogin;
2453 // Account creation blocks handled at userlogin.
2454 // Unblocking handled in SpecialUnblock
2455 if ( $rigor === 'quick' || in_array( $action, [ 'createaccount', 'unblock' ] ) ) {
2456 return $errors;
2457 }
2458
2459 // Optimize for a very common case
2460 if ( $action === 'read' && !$wgBlockDisablesLogin ) {
2461 return $errors;
2462 }
2463
2464 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2465 $errors[] = [ 'confirmedittext' ];
2466 }
2467
2468 $useSlave = ( $rigor !== 'secure' );
2469 if ( ( $action == 'edit' || $action == 'create' )
2470 && !$user->isBlockedFrom( $this, $useSlave )
2471 ) {
2472 // Don't block the user from editing their own talk page unless they've been
2473 // explicitly blocked from that too.
2474 } elseif ( $user->isBlocked() && $user->getBlock()->prevents( $action ) !== false ) {
2475 // @todo FIXME: Pass the relevant context into this function.
2476 $errors[] = $user->getBlock()->getPermissionsError( RequestContext::getMain() );
2477 }
2478
2479 return $errors;
2480 }
2481
2482 /**
2483 * Check that the user is allowed to read this page.
2484 *
2485 * @param string $action The action to check
2486 * @param User $user User to check
2487 * @param array $errors List of current errors
2488 * @param string $rigor Same format as Title::getUserPermissionsErrors()
2489 * @param bool $short Short circuit on first error
2490 *
2491 * @return array List of errors
2492 */
2493 private function checkReadPermissions( $action, $user, $errors, $rigor, $short ) {
2494 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2495
2496 $whitelisted = false;
2497 if ( User::isEveryoneAllowed( 'read' ) ) {
2498 # Shortcut for public wikis, allows skipping quite a bit of code
2499 $whitelisted = true;
2500 } elseif ( $user->isAllowed( 'read' ) ) {
2501 # If the user is allowed to read pages, he is allowed to read all pages
2502 $whitelisted = true;
2503 } elseif ( $this->isSpecial( 'Userlogin' )
2504 || $this->isSpecial( 'PasswordReset' )
2505 || $this->isSpecial( 'Userlogout' )
2506 ) {
2507 # Always grant access to the login page.
2508 # Even anons need to be able to log in.
2509 $whitelisted = true;
2510 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2511 # Time to check the whitelist
2512 # Only do these checks is there's something to check against
2513 $name = $this->getPrefixedText();
2514 $dbName = $this->getPrefixedDBkey();
2515
2516 // Check for explicit whitelisting with and without underscores
2517 if ( in_array( $name, $wgWhitelistRead, true ) || in_array( $dbName, $wgWhitelistRead, true ) ) {
2518 $whitelisted = true;
2519 } elseif ( $this->getNamespace() == NS_MAIN ) {
2520 # Old settings might have the title prefixed with
2521 # a colon for main-namespace pages
2522 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2523 $whitelisted = true;
2524 }
2525 } elseif ( $this->isSpecialPage() ) {
2526 # If it's a special page, ditch the subpage bit and check again
2527 $name = $this->getDBkey();
2528 list( $name, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $name );
2529 if ( $name ) {
2530 $pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
2531 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2532 $whitelisted = true;
2533 }
2534 }
2535 }
2536 }
2537
2538 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2539 $name = $this->getPrefixedText();
2540 // Check for regex whitelisting
2541 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2542 if ( preg_match( $listItem, $name ) ) {
2543 $whitelisted = true;
2544 break;
2545 }
2546 }
2547 }
2548
2549 if ( !$whitelisted ) {
2550 # If the title is not whitelisted, give extensions a chance to do so...
2551 Hooks::run( 'TitleReadWhitelist', [ $this, $user, &$whitelisted ] );
2552 if ( !$whitelisted ) {
2553 $errors[] = $this->missingPermissionError( $action, $short );
2554 }
2555 }
2556
2557 return $errors;
2558 }
2559
2560 /**
2561 * Get a description array when the user doesn't have the right to perform
2562 * $action (i.e. when User::isAllowed() returns false)
2563 *
2564 * @param string $action The action to check
2565 * @param bool $short Short circuit on first error
2566 * @return array Array containing an error message key and any parameters
2567 */
2568 private function missingPermissionError( $action, $short ) {
2569 // We avoid expensive display logic for quickUserCan's and such
2570 if ( $short ) {
2571 return [ 'badaccess-group0' ];
2572 }
2573
2574 return User::newFatalPermissionDeniedStatus( $action )->getErrorsArray()[0];
2575 }
2576
2577 /**
2578 * Can $user perform $action on this page? This is an internal function,
2579 * with multiple levels of checks depending on performance needs; see $rigor below.
2580 * It does not check wfReadOnly().
2581 *
2582 * @param string $action Action that permission needs to be checked for
2583 * @param User $user User to check
2584 * @param string $rigor One of (quick,full,secure)
2585 * - quick : does cheap permission checks from replica DBs (usable for GUI creation)
2586 * - full : does cheap and expensive checks possibly from a replica DB
2587 * - secure : does cheap and expensive checks, using the master as needed
2588 * @param bool $short Set this to true to stop after the first permission error.
2589 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2590 */
2591 protected function getUserPermissionsErrorsInternal(
2592 $action, $user, $rigor = 'secure', $short = false
2593 ) {
2594 if ( $rigor === true ) {
2595 $rigor = 'secure'; // b/c
2596 } elseif ( $rigor === false ) {
2597 $rigor = 'quick'; // b/c
2598 } elseif ( !in_array( $rigor, [ 'quick', 'full', 'secure' ] ) ) {
2599 throw new Exception( "Invalid rigor parameter '$rigor'." );
2600 }
2601
2602 # Read has special handling
2603 if ( $action == 'read' ) {
2604 $checks = [
2605 'checkPermissionHooks',
2606 'checkReadPermissions',
2607 'checkUserBlock', // for wgBlockDisablesLogin
2608 ];
2609 # Don't call checkSpecialsAndNSPermissions or checkCSSandJSPermissions
2610 # here as it will lead to duplicate error messages. This is okay to do
2611 # since anywhere that checks for create will also check for edit, and
2612 # those checks are called for edit.
2613 } elseif ( $action == 'create' ) {
2614 $checks = [
2615 'checkQuickPermissions',
2616 'checkPermissionHooks',
2617 'checkPageRestrictions',
2618 'checkCascadingSourcesRestrictions',
2619 'checkActionPermissions',
2620 'checkUserBlock'
2621 ];
2622 } else {
2623 $checks = [
2624 'checkQuickPermissions',
2625 'checkPermissionHooks',
2626 'checkSpecialsAndNSPermissions',
2627 'checkCSSandJSPermissions',
2628 'checkPageRestrictions',
2629 'checkCascadingSourcesRestrictions',
2630 'checkActionPermissions',
2631 'checkUserBlock'
2632 ];
2633 }
2634
2635 $errors = [];
2636 while ( count( $checks ) > 0 &&
2637 !( $short && count( $errors ) > 0 ) ) {
2638 $method = array_shift( $checks );
2639 $errors = $this->$method( $action, $user, $errors, $rigor, $short );
2640 }
2641
2642 return $errors;
2643 }
2644
2645 /**
2646 * Get a filtered list of all restriction types supported by this wiki.
2647 * @param bool $exists True to get all restriction types that apply to
2648 * titles that do exist, False for all restriction types that apply to
2649 * titles that do not exist
2650 * @return array
2651 */
2652 public static function getFilteredRestrictionTypes( $exists = true ) {
2653 global $wgRestrictionTypes;
2654 $types = $wgRestrictionTypes;
2655 if ( $exists ) {
2656 # Remove the create restriction for existing titles
2657 $types = array_diff( $types, [ 'create' ] );
2658 } else {
2659 # Only the create and upload restrictions apply to non-existing titles
2660 $types = array_intersect( $types, [ 'create', 'upload' ] );
2661 }
2662 return $types;
2663 }
2664
2665 /**
2666 * Returns restriction types for the current Title
2667 *
2668 * @return array Applicable restriction types
2669 */
2670 public function getRestrictionTypes() {
2671 if ( $this->isSpecialPage() ) {
2672 return [];
2673 }
2674
2675 $types = self::getFilteredRestrictionTypes( $this->exists() );
2676
2677 if ( $this->getNamespace() != NS_FILE ) {
2678 # Remove the upload restriction for non-file titles
2679 $types = array_diff( $types, [ 'upload' ] );
2680 }
2681
2682 Hooks::run( 'TitleGetRestrictionTypes', [ $this, &$types ] );
2683
2684 wfDebug( __METHOD__ . ': applicable restrictions to [[' .
2685 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2686
2687 return $types;
2688 }
2689
2690 /**
2691 * Is this title subject to title protection?
2692 * Title protection is the one applied against creation of such title.
2693 *
2694 * @return array|bool An associative array representing any existent title
2695 * protection, or false if there's none.
2696 */
2697 public function getTitleProtection() {
2698 $protection = $this->getTitleProtectionInternal();
2699 if ( $protection ) {
2700 if ( $protection['permission'] == 'sysop' ) {
2701 $protection['permission'] = 'editprotected'; // B/C
2702 }
2703 if ( $protection['permission'] == 'autoconfirmed' ) {
2704 $protection['permission'] = 'editsemiprotected'; // B/C
2705 }
2706 }
2707 return $protection;
2708 }
2709
2710 /**
2711 * Fetch title protection settings
2712 *
2713 * To work correctly, $this->loadRestrictions() needs to have access to the
2714 * actual protections in the database without munging 'sysop' =>
2715 * 'editprotected' and 'autoconfirmed' => 'editsemiprotected'. Other
2716 * callers probably want $this->getTitleProtection() instead.
2717 *
2718 * @return array|bool
2719 */
2720 protected function getTitleProtectionInternal() {
2721 // Can't protect pages in special namespaces
2722 if ( $this->getNamespace() < 0 ) {
2723 return false;
2724 }
2725
2726 // Can't protect pages that exist.
2727 if ( $this->exists() ) {
2728 return false;
2729 }
2730
2731 if ( $this->mTitleProtection === null ) {
2732 $dbr = wfGetDB( DB_REPLICA );
2733 $commentStore = new CommentStore( 'pt_reason' );
2734 $commentQuery = $commentStore->getJoin();
2735 $res = $dbr->select(
2736 [ 'protected_titles' ] + $commentQuery['tables'],
2737 [
2738 'user' => 'pt_user',
2739 'expiry' => 'pt_expiry',
2740 'permission' => 'pt_create_perm'
2741 ] + $commentQuery['fields'],
2742 [ 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ],
2743 __METHOD__,
2744 [],
2745 $commentQuery['joins']
2746 );
2747
2748 // fetchRow returns false if there are no rows.
2749 $row = $dbr->fetchRow( $res );
2750 if ( $row ) {
2751 $this->mTitleProtection = [
2752 'user' => $row['user'],
2753 'expiry' => $dbr->decodeExpiry( $row['expiry'] ),
2754 'permission' => $row['permission'],
2755 'reason' => $commentStore->getComment( $row )->text,
2756 ];
2757 } else {
2758 $this->mTitleProtection = false;
2759 }
2760 }
2761 return $this->mTitleProtection;
2762 }
2763
2764 /**
2765 * Remove any title protection due to page existing
2766 */
2767 public function deleteTitleProtection() {
2768 $dbw = wfGetDB( DB_MASTER );
2769
2770 $dbw->delete(
2771 'protected_titles',
2772 [ 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ],
2773 __METHOD__
2774 );
2775 $this->mTitleProtection = false;
2776 }
2777
2778 /**
2779 * Is this page "semi-protected" - the *only* protection levels are listed
2780 * in $wgSemiprotectedRestrictionLevels?
2781 *
2782 * @param string $action Action to check (default: edit)
2783 * @return bool
2784 */
2785 public function isSemiProtected( $action = 'edit' ) {
2786 global $wgSemiprotectedRestrictionLevels;
2787
2788 $restrictions = $this->getRestrictions( $action );
2789 $semi = $wgSemiprotectedRestrictionLevels;
2790 if ( !$restrictions || !$semi ) {
2791 // Not protected, or all protection is full protection
2792 return false;
2793 }
2794
2795 // Remap autoconfirmed to editsemiprotected for BC
2796 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2797 $semi[$key] = 'editsemiprotected';
2798 }
2799 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2800 $restrictions[$key] = 'editsemiprotected';
2801 }
2802
2803 return !array_diff( $restrictions, $semi );
2804 }
2805
2806 /**
2807 * Does the title correspond to a protected article?
2808 *
2809 * @param string $action The action the page is protected from,
2810 * by default checks all actions.
2811 * @return bool
2812 */
2813 public function isProtected( $action = '' ) {
2814 global $wgRestrictionLevels;
2815
2816 $restrictionTypes = $this->getRestrictionTypes();
2817
2818 # Special pages have inherent protection
2819 if ( $this->isSpecialPage() ) {
2820 return true;
2821 }
2822
2823 # Check regular protection levels
2824 foreach ( $restrictionTypes as $type ) {
2825 if ( $action == $type || $action == '' ) {
2826 $r = $this->getRestrictions( $type );
2827 foreach ( $wgRestrictionLevels as $level ) {
2828 if ( in_array( $level, $r ) && $level != '' ) {
2829 return true;
2830 }
2831 }
2832 }
2833 }
2834
2835 return false;
2836 }
2837
2838 /**
2839 * Determines if $user is unable to edit this page because it has been protected
2840 * by $wgNamespaceProtection.
2841 *
2842 * @param User $user User object to check permissions
2843 * @return bool
2844 */
2845 public function isNamespaceProtected( User $user ) {
2846 global $wgNamespaceProtection;
2847
2848 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
2849 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
2850 if ( $right != '' && !$user->isAllowed( $right ) ) {
2851 return true;
2852 }
2853 }
2854 }
2855 return false;
2856 }
2857
2858 /**
2859 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2860 *
2861 * @return bool If the page is subject to cascading restrictions.
2862 */
2863 public function isCascadeProtected() {
2864 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2865 return ( $sources > 0 );
2866 }
2867
2868 /**
2869 * Determines whether cascading protection sources have already been loaded from
2870 * the database.
2871 *
2872 * @param bool $getPages True to check if the pages are loaded, or false to check
2873 * if the status is loaded.
2874 * @return bool Whether or not the specified information has been loaded
2875 * @since 1.23
2876 */
2877 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2878 return $getPages ? $this->mCascadeSources !== null : $this->mHasCascadingRestrictions !== null;
2879 }
2880
2881 /**
2882 * Cascading protection: Get the source of any cascading restrictions on this page.
2883 *
2884 * @param bool $getPages Whether or not to retrieve the actual pages
2885 * that the restrictions have come from and the actual restrictions
2886 * themselves.
2887 * @return array Two elements: First is an array of Title objects of the
2888 * pages from which cascading restrictions have come, false for
2889 * none, or true if such restrictions exist but $getPages was not
2890 * set. Second is an array like that returned by
2891 * Title::getAllRestrictions(), or an empty array if $getPages is
2892 * false.
2893 */
2894 public function getCascadeProtectionSources( $getPages = true ) {
2895 $pagerestrictions = [];
2896
2897 if ( $this->mCascadeSources !== null && $getPages ) {
2898 return [ $this->mCascadeSources, $this->mCascadingRestrictions ];
2899 } elseif ( $this->mHasCascadingRestrictions !== null && !$getPages ) {
2900 return [ $this->mHasCascadingRestrictions, $pagerestrictions ];
2901 }
2902
2903 $dbr = wfGetDB( DB_REPLICA );
2904
2905 if ( $this->getNamespace() == NS_FILE ) {
2906 $tables = [ 'imagelinks', 'page_restrictions' ];
2907 $where_clauses = [
2908 'il_to' => $this->getDBkey(),
2909 'il_from=pr_page',
2910 'pr_cascade' => 1
2911 ];
2912 } else {
2913 $tables = [ 'templatelinks', 'page_restrictions' ];
2914 $where_clauses = [
2915 'tl_namespace' => $this->getNamespace(),
2916 'tl_title' => $this->getDBkey(),
2917 'tl_from=pr_page',
2918 'pr_cascade' => 1
2919 ];
2920 }
2921
2922 if ( $getPages ) {
2923 $cols = [ 'pr_page', 'page_namespace', 'page_title',
2924 'pr_expiry', 'pr_type', 'pr_level' ];
2925 $where_clauses[] = 'page_id=pr_page';
2926 $tables[] = 'page';
2927 } else {
2928 $cols = [ 'pr_expiry' ];
2929 }
2930
2931 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2932
2933 $sources = $getPages ? [] : false;
2934 $now = wfTimestampNow();
2935
2936 foreach ( $res as $row ) {
2937 $expiry = $dbr->decodeExpiry( $row->pr_expiry );
2938 if ( $expiry > $now ) {
2939 if ( $getPages ) {
2940 $page_id = $row->pr_page;
2941 $page_ns = $row->page_namespace;
2942 $page_title = $row->page_title;
2943 $sources[$page_id] = self::makeTitle( $page_ns, $page_title );
2944 # Add groups needed for each restriction type if its not already there
2945 # Make sure this restriction type still exists
2946
2947 if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2948 $pagerestrictions[$row->pr_type] = [];
2949 }
2950
2951 if (
2952 isset( $pagerestrictions[$row->pr_type] )
2953 && !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] )
2954 ) {
2955 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2956 }
2957 } else {
2958 $sources = true;
2959 }
2960 }
2961 }
2962
2963 if ( $getPages ) {
2964 $this->mCascadeSources = $sources;
2965 $this->mCascadingRestrictions = $pagerestrictions;
2966 } else {
2967 $this->mHasCascadingRestrictions = $sources;
2968 }
2969
2970 return [ $sources, $pagerestrictions ];
2971 }
2972
2973 /**
2974 * Accessor for mRestrictionsLoaded
2975 *
2976 * @return bool Whether or not the page's restrictions have already been
2977 * loaded from the database
2978 * @since 1.23
2979 */
2980 public function areRestrictionsLoaded() {
2981 return $this->mRestrictionsLoaded;
2982 }
2983
2984 /**
2985 * Accessor/initialisation for mRestrictions
2986 *
2987 * @param string $action Action that permission needs to be checked for
2988 * @return array Restriction levels needed to take the action. All levels are
2989 * required. Note that restriction levels are normally user rights, but 'sysop'
2990 * and 'autoconfirmed' are also allowed for backwards compatibility. These should
2991 * be mapped to 'editprotected' and 'editsemiprotected' respectively.
2992 */
2993 public function getRestrictions( $action ) {
2994 if ( !$this->mRestrictionsLoaded ) {
2995 $this->loadRestrictions();
2996 }
2997 return isset( $this->mRestrictions[$action] )
2998 ? $this->mRestrictions[$action]
2999 : [];
3000 }
3001
3002 /**
3003 * Accessor/initialisation for mRestrictions
3004 *
3005 * @return array Keys are actions, values are arrays as returned by
3006 * Title::getRestrictions()
3007 * @since 1.23
3008 */
3009 public function getAllRestrictions() {
3010 if ( !$this->mRestrictionsLoaded ) {
3011 $this->loadRestrictions();
3012 }
3013 return $this->mRestrictions;
3014 }
3015
3016 /**
3017 * Get the expiry time for the restriction against a given action
3018 *
3019 * @param string $action
3020 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
3021 * or not protected at all, or false if the action is not recognised.
3022 */
3023 public function getRestrictionExpiry( $action ) {
3024 if ( !$this->mRestrictionsLoaded ) {
3025 $this->loadRestrictions();
3026 }
3027 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
3028 }
3029
3030 /**
3031 * Returns cascading restrictions for the current article
3032 *
3033 * @return bool
3034 */
3035 function areRestrictionsCascading() {
3036 if ( !$this->mRestrictionsLoaded ) {
3037 $this->loadRestrictions();
3038 }
3039
3040 return $this->mCascadeRestriction;
3041 }
3042
3043 /**
3044 * Compiles list of active page restrictions from both page table (pre 1.10)
3045 * and page_restrictions table for this existing page.
3046 * Public for usage by LiquidThreads.
3047 *
3048 * @param array $rows Array of db result objects
3049 * @param string $oldFashionedRestrictions Comma-separated list of page
3050 * restrictions from page table (pre 1.10)
3051 */
3052 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
3053 $dbr = wfGetDB( DB_REPLICA );
3054
3055 $restrictionTypes = $this->getRestrictionTypes();
3056
3057 foreach ( $restrictionTypes as $type ) {
3058 $this->mRestrictions[$type] = [];
3059 $this->mRestrictionsExpiry[$type] = 'infinity';
3060 }
3061
3062 $this->mCascadeRestriction = false;
3063
3064 # Backwards-compatibility: also load the restrictions from the page record (old format).
3065 if ( $oldFashionedRestrictions !== null ) {
3066 $this->mOldRestrictions = $oldFashionedRestrictions;
3067 }
3068
3069 if ( $this->mOldRestrictions === false ) {
3070 $this->mOldRestrictions = $dbr->selectField( 'page', 'page_restrictions',
3071 [ 'page_id' => $this->getArticleID() ], __METHOD__ );
3072 }
3073
3074 if ( $this->mOldRestrictions != '' ) {
3075 foreach ( explode( ':', trim( $this->mOldRestrictions ) ) as $restrict ) {
3076 $temp = explode( '=', trim( $restrict ) );
3077 if ( count( $temp ) == 1 ) {
3078 // old old format should be treated as edit/move restriction
3079 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
3080 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
3081 } else {
3082 $restriction = trim( $temp[1] );
3083 if ( $restriction != '' ) { // some old entries are empty
3084 $this->mRestrictions[$temp[0]] = explode( ',', $restriction );
3085 }
3086 }
3087 }
3088 }
3089
3090 if ( count( $rows ) ) {
3091 # Current system - load second to make them override.
3092 $now = wfTimestampNow();
3093
3094 # Cycle through all the restrictions.
3095 foreach ( $rows as $row ) {
3096 // Don't take care of restrictions types that aren't allowed
3097 if ( !in_array( $row->pr_type, $restrictionTypes ) ) {
3098 continue;
3099 }
3100
3101 $expiry = $dbr->decodeExpiry( $row->pr_expiry );
3102
3103 // Only apply the restrictions if they haven't expired!
3104 if ( !$expiry || $expiry > $now ) {
3105 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
3106 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
3107
3108 $this->mCascadeRestriction |= $row->pr_cascade;
3109 }
3110 }
3111 }
3112
3113 $this->mRestrictionsLoaded = true;
3114 }
3115
3116 /**
3117 * Load restrictions from the page_restrictions table
3118 *
3119 * @param string $oldFashionedRestrictions Comma-separated list of page
3120 * restrictions from page table (pre 1.10)
3121 */
3122 public function loadRestrictions( $oldFashionedRestrictions = null ) {
3123 if ( $this->mRestrictionsLoaded ) {
3124 return;
3125 }
3126
3127 $id = $this->getArticleID();
3128 if ( $id ) {
3129 $cache = ObjectCache::getMainWANInstance();
3130 $rows = $cache->getWithSetCallback(
3131 // Page protections always leave a new null revision
3132 $cache->makeKey( 'page-restrictions', $id, $this->getLatestRevID() ),
3133 $cache::TTL_DAY,
3134 function ( $curValue, &$ttl, array &$setOpts ) {
3135 $dbr = wfGetDB( DB_REPLICA );
3136
3137 $setOpts += Database::getCacheSetOptions( $dbr );
3138
3139 return iterator_to_array(
3140 $dbr->select(
3141 'page_restrictions',
3142 [ 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ],
3143 [ 'pr_page' => $this->getArticleID() ],
3144 __METHOD__
3145 )
3146 );
3147 }
3148 );
3149
3150 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
3151 } else {
3152 $title_protection = $this->getTitleProtectionInternal();
3153
3154 if ( $title_protection ) {
3155 $now = wfTimestampNow();
3156 $expiry = wfGetDB( DB_REPLICA )->decodeExpiry( $title_protection['expiry'] );
3157
3158 if ( !$expiry || $expiry > $now ) {
3159 // Apply the restrictions
3160 $this->mRestrictionsExpiry['create'] = $expiry;
3161 $this->mRestrictions['create'] =
3162 explode( ',', trim( $title_protection['permission'] ) );
3163 } else { // Get rid of the old restrictions
3164 $this->mTitleProtection = false;
3165 }
3166 } else {
3167 $this->mRestrictionsExpiry['create'] = 'infinity';
3168 }
3169 $this->mRestrictionsLoaded = true;
3170 }
3171 }
3172
3173 /**
3174 * Flush the protection cache in this object and force reload from the database.
3175 * This is used when updating protection from WikiPage::doUpdateRestrictions().
3176 */
3177 public function flushRestrictions() {
3178 $this->mRestrictionsLoaded = false;
3179 $this->mTitleProtection = null;
3180 }
3181
3182 /**
3183 * Purge expired restrictions from the page_restrictions table
3184 *
3185 * This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
3186 */
3187 static function purgeExpiredRestrictions() {
3188 if ( wfReadOnly() ) {
3189 return;
3190 }
3191
3192 DeferredUpdates::addUpdate( new AtomicSectionUpdate(
3193 wfGetDB( DB_MASTER ),
3194 __METHOD__,
3195 function ( IDatabase $dbw, $fname ) {
3196 $config = MediaWikiServices::getInstance()->getMainConfig();
3197 $ids = $dbw->selectFieldValues(
3198 'page_restrictions',
3199 'pr_id',
3200 [ 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3201 $fname,
3202 [ 'LIMIT' => $config->get( 'UpdateRowsPerQuery' ) ] // T135470
3203 );
3204 if ( $ids ) {
3205 $dbw->delete( 'page_restrictions', [ 'pr_id' => $ids ], $fname );
3206 }
3207 }
3208 ) );
3209
3210 DeferredUpdates::addUpdate( new AtomicSectionUpdate(
3211 wfGetDB( DB_MASTER ),
3212 __METHOD__,
3213 function ( IDatabase $dbw, $fname ) {
3214 $dbw->delete(
3215 'protected_titles',
3216 [ 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ],
3217 $fname
3218 );
3219 }
3220 ) );
3221 }
3222
3223 /**
3224 * Does this have subpages? (Warning, usually requires an extra DB query.)
3225 *
3226 * @return bool
3227 */
3228 public function hasSubpages() {
3229 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
3230 # Duh
3231 return false;
3232 }
3233
3234 # We dynamically add a member variable for the purpose of this method
3235 # alone to cache the result. There's no point in having it hanging
3236 # around uninitialized in every Title object; therefore we only add it
3237 # if needed and don't declare it statically.
3238 if ( $this->mHasSubpages === null ) {
3239 $this->mHasSubpages = false;
3240 $subpages = $this->getSubpages( 1 );
3241 if ( $subpages instanceof TitleArray ) {
3242 $this->mHasSubpages = (bool)$subpages->count();
3243 }
3244 }
3245
3246 return $this->mHasSubpages;
3247 }
3248
3249 /**
3250 * Get all subpages of this page.
3251 *
3252 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3253 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3254 * doesn't allow subpages
3255 */
3256 public function getSubpages( $limit = -1 ) {
3257 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
3258 return [];
3259 }
3260
3261 $dbr = wfGetDB( DB_REPLICA );
3262 $conds['page_namespace'] = $this->getNamespace();
3263 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
3264 $options = [];
3265 if ( $limit > -1 ) {
3266 $options['LIMIT'] = $limit;
3267 }
3268 return TitleArray::newFromResult(
3269 $dbr->select( 'page',
3270 [ 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ],
3271 $conds,
3272 __METHOD__,
3273 $options
3274 )
3275 );
3276 }
3277
3278 /**
3279 * Is there a version of this page in the deletion archive?
3280 *
3281 * @return int The number of archived revisions
3282 */
3283 public function isDeleted() {
3284 if ( $this->getNamespace() < 0 ) {
3285 $n = 0;
3286 } else {
3287 $dbr = wfGetDB( DB_REPLICA );
3288
3289 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3290 [ 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ],
3291 __METHOD__
3292 );
3293 if ( $this->getNamespace() == NS_FILE ) {
3294 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
3295 [ 'fa_name' => $this->getDBkey() ],
3296 __METHOD__
3297 );
3298 }
3299 }
3300 return (int)$n;
3301 }
3302
3303 /**
3304 * Is there a version of this page in the deletion archive?
3305 *
3306 * @return bool
3307 */
3308 public function isDeletedQuick() {
3309 if ( $this->getNamespace() < 0 ) {
3310 return false;
3311 }
3312 $dbr = wfGetDB( DB_REPLICA );
3313 $deleted = (bool)$dbr->selectField( 'archive', '1',
3314 [ 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ],
3315 __METHOD__
3316 );
3317 if ( !$deleted && $this->getNamespace() == NS_FILE ) {
3318 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3319 [ 'fa_name' => $this->getDBkey() ],
3320 __METHOD__
3321 );
3322 }
3323 return $deleted;
3324 }
3325
3326 /**
3327 * Get the article ID for this Title from the link cache,
3328 * adding it if necessary
3329 *
3330 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3331 * for update
3332 * @return int The ID
3333 */
3334 public function getArticleID( $flags = 0 ) {
3335 if ( $this->getNamespace() < 0 ) {
3336 $this->mArticleID = 0;
3337 return $this->mArticleID;
3338 }
3339 $linkCache = LinkCache::singleton();
3340 if ( $flags & self::GAID_FOR_UPDATE ) {
3341 $oldUpdate = $linkCache->forUpdate( true );
3342 $linkCache->clearLink( $this );
3343 $this->mArticleID = $linkCache->addLinkObj( $this );
3344 $linkCache->forUpdate( $oldUpdate );
3345 } else {
3346 if ( -1 == $this->mArticleID ) {
3347 $this->mArticleID = $linkCache->addLinkObj( $this );
3348 }
3349 }
3350 return $this->mArticleID;
3351 }
3352
3353 /**
3354 * Is this an article that is a redirect page?
3355 * Uses link cache, adding it if necessary
3356 *
3357 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3358 * @return bool
3359 */
3360 public function isRedirect( $flags = 0 ) {
3361 if ( !is_null( $this->mRedirect ) ) {
3362 return $this->mRedirect;
3363 }
3364 if ( !$this->getArticleID( $flags ) ) {
3365 $this->mRedirect = false;
3366 return $this->mRedirect;
3367 }
3368
3369 $linkCache = LinkCache::singleton();
3370 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3371 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3372 if ( $cached === null ) {
3373 # Trust LinkCache's state over our own
3374 # LinkCache is telling us that the page doesn't exist, despite there being cached
3375 # data relating to an existing page in $this->mArticleID. Updaters should clear
3376 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3377 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3378 # LinkCache to refresh its data from the master.
3379 $this->mRedirect = false;
3380 return $this->mRedirect;
3381 }
3382
3383 $this->mRedirect = (bool)$cached;
3384
3385 return $this->mRedirect;
3386 }
3387
3388 /**
3389 * What is the length of this page?
3390 * Uses link cache, adding it if necessary
3391 *
3392 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3393 * @return int
3394 */
3395 public function getLength( $flags = 0 ) {
3396 if ( $this->mLength != -1 ) {
3397 return $this->mLength;
3398 }
3399 if ( !$this->getArticleID( $flags ) ) {
3400 $this->mLength = 0;
3401 return $this->mLength;
3402 }
3403 $linkCache = LinkCache::singleton();
3404 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3405 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3406 if ( $cached === null ) {
3407 # Trust LinkCache's state over our own, as for isRedirect()
3408 $this->mLength = 0;
3409 return $this->mLength;
3410 }
3411
3412 $this->mLength = intval( $cached );
3413
3414 return $this->mLength;
3415 }
3416
3417 /**
3418 * What is the page_latest field for this page?
3419 *
3420 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3421 * @return int Int or 0 if the page doesn't exist
3422 */
3423 public function getLatestRevID( $flags = 0 ) {
3424 if ( !( $flags & self::GAID_FOR_UPDATE ) && $this->mLatestID !== false ) {
3425 return intval( $this->mLatestID );
3426 }
3427 if ( !$this->getArticleID( $flags ) ) {
3428 $this->mLatestID = 0;
3429 return $this->mLatestID;
3430 }
3431 $linkCache = LinkCache::singleton();
3432 $linkCache->addLinkObj( $this ); # in case we already had an article ID
3433 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3434 if ( $cached === null ) {
3435 # Trust LinkCache's state over our own, as for isRedirect()
3436 $this->mLatestID = 0;
3437 return $this->mLatestID;
3438 }
3439
3440 $this->mLatestID = intval( $cached );
3441
3442 return $this->mLatestID;
3443 }
3444
3445 /**
3446 * This clears some fields in this object, and clears any associated
3447 * keys in the "bad links" section of the link cache.
3448 *
3449 * - This is called from WikiPage::doEditContent() and WikiPage::insertOn() to allow
3450 * loading of the new page_id. It's also called from
3451 * WikiPage::doDeleteArticleReal()
3452 *
3453 * @param int $newid The new Article ID
3454 */
3455 public function resetArticleID( $newid ) {
3456 $linkCache = LinkCache::singleton();
3457 $linkCache->clearLink( $this );
3458
3459 if ( $newid === false ) {
3460 $this->mArticleID = -1;
3461 } else {
3462 $this->mArticleID = intval( $newid );
3463 }
3464 $this->mRestrictionsLoaded = false;
3465 $this->mRestrictions = [];
3466 $this->mOldRestrictions = false;
3467 $this->mRedirect = null;
3468 $this->mLength = -1;
3469 $this->mLatestID = false;
3470 $this->mContentModel = false;
3471 $this->mEstimateRevisions = null;
3472 $this->mPageLanguage = false;
3473 $this->mDbPageLanguage = false;
3474 $this->mIsBigDeletion = null;
3475 }
3476
3477 public static function clearCaches() {
3478 $linkCache = LinkCache::singleton();
3479 $linkCache->clear();
3480
3481 $titleCache = self::getTitleCache();
3482 $titleCache->clear();
3483 }
3484
3485 /**
3486 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3487 *
3488 * @param string $text Containing title to capitalize
3489 * @param int $ns Namespace index, defaults to NS_MAIN
3490 * @return string Containing capitalized title
3491 */
3492 public static function capitalize( $text, $ns = NS_MAIN ) {
3493 global $wgContLang;
3494
3495 if ( MWNamespace::isCapitalized( $ns ) ) {
3496 return $wgContLang->ucfirst( $text );
3497 } else {
3498 return $text;
3499 }
3500 }
3501
3502 /**
3503 * Secure and split - main initialisation function for this object
3504 *
3505 * Assumes that mDbkeyform has been set, and is urldecoded
3506 * and uses underscores, but not otherwise munged. This function
3507 * removes illegal characters, splits off the interwiki and
3508 * namespace prefixes, sets the other forms, and canonicalizes
3509 * everything.
3510 *
3511 * @throws MalformedTitleException On invalid titles
3512 * @return bool True on success
3513 */
3514 private function secureAndSplit() {
3515 # Initialisation
3516 $this->mInterwiki = '';
3517 $this->mFragment = '';
3518 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
3519
3520 $dbkey = $this->mDbkeyform;
3521
3522 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3523 // the parsing code with Title, while avoiding massive refactoring.
3524 // @todo: get rid of secureAndSplit, refactor parsing code.
3525 // @note: getTitleParser() returns a TitleParser implementation which does not have a
3526 // splitTitleString method, but the only implementation (MediaWikiTitleCodec) does
3527 $titleCodec = MediaWikiServices::getInstance()->getTitleParser();
3528 // MalformedTitleException can be thrown here
3529 $parts = $titleCodec->splitTitleString( $dbkey, $this->getDefaultNamespace() );
3530
3531 # Fill fields
3532 $this->setFragment( '#' . $parts['fragment'] );
3533 $this->mInterwiki = $parts['interwiki'];
3534 $this->mLocalInterwiki = $parts['local_interwiki'];
3535 $this->mNamespace = $parts['namespace'];
3536 $this->mUserCaseDBKey = $parts['user_case_dbkey'];
3537
3538 $this->mDbkeyform = $parts['dbkey'];
3539 $this->mUrlform = wfUrlencode( $this->mDbkeyform );
3540 $this->mTextform = strtr( $this->mDbkeyform, '_', ' ' );
3541
3542 # We already know that some pages won't be in the database!
3543 if ( $this->isExternal() || $this->isSpecialPage() ) {
3544 $this->mArticleID = 0;
3545 }
3546
3547 return true;
3548 }
3549
3550 /**
3551 * Get an array of Title objects linking to this Title
3552 * Also stores the IDs in the link cache.
3553 *
3554 * WARNING: do not use this function on arbitrary user-supplied titles!
3555 * On heavily-used templates it will max out the memory.
3556 *
3557 * @param array $options May be FOR UPDATE
3558 * @param string $table Table name
3559 * @param string $prefix Fields prefix
3560 * @return Title[] Array of Title objects linking here
3561 */
3562 public function getLinksTo( $options = [], $table = 'pagelinks', $prefix = 'pl' ) {
3563 if ( count( $options ) > 0 ) {
3564 $db = wfGetDB( DB_MASTER );
3565 } else {
3566 $db = wfGetDB( DB_REPLICA );
3567 }
3568
3569 $res = $db->select(
3570 [ 'page', $table ],
3571 self::getSelectFields(),
3572 [
3573 "{$prefix}_from=page_id",
3574 "{$prefix}_namespace" => $this->getNamespace(),
3575 "{$prefix}_title" => $this->getDBkey() ],
3576 __METHOD__,
3577 $options
3578 );
3579
3580 $retVal = [];
3581 if ( $res->numRows() ) {
3582 $linkCache = LinkCache::singleton();
3583 foreach ( $res as $row ) {
3584 $titleObj = self::makeTitle( $row->page_namespace, $row->page_title );
3585 if ( $titleObj ) {
3586 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3587