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