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