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