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