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