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