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