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