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