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