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