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