Merge "Fix bad reference in method doc"
[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 int $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::getLinkURL to always get a URL that's the simplest URL that will be
1647 * valid to link, locally, to the current Title.
1648 * @see self::newFromText to produce a Title object.
1649 *
1650 * @param string|array $query An optional query string,
1651 * not used for interwiki links. Can be specified as an associative array as well,
1652 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1653 * Some query patterns will trigger various shorturl path replacements.
1654 * @param array $query2 An optional secondary query array. This one MUST
1655 * be an array. If a string is passed it will be interpreted as a deprecated
1656 * variant argument and urlencoded into a variant= argument.
1657 * This second query argument will be added to the $query
1658 * The second parameter is deprecated since 1.19. Pass it as a key,value
1659 * pair in the first parameter array instead.
1660 *
1661 * @return string String of the URL.
1662 */
1663 public function getLocalURL( $query = '', $query2 = false ) {
1664 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1665
1666 $query = self::fixUrlQueryArgs( $query, $query2 );
1667
1668 $interwiki = Interwiki::fetch( $this->mInterwiki );
1669 if ( $interwiki ) {
1670 $namespace = $this->getNsText();
1671 if ( $namespace != '' ) {
1672 # Can this actually happen? Interwikis shouldn't be parsed.
1673 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1674 $namespace .= ':';
1675 }
1676 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1677 $url = wfAppendQuery( $url, $query );
1678 } else {
1679 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1680 if ( $query == '' ) {
1681 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1682 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1683 } else {
1684 global $wgVariantArticlePath, $wgActionPaths, $wgContLang;
1685 $url = false;
1686 $matches = array();
1687
1688 if ( !empty( $wgActionPaths )
1689 && preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches )
1690 ) {
1691 $action = urldecode( $matches[2] );
1692 if ( isset( $wgActionPaths[$action] ) ) {
1693 $query = $matches[1];
1694 if ( isset( $matches[4] ) ) {
1695 $query .= $matches[4];
1696 }
1697 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1698 if ( $query != '' ) {
1699 $url = wfAppendQuery( $url, $query );
1700 }
1701 }
1702 }
1703
1704 if ( $url === false
1705 && $wgVariantArticlePath
1706 && $wgContLang->getCode() === $this->getPageLanguage()->getCode()
1707 && $this->getPageLanguage()->hasVariants()
1708 && preg_match( '/^variant=([^&]*)$/', $query, $matches )
1709 ) {
1710 $variant = urldecode( $matches[1] );
1711 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1712 // Only do the variant replacement if the given variant is a valid
1713 // variant for the page's language.
1714 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1715 $url = str_replace( '$1', $dbkey, $url );
1716 }
1717 }
1718
1719 if ( $url === false ) {
1720 if ( $query == '-' ) {
1721 $query = '';
1722 }
1723 $url = "{$wgScript}?title={$dbkey}&{$query}";
1724 }
1725 }
1726
1727 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1728
1729 // @todo FIXME: This causes breakage in various places when we
1730 // actually expected a local URL and end up with dupe prefixes.
1731 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1732 $url = $wgServer . $url;
1733 }
1734 }
1735 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1736 return $url;
1737 }
1738
1739 /**
1740 * Get a URL that's the simplest URL that will be valid to link, locally,
1741 * to the current Title. It includes the fragment, but does not include
1742 * the server unless action=render is used (or the link is external). If
1743 * there's a fragment but the prefixed text is empty, we just return a link
1744 * to the fragment.
1745 *
1746 * The result obviously should not be URL-escaped, but does need to be
1747 * HTML-escaped if it's being output in HTML.
1748 *
1749 * @param array $query
1750 * @param bool $query2
1751 * @param string $proto Protocol to use; setting this will cause a full URL to be used
1752 * @see self::getLocalURL for the arguments.
1753 * @return string The URL
1754 */
1755 public function getLinkURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE ) {
1756 wfProfileIn( __METHOD__ );
1757 if ( $this->isExternal() || $proto !== PROTO_RELATIVE ) {
1758 $ret = $this->getFullURL( $query, $query2, $proto );
1759 } elseif ( $this->getPrefixedText() === '' && $this->hasFragment() ) {
1760 $ret = $this->getFragmentForURL();
1761 } else {
1762 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1763 }
1764 wfProfileOut( __METHOD__ );
1765 return $ret;
1766 }
1767
1768 /**
1769 * Get the URL form for an internal link.
1770 * - Used in various Squid-related code, in case we have a different
1771 * internal hostname for the server from the exposed one.
1772 *
1773 * This uses $wgInternalServer to qualify the path, or $wgServer
1774 * if $wgInternalServer is not set. If the server variable used is
1775 * protocol-relative, the URL will be expanded to http://
1776 *
1777 * @see self::getLocalURL for the arguments.
1778 * @return string The URL
1779 */
1780 public function getInternalURL( $query = '', $query2 = false ) {
1781 global $wgInternalServer, $wgServer;
1782 $query = self::fixUrlQueryArgs( $query, $query2 );
1783 $server = $wgInternalServer !== false ? $wgInternalServer : $wgServer;
1784 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP );
1785 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1786 return $url;
1787 }
1788
1789 /**
1790 * Get the URL for a canonical link, for use in things like IRC and
1791 * e-mail notifications. Uses $wgCanonicalServer and the
1792 * GetCanonicalURL hook.
1793 *
1794 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1795 *
1796 * @see self::getLocalURL for the arguments.
1797 * @return string The URL
1798 * @since 1.18
1799 */
1800 public function getCanonicalURL( $query = '', $query2 = false ) {
1801 $query = self::fixUrlQueryArgs( $query, $query2 );
1802 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL );
1803 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1804 return $url;
1805 }
1806
1807 /**
1808 * Get the edit URL for this Title
1809 *
1810 * @return string The URL, or a null string if this is an interwiki link
1811 */
1812 public function getEditURL() {
1813 if ( $this->isExternal() ) {
1814 return '';
1815 }
1816 $s = $this->getLocalURL( 'action=edit' );
1817
1818 return $s;
1819 }
1820
1821 /**
1822 * Is $wgUser watching this page?
1823 *
1824 * @deprecated since 1.20; use User::isWatched() instead.
1825 * @return bool
1826 */
1827 public function userIsWatching() {
1828 global $wgUser;
1829
1830 if ( is_null( $this->mWatched ) ) {
1831 if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn() ) {
1832 $this->mWatched = false;
1833 } else {
1834 $this->mWatched = $wgUser->isWatched( $this );
1835 }
1836 }
1837 return $this->mWatched;
1838 }
1839
1840 /**
1841 * Can $user perform $action on this page?
1842 * This skips potentially expensive cascading permission checks
1843 * as well as avoids expensive error formatting
1844 *
1845 * Suitable for use for nonessential UI controls in common cases, but
1846 * _not_ for functional access control.
1847 *
1848 * May provide false positives, but should never provide a false negative.
1849 *
1850 * @param string $action Action that permission needs to be checked for
1851 * @param User $user User to check (since 1.19); $wgUser will be used if not provided.
1852 * @return bool
1853 */
1854 public function quickUserCan( $action, $user = null ) {
1855 return $this->userCan( $action, $user, false );
1856 }
1857
1858 /**
1859 * Can $user perform $action on this page?
1860 *
1861 * @param string $action Action that permission needs to be checked for
1862 * @param User $user User to check (since 1.19); $wgUser will be used if not
1863 * provided.
1864 * @param bool $doExpensiveQueries Set this to false to avoid doing
1865 * unnecessary queries.
1866 * @return bool
1867 */
1868 public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1869 if ( !$user instanceof User ) {
1870 global $wgUser;
1871 $user = $wgUser;
1872 }
1873
1874 return !count( $this->getUserPermissionsErrorsInternal(
1875 $action, $user, $doExpensiveQueries, true ) );
1876 }
1877
1878 /**
1879 * Can $user perform $action on this page?
1880 *
1881 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1882 *
1883 * @param string $action Action that permission needs to be checked for
1884 * @param User $user User to check
1885 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary
1886 * queries by skipping checks for cascading protections and user blocks.
1887 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
1888 * whose corresponding errors may be ignored.
1889 * @return array Array of arguments to wfMessage to explain permissions problems.
1890 */
1891 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true,
1892 $ignoreErrors = array()
1893 ) {
1894 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1895
1896 // Remove the errors being ignored.
1897 foreach ( $errors as $index => $error ) {
1898 $error_key = is_array( $error ) ? $error[0] : $error;
1899
1900 if ( in_array( $error_key, $ignoreErrors ) ) {
1901 unset( $errors[$index] );
1902 }
1903 }
1904
1905 return $errors;
1906 }
1907
1908 /**
1909 * Permissions checks that fail most often, and which are easiest to test.
1910 *
1911 * @param string $action The action to check
1912 * @param User $user User to check
1913 * @param array $errors List of current errors
1914 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
1915 * @param bool $short Short circuit on first error
1916 *
1917 * @return array List of errors
1918 */
1919 private function checkQuickPermissions( $action, $user, $errors,
1920 $doExpensiveQueries, $short
1921 ) {
1922 if ( !wfRunHooks( 'TitleQuickPermissions',
1923 array( $this, $user, $action, &$errors, $doExpensiveQueries, $short ) )
1924 ) {
1925 return $errors;
1926 }
1927
1928 if ( $action == 'create' ) {
1929 if (
1930 ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1931 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) )
1932 ) {
1933 $errors[] = $user->isAnon() ? array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1934 }
1935 } elseif ( $action == 'move' ) {
1936 if ( !$user->isAllowed( 'move-rootuserpages' )
1937 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1938 // Show user page-specific message only if the user can move other pages
1939 $errors[] = array( 'cant-move-user-page' );
1940 }
1941
1942 // Check if user is allowed to move files if it's a file
1943 if ( $this->mNamespace == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
1944 $errors[] = array( 'movenotallowedfile' );
1945 }
1946
1947 // Check if user is allowed to move category pages if it's a category page
1948 if ( $this->mNamespace == NS_CATEGORY && !$user->isAllowed( 'move-categorypages' ) ) {
1949 $errors[] = array( 'cant-move-category-page' );
1950 }
1951
1952 if ( !$user->isAllowed( 'move' ) ) {
1953 // User can't move anything
1954 $userCanMove = User::groupHasPermission( 'user', 'move' );
1955 $autoconfirmedCanMove = User::groupHasPermission( 'autoconfirmed', 'move' );
1956 if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) {
1957 // custom message if logged-in users without any special rights can move
1958 $errors[] = array( 'movenologintext' );
1959 } else {
1960 $errors[] = array( 'movenotallowed' );
1961 }
1962 }
1963 } elseif ( $action == 'move-target' ) {
1964 if ( !$user->isAllowed( 'move' ) ) {
1965 // User can't move anything
1966 $errors[] = array( 'movenotallowed' );
1967 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1968 && $this->mNamespace == NS_USER && !$this->isSubpage() ) {
1969 // Show user page-specific message only if the user can move other pages
1970 $errors[] = array( 'cant-move-to-user-page' );
1971 } elseif ( !$user->isAllowed( 'move-categorypages' )
1972 && $this->mNamespace == NS_CATEGORY ) {
1973 // Show category page-specific message only if the user can move other pages
1974 $errors[] = array( 'cant-move-to-category-page' );
1975 }
1976 } elseif ( !$user->isAllowed( $action ) ) {
1977 $errors[] = $this->missingPermissionError( $action, $short );
1978 }
1979
1980 return $errors;
1981 }
1982
1983 /**
1984 * Add the resulting error code to the errors array
1985 *
1986 * @param array $errors List of current errors
1987 * @param array $result Result of errors
1988 *
1989 * @return array List of errors
1990 */
1991 private function resultToError( $errors, $result ) {
1992 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1993 // A single array representing an error
1994 $errors[] = $result;
1995 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
1996 // A nested array representing multiple errors
1997 $errors = array_merge( $errors, $result );
1998 } elseif ( $result !== '' && is_string( $result ) ) {
1999 // A string representing a message-id
2000 $errors[] = array( $result );
2001 } elseif ( $result === false ) {
2002 // a generic "We don't want them to do that"
2003 $errors[] = array( 'badaccess-group0' );
2004 }
2005 return $errors;
2006 }
2007
2008 /**
2009 * Check various permission hooks
2010 *
2011 * @param string $action The action to check
2012 * @param User $user User to check
2013 * @param array $errors List of current errors
2014 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2015 * @param bool $short Short circuit on first error
2016 *
2017 * @return array List of errors
2018 */
2019 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
2020 // Use getUserPermissionsErrors instead
2021 $result = '';
2022 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
2023 return $result ? array() : array( array( 'badaccess-group0' ) );
2024 }
2025 // Check getUserPermissionsErrors hook
2026 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
2027 $errors = $this->resultToError( $errors, $result );
2028 }
2029 // Check getUserPermissionsErrorsExpensive hook
2030 if (
2031 $doExpensiveQueries
2032 && !( $short && count( $errors ) > 0 )
2033 && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) )
2034 ) {
2035 $errors = $this->resultToError( $errors, $result );
2036 }
2037
2038 return $errors;
2039 }
2040
2041 /**
2042 * Check permissions on special pages & namespaces
2043 *
2044 * @param string $action The action to check
2045 * @param User $user User to check
2046 * @param array $errors List of current errors
2047 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2048 * @param bool $short Short circuit on first error
2049 *
2050 * @return array List of errors
2051 */
2052 private function checkSpecialsAndNSPermissions( $action, $user, $errors,
2053 $doExpensiveQueries, $short
2054 ) {
2055 # Only 'createaccount' can be performed on special pages,
2056 # which don't actually exist in the DB.
2057 if ( NS_SPECIAL == $this->mNamespace && $action !== 'createaccount' ) {
2058 $errors[] = array( 'ns-specialprotected' );
2059 }
2060
2061 # Check $wgNamespaceProtection for restricted namespaces
2062 if ( $this->isNamespaceProtected( $user ) ) {
2063 $ns = $this->mNamespace == NS_MAIN ?
2064 wfMessage( 'nstab-main' )->text() : $this->getNsText();
2065 $errors[] = $this->mNamespace == NS_MEDIAWIKI ?
2066 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
2067 }
2068
2069 return $errors;
2070 }
2071
2072 /**
2073 * Check CSS/JS sub-page permissions
2074 *
2075 * @param string $action The action to check
2076 * @param User $user User to check
2077 * @param array $errors List of current errors
2078 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2079 * @param bool $short Short circuit on first error
2080 *
2081 * @return array List of errors
2082 */
2083 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2084 # Protect css/js subpages of user pages
2085 # XXX: this might be better using restrictions
2086 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
2087 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' ) ) {
2088 if ( preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform ) ) {
2089 if ( $this->isCssSubpage() && !$user->isAllowedAny( 'editmyusercss', 'editusercss' ) ) {
2090 $errors[] = array( 'mycustomcssprotected' );
2091 } elseif ( $this->isJsSubpage() && !$user->isAllowedAny( 'editmyuserjs', 'edituserjs' ) ) {
2092 $errors[] = array( 'mycustomjsprotected' );
2093 }
2094 } else {
2095 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
2096 $errors[] = array( 'customcssprotected' );
2097 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
2098 $errors[] = array( 'customjsprotected' );
2099 }
2100 }
2101 }
2102
2103 return $errors;
2104 }
2105
2106 /**
2107 * Check against page_restrictions table requirements on this
2108 * page. The user must possess all required rights for this
2109 * action.
2110 *
2111 * @param string $action The action to check
2112 * @param User $user User to check
2113 * @param array $errors List of current errors
2114 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2115 * @param bool $short Short circuit on first error
2116 *
2117 * @return array List of errors
2118 */
2119 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2120 foreach ( $this->getRestrictions( $action ) as $right ) {
2121 // Backwards compatibility, rewrite sysop -> editprotected
2122 if ( $right == 'sysop' ) {
2123 $right = 'editprotected';
2124 }
2125 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2126 if ( $right == 'autoconfirmed' ) {
2127 $right = 'editsemiprotected';
2128 }
2129 if ( $right == '' ) {
2130 continue;
2131 }
2132 if ( !$user->isAllowed( $right ) ) {
2133 $errors[] = array( 'protectedpagetext', $right );
2134 } elseif ( $this->mCascadeRestriction && !$user->isAllowed( 'protect' ) ) {
2135 $errors[] = array( 'protectedpagetext', 'protect' );
2136 }
2137 }
2138
2139 return $errors;
2140 }
2141
2142 /**
2143 * Check restrictions on cascading pages.
2144 *
2145 * @param string $action The action to check
2146 * @param User $user User to check
2147 * @param array $errors List of current errors
2148 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2149 * @param bool $short Short circuit on first error
2150 *
2151 * @return array List of errors
2152 */
2153 private function checkCascadingSourcesRestrictions( $action, $user, $errors,
2154 $doExpensiveQueries, $short
2155 ) {
2156 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
2157 # We /could/ use the protection level on the source page, but it's
2158 # fairly ugly as we have to establish a precedence hierarchy for pages
2159 # included by multiple cascade-protected pages. So just restrict
2160 # it to people with 'protect' permission, as they could remove the
2161 # protection anyway.
2162 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
2163 # Cascading protection depends on more than this page...
2164 # Several cascading protected pages may include this page...
2165 # Check each cascading level
2166 # This is only for protection restrictions, not for all actions
2167 if ( isset( $restrictions[$action] ) ) {
2168 foreach ( $restrictions[$action] as $right ) {
2169 // Backwards compatibility, rewrite sysop -> editprotected
2170 if ( $right == 'sysop' ) {
2171 $right = 'editprotected';
2172 }
2173 // Backwards compatibility, rewrite autoconfirmed -> editsemiprotected
2174 if ( $right == 'autoconfirmed' ) {
2175 $right = 'editsemiprotected';
2176 }
2177 if ( $right != '' && !$user->isAllowedAll( 'protect', $right ) ) {
2178 $pages = '';
2179 foreach ( $cascadingSources as $page ) {
2180 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
2181 }
2182 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
2183 }
2184 }
2185 }
2186 }
2187
2188 return $errors;
2189 }
2190
2191 /**
2192 * Check action permissions not already checked in checkQuickPermissions
2193 *
2194 * @param string $action The action to check
2195 * @param User $user User to check
2196 * @param array $errors List of current errors
2197 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2198 * @param bool $short Short circuit on first error
2199 *
2200 * @return array List of errors
2201 */
2202 private function checkActionPermissions( $action, $user, $errors,
2203 $doExpensiveQueries, $short
2204 ) {
2205 global $wgDeleteRevisionsLimit, $wgLang;
2206
2207 if ( $action == 'protect' ) {
2208 if ( count( $this->getUserPermissionsErrorsInternal( 'edit',
2209 $user, $doExpensiveQueries, true ) )
2210 ) {
2211 // If they can't edit, they shouldn't protect.
2212 $errors[] = array( 'protect-cantedit' );
2213 }
2214 } elseif ( $action == 'create' ) {
2215 $title_protection = $this->getTitleProtection();
2216 if ( $title_protection ) {
2217 if ( $title_protection['pt_create_perm'] == 'sysop' ) {
2218 $title_protection['pt_create_perm'] = 'editprotected'; // B/C
2219 }
2220 if ( $title_protection['pt_create_perm'] == 'autoconfirmed' ) {
2221 $title_protection['pt_create_perm'] = 'editsemiprotected'; // B/C
2222 }
2223 if ( $title_protection['pt_create_perm'] == ''
2224 || !$user->isAllowed( $title_protection['pt_create_perm'] )
2225 ) {
2226 $errors[] = array(
2227 'titleprotected',
2228 User::whoIs( $title_protection['pt_user'] ),
2229 $title_protection['pt_reason']
2230 );
2231 }
2232 }
2233 } elseif ( $action == 'move' ) {
2234 // Check for immobile pages
2235 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2236 // Specific message for this case
2237 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2238 } elseif ( !$this->isMovable() ) {
2239 // Less specific message for rarer cases
2240 $errors[] = array( 'immobile-source-page' );
2241 }
2242 } elseif ( $action == 'move-target' ) {
2243 if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
2244 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
2245 } elseif ( !$this->isMovable() ) {
2246 $errors[] = array( 'immobile-target-page' );
2247 }
2248 } elseif ( $action == 'delete' ) {
2249 if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
2250 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion()
2251 ) {
2252 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
2253 }
2254 }
2255 return $errors;
2256 }
2257
2258 /**
2259 * Check that the user isn't blocked from editing.
2260 *
2261 * @param string $action The action to check
2262 * @param User $user User to check
2263 * @param array $errors List of current errors
2264 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2265 * @param bool $short Short circuit on first error
2266 *
2267 * @return array List of errors
2268 */
2269 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
2270 // Account creation blocks handled at userlogin.
2271 // Unblocking handled in SpecialUnblock
2272 if ( !$doExpensiveQueries || in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
2273 return $errors;
2274 }
2275
2276 global $wgEmailConfirmToEdit;
2277
2278 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
2279 $errors[] = array( 'confirmedittext' );
2280 }
2281
2282 if ( ( $action == 'edit' || $action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
2283 // Don't block the user from editing their own talk page unless they've been
2284 // explicitly blocked from that too.
2285 } elseif ( $user->isBlocked() && $user->mBlock->prevents( $action ) !== false ) {
2286 // @todo FIXME: Pass the relevant context into this function.
2287 $errors[] = $user->getBlock()->getPermissionsError( RequestContext::getMain() );
2288 }
2289
2290 return $errors;
2291 }
2292
2293 /**
2294 * Check that the user is allowed to read this page.
2295 *
2296 * @param string $action The action to check
2297 * @param User $user User to check
2298 * @param array $errors List of current errors
2299 * @param bool $doExpensiveQueries Whether or not to perform expensive queries
2300 * @param bool $short Short circuit on first error
2301 *
2302 * @return array List of errors
2303 */
2304 private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2305 global $wgWhitelistRead, $wgWhitelistReadRegexp;
2306
2307 $whitelisted = false;
2308 if ( User::isEveryoneAllowed( 'read' ) ) {
2309 # Shortcut for public wikis, allows skipping quite a bit of code
2310 $whitelisted = true;
2311 } elseif ( $user->isAllowed( 'read' ) ) {
2312 # If the user is allowed to read pages, he is allowed to read all pages
2313 $whitelisted = true;
2314 } elseif ( $this->isSpecial( 'Userlogin' )
2315 || $this->isSpecial( 'ChangePassword' )
2316 || $this->isSpecial( 'PasswordReset' )
2317 ) {
2318 # Always grant access to the login page.
2319 # Even anons need to be able to log in.
2320 $whitelisted = true;
2321 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2322 # Time to check the whitelist
2323 # Only do these checks is there's something to check against
2324 $name = $this->getPrefixedText();
2325 $dbName = $this->getPrefixedDBkey();
2326
2327 // Check for explicit whitelisting with and without underscores
2328 if ( in_array( $name, $wgWhitelistRead, true ) || in_array( $dbName, $wgWhitelistRead, true ) ) {
2329 $whitelisted = true;
2330 } elseif ( $this->getNamespace() == NS_MAIN ) {
2331 # Old settings might have the title prefixed with
2332 # a colon for main-namespace pages
2333 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2334 $whitelisted = true;
2335 }
2336 } elseif ( $this->isSpecialPage() ) {
2337 # If it's a special page, ditch the subpage bit and check again
2338 $name = $this->getDBkey();
2339 list( $name, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $name );
2340 if ( $name ) {
2341 $pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
2342 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2343 $whitelisted = true;
2344 }
2345 }
2346 }
2347 }
2348
2349 if ( !$whitelisted && is_array( $wgWhitelistReadRegexp ) && !empty( $wgWhitelistReadRegexp ) ) {
2350 $name = $this->getPrefixedText();
2351 // Check for regex whitelisting
2352 foreach ( $wgWhitelistReadRegexp as $listItem ) {
2353 if ( preg_match( $listItem, $name ) ) {
2354 $whitelisted = true;
2355 break;
2356 }
2357 }
2358 }
2359
2360 if ( !$whitelisted ) {
2361 # If the title is not whitelisted, give extensions a chance to do so...
2362 wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2363 if ( !$whitelisted ) {
2364 $errors[] = $this->missingPermissionError( $action, $short );
2365 }
2366 }
2367
2368 return $errors;
2369 }
2370
2371 /**
2372 * Get a description array when the user doesn't have the right to perform
2373 * $action (i.e. when User::isAllowed() returns false)
2374 *
2375 * @param string $action The action to check
2376 * @param bool $short Short circuit on first error
2377 * @return array List of errors
2378 */
2379 private function missingPermissionError( $action, $short ) {
2380 // We avoid expensive display logic for quickUserCan's and such
2381 if ( $short ) {
2382 return array( 'badaccess-group0' );
2383 }
2384
2385 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2386 User::getGroupsWithPermission( $action ) );
2387
2388 if ( count( $groups ) ) {
2389 global $wgLang;
2390 return array(
2391 'badaccess-groups',
2392 $wgLang->commaList( $groups ),
2393 count( $groups )
2394 );
2395 } else {
2396 return array( 'badaccess-group0' );
2397 }
2398 }
2399
2400 /**
2401 * Can $user perform $action on this page? This is an internal function,
2402 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2403 * checks on wfReadOnly() and blocks)
2404 *
2405 * @param string $action Action that permission needs to be checked for
2406 * @param User $user User to check
2407 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
2408 * @param bool $short Set this to true to stop after the first permission error.
2409 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
2410 */
2411 protected function getUserPermissionsErrorsInternal( $action, $user,
2412 $doExpensiveQueries = true, $short = false
2413 ) {
2414 wfProfileIn( __METHOD__ );
2415
2416 # Read has special handling
2417 if ( $action == 'read' ) {
2418 $checks = array(
2419 'checkPermissionHooks',
2420 'checkReadPermissions',
2421 );
2422 } else {
2423 $checks = array(
2424 'checkQuickPermissions',
2425 'checkPermissionHooks',
2426 'checkSpecialsAndNSPermissions',
2427 'checkCSSandJSPermissions',
2428 'checkPageRestrictions',
2429 'checkCascadingSourcesRestrictions',
2430 'checkActionPermissions',
2431 'checkUserBlock'
2432 );
2433 }
2434
2435 $errors = array();
2436 while ( count( $checks ) > 0 &&
2437 !( $short && count( $errors ) > 0 ) ) {
2438 $method = array_shift( $checks );
2439 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2440 }
2441
2442 wfProfileOut( __METHOD__ );
2443 return $errors;
2444 }
2445
2446 /**
2447 * Get a filtered list of all restriction types supported by this wiki.
2448 * @param bool $exists True to get all restriction types that apply to
2449 * titles that do exist, False for all restriction types that apply to
2450 * titles that do not exist
2451 * @return array
2452 */
2453 public static function getFilteredRestrictionTypes( $exists = true ) {
2454 global $wgRestrictionTypes;
2455 $types = $wgRestrictionTypes;
2456 if ( $exists ) {
2457 # Remove the create restriction for existing titles
2458 $types = array_diff( $types, array( 'create' ) );
2459 } else {
2460 # Only the create and upload restrictions apply to non-existing titles
2461 $types = array_intersect( $types, array( 'create', 'upload' ) );
2462 }
2463 return $types;
2464 }
2465
2466 /**
2467 * Returns restriction types for the current Title
2468 *
2469 * @return array Applicable restriction types
2470 */
2471 public function getRestrictionTypes() {
2472 if ( $this->isSpecialPage() ) {
2473 return array();
2474 }
2475
2476 $types = self::getFilteredRestrictionTypes( $this->exists() );
2477
2478 if ( $this->getNamespace() != NS_FILE ) {
2479 # Remove the upload restriction for non-file titles
2480 $types = array_diff( $types, array( 'upload' ) );
2481 }
2482
2483 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2484
2485 wfDebug( __METHOD__ . ': applicable restrictions to [[' .
2486 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2487
2488 return $types;
2489 }
2490
2491 /**
2492 * Is this title subject to title protection?
2493 * Title protection is the one applied against creation of such title.
2494 *
2495 * @return array|bool An associative array representing any existent title
2496 * protection, or false if there's none.
2497 */
2498 private function getTitleProtection() {
2499 // Can't protect pages in special namespaces
2500 if ( $this->getNamespace() < 0 ) {
2501 return false;
2502 }
2503
2504 // Can't protect pages that exist.
2505 if ( $this->exists() ) {
2506 return false;
2507 }
2508
2509 if ( $this->mTitleProtection === null ) {
2510 $dbr = wfGetDB( DB_SLAVE );
2511 $res = $dbr->select(
2512 'protected_titles',
2513 array( 'pt_user', 'pt_reason', 'pt_expiry', 'pt_create_perm' ),
2514 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2515 __METHOD__
2516 );
2517
2518 // fetchRow returns false if there are no rows.
2519 $this->mTitleProtection = $dbr->fetchRow( $res );
2520 }
2521 return $this->mTitleProtection;
2522 }
2523
2524 /**
2525 * Remove any title protection due to page existing
2526 */
2527 public function deleteTitleProtection() {
2528 $dbw = wfGetDB( DB_MASTER );
2529
2530 $dbw->delete(
2531 'protected_titles',
2532 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2533 __METHOD__
2534 );
2535 $this->mTitleProtection = false;
2536 }
2537
2538 /**
2539 * Is this page "semi-protected" - the *only* protection levels are listed
2540 * in $wgSemiprotectedRestrictionLevels?
2541 *
2542 * @param string $action Action to check (default: edit)
2543 * @return bool
2544 */
2545 public function isSemiProtected( $action = 'edit' ) {
2546 global $wgSemiprotectedRestrictionLevels;
2547
2548 $restrictions = $this->getRestrictions( $action );
2549 $semi = $wgSemiprotectedRestrictionLevels;
2550 if ( !$restrictions || !$semi ) {
2551 // Not protected, or all protection is full protection
2552 return false;
2553 }
2554
2555 // Remap autoconfirmed to editsemiprotected for BC
2556 foreach ( array_keys( $semi, 'autoconfirmed' ) as $key ) {
2557 $semi[$key] = 'editsemiprotected';
2558 }
2559 foreach ( array_keys( $restrictions, 'autoconfirmed' ) as $key ) {
2560 $restrictions[$key] = 'editsemiprotected';
2561 }
2562
2563 return !array_diff( $restrictions, $semi );
2564 }
2565
2566 /**
2567 * Does the title correspond to a protected article?
2568 *
2569 * @param string $action The action the page is protected from,
2570 * by default checks all actions.
2571 * @return bool
2572 */
2573 public function isProtected( $action = '' ) {
2574 global $wgRestrictionLevels;
2575
2576 $restrictionTypes = $this->getRestrictionTypes();
2577
2578 # Special pages have inherent protection
2579 if ( $this->isSpecialPage() ) {
2580 return true;
2581 }
2582
2583 # Check regular protection levels
2584 foreach ( $restrictionTypes as $type ) {
2585 if ( $action == $type || $action == '' ) {
2586 $r = $this->getRestrictions( $type );
2587 foreach ( $wgRestrictionLevels as $level ) {
2588 if ( in_array( $level, $r ) && $level != '' ) {
2589 return true;
2590 }
2591 }
2592 }
2593 }
2594
2595 return false;
2596 }
2597
2598 /**
2599 * Determines if $user is unable to edit this page because it has been protected
2600 * by $wgNamespaceProtection.
2601 *
2602 * @param User $user User object to check permissions
2603 * @return bool
2604 */
2605 public function isNamespaceProtected( User $user ) {
2606 global $wgNamespaceProtection;
2607
2608 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
2609 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
2610 if ( $right != '' && !$user->isAllowed( $right ) ) {
2611 return true;
2612 }
2613 }
2614 }
2615 return false;
2616 }
2617
2618 /**
2619 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2620 *
2621 * @return bool If the page is subject to cascading restrictions.
2622 */
2623 public function isCascadeProtected() {
2624 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2625 return ( $sources > 0 );
2626 }
2627
2628 /**
2629 * Determines whether cascading protection sources have already been loaded from
2630 * the database.
2631 *
2632 * @param bool $getPages True to check if the pages are loaded, or false to check
2633 * if the status is loaded.
2634 * @return bool Whether or not the specified information has been loaded
2635 * @since 1.23
2636 */
2637 public function areCascadeProtectionSourcesLoaded( $getPages = true ) {
2638 return $getPages ? $this->mCascadeSources !== null : $this->mHasCascadingRestrictions !== null;
2639 }
2640
2641 /**
2642 * Cascading protection: Get the source of any cascading restrictions on this page.
2643 *
2644 * @param bool $getPages Whether or not to retrieve the actual pages
2645 * that the restrictions have come from and the actual restrictions
2646 * themselves.
2647 * @return array Two elements: First is an array of Title objects of the
2648 * pages from which cascading restrictions have come, false for
2649 * none, or true if such restrictions exist but $getPages was not
2650 * set. Second is an array like that returned by
2651 * Title::getAllRestrictions(), or an empty array if $getPages is
2652 * false.
2653 */
2654 public function getCascadeProtectionSources( $getPages = true ) {
2655 global $wgContLang;
2656 $pagerestrictions = array();
2657
2658 if ( $this->mCascadeSources !== null && $getPages ) {
2659 return array( $this->mCascadeSources, $this->mCascadingRestrictions );
2660 } elseif ( $this->mHasCascadingRestrictions !== null && !$getPages ) {
2661 return array( $this->mHasCascadingRestrictions, $pagerestrictions );
2662 }
2663
2664 wfProfileIn( __METHOD__ );
2665
2666 $dbr = wfGetDB( DB_SLAVE );
2667
2668 if ( $this->getNamespace() == NS_FILE ) {
2669 $tables = array( 'imagelinks', 'page_restrictions' );
2670 $where_clauses = array(
2671 'il_to' => $this->getDBkey(),
2672 'il_from=pr_page',
2673 'pr_cascade' => 1
2674 );
2675 } else {
2676 $tables = array( 'templatelinks', 'page_restrictions' );
2677 $where_clauses = array(
2678 'tl_namespace' => $this->getNamespace(),
2679 'tl_title' => $this->getDBkey(),
2680 'tl_from=pr_page',
2681 'pr_cascade' => 1
2682 );
2683 }
2684
2685 if ( $getPages ) {
2686 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2687 'pr_expiry', 'pr_type', 'pr_level' );
2688 $where_clauses[] = 'page_id=pr_page';
2689 $tables[] = 'page';
2690 } else {
2691 $cols = array( 'pr_expiry' );
2692 }
2693
2694 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2695
2696 $sources = $getPages ? array() : false;
2697 $now = wfTimestampNow();
2698 $purgeExpired = false;
2699
2700 foreach ( $res as $row ) {
2701 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2702 if ( $expiry > $now ) {
2703 if ( $getPages ) {
2704 $page_id = $row->pr_page;
2705 $page_ns = $row->page_namespace;
2706 $page_title = $row->page_title;
2707 $sources[$page_id] = Title::makeTitle( $page_ns, $page_title );
2708 # Add groups needed for each restriction type if its not already there
2709 # Make sure this restriction type still exists
2710
2711 if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2712 $pagerestrictions[$row->pr_type] = array();
2713 }
2714
2715 if (
2716 isset( $pagerestrictions[$row->pr_type] )
2717 && !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] )
2718 ) {
2719 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2720 }
2721 } else {
2722 $sources = true;
2723 }
2724 } else {
2725 // Trigger lazy purge of expired restrictions from the db
2726 $purgeExpired = true;
2727 }
2728 }
2729 if ( $purgeExpired ) {
2730 Title::purgeExpiredRestrictions();
2731 }
2732
2733 if ( $getPages ) {
2734 $this->mCascadeSources = $sources;
2735 $this->mCascadingRestrictions = $pagerestrictions;
2736 } else {
2737 $this->mHasCascadingRestrictions = $sources;
2738 }
2739
2740 wfProfileOut( __METHOD__ );
2741 return array( $sources, $pagerestrictions );
2742 }
2743
2744 /**
2745 * Accessor for mRestrictionsLoaded
2746 *
2747 * @return bool Whether or not the page's restrictions have already been
2748 * loaded from the database
2749 * @since 1.23
2750 */
2751 public function areRestrictionsLoaded() {
2752 return $this->mRestrictionsLoaded;
2753 }
2754
2755 /**
2756 * Accessor/initialisation for mRestrictions
2757 *
2758 * @param string $action Action that permission needs to be checked for
2759 * @return array Restriction levels needed to take the action. All levels
2760 * are required.
2761 */
2762 public function getRestrictions( $action ) {
2763 if ( !$this->mRestrictionsLoaded ) {
2764 $this->loadRestrictions();
2765 }
2766 return isset( $this->mRestrictions[$action] )
2767 ? $this->mRestrictions[$action]
2768 : array();
2769 }
2770
2771 /**
2772 * Accessor/initialisation for mRestrictions
2773 *
2774 * @return array Keys are actions, values are arrays as returned by
2775 * Title::getRestrictions()
2776 * @since 1.23
2777 */
2778 public function getAllRestrictions() {
2779 if ( !$this->mRestrictionsLoaded ) {
2780 $this->loadRestrictions();
2781 }
2782 return $this->mRestrictions;
2783 }
2784
2785 /**
2786 * Get the expiry time for the restriction against a given action
2787 *
2788 * @param string $action
2789 * @return string|bool 14-char timestamp, or 'infinity' if the page is protected forever
2790 * or not protected at all, or false if the action is not recognised.
2791 */
2792 public function getRestrictionExpiry( $action ) {
2793 if ( !$this->mRestrictionsLoaded ) {
2794 $this->loadRestrictions();
2795 }
2796 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
2797 }
2798
2799 /**
2800 * Returns cascading restrictions for the current article
2801 *
2802 * @return bool
2803 */
2804 function areRestrictionsCascading() {
2805 if ( !$this->mRestrictionsLoaded ) {
2806 $this->loadRestrictions();
2807 }
2808
2809 return $this->mCascadeRestriction;
2810 }
2811
2812 /**
2813 * Loads a string into mRestrictions array
2814 *
2815 * @param ResultWrapper $res Resource restrictions as an SQL result.
2816 * @param string $oldFashionedRestrictions Comma-separated list of page
2817 * restrictions from page table (pre 1.10)
2818 */
2819 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2820 $rows = array();
2821
2822 foreach ( $res as $row ) {
2823 $rows[] = $row;
2824 }
2825
2826 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2827 }
2828
2829 /**
2830 * Compiles list of active page restrictions from both page table (pre 1.10)
2831 * and page_restrictions table for this existing page.
2832 * Public for usage by LiquidThreads.
2833 *
2834 * @param array $rows Array of db result objects
2835 * @param string $oldFashionedRestrictions Comma-separated list of page
2836 * restrictions from page table (pre 1.10)
2837 */
2838 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2839 global $wgContLang;
2840 $dbr = wfGetDB( DB_SLAVE );
2841
2842 $restrictionTypes = $this->getRestrictionTypes();
2843
2844 foreach ( $restrictionTypes as $type ) {
2845 $this->mRestrictions[$type] = array();
2846 $this->mRestrictionsExpiry[$type] = $wgContLang->formatExpiry( '', TS_MW );
2847 }
2848
2849 $this->mCascadeRestriction = false;
2850
2851 # Backwards-compatibility: also load the restrictions from the page record (old format).
2852
2853 if ( $oldFashionedRestrictions === null ) {
2854 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2855 array( 'page_id' => $this->getArticleID() ), __METHOD__ );
2856 }
2857
2858 if ( $oldFashionedRestrictions != '' ) {
2859
2860 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2861 $temp = explode( '=', trim( $restrict ) );
2862 if ( count( $temp ) == 1 ) {
2863 // old old format should be treated as edit/move restriction
2864 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
2865 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
2866 } else {
2867 $restriction = trim( $temp[1] );
2868 if ( $restriction != '' ) { //some old entries are empty
2869 $this->mRestrictions[$temp[0]] = explode( ',', $restriction );
2870 }
2871 }
2872 }
2873
2874 $this->mOldRestrictions = true;
2875
2876 }
2877
2878 if ( count( $rows ) ) {
2879 # Current system - load second to make them override.
2880 $now = wfTimestampNow();
2881 $purgeExpired = false;
2882
2883 # Cycle through all the restrictions.
2884 foreach ( $rows as $row ) {
2885
2886 // Don't take care of restrictions types that aren't allowed
2887 if ( !in_array( $row->pr_type, $restrictionTypes ) ) {
2888 continue;
2889 }
2890
2891 // This code should be refactored, now that it's being used more generally,
2892 // But I don't really see any harm in leaving it in Block for now -werdna
2893 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2894
2895 // Only apply the restrictions if they haven't expired!
2896 if ( !$expiry || $expiry > $now ) {
2897 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
2898 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
2899
2900 $this->mCascadeRestriction |= $row->pr_cascade;
2901 } else {
2902 // Trigger a lazy purge of expired restrictions
2903 $purgeExpired = true;
2904 }
2905 }
2906
2907 if ( $purgeExpired ) {
2908 Title::purgeExpiredRestrictions();
2909 }
2910 }
2911
2912 $this->mRestrictionsLoaded = true;
2913 }
2914
2915 /**
2916 * Load restrictions from the page_restrictions table
2917 *
2918 * @param string $oldFashionedRestrictions Comma-separated list of page
2919 * restrictions from page table (pre 1.10)
2920 */
2921 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2922 global $wgContLang;
2923 if ( !$this->mRestrictionsLoaded ) {
2924 if ( $this->exists() ) {
2925 $dbr = wfGetDB( DB_SLAVE );
2926
2927 $res = $dbr->select(
2928 'page_restrictions',
2929 array( 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ),
2930 array( 'pr_page' => $this->getArticleID() ),
2931 __METHOD__
2932 );
2933
2934 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2935 } else {
2936 $title_protection = $this->getTitleProtection();
2937
2938 if ( $title_protection ) {
2939 $now = wfTimestampNow();
2940 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW );
2941
2942 if ( !$expiry || $expiry > $now ) {
2943 // Apply the restrictions
2944 $this->mRestrictionsExpiry['create'] = $expiry;
2945 $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2946 } else { // Get rid of the old restrictions
2947 Title::purgeExpiredRestrictions();
2948 $this->mTitleProtection = false;
2949 }
2950 } else {
2951 $this->mRestrictionsExpiry['create'] = $wgContLang->formatExpiry( '', TS_MW );
2952 }
2953 $this->mRestrictionsLoaded = true;
2954 }
2955 }
2956 }
2957
2958 /**
2959 * Flush the protection cache in this object and force reload from the database.
2960 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2961 */
2962 public function flushRestrictions() {
2963 $this->mRestrictionsLoaded = false;
2964 $this->mTitleProtection = null;
2965 }
2966
2967 /**
2968 * Purge expired restrictions from the page_restrictions table
2969 */
2970 static function purgeExpiredRestrictions() {
2971 if ( wfReadOnly() ) {
2972 return;
2973 }
2974
2975 $method = __METHOD__;
2976 $dbw = wfGetDB( DB_MASTER );
2977 $dbw->onTransactionIdle( function () use ( $dbw, $method ) {
2978 $dbw->delete(
2979 'page_restrictions',
2980 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2981 $method
2982 );
2983 $dbw->delete(
2984 'protected_titles',
2985 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2986 $method
2987 );
2988 } );
2989 }
2990
2991 /**
2992 * Does this have subpages? (Warning, usually requires an extra DB query.)
2993 *
2994 * @return bool
2995 */
2996 public function hasSubpages() {
2997 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
2998 # Duh
2999 return false;
3000 }
3001
3002 # We dynamically add a member variable for the purpose of this method
3003 # alone to cache the result. There's no point in having it hanging
3004 # around uninitialized in every Title object; therefore we only add it
3005 # if needed and don't declare it statically.
3006 if ( $this->mHasSubpages === null ) {
3007 $this->mHasSubpages = false;
3008 $subpages = $this->getSubpages( 1 );
3009 if ( $subpages instanceof TitleArray ) {
3010 $this->mHasSubpages = (bool)$subpages->count();
3011 }
3012 }
3013
3014 return $this->mHasSubpages;
3015 }
3016
3017 /**
3018 * Get all subpages of this page.
3019 *
3020 * @param int $limit Maximum number of subpages to fetch; -1 for no limit
3021 * @return TitleArray|array TitleArray, or empty array if this page's namespace
3022 * doesn't allow subpages
3023 */
3024 public function getSubpages( $limit = -1 ) {
3025 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
3026 return array();
3027 }
3028
3029 $dbr = wfGetDB( DB_SLAVE );
3030 $conds['page_namespace'] = $this->getNamespace();
3031 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
3032 $options = array();
3033 if ( $limit > -1 ) {
3034 $options['LIMIT'] = $limit;
3035 }
3036 $this->mSubpages = TitleArray::newFromResult(
3037 $dbr->select( 'page',
3038 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
3039 $conds,
3040 __METHOD__,
3041 $options
3042 )
3043 );
3044 return $this->mSubpages;
3045 }
3046
3047 /**
3048 * Is there a version of this page in the deletion archive?
3049 *
3050 * @return int The number of archived revisions
3051 */
3052 public function isDeleted() {
3053 if ( $this->getNamespace() < 0 ) {
3054 $n = 0;
3055 } else {
3056 $dbr = wfGetDB( DB_SLAVE );
3057
3058 $n = $dbr->selectField( 'archive', 'COUNT(*)',
3059 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3060 __METHOD__
3061 );
3062 if ( $this->getNamespace() == NS_FILE ) {
3063 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
3064 array( 'fa_name' => $this->getDBkey() ),
3065 __METHOD__
3066 );
3067 }
3068 }
3069 return (int)$n;
3070 }
3071
3072 /**
3073 * Is there a version of this page in the deletion archive?
3074 *
3075 * @return bool
3076 */
3077 public function isDeletedQuick() {
3078 if ( $this->getNamespace() < 0 ) {
3079 return false;
3080 }
3081 $dbr = wfGetDB( DB_SLAVE );
3082 $deleted = (bool)$dbr->selectField( 'archive', '1',
3083 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
3084 __METHOD__
3085 );
3086 if ( !$deleted && $this->getNamespace() == NS_FILE ) {
3087 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
3088 array( 'fa_name' => $this->getDBkey() ),
3089 __METHOD__
3090 );
3091 }
3092 return $deleted;
3093 }
3094
3095 /**
3096 * Get the article ID for this Title from the link cache,
3097 * adding it if necessary
3098 *
3099 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select
3100 * for update
3101 * @return int The ID
3102 */
3103 public function getArticleID( $flags = 0 ) {
3104 if ( $this->getNamespace() < 0 ) {
3105 $this->mArticleID = 0;
3106 return $this->mArticleID;
3107 }
3108 $linkCache = LinkCache::singleton();
3109 if ( $flags & self::GAID_FOR_UPDATE ) {
3110 $oldUpdate = $linkCache->forUpdate( true );
3111 $linkCache->clearLink( $this );
3112 $this->mArticleID = $linkCache->addLinkObj( $this );
3113 $linkCache->forUpdate( $oldUpdate );
3114 } else {
3115 if ( -1 == $this->mArticleID ) {
3116 $this->mArticleID = $linkCache->addLinkObj( $this );
3117 }
3118 }
3119 return $this->mArticleID;
3120 }
3121
3122 /**
3123 * Is this an article that is a redirect page?
3124 * Uses link cache, adding it if necessary
3125 *
3126 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3127 * @return bool
3128 */
3129 public function isRedirect( $flags = 0 ) {
3130 if ( !is_null( $this->mRedirect ) ) {
3131 return $this->mRedirect;
3132 }
3133 # Calling getArticleID() loads the field from cache as needed
3134 if ( !$this->getArticleID( $flags ) ) {
3135 $this->mRedirect = false;
3136 return $this->mRedirect;
3137 }
3138
3139 $linkCache = LinkCache::singleton();
3140 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
3141 if ( $cached === null ) {
3142 # Trust LinkCache's state over our own
3143 # LinkCache is telling us that the page doesn't exist, despite there being cached
3144 # data relating to an existing page in $this->mArticleID. Updaters should clear
3145 # LinkCache as appropriate, or use $flags = Title::GAID_FOR_UPDATE. If that flag is
3146 # set, then LinkCache will definitely be up to date here, since getArticleID() forces
3147 # LinkCache to refresh its data from the master.
3148 $this->mRedirect = false;
3149 return $this->mRedirect;
3150 }
3151
3152 $this->mRedirect = (bool)$cached;
3153
3154 return $this->mRedirect;
3155 }
3156
3157 /**
3158 * What is the length of this page?
3159 * Uses link cache, adding it if necessary
3160 *
3161 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3162 * @return int
3163 */
3164 public function getLength( $flags = 0 ) {
3165 if ( $this->mLength != -1 ) {
3166 return $this->mLength;
3167 }
3168 # Calling getArticleID() loads the field from cache as needed
3169 if ( !$this->getArticleID( $flags ) ) {
3170 $this->mLength = 0;
3171 return $this->mLength;
3172 }
3173 $linkCache = LinkCache::singleton();
3174 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
3175 if ( $cached === null ) {
3176 # Trust LinkCache's state over our own, as for isRedirect()
3177 $this->mLength = 0;
3178 return $this->mLength;
3179 }
3180
3181 $this->mLength = intval( $cached );
3182
3183 return $this->mLength;
3184 }
3185
3186 /**
3187 * What is the page_latest field for this page?
3188 *
3189 * @param int $flags A bit field; may be Title::GAID_FOR_UPDATE to select for update
3190 * @return int Int or 0 if the page doesn't exist
3191 */
3192 public function getLatestRevID( $flags = 0 ) {
3193 if ( !( $flags & Title::GAID_FOR_UPDATE ) && $this->mLatestID !== false ) {
3194 return intval( $this->mLatestID );
3195 }
3196 # Calling getArticleID() loads the field from cache as needed
3197 if ( !$this->getArticleID( $flags ) ) {
3198 $this->mLatestID = 0;
3199 return $this->mLatestID;
3200 }
3201 $linkCache = LinkCache::singleton();
3202 $linkCache->addLinkObj( $this );
3203 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3204 if ( $cached === null ) {
3205 # Trust LinkCache's state over our own, as for isRedirect()
3206 $this->mLatestID = 0;
3207 return $this->mLatestID;
3208 }
3209
3210 $this->mLatestID = intval( $cached );
3211
3212 return $this->mLatestID;
3213 }
3214
3215 /**
3216 * This clears some fields in this object, and clears any associated
3217 * keys in the "bad links" section of the link cache.
3218 *
3219 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
3220 * loading of the new page_id. It's also called from
3221 * WikiPage::doDeleteArticleReal()
3222 *
3223 * @param int $newid The new Article ID
3224 */
3225 public function resetArticleID( $newid ) {
3226 $linkCache = LinkCache::singleton();
3227 $linkCache->clearLink( $this );
3228
3229 if ( $newid === false ) {
3230 $this->mArticleID = -1;
3231 } else {
3232 $this->mArticleID = intval( $newid );
3233 }
3234 $this->mRestrictionsLoaded = false;
3235 $this->mRestrictions = array();
3236 $this->mRedirect = null;
3237 $this->mLength = -1;
3238 $this->mLatestID = false;
3239 $this->mContentModel = false;
3240 $this->mEstimateRevisions = null;
3241 $this->mPageLanguage = false;
3242 $this->mDbPageLanguage = null;
3243 }
3244
3245 /**
3246 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3247 *
3248 * @param string $text Containing title to capitalize
3249 * @param int $ns Namespace index, defaults to NS_MAIN
3250 * @return string Containing capitalized title
3251 */
3252 public static function capitalize( $text, $ns = NS_MAIN ) {
3253 global $wgContLang;
3254
3255 if ( MWNamespace::isCapitalized( $ns ) ) {
3256 return $wgContLang->ucfirst( $text );
3257 } else {
3258 return $text;
3259 }
3260 }
3261
3262 /**
3263 * Secure and split - main initialisation function for this object
3264 *
3265 * Assumes that mDbkeyform has been set, and is urldecoded
3266 * and uses underscores, but not otherwise munged. This function
3267 * removes illegal characters, splits off the interwiki and
3268 * namespace prefixes, sets the other forms, and canonicalizes
3269 * everything.
3270 *
3271 * @return bool True on success
3272 */
3273 private function secureAndSplit() {
3274 # Initialisation
3275 $this->mInterwiki = '';
3276 $this->mFragment = '';
3277 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
3278
3279 $dbkey = $this->mDbkeyform;
3280
3281 try {
3282 // @note: splitTitleString() is a temporary hack to allow MediaWikiTitleCodec to share
3283 // the parsing code with Title, while avoiding massive refactoring.
3284 // @todo: get rid of secureAndSplit, refactor parsing code.
3285 $parser = self::getTitleParser();
3286 $parts = $parser->splitTitleString( $dbkey, $this->getDefaultNamespace() );
3287 } catch ( MalformedTitleException $ex ) {
3288 return false;
3289 }
3290
3291 # Fill fields
3292 $this->setFragment( '#' . $parts['fragment'] );
3293 $this->mInterwiki = $parts['interwiki'];
3294 $this->mNamespace = $parts['namespace'];
3295 $this->mUserCaseDBKey = $parts['user_case_dbkey'];
3296
3297 $this->mDbkeyform = $parts['dbkey'];
3298 $this->mUrlform = wfUrlencode( $this->mDbkeyform );
3299 $this->mTextform = str_replace( '_', ' ', $this->mDbkeyform );
3300
3301 # We already know that some pages won't be in the database!
3302 if ( $this->isExternal() || $this->mNamespace == NS_SPECIAL ) {
3303 $this->mArticleID = 0;
3304 }
3305
3306 return true;
3307 }
3308
3309 /**
3310 * Get an array of Title objects linking to this Title
3311 * Also stores the IDs in the link cache.
3312 *
3313 * WARNING: do not use this function on arbitrary user-supplied titles!
3314 * On heavily-used templates it will max out the memory.
3315 *
3316 * @param array $options May be FOR UPDATE
3317 * @param string $table Table name
3318 * @param string $prefix Fields prefix
3319 * @return Title[] Array of Title objects linking here
3320 */
3321 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3322 if ( count( $options ) > 0 ) {
3323 $db = wfGetDB( DB_MASTER );
3324 } else {
3325 $db = wfGetDB( DB_SLAVE );
3326 }
3327
3328 $res = $db->select(
3329 array( 'page', $table ),
3330 self::getSelectFields(),
3331 array(
3332 "{$prefix}_from=page_id",
3333 "{$prefix}_namespace" => $this->getNamespace(),
3334 "{$prefix}_title" => $this->getDBkey() ),
3335 __METHOD__,
3336 $options
3337 );
3338
3339 $retVal = array();
3340 if ( $res->numRows() ) {
3341 $linkCache = LinkCache::singleton();
3342 foreach ( $res as $row ) {
3343 $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title );
3344 if ( $titleObj ) {
3345 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3346 $retVal[] = $titleObj;
3347 }
3348 }
3349 }
3350 return $retVal;
3351 }
3352
3353 /**
3354 * Get an array of Title objects using this Title as a template
3355 * Also stores the IDs in the link cache.
3356 *
3357 * WARNING: do not use this function on arbitrary user-supplied titles!
3358 * On heavily-used templates it will max out the memory.
3359 *
3360 * @param array $options May be FOR UPDATE
3361 * @return Title[] Array of Title the Title objects linking here
3362 */
3363 public function getTemplateLinksTo( $options = array() ) {
3364 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3365 }
3366
3367 /**
3368 * Get an array of Title objects linked from this Title
3369 * Also stores the IDs in the link cache.
3370 *
3371 * WARNING: do not use this function on arbitrary user-supplied titles!
3372 * On heavily-used templates it will max out the memory.
3373 *
3374 * @param array $options May be FOR UPDATE
3375 * @param string $table Table name
3376 * @param string $prefix Fields prefix
3377 * @return array Array of Title objects linking here
3378 */
3379 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3380 global $wgContentHandlerUseDB;
3381
3382 $id = $this->getArticleID();
3383
3384 # If the page doesn't exist; there can't be any link from this page
3385 if ( !$id ) {
3386 return array();
3387 }
3388
3389 if ( count( $options ) > 0 ) {
3390 $db = wfGetDB( DB_MASTER );
3391 } else {
3392 $db = wfGetDB( DB_SLAVE );
3393 }
3394
3395 $namespaceFiled = "{$prefix}_namespace";
3396 $titleField = "{$prefix}_title";
3397
3398 $fields = array(
3399 $namespaceFiled,
3400 $titleField,
3401 'page_id',
3402 'page_len',
3403 'page_is_redirect',
3404 'page_latest'
3405 );
3406
3407 if ( $wgContentHandlerUseDB ) {
3408 $fields[] = 'page_content_model';
3409 }
3410
3411 $res = $db->select(
3412 array( $table, 'page' ),
3413 $fields,
3414 array( "{$prefix}_from" => $id ),
3415 __METHOD__,
3416 $options,
3417 array( 'page' => array(
3418 'LEFT JOIN',
3419 array( "page_namespace=$namespaceFiled", "page_title=$titleField" )
3420 ) )
3421 );
3422
3423 $retVal = array();
3424 if ( $res->numRows() ) {
3425 $linkCache = LinkCache::singleton();
3426 foreach ( $res as $row ) {
3427 $titleObj = Title::makeTitle( $row->$namespaceFiled, $row->$titleField );
3428 if ( $titleObj ) {
3429 if ( $row->page_id ) {
3430 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3431 } else {
3432 $linkCache->addBadLinkObj( $titleObj );
3433 }
3434 $retVal[] = $titleObj;
3435 }
3436 }
3437 }
3438 return $retVal;
3439 }
3440
3441 /**
3442 * Get an array of Title objects used on this Title as a template
3443 * Also stores the IDs in the link cache.
3444 *
3445 * WARNING: do not use this function on arbitrary user-supplied titles!
3446 * On heavily-used templates it will max out the memory.
3447 *
3448 * @param array $options May be FOR UPDATE
3449 * @return Title[] Array of Title the Title objects used here
3450 */
3451 public function getTemplateLinksFrom( $options = array() ) {
3452 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3453 }
3454
3455 /**
3456 * Get an array of Title objects referring to non-existent articles linked
3457 * from this page.
3458 *
3459 * @todo check if needed (used only in SpecialBrokenRedirects.php, and
3460 * should use redirect table in this case).
3461 * @return Title[] Array of Title the Title objects
3462 */
3463 public function getBrokenLinksFrom() {
3464 if ( $this->getArticleID() == 0 ) {
3465 # All links from article ID 0 are false positives
3466 return array();
3467 }
3468
3469 $dbr = wfGetDB( DB_SLAVE );
3470 $res = $dbr->select(
3471 array( 'page', 'pagelinks' ),
3472 array( 'pl_namespace', 'pl_title' ),
3473 array(
3474 'pl_from' => $this->getArticleID(),
3475 'page_namespace IS NULL'
3476 ),
3477 __METHOD__, array(),
3478 array(
3479 'page' => array(
3480 'LEFT JOIN',
3481 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3482 )
3483 )
3484 );
3485
3486 $retVal = array();
3487 foreach ( $res as $row ) {
3488 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
3489 }
3490 return $retVal;
3491 }
3492
3493 /**
3494 * Get a list of URLs to purge from the Squid cache when this
3495 * page changes
3496 *
3497 * @return string[] Array of String the URLs
3498 */
3499 public function getSquidURLs() {
3500 $urls = array(
3501 $this->getInternalURL(),
3502 $this->getInternalURL( 'action=history' )
3503 );
3504
3505 $pageLang = $this->getPageLanguage();
3506 if ( $pageLang->hasVariants() ) {
3507 $variants = $pageLang->getVariants();
3508 foreach ( $variants as $vCode ) {
3509 $urls[] = $this->getInternalURL( '', $vCode );
3510 }
3511 }
3512
3513 // If we are looking at a css/js user subpage, purge the action=raw.
3514 if ( $this->isJsSubpage() ) {
3515 $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/javascript' );
3516 } elseif ( $this->isCssSubpage() ) {
3517 $urls[] = $this->getInternalUrl( 'action=raw&ctype=text/css' );
3518 }
3519
3520 wfRunHooks( 'TitleSquidURLs', array( $this, &$urls ) );
3521 return $urls;
3522 }
3523
3524 /**
3525 * Purge all applicable Squid URLs
3526 */
3527 public function purgeSquid() {
3528 global $wgUseSquid;
3529 if ( $wgUseSquid ) {
3530 $urls = $this->getSquidURLs();
3531 $u = new SquidUpdate( $urls );
3532 $u->doUpdate();
3533 }
3534 }
3535
3536 /**
3537 * Move this page without authentication
3538 *
3539 * @param Title $nt The new page Title
3540 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3541 */
3542 public function moveNoAuth( &$nt ) {
3543 return $this->moveTo( $nt, false );
3544 }
3545
3546 /**
3547 * Check whether a given move operation would be valid.
3548 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3549 *
3550 * @param Title $nt The new title
3551 * @param bool $auth Indicates whether $wgUser's permissions
3552 * should be checked
3553 * @param string $reason Is the log summary of the move, used for spam checking
3554 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3555 */
3556 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3557 global $wgUser, $wgContentHandlerUseDB;
3558
3559 $errors = array();
3560 if ( !$nt ) {
3561 // Normally we'd add this to $errors, but we'll get
3562 // lots of syntax errors if $nt is not an object
3563 return array( array( 'badtitletext' ) );
3564 }
3565 if ( $this->equals( $nt ) ) {
3566 $errors[] = array( 'selfmove' );
3567 }
3568 if ( !$this->isMovable() ) {
3569 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3570 }
3571 if ( $nt->isExternal() ) {
3572 $errors[] = array( 'immobile-target-namespace-iw' );
3573 }
3574 if ( !$nt->isMovable() ) {
3575 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3576 }
3577
3578 $oldid = $this->getArticleID();
3579 $newid = $nt->getArticleID();
3580
3581 if ( strlen( $nt->getDBkey() ) < 1 ) {
3582 $errors[] = array( 'articleexists' );
3583 }
3584 if (
3585 ( $this->getDBkey() == '' ) ||
3586 ( !$oldid ) ||
3587 ( $nt->getDBkey() == '' )
3588 ) {
3589 $errors[] = array( 'badarticleerror' );
3590 }
3591
3592 // Content model checks
3593 if ( !$wgContentHandlerUseDB &&
3594 $this->getContentModel() !== $nt->getContentModel() ) {
3595 // can't move a page if that would change the page's content model
3596 $errors[] = array(
3597 'bad-target-model',
3598 ContentHandler::getLocalizedName( $this->getContentModel() ),
3599 ContentHandler::getLocalizedName( $nt->getContentModel() )
3600 );
3601 }
3602
3603 // Image-specific checks
3604 if ( $this->getNamespace() == NS_FILE ) {
3605 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3606 }
3607
3608 if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) {
3609 $errors[] = array( 'nonfile-cannot-move-to-file' );
3610 }
3611
3612 if ( $auth ) {
3613 $errors = wfMergeErrorArrays( $errors,
3614 $this->getUserPermissionsErrors( 'move', $wgUser ),
3615 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3616 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3617 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3618 }
3619
3620 $match = EditPage::matchSummarySpamRegex( $reason );
3621 if ( $match !== false ) {
3622 // This is kind of lame, won't display nice
3623 $errors[] = array( 'spamprotectiontext' );
3624 }
3625
3626 $err = null;
3627 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3628 $errors[] = array( 'hookaborted', $err );
3629 }
3630
3631 # The move is allowed only if (1) the target doesn't exist, or
3632 # (2) the target is a redirect to the source, and has no history
3633 # (so we can undo bad moves right after they're done).
3634
3635 if ( 0 != $newid ) { # Target exists; check for validity
3636 if ( !$this->isValidMoveTarget( $nt ) ) {
3637 $errors[] = array( 'articleexists' );
3638 }
3639 } else {
3640 $tp = $nt->getTitleProtection();
3641 $right = $tp['pt_create_perm'];
3642 if ( $right == 'sysop' ) {
3643 $right = 'editprotected'; // B/C
3644 }
3645 if ( $right == 'autoconfirmed' ) {
3646 $right = 'editsemiprotected'; // B/C
3647 }
3648 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3649 $errors[] = array( 'cantmove-titleprotected' );
3650 }
3651 }
3652 if ( empty( $errors ) ) {
3653 return true;
3654 }
3655 return $errors;
3656 }
3657
3658 /**
3659 * Check if the requested move target is a valid file move target
3660 * @param Title $nt Target title
3661 * @return array List of errors
3662 */
3663 protected function validateFileMoveOperation( $nt ) {
3664 global $wgUser;
3665
3666 $errors = array();
3667
3668 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3669
3670 $file = wfLocalFile( $this );
3671 if ( $file->exists() ) {
3672 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3673 $errors[] = array( 'imageinvalidfilename' );
3674 }
3675 if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3676 $errors[] = array( 'imagetypemismatch' );
3677 }
3678 }
3679
3680 if ( $nt->getNamespace() != NS_FILE ) {
3681 $errors[] = array( 'imagenocrossnamespace' );
3682 // From here we want to do checks on a file object, so if we can't
3683 // create one, we must return.
3684 return $errors;
3685 }
3686
3687 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3688
3689 $destFile = wfLocalFile( $nt );
3690 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3691 $errors[] = array( 'file-exists-sharedrepo' );
3692 }
3693
3694 return $errors;
3695 }
3696
3697 /**
3698 * Move a title to a new location
3699 *
3700 * @param Title $nt The new title
3701 * @param bool $auth Indicates whether $wgUser's permissions
3702 * should be checked
3703 * @param string $reason The reason for the move
3704 * @param bool $createRedirect Whether to create a redirect from the old title to the new title.
3705 * Ignored if the user doesn't have the suppressredirect right.
3706 * @return array|bool True on success, getUserPermissionsErrors()-like array on failure
3707 */
3708 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3709 global $wgUser;
3710 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3711 if ( is_array( $err ) ) {
3712 // Auto-block user's IP if the account was "hard" blocked
3713 $wgUser->spreadAnyEditBlock();
3714 return $err;
3715 }
3716 // Check suppressredirect permission
3717 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3718 $createRedirect = true;
3719 }
3720
3721 wfRunHooks( 'TitleMove', array( $this, $nt, $wgUser ) );
3722
3723 // If it is a file, move it first.
3724 // It is done before all other moving stuff is done because it's hard to revert.
3725 $dbw = wfGetDB( DB_MASTER );
3726 if ( $this->getNamespace() == NS_FILE ) {
3727 $file = wfLocalFile( $this );
3728 if ( $file->exists() ) {
3729 $status = $file->move( $nt );
3730 if ( !$status->isOk() ) {
3731 return $status->getErrorsArray();
3732 }
3733 }
3734 // Clear RepoGroup process cache
3735 RepoGroup::singleton()->clearCache( $this );
3736 RepoGroup::singleton()->clearCache( $nt ); # clear false negative cache
3737 }
3738
3739 $dbw->begin( __METHOD__ ); # If $file was a LocalFile, its transaction would have closed our own.
3740 $pageid = $this->getArticleID( self::GAID_FOR_UPDATE );
3741 $protected = $this->isProtected();
3742
3743 // Do the actual move
3744 $this->moveToInternal( $nt, $reason, $createRedirect );
3745
3746 // Refresh the sortkey for this row. Be careful to avoid resetting
3747 // cl_timestamp, which may disturb time-based lists on some sites.
3748 $prefixes = $dbw->select(
3749 'categorylinks',
3750 array( 'cl_sortkey_prefix', 'cl_to' ),
3751 array( 'cl_from' => $pageid ),
3752 __METHOD__
3753 );
3754 foreach ( $prefixes as $prefixRow ) {
3755 $prefix = $prefixRow->cl_sortkey_prefix;
3756 $catTo = $prefixRow->cl_to;
3757 $dbw->update( 'categorylinks',
3758 array(
3759 'cl_sortkey' => Collation::singleton()->getSortKey(
3760 $nt->getCategorySortkey( $prefix ) ),
3761 'cl_timestamp=cl_timestamp' ),
3762 array(
3763 'cl_from' => $pageid,
3764 'cl_to' => $catTo ),
3765 __METHOD__
3766 );
3767 }
3768
3769 $redirid = $this->getArticleID();
3770
3771 if ( $protected ) {
3772 # Protect the redirect title as the title used to be...
3773 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3774 array(
3775 'pr_page' => $redirid,
3776 'pr_type' => 'pr_type',
3777 'pr_level' => 'pr_level',
3778 'pr_cascade' => 'pr_cascade',
3779 'pr_user' => 'pr_user',
3780 'pr_expiry' => 'pr_expiry'
3781 ),
3782 array( 'pr_page' => $pageid ),
3783 __METHOD__,
3784 array( 'IGNORE' )
3785 );
3786 # Update the protection log
3787 $log = new LogPage( 'protect' );
3788 $comment = wfMessage(
3789 'prot_1movedto2',
3790 $this->getPrefixedText(),
3791 $nt->getPrefixedText()
3792 )->inContentLanguage()->text();
3793 if ( $reason ) {
3794 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3795 }
3796 // @todo FIXME: $params?
3797 $logId = $log->addEntry(
3798 'move_prot',
3799 $nt,
3800 $comment,
3801 array( $this->getPrefixedText() ),
3802 $wgUser
3803 );
3804
3805 // reread inserted pr_ids for log relation
3806 $insertedPrIds = $dbw->select(
3807 'page_restrictions',
3808 'pr_id',
3809 array( 'pr_page' => $redirid ),
3810 __METHOD__
3811 );
3812 $logRelationsValues = array();
3813 foreach ( $insertedPrIds as $prid ) {
3814 $logRelationsValues[] = $prid->pr_id;
3815 }
3816 $log->addRelations( 'pr_id', $logRelationsValues, $logId );
3817 }
3818
3819 // Update *_from_namespace fields as needed
3820 if ( $this->getNamespace() != $nt->getNamespace() ) {
3821 $dbw->update( 'pagelinks',
3822 array( 'pl_from_namespace' => $nt->getNamespace() ),
3823 array( 'pl_from' => $pageid ),
3824 __METHOD__
3825 );
3826 $dbw->update( 'templatelinks',
3827 array( 'tl_from_namespace' => $nt->getNamespace() ),
3828 array( 'tl_from' => $pageid ),
3829 __METHOD__
3830 );
3831 $dbw->update( 'imagelinks',
3832 array( 'il_from_namespace' => $nt->getNamespace() ),
3833 array( 'il_from' => $pageid ),
3834 __METHOD__
3835 );
3836 }
3837
3838 # Update watchlists
3839 $oldtitle = $this->getDBkey();
3840 $newtitle = $nt->getDBkey();
3841 $oldsnamespace = MWNamespace::getSubject( $this->getNamespace() );
3842 $newsnamespace = MWNamespace::getSubject( $nt->getNamespace() );
3843 if ( $oldsnamespace != $newsnamespace || $oldtitle != $newtitle ) {
3844 WatchedItem::duplicateEntries( $this, $nt );
3845 }
3846
3847 $dbw->commit( __METHOD__ );
3848
3849 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid, $reason ) );
3850 return true;
3851 }
3852
3853 /**
3854 * Move page to a title which is either a redirect to the
3855 * source page or nonexistent
3856 *
3857 * @param Title $nt The page to move to, which should be a redirect or nonexistent
3858 * @param string $reason The reason for the move
3859 * @param bool $createRedirect Whether to leave a redirect at the old title. Does not check
3860 * if the user has the suppressredirect right
3861 * @throws MWException
3862 */
3863 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3864 global $wgUser, $wgContLang;
3865
3866 if ( $nt->exists() ) {
3867 $moveOverRedirect = true;
3868 $logType = 'move_redir';
3869 } else {
3870 $moveOverRedirect = false;
3871 $logType = 'move';
3872 }
3873
3874 if ( $createRedirect ) {
3875 if ( $this->getNamespace() == NS_CATEGORY
3876 && !wfMessage( 'category-move-redirect-override' )->inContentLanguage()->isDisabled()
3877 ) {
3878 $redirectContent = new WikitextContent(
3879 wfMessage( 'category-move-redirect-override' )
3880 ->params( $nt->getPrefixedText() )->inContentLanguage()->plain() );
3881 } else {
3882 $contentHandler = ContentHandler::getForTitle( $this );
3883 $redirectContent = $contentHandler->makeRedirectContent( $nt,
3884 wfMessage( 'move-redirect-text' )->inContentLanguage()->plain() );
3885 }
3886
3887 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
3888 } else {
3889 $redirectContent = null;
3890 }
3891
3892 $logEntry = new ManualLogEntry( 'move', $logType );
3893 $logEntry->setPerformer( $wgUser );
3894 $logEntry->setTarget( $this );
3895 $logEntry->setComment( $reason );
3896 $logEntry->setParameters( array(
3897 '4::target' => $nt->getPrefixedText(),
3898 '5::noredir' => $redirectContent ? '0': '1',
3899 ) );
3900
3901 $formatter = LogFormatter::newFromEntry( $logEntry );
3902 $formatter->setContext( RequestContext::newExtraneousContext( $this ) );
3903 $comment = $formatter->getPlainActionText();
3904 if ( $reason ) {
3905 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3906 }
3907 # Truncate for whole multibyte characters.
3908 $comment = $wgContLang->truncate( $comment, 255 );
3909
3910 $oldid = $this->getArticleID();
3911
3912 $dbw = wfGetDB( DB_MASTER );
3913
3914 $newpage = WikiPage::factory( $nt );
3915
3916 if ( $moveOverRedirect ) {
3917 $newid = $nt->getArticleID();
3918 $newcontent = $newpage->getContent();
3919
3920 # Delete the old redirect. We don't save it to history since
3921 # by definition if we've got here it's rather uninteresting.
3922 # We have to remove it so that the next step doesn't trigger
3923 # a conflict on the unique namespace+title index...
3924 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ );
3925
3926 $newpage->doDeleteUpdates( $newid, $newcontent );
3927 }
3928
3929 # Save a null revision in the page's history notifying of the move
3930 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true, $wgUser );
3931 if ( !is_object( $nullRevision ) ) {
3932 throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
3933 }
3934
3935 $nullRevision->insertOn( $dbw );
3936
3937 # Change the name of the target page:
3938 $dbw->update( 'page',
3939 /* SET */ array(
3940 'page_namespace' => $nt->getNamespace(),
3941 'page_title' => $nt->getDBkey(),
3942 ),
3943 /* WHERE */ array( 'page_id' => $oldid ),
3944 __METHOD__
3945 );
3946
3947 // clean up the old title before reset article id - bug 45348
3948 if ( !$redirectContent ) {
3949 WikiPage::onArticleDelete( $this );
3950 }
3951
3952 $this->resetArticleID( 0 ); // 0 == non existing
3953 $nt->resetArticleID( $oldid );
3954 $newpage->loadPageData( WikiPage::READ_LOCKING ); // bug 46397
3955
3956 $newpage->updateRevisionOn( $dbw, $nullRevision );
3957
3958 wfRunHooks( 'NewRevisionFromEditComplete',
3959 array( $newpage, $nullRevision, $nullRevision->getParentId(), $wgUser ) );
3960
3961 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3962
3963 if ( !$moveOverRedirect ) {
3964 WikiPage::onArticleCreate( $nt );
3965 }
3966
3967 # Recreate the redirect, this time in the other direction.
3968 if ( $redirectContent ) {
3969 $redirectArticle = WikiPage::factory( $this );
3970 $redirectArticle->loadFromRow( false, WikiPage::READ_LOCKING ); // bug 46397
3971 $newid = $redirectArticle->insertOn( $dbw );
3972 if ( $newid ) { // sanity
3973 $this->resetArticleID( $newid );
3974 $redirectRevision = new Revision( array(
3975 'title' => $this, // for determining the default content model
3976 'page' => $newid,
3977 'user_text' => $wgUser->getName(),
3978 'user' => $wgUser->getId(),
3979 'comment' => $comment,
3980 'content' => $redirectContent ) );
3981 $redirectRevision->insertOn( $dbw );
3982 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3983
3984 wfRunHooks( 'NewRevisionFromEditComplete',
3985 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3986
3987 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3988 }
3989 }
3990
3991 # Log the move
3992 $logid = $logEntry->insert();
3993 $logEntry->publish( $logid );
3994 }
3995
3996 /**
3997 * Move this page's subpages to be subpages of $nt
3998 *
3999 * @param Title $nt Move target
4000 * @param bool $auth Whether $wgUser's permissions should be checked
4001 * @param string $reason The reason for the move
4002 * @param bool $createRedirect Whether to create redirects from the old subpages to
4003 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
4004 * @return array Array with old page titles as keys, and strings (new page titles) or
4005 * arrays (errors) as values, or an error array with numeric indices if no pages
4006 * were moved
4007 */
4008 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
4009 global $wgMaximumMovedPages;
4010 // Check permissions
4011 if ( !$this->userCan( 'move-subpages' ) ) {
4012 return array( 'cant-move-subpages' );
4013 }
4014 // Do the source and target namespaces support subpages?
4015 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
4016 return array( 'namespace-nosubpages',
4017 MWNamespace::getCanonicalName( $this->getNamespace() ) );
4018 }
4019 if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) {
4020 return array( 'namespace-nosubpages',
4021 MWNamespace::getCanonicalName( $nt->getNamespace() ) );
4022 }
4023
4024 $subpages = $this->getSubpages( $wgMaximumMovedPages + 1 );
4025 $retval = array();
4026 $count = 0;
4027 foreach ( $subpages as $oldSubpage ) {
4028 $count++;
4029 if ( $count > $wgMaximumMovedPages ) {
4030 $retval[$oldSubpage->getPrefixedText()] =
4031 array( 'movepage-max-pages',
4032 $wgMaximumMovedPages );
4033 break;
4034 }
4035
4036 // We don't know whether this function was called before
4037 // or after moving the root page, so check both
4038 // $this and $nt
4039 if ( $oldSubpage->getArticleID() == $this->getArticleID()
4040 || $oldSubpage->getArticleID() == $nt->getArticleID()
4041 ) {
4042 // When moving a page to a subpage of itself,
4043 // don't move it twice
4044 continue;
4045 }
4046 $newPageName = preg_replace(
4047 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
4048 StringUtils::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
4049 $oldSubpage->getDBkey() );
4050 if ( $oldSubpage->isTalkPage() ) {
4051 $newNs = $nt->getTalkPage()->getNamespace();
4052 } else {
4053 $newNs = $nt->getSubjectPage()->getNamespace();
4054 }
4055 # Bug 14385: we need makeTitleSafe because the new page names may
4056 # be longer than 255 characters.
4057 $newSubpage = Title::makeTitleSafe( $newNs, $newPageName );
4058
4059 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
4060 if ( $success === true ) {
4061 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
4062 } else {
4063 $retval[$oldSubpage->getPrefixedText()] = $success;
4064 }
4065 }
4066 return $retval;
4067 }
4068
4069 /**
4070 * Checks if this page is just a one-rev redirect.
4071 * Adds lock, so don't use just for light purposes.
4072 *
4073 * @return bool
4074 */
4075 public function isSingleRevRedirect() {
4076 global $wgContentHandlerUseDB;
4077
4078 $dbw = wfGetDB( DB_MASTER );
4079
4080 # Is it a redirect?
4081 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
4082 if ( $wgContentHandlerUseDB ) {
4083 $fields[] = 'page_content_model';
4084 }
4085
4086 $row = $dbw->selectRow( 'page',
4087 $fields,
4088 $this->pageCond(),
4089 __METHOD__,
4090 array( 'FOR UPDATE' )
4091 );
4092 # Cache some fields we may want
4093 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
4094 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
4095 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
4096 $this->mContentModel = $row && isset( $row->page_content_model )
4097 ? strval( $row->page_content_model )
4098 : false;
4099
4100 if ( !$this->mRedirect ) {
4101 return false;
4102 }
4103 # Does the article have a history?
4104 $row = $dbw->selectField( array( 'page', 'revision' ),
4105 'rev_id',
4106 array( 'page_namespace' => $this->getNamespace(),
4107 'page_title' => $this->getDBkey(),
4108 'page_id=rev_page',
4109 'page_latest != rev_id'
4110 ),
4111 __METHOD__,
4112 array( 'FOR UPDATE' )
4113 );
4114 # Return true if there was no history
4115 return ( $row === false );
4116 }
4117
4118 /**
4119 * Checks if $this can be moved to a given Title
4120 * - Selects for update, so don't call it unless you mean business
4121 *
4122 * @param Title $nt The new title to check
4123 * @return bool
4124 */
4125 public function isValidMoveTarget( $nt ) {
4126 # Is it an existing file?
4127 if ( $nt->getNamespace() == NS_FILE ) {
4128 $file = wfLocalFile( $nt );
4129 if ( $file->exists() ) {
4130 wfDebug( __METHOD__ . ": file exists\n" );
4131 return false;
4132 }
4133 }
4134 # Is it a redirect with no history?
4135 if ( !$nt->isSingleRevRedirect() ) {
4136 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
4137 return false;
4138 }
4139 # Get the article text
4140 $rev = Revision::newFromTitle( $nt, false, Revision::READ_LATEST );
4141 if ( !is_object( $rev ) ) {
4142 return false;
4143 }
4144 $content = $rev->getContent();
4145 # Does the redirect point to the source?
4146 # Or is it a broken self-redirect, usually caused by namespace collisions?
4147 $redirTitle = $content ? $content->getRedirectTarget() : null;
4148
4149 if ( $redirTitle ) {
4150 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
4151 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
4152 wfDebug( __METHOD__ . ": redirect points to other page\n" );
4153 return false;
4154 } else {
4155 return true;
4156 }
4157 } else {
4158 # Fail safe (not a redirect after all. strange.)
4159 wfDebug( __METHOD__ . ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4160 " is a redirect, but it doesn't contain a valid redirect.\n" );
4161 return false;
4162 }
4163 }
4164
4165 /**
4166 * Get categories to which this Title belongs and return an array of
4167 * categories' names.
4168 *
4169 * @return array Array of parents in the form:
4170 * $parent => $currentarticle
4171 */
4172 public function getParentCategories() {
4173 global $wgContLang;
4174
4175 $data = array();
4176
4177 $titleKey = $this->getArticleID();
4178
4179 if ( $titleKey === 0 ) {
4180 return $data;
4181 }
4182
4183 $dbr = wfGetDB( DB_SLAVE );
4184
4185 $res = $dbr->select(
4186 'categorylinks',
4187 'cl_to',
4188 array( 'cl_from' => $titleKey ),
4189 __METHOD__
4190 );
4191
4192 if ( $res->numRows() > 0 ) {
4193 foreach ( $res as $row ) {
4194 // $data[] = Title::newFromText($wgContLang->getNsText ( NS_CATEGORY ).':'.$row->cl_to);
4195 $data[$wgContLang->getNsText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText();
4196 }
4197 }
4198 return $data;
4199 }
4200
4201 /**
4202 * Get a tree of parent categories
4203 *
4204 * @param array $children Array with the children in the keys, to check for circular refs
4205 * @return array Tree of parent categories
4206 */
4207 public function getParentCategoryTree( $children = array() ) {
4208 $stack = array();
4209 $parents = $this->getParentCategories();
4210
4211 if ( $parents ) {
4212 foreach ( $parents as $parent => $current ) {
4213 if ( array_key_exists( $parent, $children ) ) {
4214 # Circular reference
4215 $stack[$parent] = array();
4216 } else {
4217 $nt = Title::newFromText( $parent );
4218 if ( $nt ) {
4219 $stack[$parent] = $nt->getParentCategoryTree( $children + array( $parent => 1 ) );
4220 }
4221 }
4222 }
4223 }
4224
4225 return $stack;
4226 }
4227
4228 /**
4229 * Get an associative array for selecting this title from
4230 * the "page" table
4231 *
4232 * @return array Array suitable for the $where parameter of DB::select()
4233 */
4234 public function pageCond() {
4235 if ( $this->mArticleID > 0 ) {
4236 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4237 return array( 'page_id' => $this->mArticleID );
4238 } else {
4239 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
4240 }
4241 }
4242
4243 /**
4244 * Get the revision ID of the previous revision
4245 *
4246 * @param int $revId Revision ID. Get the revision that was before this one.
4247 * @param int $flags Title::GAID_FOR_UPDATE
4248 * @return int|bool Old revision ID, or false if none exists
4249 */
4250 public function getPreviousRevisionID( $revId, $flags = 0 ) {
4251 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4252 $revId = $db->selectField( 'revision', 'rev_id',
4253 array(
4254 'rev_page' => $this->getArticleID( $flags ),
4255 'rev_id < ' . intval( $revId )
4256 ),
4257 __METHOD__,
4258 array( 'ORDER BY' => 'rev_id DESC' )
4259 );
4260
4261 if ( $revId === false ) {
4262 return false;
4263 } else {
4264 return intval( $revId );
4265 }
4266 }
4267
4268 /**
4269 * Get the revision ID of the next revision
4270 *
4271 * @param int $revId Revision ID. Get the revision that was after this one.
4272 * @param int $flags Title::GAID_FOR_UPDATE
4273 * @return int|bool Next revision ID, or false if none exists
4274 */
4275 public function getNextRevisionID( $revId, $flags = 0 ) {
4276 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4277 $revId = $db->selectField( 'revision', 'rev_id',
4278 array(
4279 'rev_page' => $this->getArticleID( $flags ),
4280 'rev_id > ' . intval( $revId )
4281 ),
4282 __METHOD__,
4283 array( 'ORDER BY' => 'rev_id' )
4284 );
4285
4286 if ( $revId === false ) {
4287 return false;
4288 } else {
4289 return intval( $revId );
4290 }
4291 }
4292
4293 /**
4294 * Get the first revision of the page
4295 *
4296 * @param int $flags Title::GAID_FOR_UPDATE
4297 * @return Revision|null If page doesn't exist
4298 */
4299 public function getFirstRevision( $flags = 0 ) {
4300 $pageId = $this->getArticleID( $flags );
4301 if ( $pageId ) {
4302 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4303 $row = $db->selectRow( 'revision', Revision::selectFields(),
4304 array( 'rev_page' => $pageId ),
4305 __METHOD__,
4306 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
4307 );
4308 if ( $row ) {
4309 return new Revision( $row );
4310 }
4311 }
4312 return null;
4313 }
4314
4315 /**
4316 * Get the oldest revision timestamp of this page
4317 *
4318 * @param int $flags Title::GAID_FOR_UPDATE
4319 * @return string MW timestamp
4320 */
4321 public function getEarliestRevTime( $flags = 0 ) {
4322 $rev = $this->getFirstRevision( $flags );
4323 return $rev ? $rev->getTimestamp() : null;
4324 }
4325
4326 /**
4327 * Check if this is a new page
4328 *
4329 * @return bool
4330 */
4331 public function isNewPage() {
4332 $dbr = wfGetDB( DB_SLAVE );
4333 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
4334 }
4335
4336 /**
4337 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4338 *
4339 * @return bool
4340 */
4341 public function isBigDeletion() {
4342 global $wgDeleteRevisionsLimit;
4343
4344 if ( !$wgDeleteRevisionsLimit ) {
4345 return false;
4346 }
4347
4348 $revCount = $this->estimateRevisionCount();
4349 return $revCount > $wgDeleteRevisionsLimit;
4350 }
4351
4352 /**
4353 * Get the approximate revision count of this page.
4354 *
4355 * @return int
4356 */
4357 public function estimateRevisionCount() {
4358 if ( !$this->exists() ) {
4359 return 0;
4360 }
4361
4362 if ( $this->mEstimateRevisions === null ) {
4363 $dbr = wfGetDB( DB_SLAVE );
4364 $this->mEstimateRevisions = $dbr->estimateRowCount( 'revision', '*',
4365 array( 'rev_page' => $this->getArticleID() ), __METHOD__ );
4366 }
4367
4368 return $this->mEstimateRevisions;
4369 }
4370
4371 /**
4372 * Get the number of revisions between the given revision.
4373 * Used for diffs and other things that really need it.
4374 *
4375 * @param int|Revision $old Old revision or rev ID (first before range)
4376 * @param int|Revision $new New revision or rev ID (first after range)
4377 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
4378 * @return int Number of revisions between these revisions.
4379 */
4380 public function countRevisionsBetween( $old, $new, $max = null ) {
4381 if ( !( $old instanceof Revision ) ) {
4382 $old = Revision::newFromTitle( $this, (int)$old );
4383 }
4384 if ( !( $new instanceof Revision ) ) {
4385 $new = Revision::newFromTitle( $this, (int)$new );
4386 }
4387 if ( !$old || !$new ) {
4388 return 0; // nothing to compare
4389 }
4390 $dbr = wfGetDB( DB_SLAVE );
4391 $conds = array(
4392 'rev_page' => $this->getArticleID(),
4393 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4394 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4395 );
4396 if ( $max !== null ) {
4397 $res = $dbr->select( 'revision', '1',
4398 $conds,
4399 __METHOD__,
4400 array( 'LIMIT' => $max + 1 ) // extra to detect truncation
4401 );
4402 return $res->numRows();
4403 } else {
4404 return (int)$dbr->selectField( 'revision', 'count(*)', $conds, __METHOD__ );
4405 }
4406 }
4407
4408 /**
4409 * Get the authors between the given revisions or revision IDs.
4410 * Used for diffs and other things that really need it.
4411 *
4412 * @since 1.23
4413 *
4414 * @param int|Revision $old Old revision or rev ID (first before range by default)
4415 * @param int|Revision $new New revision or rev ID (first after range by default)
4416 * @param int $limit Maximum number of authors
4417 * @param string|array $options (Optional): Single option, or an array of options:
4418 * 'include_old' Include $old in the range; $new is excluded.
4419 * 'include_new' Include $new in the range; $old is excluded.
4420 * 'include_both' Include both $old and $new in the range.
4421 * Unknown option values are ignored.
4422 * @return array|null Names of revision authors in the range; null if not both revisions exist
4423 */
4424 public function getAuthorsBetween( $old, $new, $limit, $options = array() ) {
4425 if ( !( $old instanceof Revision ) ) {
4426 $old = Revision::newFromTitle( $this, (int)$old );
4427 }
4428 if ( !( $new instanceof Revision ) ) {
4429 $new = Revision::newFromTitle( $this, (int)$new );
4430 }
4431 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4432 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4433 // in the sanity check below?
4434 if ( !$old || !$new ) {
4435 return null; // nothing to compare
4436 }
4437 $authors = array();
4438 $old_cmp = '>';
4439 $new_cmp = '<';
4440 $options = (array)$options;
4441 if ( in_array( 'include_old', $options ) ) {
4442 $old_cmp = '>=';
4443 }
4444 if ( in_array( 'include_new', $options ) ) {
4445 $new_cmp = '<=';
4446 }
4447 if ( in_array( 'include_both', $options ) ) {
4448 $old_cmp = '>=';
4449 $new_cmp = '<=';
4450 }
4451 // No DB query needed if $old and $new are the same or successive revisions:
4452 if ( $old->getId() === $new->getId() ) {
4453 return ( $old_cmp === '>' && $new_cmp === '<' ) ? array() : array( $old->getRawUserText() );
4454 } elseif ( $old->getId() === $new->getParentId() ) {
4455 if ( $old_cmp === '>=' && $new_cmp === '<=' ) {
4456 $authors[] = $old->getRawUserText();
4457 if ( $old->getRawUserText() != $new->getRawUserText() ) {
4458 $authors[] = $new->getRawUserText();
4459 }
4460 } elseif ( $old_cmp === '>=' ) {
4461 $authors[] = $old->getRawUserText();
4462 } elseif ( $new_cmp === '<=' ) {
4463 $authors[] = $new->getRawUserText();
4464 }
4465 return $authors;
4466 }
4467 $dbr = wfGetDB( DB_SLAVE );
4468 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4469 array(
4470 'rev_page' => $this->getArticleID(),
4471 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4472 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4473 ), __METHOD__,
4474 array( 'LIMIT' => $limit + 1 ) // add one so caller knows it was truncated
4475 );
4476 foreach ( $res as $row ) {
4477 $authors[] = $row->rev_user_text;
4478 }
4479 return $authors;
4480 }
4481
4482 /**
4483 * Get the number of authors between the given revisions or revision IDs.
4484 * Used for diffs and other things that really need it.
4485 *
4486 * @param int|Revision $old Old revision or rev ID (first before range by default)
4487 * @param int|Revision $new New revision or rev ID (first after range by default)
4488 * @param int $limit Maximum number of authors
4489 * @param string|array $options (Optional): Single option, or an array of options:
4490 * 'include_old' Include $old in the range; $new is excluded.
4491 * 'include_new' Include $new in the range; $old is excluded.
4492 * 'include_both' Include both $old and $new in the range.
4493 * Unknown option values are ignored.
4494 * @return int Number of revision authors in the range; zero if not both revisions exist
4495 */
4496 public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4497 $authors = $this->getAuthorsBetween( $old, $new, $limit, $options );
4498 return $authors ? count( $authors ) : 0;
4499 }
4500
4501 /**
4502 * Compare with another title.
4503 *
4504 * @param Title $title
4505 * @return bool
4506 */
4507 public function equals( Title $title ) {
4508 // Note: === is necessary for proper matching of number-like titles.
4509 return $this->getInterwiki() === $title->getInterwiki()
4510 && $this->getNamespace() == $title->getNamespace()
4511 && $this->getDBkey() === $title->getDBkey();
4512 }
4513
4514 /**
4515 * Check if this title is a subpage of another title
4516 *
4517 * @param Title $title
4518 * @return bool
4519 */
4520 public function isSubpageOf( Title $title ) {
4521 return $this->getInterwiki() === $title->getInterwiki()
4522 && $this->getNamespace() == $title->getNamespace()
4523 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4524 }
4525
4526 /**
4527 * Check if page exists. For historical reasons, this function simply
4528 * checks for the existence of the title in the page table, and will
4529 * thus return false for interwiki links, special pages and the like.
4530 * If you want to know if a title can be meaningfully viewed, you should
4531 * probably call the isKnown() method instead.
4532 *
4533 * @return bool
4534 */
4535 public function exists() {
4536 return $this->getArticleID() != 0;
4537 }
4538
4539 /**
4540 * Should links to this title be shown as potentially viewable (i.e. as
4541 * "bluelinks"), even if there's no record by this title in the page
4542 * table?
4543 *
4544 * This function is semi-deprecated for public use, as well as somewhat
4545 * misleadingly named. You probably just want to call isKnown(), which
4546 * calls this function internally.
4547 *
4548 * (ISSUE: Most of these checks are cheap, but the file existence check
4549 * can potentially be quite expensive. Including it here fixes a lot of
4550 * existing code, but we might want to add an optional parameter to skip
4551 * it and any other expensive checks.)
4552 *
4553 * @return bool
4554 */
4555 public function isAlwaysKnown() {
4556 $isKnown = null;
4557
4558 /**
4559 * Allows overriding default behavior for determining if a page exists.
4560 * If $isKnown is kept as null, regular checks happen. If it's
4561 * a boolean, this value is returned by the isKnown method.
4562 *
4563 * @since 1.20
4564 *
4565 * @param Title $title
4566 * @param bool|null $isKnown
4567 */
4568 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4569
4570 if ( !is_null( $isKnown ) ) {
4571 return $isKnown;
4572 }
4573
4574 if ( $this->isExternal() ) {
4575 return true; // any interwiki link might be viewable, for all we know
4576 }
4577
4578 switch ( $this->mNamespace ) {
4579 case NS_MEDIA:
4580 case NS_FILE:
4581 // file exists, possibly in a foreign repo
4582 return (bool)wfFindFile( $this );
4583 case NS_SPECIAL:
4584 // valid special page
4585 return SpecialPageFactory::exists( $this->getDBkey() );
4586 case NS_MAIN:
4587 // selflink, possibly with fragment
4588 return $this->mDbkeyform == '';
4589 case NS_MEDIAWIKI:
4590 // known system message
4591 return $this->hasSourceText() !== false;
4592 default:
4593 return false;
4594 }
4595 }
4596
4597 /**
4598 * Does this title refer to a page that can (or might) be meaningfully
4599 * viewed? In particular, this function may be used to determine if
4600 * links to the title should be rendered as "bluelinks" (as opposed to
4601 * "redlinks" to non-existent pages).
4602 * Adding something else to this function will cause inconsistency
4603 * since LinkHolderArray calls isAlwaysKnown() and does its own
4604 * page existence check.
4605 *
4606 * @return bool
4607 */
4608 public function isKnown() {
4609 return $this->isAlwaysKnown() || $this->exists();
4610 }
4611
4612 /**
4613 * Does this page have source text?
4614 *
4615 * @return bool
4616 */
4617 public function hasSourceText() {
4618 if ( $this->exists() ) {
4619 return true;
4620 }
4621
4622 if ( $this->mNamespace == NS_MEDIAWIKI ) {
4623 // If the page doesn't exist but is a known system message, default
4624 // message content will be displayed, same for language subpages-
4625 // Use always content language to avoid loading hundreds of languages
4626 // to get the link color.
4627 global $wgContLang;
4628 list( $name, ) = MessageCache::singleton()->figureMessage(
4629 $wgContLang->lcfirst( $this->getText() )
4630 );
4631 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4632 return $message->exists();
4633 }
4634
4635 return false;
4636 }
4637
4638 /**
4639 * Get the default message text or false if the message doesn't exist
4640 *
4641 * @return string|bool
4642 */
4643 public function getDefaultMessageText() {
4644 global $wgContLang;
4645
4646 if ( $this->getNamespace() != NS_MEDIAWIKI ) { // Just in case
4647 return false;
4648 }
4649
4650 list( $name, $lang ) = MessageCache::singleton()->figureMessage(
4651 $wgContLang->lcfirst( $this->getText() )
4652 );
4653 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4654
4655 if ( $message->exists() ) {
4656 return $message->plain();
4657 } else {
4658 return false;
4659 }
4660 }
4661
4662 /**
4663 * Updates page_touched for this page; called from LinksUpdate.php
4664 *
4665 * @return bool True if the update succeeded
4666 */
4667 public function invalidateCache() {
4668 if ( wfReadOnly() ) {
4669 return false;
4670 }
4671
4672 if ( $this->mArticleID === 0 ) {
4673 return true; // avoid gap locking if we know it's not there
4674 }
4675
4676 $method = __METHOD__;
4677 $dbw = wfGetDB( DB_MASTER );
4678 $conds = $this->pageCond();
4679 $dbw->onTransactionIdle( function () use ( $dbw, $conds, $method ) {
4680 $dbw->update(
4681 'page',
4682 array( 'page_touched' => $dbw->timestamp() ),
4683 $conds,
4684 $method
4685 );
4686 } );
4687
4688 return true;
4689 }
4690
4691 /**
4692 * Update page_touched timestamps and send squid purge messages for
4693 * pages linking to this title. May be sent to the job queue depending
4694 * on the number of links. Typically called on create and delete.
4695 */
4696 public function touchLinks() {
4697 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4698 $u->doUpdate();
4699
4700 if ( $this->getNamespace() == NS_CATEGORY ) {
4701 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4702 $u->doUpdate();
4703 }
4704 }
4705
4706 /**
4707 * Get the last touched timestamp
4708 *
4709 * @param DatabaseBase $db Optional db
4710 * @return string Last-touched timestamp
4711 */
4712 public function getTouched( $db = null ) {
4713 if ( $db === null ) {
4714 $db = wfGetDB( DB_SLAVE );
4715 }
4716 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
4717 return $touched;
4718 }
4719
4720 /**
4721 * Get the timestamp when this page was updated since the user last saw it.
4722 *
4723 * @param User $user
4724 * @return string|null
4725 */
4726 public function getNotificationTimestamp( $user = null ) {
4727 global $wgUser, $wgShowUpdatedMarker;
4728 // Assume current user if none given
4729 if ( !$user ) {
4730 $user = $wgUser;
4731 }
4732 // Check cache first
4733 $uid = $user->getId();
4734 // avoid isset here, as it'll return false for null entries
4735 if ( array_key_exists( $uid, $this->mNotificationTimestamp ) ) {
4736 return $this->mNotificationTimestamp[$uid];
4737 }
4738 if ( !$uid || !$wgShowUpdatedMarker || !$user->isAllowed( 'viewmywatchlist' ) ) {
4739 $this->mNotificationTimestamp[$uid] = false;
4740 return $this->mNotificationTimestamp[$uid];
4741 }
4742 // Don't cache too much!
4743 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
4744 $this->mNotificationTimestamp = array();
4745 }
4746 $dbr = wfGetDB( DB_SLAVE );
4747 $this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
4748 'wl_notificationtimestamp',
4749 array(
4750 'wl_user' => $user->getId(),
4751 'wl_namespace' => $this->getNamespace(),
4752 'wl_title' => $this->getDBkey(),
4753 ),
4754 __METHOD__
4755 );
4756 return $this->mNotificationTimestamp[$uid];
4757 }
4758
4759 /**
4760 * Generate strings used for xml 'id' names in monobook tabs
4761 *
4762 * @param string $prepend Defaults to 'nstab-'
4763 * @return string XML 'id' name
4764 */
4765 public function getNamespaceKey( $prepend = 'nstab-' ) {
4766 global $wgContLang;
4767 // Gets the subject namespace if this title
4768 $namespace = MWNamespace::getSubject( $this->getNamespace() );
4769 // Checks if canonical namespace name exists for namespace
4770 if ( MWNamespace::exists( $this->getNamespace() ) ) {
4771 // Uses canonical namespace name
4772 $namespaceKey = MWNamespace::getCanonicalName( $namespace );
4773 } else {
4774 // Uses text of namespace
4775 $namespaceKey = $this->getSubjectNsText();
4776 }
4777 // Makes namespace key lowercase
4778 $namespaceKey = $wgContLang->lc( $namespaceKey );
4779 // Uses main
4780 if ( $namespaceKey == '' ) {
4781 $namespaceKey = 'main';
4782 }
4783 // Changes file to image for backwards compatibility
4784 if ( $namespaceKey == 'file' ) {
4785 $namespaceKey = 'image';
4786 }
4787 return $prepend . $namespaceKey;
4788 }
4789
4790 /**
4791 * Get all extant redirects to this Title
4792 *
4793 * @param int|null $ns Single namespace to consider; null to consider all namespaces
4794 * @return Title[] Array of Title redirects to this title
4795 */
4796 public function getRedirectsHere( $ns = null ) {
4797 $redirs = array();
4798
4799 $dbr = wfGetDB( DB_SLAVE );
4800 $where = array(
4801 'rd_namespace' => $this->getNamespace(),
4802 'rd_title' => $this->getDBkey(),
4803 'rd_from = page_id'
4804 );
4805 if ( $this->isExternal() ) {
4806 $where['rd_interwiki'] = $this->getInterwiki();
4807 } else {
4808 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4809 }
4810 if ( !is_null( $ns ) ) {
4811 $where['page_namespace'] = $ns;
4812 }
4813
4814 $res = $dbr->select(
4815 array( 'redirect', 'page' ),
4816 array( 'page_namespace', 'page_title' ),
4817 $where,
4818 __METHOD__
4819 );
4820
4821 foreach ( $res as $row ) {
4822 $redirs[] = self::newFromRow( $row );
4823 }
4824 return $redirs;
4825 }
4826
4827 /**
4828 * Check if this Title is a valid redirect target
4829 *
4830 * @return bool
4831 */
4832 public function isValidRedirectTarget() {
4833 global $wgInvalidRedirectTargets;
4834
4835 // invalid redirect targets are stored in a global array, but explicitly disallow Userlogout here
4836 if ( $this->isSpecial( 'Userlogout' ) ) {
4837 return false;
4838 }
4839
4840 foreach ( $wgInvalidRedirectTargets as $target ) {
4841 if ( $this->isSpecial( $target ) ) {
4842 return false;
4843 }
4844 }
4845
4846 return true;
4847 }
4848
4849 /**
4850 * Get a backlink cache object
4851 *
4852 * @return BacklinkCache
4853 */
4854 public function getBacklinkCache() {
4855 return BacklinkCache::get( $this );
4856 }
4857
4858 /**
4859 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4860 *
4861 * @return bool
4862 */
4863 public function canUseNoindex() {
4864 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4865
4866 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4867 ? $wgContentNamespaces
4868 : $wgExemptFromUserRobotsControl;
4869
4870 return !in_array( $this->mNamespace, $bannedNamespaces );
4871
4872 }
4873
4874 /**
4875 * Returns the raw sort key to be used for categories, with the specified
4876 * prefix. This will be fed to Collation::getSortKey() to get a
4877 * binary sortkey that can be used for actual sorting.
4878 *
4879 * @param string $prefix The prefix to be used, specified using
4880 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4881 * prefix.
4882 * @return string
4883 */
4884 public function getCategorySortkey( $prefix = '' ) {
4885 $unprefixed = $this->getText();
4886
4887 // Anything that uses this hook should only depend
4888 // on the Title object passed in, and should probably
4889 // tell the users to run updateCollations.php --force
4890 // in order to re-sort existing category relations.
4891 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4892 if ( $prefix !== '' ) {
4893 # Separate with a line feed, so the unprefixed part is only used as
4894 # a tiebreaker when two pages have the exact same prefix.
4895 # In UCA, tab is the only character that can sort above LF
4896 # so we strip both of them from the original prefix.
4897 $prefix = strtr( $prefix, "\n\t", ' ' );
4898 return "$prefix\n$unprefixed";
4899 }
4900 return $unprefixed;
4901 }
4902
4903 /**
4904 * Get the language in which the content of this page is written in
4905 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4906 * e.g. $wgLang (such as special pages, which are in the user language).
4907 *
4908 * @since 1.18
4909 * @return Language
4910 */
4911 public function getPageLanguage() {
4912 global $wgLang, $wgLanguageCode;
4913 wfProfileIn( __METHOD__ );
4914 if ( $this->isSpecialPage() ) {
4915 // special pages are in the user language
4916 wfProfileOut( __METHOD__ );
4917 return $wgLang;
4918 }
4919
4920 // Checking if DB language is set
4921 if ( $this->mDbPageLanguage ) {
4922 wfProfileOut( __METHOD__ );
4923 return wfGetLangObj( $this->mDbPageLanguage );
4924 }
4925
4926 if ( !$this->mPageLanguage || $this->mPageLanguage[1] !== $wgLanguageCode ) {
4927 // Note that this may depend on user settings, so the cache should
4928 // be only per-request.
4929 // NOTE: ContentHandler::getPageLanguage() may need to load the
4930 // content to determine the page language!
4931 // Checking $wgLanguageCode hasn't changed for the benefit of unit
4932 // tests.
4933 $contentHandler = ContentHandler::getForTitle( $this );
4934 $langObj = wfGetLangObj( $contentHandler->getPageLanguage( $this ) );
4935 $this->mPageLanguage = array( $langObj->getCode(), $wgLanguageCode );
4936 } else {
4937 $langObj = wfGetLangObj( $this->mPageLanguage[0] );
4938 }
4939
4940 wfProfileOut( __METHOD__ );
4941 return $langObj;
4942 }
4943
4944 /**
4945 * Get the language in which the content of this page is written when
4946 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4947 * e.g. $wgLang (such as special pages, which are in the user language).
4948 *
4949 * @since 1.20
4950 * @return Language
4951 */
4952 public function getPageViewLanguage() {
4953 global $wgLang;
4954
4955 if ( $this->isSpecialPage() ) {
4956 // If the user chooses a variant, the content is actually
4957 // in a language whose code is the variant code.
4958 $variant = $wgLang->getPreferredVariant();
4959 if ( $wgLang->getCode() !== $variant ) {
4960 return Language::factory( $variant );
4961 }
4962
4963 return $wgLang;
4964 }
4965
4966 // @note Can't be cached persistently, depends on user settings.
4967 // @note ContentHandler::getPageViewLanguage() may need to load the
4968 // content to determine the page language!
4969 $contentHandler = ContentHandler::getForTitle( $this );
4970 $pageLang = $contentHandler->getPageViewLanguage( $this );
4971 return $pageLang;
4972 }
4973
4974 /**
4975 * Get a list of rendered edit notices for this page.
4976 *
4977 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4978 * they will already be wrapped in paragraphs.
4979 *
4980 * @since 1.21
4981 * @param int $oldid Revision ID that's being edited
4982 * @return array
4983 */
4984 public function getEditNotices( $oldid = 0 ) {
4985 $notices = array();
4986
4987 # Optional notices on a per-namespace and per-page basis
4988 $editnotice_ns = 'editnotice-' . $this->getNamespace();
4989 $editnotice_ns_message = wfMessage( $editnotice_ns );
4990 if ( $editnotice_ns_message->exists() ) {
4991 $notices[$editnotice_ns] = $editnotice_ns_message->parseAsBlock();
4992 }
4993 if ( MWNamespace::hasSubpages( $this->getNamespace() ) ) {
4994 $parts = explode( '/', $this->getDBkey() );
4995 $editnotice_base = $editnotice_ns;
4996 while ( count( $parts ) > 0 ) {
4997 $editnotice_base .= '-' . array_shift( $parts );
4998 $editnotice_base_msg = wfMessage( $editnotice_base );
4999 if ( $editnotice_base_msg->exists() ) {
5000 $notices[$editnotice_base] = $editnotice_base_msg->parseAsBlock();
5001 }
5002 }
5003 } else {
5004 # Even if there are no subpages in namespace, we still don't want / in MW ns.
5005 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->getDBkey() );
5006 $editnoticeMsg = wfMessage( $editnoticeText );
5007 if ( $editnoticeMsg->exists() ) {
5008 $notices[$editnoticeText] = $editnoticeMsg->parseAsBlock();
5009 }
5010 }
5011
5012 wfRunHooks( 'TitleGetEditNotices', array( $this, $oldid, &$notices ) );
5013 return $notices;
5014 }
5015 }