Tests: Add missing expect numbers in QUnit tests.
[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 ) {
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(
2347 'protected_titles',
2348 array( 'pt_user', 'pt_reason', 'pt_expiry', 'pt_create_perm' ),
2349 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2350 __METHOD__
2351 );
2352
2353 // fetchRow returns false if there are no rows.
2354 $this->mTitleProtection = $dbr->fetchRow( $res );
2355 }
2356 return $this->mTitleProtection;
2357 }
2358
2359 /**
2360 * Update the title protection status
2361 *
2362 * @deprecated in 1.19; will be removed in 1.20. Use WikiPage::doUpdateRestrictions() instead.
2363 * @param $create_perm String Permission required for creation
2364 * @param $reason String Reason for protection
2365 * @param $expiry String Expiry timestamp
2366 * @return boolean true
2367 */
2368 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
2369 wfDeprecated( __METHOD__, '1.19' );
2370
2371 global $wgUser;
2372
2373 $limit = array( 'create' => $create_perm );
2374 $expiry = array( 'create' => $expiry );
2375
2376 $page = WikiPage::factory( $this );
2377 $cascade = false;
2378 $status = $page->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $wgUser );
2379
2380 return $status->isOK();
2381 }
2382
2383 /**
2384 * Remove any title protection due to page existing
2385 */
2386 public function deleteTitleProtection() {
2387 $dbw = wfGetDB( DB_MASTER );
2388
2389 $dbw->delete(
2390 'protected_titles',
2391 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2392 __METHOD__
2393 );
2394 $this->mTitleProtection = false;
2395 }
2396
2397 /**
2398 * Is this page "semi-protected" - the *only* protection is autoconfirm?
2399 *
2400 * @param $action String Action to check (default: edit)
2401 * @return Bool
2402 */
2403 public function isSemiProtected( $action = 'edit' ) {
2404 if ( $this->exists() ) {
2405 $restrictions = $this->getRestrictions( $action );
2406 if ( count( $restrictions ) > 0 ) {
2407 foreach ( $restrictions as $restriction ) {
2408 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
2409 return false;
2410 }
2411 }
2412 } else {
2413 # Not protected
2414 return false;
2415 }
2416 return true;
2417 } else {
2418 # If it doesn't exist, it can't be protected
2419 return false;
2420 }
2421 }
2422
2423 /**
2424 * Does the title correspond to a protected article?
2425 *
2426 * @param $action String the action the page is protected from,
2427 * by default checks all actions.
2428 * @return Bool
2429 */
2430 public function isProtected( $action = '' ) {
2431 global $wgRestrictionLevels;
2432
2433 $restrictionTypes = $this->getRestrictionTypes();
2434
2435 # Special pages have inherent protection
2436 if( $this->isSpecialPage() ) {
2437 return true;
2438 }
2439
2440 # Check regular protection levels
2441 foreach ( $restrictionTypes as $type ) {
2442 if ( $action == $type || $action == '' ) {
2443 $r = $this->getRestrictions( $type );
2444 foreach ( $wgRestrictionLevels as $level ) {
2445 if ( in_array( $level, $r ) && $level != '' ) {
2446 return true;
2447 }
2448 }
2449 }
2450 }
2451
2452 return false;
2453 }
2454
2455 /**
2456 * Determines if $user is unable to edit this page because it has been protected
2457 * by $wgNamespaceProtection.
2458 *
2459 * @param $user User object to check permissions
2460 * @return Bool
2461 */
2462 public function isNamespaceProtected( User $user ) {
2463 global $wgNamespaceProtection;
2464
2465 if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) {
2466 foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) {
2467 if ( $right != '' && !$user->isAllowed( $right ) ) {
2468 return true;
2469 }
2470 }
2471 }
2472 return false;
2473 }
2474
2475 /**
2476 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2477 *
2478 * @return Bool If the page is subject to cascading restrictions.
2479 */
2480 public function isCascadeProtected() {
2481 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2482 return ( $sources > 0 );
2483 }
2484
2485 /**
2486 * Cascading protection: Get the source of any cascading restrictions on this page.
2487 *
2488 * @param $getPages Bool Whether or not to retrieve the actual pages
2489 * that the restrictions have come from.
2490 * @return Mixed Array of Title objects of the pages from which cascading restrictions
2491 * have come, false for none, or true if such restrictions exist, but $getPages
2492 * was not set. The restriction array is an array of each type, each of which
2493 * contains a array of unique groups.
2494 */
2495 public function getCascadeProtectionSources( $getPages = true ) {
2496 global $wgContLang;
2497 $pagerestrictions = array();
2498
2499 if ( isset( $this->mCascadeSources ) && $getPages ) {
2500 return array( $this->mCascadeSources, $this->mCascadingRestrictions );
2501 } elseif ( isset( $this->mHasCascadingRestrictions ) && !$getPages ) {
2502 return array( $this->mHasCascadingRestrictions, $pagerestrictions );
2503 }
2504
2505 wfProfileIn( __METHOD__ );
2506
2507 $dbr = wfGetDB( DB_SLAVE );
2508
2509 if ( $this->getNamespace() == NS_FILE ) {
2510 $tables = array( 'imagelinks', 'page_restrictions' );
2511 $where_clauses = array(
2512 'il_to' => $this->getDBkey(),
2513 'il_from=pr_page',
2514 'pr_cascade' => 1
2515 );
2516 } else {
2517 $tables = array( 'templatelinks', 'page_restrictions' );
2518 $where_clauses = array(
2519 'tl_namespace' => $this->getNamespace(),
2520 'tl_title' => $this->getDBkey(),
2521 'tl_from=pr_page',
2522 'pr_cascade' => 1
2523 );
2524 }
2525
2526 if ( $getPages ) {
2527 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2528 'pr_expiry', 'pr_type', 'pr_level' );
2529 $where_clauses[] = 'page_id=pr_page';
2530 $tables[] = 'page';
2531 } else {
2532 $cols = array( 'pr_expiry' );
2533 }
2534
2535 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
2536
2537 $sources = $getPages ? array() : false;
2538 $now = wfTimestampNow();
2539 $purgeExpired = false;
2540
2541 foreach ( $res as $row ) {
2542 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2543 if ( $expiry > $now ) {
2544 if ( $getPages ) {
2545 $page_id = $row->pr_page;
2546 $page_ns = $row->page_namespace;
2547 $page_title = $row->page_title;
2548 $sources[$page_id] = Title::makeTitle( $page_ns, $page_title );
2549 # Add groups needed for each restriction type if its not already there
2550 # Make sure this restriction type still exists
2551
2552 if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
2553 $pagerestrictions[$row->pr_type] = array();
2554 }
2555
2556 if ( isset( $pagerestrictions[$row->pr_type] ) &&
2557 !in_array( $row->pr_level, $pagerestrictions[$row->pr_type] ) ) {
2558 $pagerestrictions[$row->pr_type][] = $row->pr_level;
2559 }
2560 } else {
2561 $sources = true;
2562 }
2563 } else {
2564 // Trigger lazy purge of expired restrictions from the db
2565 $purgeExpired = true;
2566 }
2567 }
2568 if ( $purgeExpired ) {
2569 Title::purgeExpiredRestrictions();
2570 }
2571
2572 if ( $getPages ) {
2573 $this->mCascadeSources = $sources;
2574 $this->mCascadingRestrictions = $pagerestrictions;
2575 } else {
2576 $this->mHasCascadingRestrictions = $sources;
2577 }
2578
2579 wfProfileOut( __METHOD__ );
2580 return array( $sources, $pagerestrictions );
2581 }
2582
2583 /**
2584 * Accessor/initialisation for mRestrictions
2585 *
2586 * @param $action String action that permission needs to be checked for
2587 * @return Array of Strings the array of groups allowed to edit this article
2588 */
2589 public function getRestrictions( $action ) {
2590 if ( !$this->mRestrictionsLoaded ) {
2591 $this->loadRestrictions();
2592 }
2593 return isset( $this->mRestrictions[$action] )
2594 ? $this->mRestrictions[$action]
2595 : array();
2596 }
2597
2598 /**
2599 * Get the expiry time for the restriction against a given action
2600 *
2601 * @param $action
2602 * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever
2603 * or not protected at all, or false if the action is not recognised.
2604 */
2605 public function getRestrictionExpiry( $action ) {
2606 if ( !$this->mRestrictionsLoaded ) {
2607 $this->loadRestrictions();
2608 }
2609 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
2610 }
2611
2612 /**
2613 * Returns cascading restrictions for the current article
2614 *
2615 * @return Boolean
2616 */
2617 function areRestrictionsCascading() {
2618 if ( !$this->mRestrictionsLoaded ) {
2619 $this->loadRestrictions();
2620 }
2621
2622 return $this->mCascadeRestriction;
2623 }
2624
2625 /**
2626 * Loads a string into mRestrictions array
2627 *
2628 * @param $res Resource restrictions as an SQL result.
2629 * @param $oldFashionedRestrictions String comma-separated list of page
2630 * restrictions from page table (pre 1.10)
2631 */
2632 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2633 $rows = array();
2634
2635 foreach ( $res as $row ) {
2636 $rows[] = $row;
2637 }
2638
2639 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2640 }
2641
2642 /**
2643 * Compiles list of active page restrictions from both page table (pre 1.10)
2644 * and page_restrictions table for this existing page.
2645 * Public for usage by LiquidThreads.
2646 *
2647 * @param $rows array of db result objects
2648 * @param $oldFashionedRestrictions string comma-separated list of page
2649 * restrictions from page table (pre 1.10)
2650 */
2651 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2652 global $wgContLang;
2653 $dbr = wfGetDB( DB_SLAVE );
2654
2655 $restrictionTypes = $this->getRestrictionTypes();
2656
2657 foreach ( $restrictionTypes as $type ) {
2658 $this->mRestrictions[$type] = array();
2659 $this->mRestrictionsExpiry[$type] = $wgContLang->formatExpiry( '', TS_MW );
2660 }
2661
2662 $this->mCascadeRestriction = false;
2663
2664 # Backwards-compatibility: also load the restrictions from the page record (old format).
2665
2666 if ( $oldFashionedRestrictions === null ) {
2667 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2668 array( 'page_id' => $this->getArticleID() ), __METHOD__ );
2669 }
2670
2671 if ( $oldFashionedRestrictions != '' ) {
2672
2673 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2674 $temp = explode( '=', trim( $restrict ) );
2675 if ( count( $temp ) == 1 ) {
2676 // old old format should be treated as edit/move restriction
2677 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
2678 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
2679 } else {
2680 $restriction = trim( $temp[1] );
2681 if( $restriction != '' ) { //some old entries are empty
2682 $this->mRestrictions[$temp[0]] = explode( ',', $restriction );
2683 }
2684 }
2685 }
2686
2687 $this->mOldRestrictions = true;
2688
2689 }
2690
2691 if ( count( $rows ) ) {
2692 # Current system - load second to make them override.
2693 $now = wfTimestampNow();
2694 $purgeExpired = false;
2695
2696 # Cycle through all the restrictions.
2697 foreach ( $rows as $row ) {
2698
2699 // Don't take care of restrictions types that aren't allowed
2700 if ( !in_array( $row->pr_type, $restrictionTypes ) )
2701 continue;
2702
2703 // This code should be refactored, now that it's being used more generally,
2704 // But I don't really see any harm in leaving it in Block for now -werdna
2705 $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW );
2706
2707 // Only apply the restrictions if they haven't expired!
2708 if ( !$expiry || $expiry > $now ) {
2709 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
2710 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
2711
2712 $this->mCascadeRestriction |= $row->pr_cascade;
2713 } else {
2714 // Trigger a lazy purge of expired restrictions
2715 $purgeExpired = true;
2716 }
2717 }
2718
2719 if ( $purgeExpired ) {
2720 Title::purgeExpiredRestrictions();
2721 }
2722 }
2723
2724 $this->mRestrictionsLoaded = true;
2725 }
2726
2727 /**
2728 * Load restrictions from the page_restrictions table
2729 *
2730 * @param $oldFashionedRestrictions String comma-separated list of page
2731 * restrictions from page table (pre 1.10)
2732 */
2733 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2734 global $wgContLang;
2735 if ( !$this->mRestrictionsLoaded ) {
2736 if ( $this->exists() ) {
2737 $dbr = wfGetDB( DB_SLAVE );
2738
2739 $res = $dbr->select(
2740 'page_restrictions',
2741 array( 'pr_type', 'pr_expiry', 'pr_level', 'pr_cascade' ),
2742 array( 'pr_page' => $this->getArticleID() ),
2743 __METHOD__
2744 );
2745
2746 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2747 } else {
2748 $title_protection = $this->getTitleProtection();
2749
2750 if ( $title_protection ) {
2751 $now = wfTimestampNow();
2752 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW );
2753
2754 if ( !$expiry || $expiry > $now ) {
2755 // Apply the restrictions
2756 $this->mRestrictionsExpiry['create'] = $expiry;
2757 $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2758 } else { // Get rid of the old restrictions
2759 Title::purgeExpiredRestrictions();
2760 $this->mTitleProtection = false;
2761 }
2762 } else {
2763 $this->mRestrictionsExpiry['create'] = $wgContLang->formatExpiry( '', TS_MW );
2764 }
2765 $this->mRestrictionsLoaded = true;
2766 }
2767 }
2768 }
2769
2770 /**
2771 * Flush the protection cache in this object and force reload from the database.
2772 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2773 */
2774 public function flushRestrictions() {
2775 $this->mRestrictionsLoaded = false;
2776 $this->mTitleProtection = null;
2777 }
2778
2779 /**
2780 * Purge expired restrictions from the page_restrictions table
2781 */
2782 static function purgeExpiredRestrictions() {
2783 if ( wfReadOnly() ) {
2784 return;
2785 }
2786
2787 $dbw = wfGetDB( DB_MASTER );
2788 $dbw->delete(
2789 'page_restrictions',
2790 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2791 __METHOD__
2792 );
2793
2794 $dbw->delete(
2795 'protected_titles',
2796 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2797 __METHOD__
2798 );
2799 }
2800
2801 /**
2802 * Does this have subpages? (Warning, usually requires an extra DB query.)
2803 *
2804 * @return Bool
2805 */
2806 public function hasSubpages() {
2807 if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
2808 # Duh
2809 return false;
2810 }
2811
2812 # We dynamically add a member variable for the purpose of this method
2813 # alone to cache the result. There's no point in having it hanging
2814 # around uninitialized in every Title object; therefore we only add it
2815 # if needed and don't declare it statically.
2816 if ( isset( $this->mHasSubpages ) ) {
2817 return $this->mHasSubpages;
2818 }
2819
2820 $subpages = $this->getSubpages( 1 );
2821 if ( $subpages instanceof TitleArray ) {
2822 return $this->mHasSubpages = (bool)$subpages->count();
2823 }
2824 return $this->mHasSubpages = false;
2825 }
2826
2827 /**
2828 * Get all subpages of this page.
2829 *
2830 * @param $limit Int maximum number of subpages to fetch; -1 for no limit
2831 * @return mixed TitleArray, or empty array if this page's namespace
2832 * doesn't allow subpages
2833 */
2834 public function getSubpages( $limit = -1 ) {
2835 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
2836 return array();
2837 }
2838
2839 $dbr = wfGetDB( DB_SLAVE );
2840 $conds['page_namespace'] = $this->getNamespace();
2841 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
2842 $options = array();
2843 if ( $limit > -1 ) {
2844 $options['LIMIT'] = $limit;
2845 }
2846 return $this->mSubpages = TitleArray::newFromResult(
2847 $dbr->select( 'page',
2848 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
2849 $conds,
2850 __METHOD__,
2851 $options
2852 )
2853 );
2854 }
2855
2856 /**
2857 * Is there a version of this page in the deletion archive?
2858 *
2859 * @return Int the number of archived revisions
2860 */
2861 public function isDeleted() {
2862 if ( $this->getNamespace() < 0 ) {
2863 $n = 0;
2864 } else {
2865 $dbr = wfGetDB( DB_SLAVE );
2866
2867 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2868 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2869 __METHOD__
2870 );
2871 if ( $this->getNamespace() == NS_FILE ) {
2872 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
2873 array( 'fa_name' => $this->getDBkey() ),
2874 __METHOD__
2875 );
2876 }
2877 }
2878 return (int)$n;
2879 }
2880
2881 /**
2882 * Is there a version of this page in the deletion archive?
2883 *
2884 * @return Boolean
2885 */
2886 public function isDeletedQuick() {
2887 if ( $this->getNamespace() < 0 ) {
2888 return false;
2889 }
2890 $dbr = wfGetDB( DB_SLAVE );
2891 $deleted = (bool)$dbr->selectField( 'archive', '1',
2892 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2893 __METHOD__
2894 );
2895 if ( !$deleted && $this->getNamespace() == NS_FILE ) {
2896 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2897 array( 'fa_name' => $this->getDBkey() ),
2898 __METHOD__
2899 );
2900 }
2901 return $deleted;
2902 }
2903
2904 /**
2905 * Get the article ID for this Title from the link cache,
2906 * adding it if necessary
2907 *
2908 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select
2909 * for update
2910 * @return Int the ID
2911 */
2912 public function getArticleID( $flags = 0 ) {
2913 if ( $this->getNamespace() < 0 ) {
2914 return $this->mArticleID = 0;
2915 }
2916 $linkCache = LinkCache::singleton();
2917 if ( $flags & self::GAID_FOR_UPDATE ) {
2918 $oldUpdate = $linkCache->forUpdate( true );
2919 $linkCache->clearLink( $this );
2920 $this->mArticleID = $linkCache->addLinkObj( $this );
2921 $linkCache->forUpdate( $oldUpdate );
2922 } else {
2923 if ( -1 == $this->mArticleID ) {
2924 $this->mArticleID = $linkCache->addLinkObj( $this );
2925 }
2926 }
2927 return $this->mArticleID;
2928 }
2929
2930 /**
2931 * Is this an article that is a redirect page?
2932 * Uses link cache, adding it if necessary
2933 *
2934 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2935 * @return Bool
2936 */
2937 public function isRedirect( $flags = 0 ) {
2938 if ( !is_null( $this->mRedirect ) ) {
2939 return $this->mRedirect;
2940 }
2941 # Calling getArticleID() loads the field from cache as needed
2942 if ( !$this->getArticleID( $flags ) ) {
2943 return $this->mRedirect = false;
2944 }
2945
2946 $linkCache = LinkCache::singleton();
2947 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2948 if ( $cached === null ) {
2949 // TODO: check the assumption that the cache actually knows about this title
2950 // and handle this, such as get the title from the database.
2951 // See https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2952 wfDebug( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2953 wfDebug( wfBacktrace() );
2954 }
2955
2956 $this->mRedirect = (bool)$cached;
2957
2958 return $this->mRedirect;
2959 }
2960
2961 /**
2962 * What is the length of this page?
2963 * Uses link cache, adding it if necessary
2964 *
2965 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2966 * @return Int
2967 */
2968 public function getLength( $flags = 0 ) {
2969 if ( $this->mLength != -1 ) {
2970 return $this->mLength;
2971 }
2972 # Calling getArticleID() loads the field from cache as needed
2973 if ( !$this->getArticleID( $flags ) ) {
2974 return $this->mLength = 0;
2975 }
2976 $linkCache = LinkCache::singleton();
2977 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
2978 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
2979 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2980 # as a stop gap, perhaps log this, but don't throw an exception?
2981 wfDebug( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2982 wfDebug( wfBacktrace() );
2983 }
2984
2985 $this->mLength = intval( $cached );
2986
2987 return $this->mLength;
2988 }
2989
2990 /**
2991 * What is the page_latest field for this page?
2992 *
2993 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2994 * @throws MWException
2995 * @return Int or 0 if the page doesn't exist
2996 */
2997 public function getLatestRevID( $flags = 0 ) {
2998 if ( !( $flags & Title::GAID_FOR_UPDATE ) && $this->mLatestID !== false ) {
2999 return intval( $this->mLatestID );
3000 }
3001 # Calling getArticleID() loads the field from cache as needed
3002 if ( !$this->getArticleID( $flags ) ) {
3003 return $this->mLatestID = 0;
3004 }
3005 $linkCache = LinkCache::singleton();
3006 $linkCache->addLinkObj( $this );
3007 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
3008 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
3009 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
3010 # as a stop gap, perhaps log this, but don't throw an exception?
3011 throw new MWException( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
3012 }
3013
3014 $this->mLatestID = intval( $cached );
3015
3016 return $this->mLatestID;
3017 }
3018
3019 /**
3020 * This clears some fields in this object, and clears any associated
3021 * keys in the "bad links" section of the link cache.
3022 *
3023 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
3024 * loading of the new page_id. It's also called from
3025 * WikiPage::doDeleteArticleReal()
3026 *
3027 * @param $newid Int the new Article ID
3028 */
3029 public function resetArticleID( $newid ) {
3030 $linkCache = LinkCache::singleton();
3031 $linkCache->clearLink( $this );
3032
3033 if ( $newid === false ) {
3034 $this->mArticleID = -1;
3035 } else {
3036 $this->mArticleID = intval( $newid );
3037 }
3038 $this->mRestrictionsLoaded = false;
3039 $this->mRestrictions = array();
3040 $this->mRedirect = null;
3041 $this->mLength = -1;
3042 $this->mLatestID = false;
3043 $this->mContentModel = false;
3044 $this->mEstimateRevisions = null;
3045 }
3046
3047 /**
3048 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
3049 *
3050 * @param $text String containing title to capitalize
3051 * @param $ns int namespace index, defaults to NS_MAIN
3052 * @return String containing capitalized title
3053 */
3054 public static function capitalize( $text, $ns = NS_MAIN ) {
3055 global $wgContLang;
3056
3057 if ( MWNamespace::isCapitalized( $ns ) ) {
3058 return $wgContLang->ucfirst( $text );
3059 } else {
3060 return $text;
3061 }
3062 }
3063
3064 /**
3065 * Secure and split - main initialisation function for this object
3066 *
3067 * Assumes that mDbkeyform has been set, and is urldecoded
3068 * and uses underscores, but not otherwise munged. This function
3069 * removes illegal characters, splits off the interwiki and
3070 * namespace prefixes, sets the other forms, and canonicalizes
3071 * everything.
3072 *
3073 * @return Bool true on success
3074 */
3075 private function secureAndSplit() {
3076 global $wgContLang, $wgLocalInterwiki;
3077
3078 # Initialisation
3079 $this->mInterwiki = $this->mFragment = '';
3080 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
3081
3082 $dbkey = $this->mDbkeyform;
3083
3084 # Strip Unicode bidi override characters.
3085 # Sometimes they slip into cut-n-pasted page titles, where the
3086 # override chars get included in list displays.
3087 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
3088
3089 # Clean up whitespace
3090 # Note: use of the /u option on preg_replace here will cause
3091 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
3092 # conveniently disabling them.
3093 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
3094 $dbkey = trim( $dbkey, '_' );
3095
3096 if ( $dbkey == '' ) {
3097 return false;
3098 }
3099
3100 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
3101 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
3102 return false;
3103 }
3104
3105 $this->mDbkeyform = $dbkey;
3106
3107 # Initial colon indicates main namespace rather than specified default
3108 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
3109 if ( ':' == $dbkey[0] ) {
3110 $this->mNamespace = NS_MAIN;
3111 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
3112 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
3113 }
3114
3115 # Namespace or interwiki prefix
3116 $firstPass = true;
3117 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
3118 do {
3119 $m = array();
3120 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
3121 $p = $m[1];
3122 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
3123 # Ordinary namespace
3124 $dbkey = $m[2];
3125 $this->mNamespace = $ns;
3126 # For Talk:X pages, check if X has a "namespace" prefix
3127 if ( $ns == NS_TALK && preg_match( $prefixRegexp, $dbkey, $x ) ) {
3128 if ( $wgContLang->getNsIndex( $x[1] ) ) {
3129 # Disallow Talk:File:x type titles...
3130 return false;
3131 } elseif ( Interwiki::isValidInterwiki( $x[1] ) ) {
3132 # Disallow Talk:Interwiki:x type titles...
3133 return false;
3134 }
3135 }
3136 } elseif ( Interwiki::isValidInterwiki( $p ) ) {
3137 if ( !$firstPass ) {
3138 # Can't make a local interwiki link to an interwiki link.
3139 # That's just crazy!
3140 return false;
3141 }
3142
3143 # Interwiki link
3144 $dbkey = $m[2];
3145 $this->mInterwiki = $wgContLang->lc( $p );
3146
3147 # Redundant interwiki prefix to the local wiki
3148 if ( $wgLocalInterwiki !== false
3149 && 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) )
3150 {
3151 if ( $dbkey == '' ) {
3152 # Can't have an empty self-link
3153 return false;
3154 }
3155 $this->mInterwiki = '';
3156 $firstPass = false;
3157 # Do another namespace split...
3158 continue;
3159 }
3160
3161 # If there's an initial colon after the interwiki, that also
3162 # resets the default namespace
3163 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
3164 $this->mNamespace = NS_MAIN;
3165 $dbkey = substr( $dbkey, 1 );
3166 }
3167 }
3168 # If there's no recognized interwiki or namespace,
3169 # then let the colon expression be part of the title.
3170 }
3171 break;
3172 } while ( true );
3173
3174 # We already know that some pages won't be in the database!
3175 if ( $this->mInterwiki != '' || NS_SPECIAL == $this->mNamespace ) {
3176 $this->mArticleID = 0;
3177 }
3178 $fragment = strstr( $dbkey, '#' );
3179 if ( false !== $fragment ) {
3180 $this->setFragment( $fragment );
3181 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
3182 # remove whitespace again: prevents "Foo_bar_#"
3183 # becoming "Foo_bar_"
3184 $dbkey = preg_replace( '/_*$/', '', $dbkey );
3185 }
3186
3187 # Reject illegal characters.
3188 $rxTc = self::getTitleInvalidRegex();
3189 if ( preg_match( $rxTc, $dbkey ) ) {
3190 return false;
3191 }
3192
3193 # Pages with "/./" or "/../" appearing in the URLs will often be un-
3194 # reachable due to the way web browsers deal with 'relative' URLs.
3195 # Also, they conflict with subpage syntax. Forbid them explicitly.
3196 if ( strpos( $dbkey, '.' ) !== false &&
3197 ( $dbkey === '.' || $dbkey === '..' ||
3198 strpos( $dbkey, './' ) === 0 ||
3199 strpos( $dbkey, '../' ) === 0 ||
3200 strpos( $dbkey, '/./' ) !== false ||
3201 strpos( $dbkey, '/../' ) !== false ||
3202 substr( $dbkey, -2 ) == '/.' ||
3203 substr( $dbkey, -3 ) == '/..' ) )
3204 {
3205 return false;
3206 }
3207
3208 # Magic tilde sequences? Nu-uh!
3209 if ( strpos( $dbkey, '~~~' ) !== false ) {
3210 return false;
3211 }
3212
3213 # Limit the size of titles to 255 bytes. This is typically the size of the
3214 # underlying database field. We make an exception for special pages, which
3215 # don't need to be stored in the database, and may edge over 255 bytes due
3216 # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
3217 if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) ||
3218 strlen( $dbkey ) > 512 )
3219 {
3220 return false;
3221 }
3222
3223 # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
3224 # and [[Foo]] point to the same place. Don't force it for interwikis, since the
3225 # other site might be case-sensitive.
3226 $this->mUserCaseDBKey = $dbkey;
3227 if ( $this->mInterwiki == '' ) {
3228 $dbkey = self::capitalize( $dbkey, $this->mNamespace );
3229 }
3230
3231 # Can't make a link to a namespace alone... "empty" local links can only be
3232 # self-links with a fragment identifier.
3233 if ( $dbkey == '' && $this->mInterwiki == '' && $this->mNamespace != NS_MAIN ) {
3234 return false;
3235 }
3236
3237 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
3238 // IP names are not allowed for accounts, and can only be referring to
3239 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
3240 // there are numerous ways to present the same IP. Having sp:contribs scan
3241 // them all is silly and having some show the edits and others not is
3242 // inconsistent. Same for talk/userpages. Keep them normalized instead.
3243 $dbkey = ( $this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK )
3244 ? IP::sanitizeIP( $dbkey )
3245 : $dbkey;
3246
3247 // Any remaining initial :s are illegal.
3248 if ( $dbkey !== '' && ':' == $dbkey[0] ) {
3249 return false;
3250 }
3251
3252 # Fill fields
3253 $this->mDbkeyform = $dbkey;
3254 $this->mUrlform = wfUrlencode( $dbkey );
3255
3256 $this->mTextform = str_replace( '_', ' ', $dbkey );
3257
3258 return true;
3259 }
3260
3261 /**
3262 * Get an array of Title objects linking to this Title
3263 * Also stores the IDs in the link cache.
3264 *
3265 * WARNING: do not use this function on arbitrary user-supplied titles!
3266 * On heavily-used templates it will max out the memory.
3267 *
3268 * @param $options Array: may be FOR UPDATE
3269 * @param $table String: table name
3270 * @param $prefix String: fields prefix
3271 * @return Array of Title objects linking here
3272 */
3273 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3274 if ( count( $options ) > 0 ) {
3275 $db = wfGetDB( DB_MASTER );
3276 } else {
3277 $db = wfGetDB( DB_SLAVE );
3278 }
3279
3280 $res = $db->select(
3281 array( 'page', $table ),
3282 self::getSelectFields(),
3283 array(
3284 "{$prefix}_from=page_id",
3285 "{$prefix}_namespace" => $this->getNamespace(),
3286 "{$prefix}_title" => $this->getDBkey() ),
3287 __METHOD__,
3288 $options
3289 );
3290
3291 $retVal = array();
3292 if ( $res->numRows() ) {
3293 $linkCache = LinkCache::singleton();
3294 foreach ( $res as $row ) {
3295 $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title );
3296 if ( $titleObj ) {
3297 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3298 $retVal[] = $titleObj;
3299 }
3300 }
3301 }
3302 return $retVal;
3303 }
3304
3305 /**
3306 * Get an array of Title objects using this Title as a template
3307 * Also stores the IDs in the link cache.
3308 *
3309 * WARNING: do not use this function on arbitrary user-supplied titles!
3310 * On heavily-used templates it will max out the memory.
3311 *
3312 * @param $options Array: may be FOR UPDATE
3313 * @return Array of Title the Title objects linking here
3314 */
3315 public function getTemplateLinksTo( $options = array() ) {
3316 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3317 }
3318
3319 /**
3320 * Get an array of Title objects linked from this Title
3321 * Also stores the IDs in the link cache.
3322 *
3323 * WARNING: do not use this function on arbitrary user-supplied titles!
3324 * On heavily-used templates it will max out the memory.
3325 *
3326 * @param $options Array: may be FOR UPDATE
3327 * @param $table String: table name
3328 * @param $prefix String: fields prefix
3329 * @return Array of Title objects linking here
3330 */
3331 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3332 global $wgContentHandlerUseDB;
3333
3334 $id = $this->getArticleID();
3335
3336 # If the page doesn't exist; there can't be any link from this page
3337 if ( !$id ) {
3338 return array();
3339 }
3340
3341 if ( count( $options ) > 0 ) {
3342 $db = wfGetDB( DB_MASTER );
3343 } else {
3344 $db = wfGetDB( DB_SLAVE );
3345 }
3346
3347 $namespaceFiled = "{$prefix}_namespace";
3348 $titleField = "{$prefix}_title";
3349
3350 $fields = array( $namespaceFiled, $titleField, 'page_id', 'page_len', 'page_is_redirect', 'page_latest' );
3351 if ( $wgContentHandlerUseDB ) $fields[] = 'page_content_model';
3352
3353 $res = $db->select(
3354 array( $table, 'page' ),
3355 $fields,
3356 array( "{$prefix}_from" => $id ),
3357 __METHOD__,
3358 $options,
3359 array( 'page' => array( 'LEFT JOIN', array( "page_namespace=$namespaceFiled", "page_title=$titleField" ) ) )
3360 );
3361
3362 $retVal = array();
3363 if ( $res->numRows() ) {
3364 $linkCache = LinkCache::singleton();
3365 foreach ( $res as $row ) {
3366 $titleObj = Title::makeTitle( $row->$namespaceFiled, $row->$titleField );
3367 if ( $titleObj ) {
3368 if ( $row->page_id ) {
3369 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3370 } else {
3371 $linkCache->addBadLinkObj( $titleObj );
3372 }
3373 $retVal[] = $titleObj;
3374 }
3375 }
3376 }
3377 return $retVal;
3378 }
3379
3380 /**
3381 * Get an array of Title objects used on this Title as a template
3382 * Also stores the IDs in the link cache.
3383 *
3384 * WARNING: do not use this function on arbitrary user-supplied titles!
3385 * On heavily-used templates it will max out the memory.
3386 *
3387 * @param $options Array: may be FOR UPDATE
3388 * @return Array of Title the Title objects used here
3389 */
3390 public function getTemplateLinksFrom( $options = array() ) {
3391 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3392 }
3393
3394 /**
3395 * Get an array of Title objects referring to non-existent articles linked from this page
3396 *
3397 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
3398 * @return Array of Title the Title objects
3399 */
3400 public function getBrokenLinksFrom() {
3401 if ( $this->getArticleID() == 0 ) {
3402 # All links from article ID 0 are false positives
3403 return array();
3404 }
3405
3406 $dbr = wfGetDB( DB_SLAVE );
3407 $res = $dbr->select(
3408 array( 'page', 'pagelinks' ),
3409 array( 'pl_namespace', 'pl_title' ),
3410 array(
3411 'pl_from' => $this->getArticleID(),
3412 'page_namespace IS NULL'
3413 ),
3414 __METHOD__, array(),
3415 array(
3416 'page' => array(
3417 'LEFT JOIN',
3418 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3419 )
3420 )
3421 );
3422
3423 $retVal = array();
3424 foreach ( $res as $row ) {
3425 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
3426 }
3427 return $retVal;
3428 }
3429
3430
3431 /**
3432 * Get a list of URLs to purge from the Squid cache when this
3433 * page changes
3434 *
3435 * @return Array of String the URLs
3436 */
3437 public function getSquidURLs() {
3438 $urls = array(
3439 $this->getInternalURL(),
3440 $this->getInternalURL( 'action=history' )
3441 );
3442
3443 $pageLang = $this->getPageLanguage();
3444 if ( $pageLang->hasVariants() ) {
3445 $variants = $pageLang->getVariants();
3446 foreach ( $variants as $vCode ) {
3447 $urls[] = $this->getInternalURL( '', $vCode );
3448 }
3449 }
3450
3451 return $urls;
3452 }
3453
3454 /**
3455 * Purge all applicable Squid URLs
3456 */
3457 public function purgeSquid() {
3458 global $wgUseSquid;
3459 if ( $wgUseSquid ) {
3460 $urls = $this->getSquidURLs();
3461 $u = new SquidUpdate( $urls );
3462 $u->doUpdate();
3463 }
3464 }
3465
3466 /**
3467 * Move this page without authentication
3468 *
3469 * @param $nt Title the new page Title
3470 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3471 */
3472 public function moveNoAuth( &$nt ) {
3473 return $this->moveTo( $nt, false );
3474 }
3475
3476 /**
3477 * Check whether a given move operation would be valid.
3478 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3479 *
3480 * @param $nt Title the new title
3481 * @param $auth Bool indicates whether $wgUser's permissions
3482 * should be checked
3483 * @param $reason String is the log summary of the move, used for spam checking
3484 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
3485 */
3486 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3487 global $wgUser, $wgContentHandlerUseDB;
3488
3489 $errors = array();
3490 if ( !$nt ) {
3491 // Normally we'd add this to $errors, but we'll get
3492 // lots of syntax errors if $nt is not an object
3493 return array( array( 'badtitletext' ) );
3494 }
3495 if ( $this->equals( $nt ) ) {
3496 $errors[] = array( 'selfmove' );
3497 }
3498 if ( !$this->isMovable() ) {
3499 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3500 }
3501 if ( $nt->getInterwiki() != '' ) {
3502 $errors[] = array( 'immobile-target-namespace-iw' );
3503 }
3504 if ( !$nt->isMovable() ) {
3505 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3506 }
3507
3508 $oldid = $this->getArticleID();
3509 $newid = $nt->getArticleID();
3510
3511 if ( strlen( $nt->getDBkey() ) < 1 ) {
3512 $errors[] = array( 'articleexists' );
3513 }
3514 if ( ( $this->getDBkey() == '' ) ||
3515 ( !$oldid ) ||
3516 ( $nt->getDBkey() == '' ) ) {
3517 $errors[] = array( 'badarticleerror' );
3518 }
3519
3520 // Content model checks
3521 if ( !$wgContentHandlerUseDB &&
3522 $this->getContentModel() !== $nt->getContentModel() ) {
3523 // can't move a page if that would change the page's content model
3524 $errors[] = array(
3525 'bad-target-model',
3526 ContentHandler::getLocalizedName( $this->getContentModel() ),
3527 ContentHandler::getLocalizedName( $nt->getContentModel() )
3528 );
3529 }
3530
3531 // Image-specific checks
3532 if ( $this->getNamespace() == NS_FILE ) {
3533 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3534 }
3535
3536 if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) {
3537 $errors[] = array( 'nonfile-cannot-move-to-file' );
3538 }
3539
3540 if ( $auth ) {
3541 $errors = wfMergeErrorArrays( $errors,
3542 $this->getUserPermissionsErrors( 'move', $wgUser ),
3543 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3544 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3545 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3546 }
3547
3548 $match = EditPage::matchSummarySpamRegex( $reason );
3549 if ( $match !== false ) {
3550 // This is kind of lame, won't display nice
3551 $errors[] = array( 'spamprotectiontext' );
3552 }
3553
3554 $err = null;
3555 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3556 $errors[] = array( 'hookaborted', $err );
3557 }
3558
3559 # The move is allowed only if (1) the target doesn't exist, or
3560 # (2) the target is a redirect to the source, and has no history
3561 # (so we can undo bad moves right after they're done).
3562
3563 if ( 0 != $newid ) { # Target exists; check for validity
3564 if ( !$this->isValidMoveTarget( $nt ) ) {
3565 $errors[] = array( 'articleexists' );
3566 }
3567 } else {
3568 $tp = $nt->getTitleProtection();
3569 $right = ( $tp['pt_create_perm'] == 'sysop' ) ? 'protect' : $tp['pt_create_perm'];
3570 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3571 $errors[] = array( 'cantmove-titleprotected' );
3572 }
3573 }
3574 if ( empty( $errors ) ) {
3575 return true;
3576 }
3577 return $errors;
3578 }
3579
3580 /**
3581 * Check if the requested move target is a valid file move target
3582 * @param Title $nt Target title
3583 * @return array List of errors
3584 */
3585 protected function validateFileMoveOperation( $nt ) {
3586 global $wgUser;
3587
3588 $errors = array();
3589
3590 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3591
3592 $file = wfLocalFile( $this );
3593 if ( $file->exists() ) {
3594 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3595 $errors[] = array( 'imageinvalidfilename' );
3596 }
3597 if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3598 $errors[] = array( 'imagetypemismatch' );
3599 }
3600 }
3601
3602 if ( $nt->getNamespace() != NS_FILE ) {
3603 $errors[] = array( 'imagenocrossnamespace' );
3604 // From here we want to do checks on a file object, so if we can't
3605 // create one, we must return.
3606 return $errors;
3607 }
3608
3609 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3610
3611 $destFile = wfLocalFile( $nt );
3612 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3613 $errors[] = array( 'file-exists-sharedrepo' );
3614 }
3615
3616 return $errors;
3617 }
3618
3619 /**
3620 * Move a title to a new location
3621 *
3622 * @param $nt Title the new title
3623 * @param $auth Bool indicates whether $wgUser's permissions
3624 * should be checked
3625 * @param $reason String the reason for the move
3626 * @param $createRedirect Bool Whether to create a redirect from the old title to the new title.
3627 * Ignored if the user doesn't have the suppressredirect right.
3628 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3629 */
3630 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3631 global $wgUser;
3632 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3633 if ( is_array( $err ) ) {
3634 // Auto-block user's IP if the account was "hard" blocked
3635 $wgUser->spreadAnyEditBlock();
3636 return $err;
3637 }
3638 // Check suppressredirect permission
3639 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3640 $createRedirect = true;
3641 }
3642
3643 // If it is a file, move it first.
3644 // It is done before all other moving stuff is done because it's hard to revert.
3645 $dbw = wfGetDB( DB_MASTER );
3646 if ( $this->getNamespace() == NS_FILE ) {
3647 $file = wfLocalFile( $this );
3648 if ( $file->exists() ) {
3649 $status = $file->move( $nt );
3650 if ( !$status->isOk() ) {
3651 return $status->getErrorsArray();
3652 }
3653 }
3654 // Clear RepoGroup process cache
3655 RepoGroup::singleton()->clearCache( $this );
3656 RepoGroup::singleton()->clearCache( $nt ); # clear false negative cache
3657 }
3658
3659 $dbw->begin( __METHOD__ ); # If $file was a LocalFile, its transaction would have closed our own.
3660 $pageid = $this->getArticleID( self::GAID_FOR_UPDATE );
3661 $protected = $this->isProtected();
3662
3663 // Do the actual move
3664 $this->moveToInternal( $nt, $reason, $createRedirect );
3665
3666 // Refresh the sortkey for this row. Be careful to avoid resetting
3667 // cl_timestamp, which may disturb time-based lists on some sites.
3668 $prefixes = $dbw->select(
3669 'categorylinks',
3670 array( 'cl_sortkey_prefix', 'cl_to' ),
3671 array( 'cl_from' => $pageid ),
3672 __METHOD__
3673 );
3674 foreach ( $prefixes as $prefixRow ) {
3675 $prefix = $prefixRow->cl_sortkey_prefix;
3676 $catTo = $prefixRow->cl_to;
3677 $dbw->update( 'categorylinks',
3678 array(
3679 'cl_sortkey' => Collation::singleton()->getSortKey(
3680 $nt->getCategorySortkey( $prefix ) ),
3681 'cl_timestamp=cl_timestamp' ),
3682 array(
3683 'cl_from' => $pageid,
3684 'cl_to' => $catTo ),
3685 __METHOD__
3686 );
3687 }
3688
3689 $redirid = $this->getArticleID();
3690
3691 if ( $protected ) {
3692 # Protect the redirect title as the title used to be...
3693 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3694 array(
3695 'pr_page' => $redirid,
3696 'pr_type' => 'pr_type',
3697 'pr_level' => 'pr_level',
3698 'pr_cascade' => 'pr_cascade',
3699 'pr_user' => 'pr_user',
3700 'pr_expiry' => 'pr_expiry'
3701 ),
3702 array( 'pr_page' => $pageid ),
3703 __METHOD__,
3704 array( 'IGNORE' )
3705 );
3706 # Update the protection log
3707 $log = new LogPage( 'protect' );
3708 $comment = wfMessage(
3709 'prot_1movedto2',
3710 $this->getPrefixedText(),
3711 $nt->getPrefixedText()
3712 )->inContentLanguage()->text();
3713 if ( $reason ) {
3714 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3715 }
3716 // @todo FIXME: $params?
3717 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) );
3718 }
3719
3720 # Update watchlists
3721 $oldnamespace = MWNamespace::getSubject( $this->getNamespace() );
3722 $newnamespace = MWNamespace::getSubject( $nt->getNamespace() );
3723 $oldtitle = $this->getDBkey();
3724 $newtitle = $nt->getDBkey();
3725
3726 if ( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
3727 WatchedItem::duplicateEntries( $this, $nt );
3728 }
3729
3730 $dbw->commit( __METHOD__ );
3731
3732 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3733 return true;
3734 }
3735
3736 /**
3737 * Move page to a title which is either a redirect to the
3738 * source page or nonexistent
3739 *
3740 * @param $nt Title the page to move to, which should be a redirect or nonexistent
3741 * @param $reason String The reason for the move
3742 * @param $createRedirect Bool Whether to leave a redirect at the old title. Does not check
3743 * if the user has the suppressredirect right
3744 * @throws MWException
3745 */
3746 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3747 global $wgUser, $wgContLang;
3748
3749 if ( $nt->exists() ) {
3750 $moveOverRedirect = true;
3751 $logType = 'move_redir';
3752 } else {
3753 $moveOverRedirect = false;
3754 $logType = 'move';
3755 }
3756
3757 if ( $createRedirect ) {
3758 $contentHandler = ContentHandler::getForTitle( $this );
3759 $redirectContent = $contentHandler->makeRedirectContent( $nt );
3760
3761 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
3762 } else {
3763 $redirectContent = null;
3764 }
3765
3766 $logEntry = new ManualLogEntry( 'move', $logType );
3767 $logEntry->setPerformer( $wgUser );
3768 $logEntry->setTarget( $this );
3769 $logEntry->setComment( $reason );
3770 $logEntry->setParameters( array(
3771 '4::target' => $nt->getPrefixedText(),
3772 '5::noredir' => $redirectContent ? '0': '1',
3773 ) );
3774
3775 $formatter = LogFormatter::newFromEntry( $logEntry );
3776 $formatter->setContext( RequestContext::newExtraneousContext( $this ) );
3777 $comment = $formatter->getPlainActionText();
3778 if ( $reason ) {
3779 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3780 }
3781 # Truncate for whole multibyte characters.
3782 $comment = $wgContLang->truncate( $comment, 255 );
3783
3784 $oldid = $this->getArticleID();
3785
3786 $dbw = wfGetDB( DB_MASTER );
3787
3788 $newpage = WikiPage::factory( $nt );
3789
3790 if ( $moveOverRedirect ) {
3791 $newid = $nt->getArticleID();
3792
3793 # Delete the old redirect. We don't save it to history since
3794 # by definition if we've got here it's rather uninteresting.
3795 # We have to remove it so that the next step doesn't trigger
3796 # a conflict on the unique namespace+title index...
3797 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ );
3798
3799 $newpage->doDeleteUpdates( $newid );
3800 }
3801
3802 # Save a null revision in the page's history notifying of the move
3803 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
3804 if ( !is_object( $nullRevision ) ) {
3805 throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
3806 }
3807
3808 $nullRevision->insertOn( $dbw );
3809
3810 # Change the name of the target page:
3811 $dbw->update( 'page',
3812 /* SET */ array(
3813 'page_namespace' => $nt->getNamespace(),
3814 'page_title' => $nt->getDBkey(),
3815 ),
3816 /* WHERE */ array( 'page_id' => $oldid ),
3817 __METHOD__
3818 );
3819
3820 $this->resetArticleID( 0 );
3821 $nt->resetArticleID( $oldid );
3822
3823 $newpage->updateRevisionOn( $dbw, $nullRevision );
3824
3825 wfRunHooks( 'NewRevisionFromEditComplete',
3826 array( $newpage, $nullRevision, $nullRevision->getParentId(), $wgUser ) );
3827
3828 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3829
3830 if ( !$moveOverRedirect ) {
3831 WikiPage::onArticleCreate( $nt );
3832 }
3833
3834 # Recreate the redirect, this time in the other direction.
3835 if ( !$redirectContent ) {
3836 WikiPage::onArticleDelete( $this );
3837 } else {
3838 $redirectArticle = WikiPage::factory( $this );
3839 $newid = $redirectArticle->insertOn( $dbw );
3840 if ( $newid ) { // sanity
3841 $redirectRevision = new Revision( array(
3842 'title' => $this, // for determining the default content model
3843 'page' => $newid,
3844 'comment' => $comment,
3845 'content' => $redirectContent ) );
3846 $redirectRevision->insertOn( $dbw );
3847 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3848
3849 wfRunHooks( 'NewRevisionFromEditComplete',
3850 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3851
3852 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3853 }
3854 }
3855
3856 # Log the move
3857 $logid = $logEntry->insert();
3858 $logEntry->publish( $logid );
3859 }
3860
3861 /**
3862 * Move this page's subpages to be subpages of $nt
3863 *
3864 * @param $nt Title Move target
3865 * @param $auth bool Whether $wgUser's permissions should be checked
3866 * @param $reason string The reason for the move
3867 * @param $createRedirect bool Whether to create redirects from the old subpages to
3868 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3869 * @return mixed array with old page titles as keys, and strings (new page titles) or
3870 * arrays (errors) as values, or an error array with numeric indices if no pages
3871 * were moved
3872 */
3873 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3874 global $wgMaximumMovedPages;
3875 // Check permissions
3876 if ( !$this->userCan( 'move-subpages' ) ) {
3877 return array( 'cant-move-subpages' );
3878 }
3879 // Do the source and target namespaces support subpages?
3880 if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) {
3881 return array( 'namespace-nosubpages',
3882 MWNamespace::getCanonicalName( $this->getNamespace() ) );
3883 }
3884 if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) {
3885 return array( 'namespace-nosubpages',
3886 MWNamespace::getCanonicalName( $nt->getNamespace() ) );
3887 }
3888
3889 $subpages = $this->getSubpages( $wgMaximumMovedPages + 1 );
3890 $retval = array();
3891 $count = 0;
3892 foreach ( $subpages as $oldSubpage ) {
3893 $count++;
3894 if ( $count > $wgMaximumMovedPages ) {
3895 $retval[$oldSubpage->getPrefixedTitle()] =
3896 array( 'movepage-max-pages',
3897 $wgMaximumMovedPages );
3898 break;
3899 }
3900
3901 // We don't know whether this function was called before
3902 // or after moving the root page, so check both
3903 // $this and $nt
3904 if ( $oldSubpage->getArticleID() == $this->getArticleID() ||
3905 $oldSubpage->getArticleID() == $nt->getArticleID() )
3906 {
3907 // When moving a page to a subpage of itself,
3908 // don't move it twice
3909 continue;
3910 }
3911 $newPageName = preg_replace(
3912 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3913 StringUtils::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3914 $oldSubpage->getDBkey() );
3915 if ( $oldSubpage->isTalkPage() ) {
3916 $newNs = $nt->getTalkPage()->getNamespace();
3917 } else {
3918 $newNs = $nt->getSubjectPage()->getNamespace();
3919 }
3920 # Bug 14385: we need makeTitleSafe because the new page names may
3921 # be longer than 255 characters.
3922 $newSubpage = Title::makeTitleSafe( $newNs, $newPageName );
3923
3924 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3925 if ( $success === true ) {
3926 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3927 } else {
3928 $retval[$oldSubpage->getPrefixedText()] = $success;
3929 }
3930 }
3931 return $retval;
3932 }
3933
3934 /**
3935 * Checks if this page is just a one-rev redirect.
3936 * Adds lock, so don't use just for light purposes.
3937 *
3938 * @return Bool
3939 */
3940 public function isSingleRevRedirect() {
3941 global $wgContentHandlerUseDB;
3942
3943 $dbw = wfGetDB( DB_MASTER );
3944
3945 # Is it a redirect?
3946 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
3947 if ( $wgContentHandlerUseDB ) $fields[] = 'page_content_model';
3948
3949 $row = $dbw->selectRow( 'page',
3950 $fields,
3951 $this->pageCond(),
3952 __METHOD__,
3953 array( 'FOR UPDATE' )
3954 );
3955 # Cache some fields we may want
3956 $this->mArticleID = $row ? intval( $row->page_id ) : 0;
3957 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
3958 $this->mLatestID = $row ? intval( $row->page_latest ) : false;
3959 $this->mContentModel = $row && isset( $row->page_content_model ) ? strval( $row->page_content_model ) : false;
3960 if ( !$this->mRedirect ) {
3961 return false;
3962 }
3963 # Does the article have a history?
3964 $row = $dbw->selectField( array( 'page', 'revision' ),
3965 'rev_id',
3966 array( 'page_namespace' => $this->getNamespace(),
3967 'page_title' => $this->getDBkey(),
3968 'page_id=rev_page',
3969 'page_latest != rev_id'
3970 ),
3971 __METHOD__,
3972 array( 'FOR UPDATE' )
3973 );
3974 # Return true if there was no history
3975 return ( $row === false );
3976 }
3977
3978 /**
3979 * Checks if $this can be moved to a given Title
3980 * - Selects for update, so don't call it unless you mean business
3981 *
3982 * @param $nt Title the new title to check
3983 * @return Bool
3984 */
3985 public function isValidMoveTarget( $nt ) {
3986 # Is it an existing file?
3987 if ( $nt->getNamespace() == NS_FILE ) {
3988 $file = wfLocalFile( $nt );
3989 if ( $file->exists() ) {
3990 wfDebug( __METHOD__ . ": file exists\n" );
3991 return false;
3992 }
3993 }
3994 # Is it a redirect with no history?
3995 if ( !$nt->isSingleRevRedirect() ) {
3996 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
3997 return false;
3998 }
3999 # Get the article text
4000 $rev = Revision::newFromTitle( $nt, false, Revision::READ_LATEST );
4001 if( !is_object( $rev ) ) {
4002 return false;
4003 }
4004 $content = $rev->getContent();
4005 # Does the redirect point to the source?
4006 # Or is it a broken self-redirect, usually caused by namespace collisions?
4007 $redirTitle = $content ? $content->getRedirectTarget() : null;
4008
4009 if ( $redirTitle ) {
4010 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
4011 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
4012 wfDebug( __METHOD__ . ": redirect points to other page\n" );
4013 return false;
4014 } else {
4015 return true;
4016 }
4017 } else {
4018 # Fail safe (not a redirect after all. strange.)
4019 wfDebug( __METHOD__ . ": failsafe: database sais " . $nt->getPrefixedDBkey() .
4020 " is a redirect, but it doesn't contain a valid redirect.\n" );
4021 return false;
4022 }
4023 }
4024
4025 /**
4026 * Get categories to which this Title belongs and return an array of
4027 * categories' names.
4028 *
4029 * @return Array of parents in the form:
4030 * $parent => $currentarticle
4031 */
4032 public function getParentCategories() {
4033 global $wgContLang;
4034
4035 $data = array();
4036
4037 $titleKey = $this->getArticleID();
4038
4039 if ( $titleKey === 0 ) {
4040 return $data;
4041 }
4042
4043 $dbr = wfGetDB( DB_SLAVE );
4044
4045 $res = $dbr->select(
4046 'categorylinks',
4047 'cl_to',
4048 array( 'cl_from' => $titleKey ),
4049 __METHOD__
4050 );
4051
4052 if ( $res->numRows() > 0 ) {
4053 foreach ( $res as $row ) {
4054 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
4055 $data[$wgContLang->getNSText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText();
4056 }
4057 }
4058 return $data;
4059 }
4060
4061 /**
4062 * Get a tree of parent categories
4063 *
4064 * @param $children Array with the children in the keys, to check for circular refs
4065 * @return Array Tree of parent categories
4066 */
4067 public function getParentCategoryTree( $children = array() ) {
4068 $stack = array();
4069 $parents = $this->getParentCategories();
4070
4071 if ( $parents ) {
4072 foreach ( $parents as $parent => $current ) {
4073 if ( array_key_exists( $parent, $children ) ) {
4074 # Circular reference
4075 $stack[$parent] = array();
4076 } else {
4077 $nt = Title::newFromText( $parent );
4078 if ( $nt ) {
4079 $stack[$parent] = $nt->getParentCategoryTree( $children + array( $parent => 1 ) );
4080 }
4081 }
4082 }
4083 }
4084
4085 return $stack;
4086 }
4087
4088 /**
4089 * Get an associative array for selecting this title from
4090 * the "page" table
4091 *
4092 * @return Array suitable for the $where parameter of DB::select()
4093 */
4094 public function pageCond() {
4095 if ( $this->mArticleID > 0 ) {
4096 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
4097 return array( 'page_id' => $this->mArticleID );
4098 } else {
4099 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
4100 }
4101 }
4102
4103 /**
4104 * Get the revision ID of the previous revision
4105 *
4106 * @param $revId Int Revision ID. Get the revision that was before this one.
4107 * @param $flags Int Title::GAID_FOR_UPDATE
4108 * @return Int|Bool Old revision ID, or FALSE if none exists
4109 */
4110 public function getPreviousRevisionID( $revId, $flags = 0 ) {
4111 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4112 $revId = $db->selectField( 'revision', 'rev_id',
4113 array(
4114 'rev_page' => $this->getArticleID( $flags ),
4115 'rev_id < ' . intval( $revId )
4116 ),
4117 __METHOD__,
4118 array( 'ORDER BY' => 'rev_id DESC' )
4119 );
4120
4121 if ( $revId === false ) {
4122 return false;
4123 } else {
4124 return intval( $revId );
4125 }
4126 }
4127
4128 /**
4129 * Get the revision ID of the next revision
4130 *
4131 * @param $revId Int Revision ID. Get the revision that was after this one.
4132 * @param $flags Int Title::GAID_FOR_UPDATE
4133 * @return Int|Bool Next revision ID, or FALSE if none exists
4134 */
4135 public function getNextRevisionID( $revId, $flags = 0 ) {
4136 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4137 $revId = $db->selectField( 'revision', 'rev_id',
4138 array(
4139 'rev_page' => $this->getArticleID( $flags ),
4140 'rev_id > ' . intval( $revId )
4141 ),
4142 __METHOD__,
4143 array( 'ORDER BY' => 'rev_id' )
4144 );
4145
4146 if ( $revId === false ) {
4147 return false;
4148 } else {
4149 return intval( $revId );
4150 }
4151 }
4152
4153 /**
4154 * Get the first revision of the page
4155 *
4156 * @param $flags Int Title::GAID_FOR_UPDATE
4157 * @return Revision|Null if page doesn't exist
4158 */
4159 public function getFirstRevision( $flags = 0 ) {
4160 $pageId = $this->getArticleID( $flags );
4161 if ( $pageId ) {
4162 $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
4163 $row = $db->selectRow( 'revision', Revision::selectFields(),
4164 array( 'rev_page' => $pageId ),
4165 __METHOD__,
4166 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
4167 );
4168 if ( $row ) {
4169 return new Revision( $row );
4170 }
4171 }
4172 return null;
4173 }
4174
4175 /**
4176 * Get the oldest revision timestamp of this page
4177 *
4178 * @param $flags Int Title::GAID_FOR_UPDATE
4179 * @return String: MW timestamp
4180 */
4181 public function getEarliestRevTime( $flags = 0 ) {
4182 $rev = $this->getFirstRevision( $flags );
4183 return $rev ? $rev->getTimestamp() : null;
4184 }
4185
4186 /**
4187 * Check if this is a new page
4188 *
4189 * @return bool
4190 */
4191 public function isNewPage() {
4192 $dbr = wfGetDB( DB_SLAVE );
4193 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
4194 }
4195
4196 /**
4197 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4198 *
4199 * @return bool
4200 */
4201 public function isBigDeletion() {
4202 global $wgDeleteRevisionsLimit;
4203
4204 if ( !$wgDeleteRevisionsLimit ) {
4205 return false;
4206 }
4207
4208 $revCount = $this->estimateRevisionCount();
4209 return $revCount > $wgDeleteRevisionsLimit;
4210 }
4211
4212 /**
4213 * Get the approximate revision count of this page.
4214 *
4215 * @return int
4216 */
4217 public function estimateRevisionCount() {
4218 if ( !$this->exists() ) {
4219 return 0;
4220 }
4221
4222 if ( $this->mEstimateRevisions === null ) {
4223 $dbr = wfGetDB( DB_SLAVE );
4224 $this->mEstimateRevisions = $dbr->estimateRowCount( 'revision', '*',
4225 array( 'rev_page' => $this->getArticleID() ), __METHOD__ );
4226 }
4227
4228 return $this->mEstimateRevisions;
4229 }
4230
4231 /**
4232 * Get the number of revisions between the given revision.
4233 * Used for diffs and other things that really need it.
4234 *
4235 * @param $old int|Revision Old revision or rev ID (first before range)
4236 * @param $new int|Revision New revision or rev ID (first after range)
4237 * @return Int Number of revisions between these revisions.
4238 */
4239 public function countRevisionsBetween( $old, $new ) {
4240 if ( !( $old instanceof Revision ) ) {
4241 $old = Revision::newFromTitle( $this, (int)$old );
4242 }
4243 if ( !( $new instanceof Revision ) ) {
4244 $new = Revision::newFromTitle( $this, (int)$new );
4245 }
4246 if ( !$old || !$new ) {
4247 return 0; // nothing to compare
4248 }
4249 $dbr = wfGetDB( DB_SLAVE );
4250 return (int)$dbr->selectField( 'revision', 'count(*)',
4251 array(
4252 'rev_page' => $this->getArticleID(),
4253 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4254 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4255 ),
4256 __METHOD__
4257 );
4258 }
4259
4260 /**
4261 * Get the number of authors between the given revisions or revision IDs.
4262 * Used for diffs and other things that really need it.
4263 *
4264 * @param $old int|Revision Old revision or rev ID (first before range by default)
4265 * @param $new int|Revision New revision or rev ID (first after range by default)
4266 * @param $limit int Maximum number of authors
4267 * @param $options string|array (Optional): Single option, or an array of options:
4268 * 'include_old' Include $old in the range; $new is excluded.
4269 * 'include_new' Include $new in the range; $old is excluded.
4270 * 'include_both' Include both $old and $new in the range.
4271 * Unknown option values are ignored.
4272 * @return int Number of revision authors in the range; zero if not both revisions exist
4273 */
4274 public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4275 if ( !( $old instanceof Revision ) ) {
4276 $old = Revision::newFromTitle( $this, (int)$old );
4277 }
4278 if ( !( $new instanceof Revision ) ) {
4279 $new = Revision::newFromTitle( $this, (int)$new );
4280 }
4281 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4282 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4283 // in the sanity check below?
4284 if ( !$old || !$new ) {
4285 return 0; // nothing to compare
4286 }
4287 $old_cmp = '>';
4288 $new_cmp = '<';
4289 $options = (array) $options;
4290 if ( in_array( 'include_old', $options ) ) {
4291 $old_cmp = '>=';
4292 }
4293 if ( in_array( 'include_new', $options ) ) {
4294 $new_cmp = '<=';
4295 }
4296 if ( in_array( 'include_both', $options ) ) {
4297 $old_cmp = '>=';
4298 $new_cmp = '<=';
4299 }
4300 // No DB query needed if $old and $new are the same or successive revisions:
4301 if ( $old->getId() === $new->getId() ) {
4302 return ( $old_cmp === '>' && $new_cmp === '<' ) ? 0 : 1;
4303 } else if ( $old->getId() === $new->getParentId() ) {
4304 if ( $old_cmp === '>' || $new_cmp === '<' ) {
4305 return ( $old_cmp === '>' && $new_cmp === '<' ) ? 0 : 1;
4306 }
4307 return ( $old->getRawUserText() === $new->getRawUserText() ) ? 1 : 2;
4308 }
4309 $dbr = wfGetDB( DB_SLAVE );
4310 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4311 array(
4312 'rev_page' => $this->getArticleID(),
4313 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4314 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4315 ), __METHOD__,
4316 array( 'LIMIT' => $limit + 1 ) // add one so caller knows it was truncated
4317 );
4318 return (int)$dbr->numRows( $res );
4319 }
4320
4321 /**
4322 * Compare with another title.
4323 *
4324 * @param $title Title
4325 * @return Bool
4326 */
4327 public function equals( Title $title ) {
4328 // Note: === is necessary for proper matching of number-like titles.
4329 return $this->getInterwiki() === $title->getInterwiki()
4330 && $this->getNamespace() == $title->getNamespace()
4331 && $this->getDBkey() === $title->getDBkey();
4332 }
4333
4334 /**
4335 * Check if this title is a subpage of another title
4336 *
4337 * @param $title Title
4338 * @return Bool
4339 */
4340 public function isSubpageOf( Title $title ) {
4341 return $this->getInterwiki() === $title->getInterwiki()
4342 && $this->getNamespace() == $title->getNamespace()
4343 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4344 }
4345
4346 /**
4347 * Check if page exists. For historical reasons, this function simply
4348 * checks for the existence of the title in the page table, and will
4349 * thus return false for interwiki links, special pages and the like.
4350 * If you want to know if a title can be meaningfully viewed, you should
4351 * probably call the isKnown() method instead.
4352 *
4353 * @return Bool
4354 */
4355 public function exists() {
4356 return $this->getArticleID() != 0;
4357 }
4358
4359 /**
4360 * Should links to this title be shown as potentially viewable (i.e. as
4361 * "bluelinks"), even if there's no record by this title in the page
4362 * table?
4363 *
4364 * This function is semi-deprecated for public use, as well as somewhat
4365 * misleadingly named. You probably just want to call isKnown(), which
4366 * calls this function internally.
4367 *
4368 * (ISSUE: Most of these checks are cheap, but the file existence check
4369 * can potentially be quite expensive. Including it here fixes a lot of
4370 * existing code, but we might want to add an optional parameter to skip
4371 * it and any other expensive checks.)
4372 *
4373 * @return Bool
4374 */
4375 public function isAlwaysKnown() {
4376 $isKnown = null;
4377
4378 /**
4379 * Allows overriding default behaviour for determining if a page exists.
4380 * If $isKnown is kept as null, regular checks happen. If it's
4381 * a boolean, this value is returned by the isKnown method.
4382 *
4383 * @since 1.20
4384 *
4385 * @param Title $title
4386 * @param boolean|null $isKnown
4387 */
4388 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4389
4390 if ( !is_null( $isKnown ) ) {
4391 return $isKnown;
4392 }
4393
4394 if ( $this->mInterwiki != '' ) {
4395 return true; // any interwiki link might be viewable, for all we know
4396 }
4397
4398 switch( $this->mNamespace ) {
4399 case NS_MEDIA:
4400 case NS_FILE:
4401 // file exists, possibly in a foreign repo
4402 return (bool)wfFindFile( $this );
4403 case NS_SPECIAL:
4404 // valid special page
4405 return SpecialPageFactory::exists( $this->getDBkey() );
4406 case NS_MAIN:
4407 // selflink, possibly with fragment
4408 return $this->mDbkeyform == '';
4409 case NS_MEDIAWIKI:
4410 // known system message
4411 return $this->hasSourceText() !== false;
4412 default:
4413 return false;
4414 }
4415 }
4416
4417 /**
4418 * Does this title refer to a page that can (or might) be meaningfully
4419 * viewed? In particular, this function may be used to determine if
4420 * links to the title should be rendered as "bluelinks" (as opposed to
4421 * "redlinks" to non-existent pages).
4422 * Adding something else to this function will cause inconsistency
4423 * since LinkHolderArray calls isAlwaysKnown() and does its own
4424 * page existence check.
4425 *
4426 * @return Bool
4427 */
4428 public function isKnown() {
4429 return $this->isAlwaysKnown() || $this->exists();
4430 }
4431
4432 /**
4433 * Does this page have source text?
4434 *
4435 * @return Boolean
4436 */
4437 public function hasSourceText() {
4438 if ( $this->exists() ) {
4439 return true;
4440 }
4441
4442 if ( $this->mNamespace == NS_MEDIAWIKI ) {
4443 // If the page doesn't exist but is a known system message, default
4444 // message content will be displayed, same for language subpages-
4445 // Use always content language to avoid loading hundreds of languages
4446 // to get the link color.
4447 global $wgContLang;
4448 list( $name, $lang ) = MessageCache::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4449 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4450 return $message->exists();
4451 }
4452
4453 return false;
4454 }
4455
4456 /**
4457 * Get the default message text or false if the message doesn't exist
4458 *
4459 * @return String or false
4460 */
4461 public function getDefaultMessageText() {
4462 global $wgContLang;
4463
4464 if ( $this->getNamespace() != NS_MEDIAWIKI ) { // Just in case
4465 return false;
4466 }
4467
4468 list( $name, $lang ) = MessageCache::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4469 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4470
4471 if ( $message->exists() ) {
4472 return $message->plain();
4473 } else {
4474 return false;
4475 }
4476 }
4477
4478 /**
4479 * Updates page_touched for this page; called from LinksUpdate.php
4480 *
4481 * @return Bool true if the update succeded
4482 */
4483 public function invalidateCache() {
4484 global $wgMemc;
4485 if ( wfReadOnly() ) {
4486 return false;
4487 }
4488 $dbw = wfGetDB( DB_MASTER );
4489 $success = $dbw->update(
4490 'page',
4491 array( 'page_touched' => $dbw->timestamp() ),
4492 $this->pageCond(),
4493 __METHOD__
4494 );
4495 HTMLFileCache::clearFileCache( $this );
4496
4497 // Clear page info.
4498 $revision = WikiPage::factory( $this )->getRevision();
4499 if( $revision !== null ) {
4500 $memcKey = wfMemcKey( 'infoaction', $this->getPrefixedText(), $revision->getId() );
4501 $success = $success && $wgMemc->delete( $memcKey );
4502 }
4503
4504 return $success;
4505 }
4506
4507 /**
4508 * Update page_touched timestamps and send squid purge messages for
4509 * pages linking to this title. May be sent to the job queue depending
4510 * on the number of links. Typically called on create and delete.
4511 */
4512 public function touchLinks() {
4513 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4514 $u->doUpdate();
4515
4516 if ( $this->getNamespace() == NS_CATEGORY ) {
4517 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4518 $u->doUpdate();
4519 }
4520 }
4521
4522 /**
4523 * Get the last touched timestamp
4524 *
4525 * @param $db DatabaseBase: optional db
4526 * @return String last-touched timestamp
4527 */
4528 public function getTouched( $db = null ) {
4529 $db = isset( $db ) ? $db : wfGetDB( DB_SLAVE );
4530 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
4531 return $touched;
4532 }
4533
4534 /**
4535 * Get the timestamp when this page was updated since the user last saw it.
4536 *
4537 * @param $user User
4538 * @return String|Null
4539 */
4540 public function getNotificationTimestamp( $user = null ) {
4541 global $wgUser, $wgShowUpdatedMarker;
4542 // Assume current user if none given
4543 if ( !$user ) {
4544 $user = $wgUser;
4545 }
4546 // Check cache first
4547 $uid = $user->getId();
4548 // avoid isset here, as it'll return false for null entries
4549 if ( array_key_exists( $uid, $this->mNotificationTimestamp ) ) {
4550 return $this->mNotificationTimestamp[$uid];
4551 }
4552 if ( !$uid || !$wgShowUpdatedMarker ) {
4553 return $this->mNotificationTimestamp[$uid] = false;
4554 }
4555 // Don't cache too much!
4556 if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
4557 $this->mNotificationTimestamp = array();
4558 }
4559 $dbr = wfGetDB( DB_SLAVE );
4560 $this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
4561 'wl_notificationtimestamp',
4562 array(
4563 'wl_user' => $user->getId(),
4564 'wl_namespace' => $this->getNamespace(),
4565 'wl_title' => $this->getDBkey(),
4566 ),
4567 __METHOD__
4568 );
4569 return $this->mNotificationTimestamp[$uid];
4570 }
4571
4572 /**
4573 * Generate strings used for xml 'id' names in monobook tabs
4574 *
4575 * @param $prepend string defaults to 'nstab-'
4576 * @return String XML 'id' name
4577 */
4578 public function getNamespaceKey( $prepend = 'nstab-' ) {
4579 global $wgContLang;
4580 // Gets the subject namespace if this title
4581 $namespace = MWNamespace::getSubject( $this->getNamespace() );
4582 // Checks if cononical namespace name exists for namespace
4583 if ( MWNamespace::exists( $this->getNamespace() ) ) {
4584 // Uses canonical namespace name
4585 $namespaceKey = MWNamespace::getCanonicalName( $namespace );
4586 } else {
4587 // Uses text of namespace
4588 $namespaceKey = $this->getSubjectNsText();
4589 }
4590 // Makes namespace key lowercase
4591 $namespaceKey = $wgContLang->lc( $namespaceKey );
4592 // Uses main
4593 if ( $namespaceKey == '' ) {
4594 $namespaceKey = 'main';
4595 }
4596 // Changes file to image for backwards compatibility
4597 if ( $namespaceKey == 'file' ) {
4598 $namespaceKey = 'image';
4599 }
4600 return $prepend . $namespaceKey;
4601 }
4602
4603 /**
4604 * Get all extant redirects to this Title
4605 *
4606 * @param $ns Int|Null Single namespace to consider; NULL to consider all namespaces
4607 * @return Array of Title redirects to this title
4608 */
4609 public function getRedirectsHere( $ns = null ) {
4610 $redirs = array();
4611
4612 $dbr = wfGetDB( DB_SLAVE );
4613 $where = array(
4614 'rd_namespace' => $this->getNamespace(),
4615 'rd_title' => $this->getDBkey(),
4616 'rd_from = page_id'
4617 );
4618 if ( $this->isExternal() ) {
4619 $where['rd_interwiki'] = $this->getInterwiki();
4620 } else {
4621 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4622 }
4623 if ( !is_null( $ns ) ) {
4624 $where['page_namespace'] = $ns;
4625 }
4626
4627 $res = $dbr->select(
4628 array( 'redirect', 'page' ),
4629 array( 'page_namespace', 'page_title' ),
4630 $where,
4631 __METHOD__
4632 );
4633
4634 foreach ( $res as $row ) {
4635 $redirs[] = self::newFromRow( $row );
4636 }
4637 return $redirs;
4638 }
4639
4640 /**
4641 * Check if this Title is a valid redirect target
4642 *
4643 * @return Bool
4644 */
4645 public function isValidRedirectTarget() {
4646 global $wgInvalidRedirectTargets;
4647
4648 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4649 if ( $this->isSpecial( 'Userlogout' ) ) {
4650 return false;
4651 }
4652
4653 foreach ( $wgInvalidRedirectTargets as $target ) {
4654 if ( $this->isSpecial( $target ) ) {
4655 return false;
4656 }
4657 }
4658
4659 return true;
4660 }
4661
4662 /**
4663 * Get a backlink cache object
4664 *
4665 * @return BacklinkCache
4666 */
4667 public function getBacklinkCache() {
4668 return BacklinkCache::get( $this );
4669 }
4670
4671 /**
4672 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4673 *
4674 * @return Boolean
4675 */
4676 public function canUseNoindex() {
4677 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4678
4679 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4680 ? $wgContentNamespaces
4681 : $wgExemptFromUserRobotsControl;
4682
4683 return !in_array( $this->mNamespace, $bannedNamespaces );
4684
4685 }
4686
4687 /**
4688 * Returns the raw sort key to be used for categories, with the specified
4689 * prefix. This will be fed to Collation::getSortKey() to get a
4690 * binary sortkey that can be used for actual sorting.
4691 *
4692 * @param $prefix string The prefix to be used, specified using
4693 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4694 * prefix.
4695 * @return string
4696 */
4697 public function getCategorySortkey( $prefix = '' ) {
4698 $unprefixed = $this->getText();
4699
4700 // Anything that uses this hook should only depend
4701 // on the Title object passed in, and should probably
4702 // tell the users to run updateCollations.php --force
4703 // in order to re-sort existing category relations.
4704 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4705 if ( $prefix !== '' ) {
4706 # Separate with a line feed, so the unprefixed part is only used as
4707 # a tiebreaker when two pages have the exact same prefix.
4708 # In UCA, tab is the only character that can sort above LF
4709 # so we strip both of them from the original prefix.
4710 $prefix = strtr( $prefix, "\n\t", ' ' );
4711 return "$prefix\n$unprefixed";
4712 }
4713 return $unprefixed;
4714 }
4715
4716 /**
4717 * Get the language in which the content of this page is written in
4718 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4719 * e.g. $wgLang (such as special pages, which are in the user language).
4720 *
4721 * @since 1.18
4722 * @return Language
4723 */
4724 public function getPageLanguage() {
4725 global $wgLang;
4726 if ( $this->isSpecialPage() ) {
4727 // special pages are in the user language
4728 return $wgLang;
4729 }
4730
4731 //TODO: use the LinkCache to cache this! Note that this may depend on user settings, so the cache should be only per-request.
4732 //NOTE: ContentHandler::getPageLanguage() may need to load the content to determine the page language!
4733 $contentHandler = ContentHandler::getForTitle( $this );
4734 $pageLang = $contentHandler->getPageLanguage( $this );
4735
4736 return wfGetLangObj( $pageLang );
4737 }
4738
4739 /**
4740 * Get the language in which the content of this page is written when
4741 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4742 * e.g. $wgLang (such as special pages, which are in the user language).
4743 *
4744 * @since 1.20
4745 * @return Language
4746 */
4747 public function getPageViewLanguage() {
4748 global $wgLang;
4749
4750 if ( $this->isSpecialPage() ) {
4751 // If the user chooses a variant, the content is actually
4752 // in a language whose code is the variant code.
4753 $variant = $wgLang->getPreferredVariant();
4754 if ( $wgLang->getCode() !== $variant ) {
4755 return Language::factory( $variant );
4756 }
4757
4758 return $wgLang;
4759 }
4760
4761 //NOTE: can't be cached persistently, depends on user settings
4762 //NOTE: ContentHandler::getPageViewLanguage() may need to load the content to determine the page language!
4763 $contentHandler = ContentHandler::getForTitle( $this );
4764 $pageLang = $contentHandler->getPageViewLanguage( $this );
4765 return $pageLang;
4766 }
4767
4768 /**
4769 * Get a list of rendered edit notices for this page.
4770 *
4771 * Array is keyed by the original message key, and values are rendered using parseAsBlock, so
4772 * they will already be wrapped in paragraphs.
4773 *
4774 * @since 1.21
4775 * @return Array
4776 */
4777 public function getEditNotices() {
4778 $notices = array();
4779
4780 # Optional notices on a per-namespace and per-page basis
4781 $editnotice_ns = 'editnotice-' . $this->getNamespace();
4782 $editnotice_ns_message = wfMessage( $editnotice_ns );
4783 if ( $editnotice_ns_message->exists() ) {
4784 $notices[$editnotice_ns] = $editnotice_ns_message->parseAsBlock();
4785 }
4786 if ( MWNamespace::hasSubpages( $this->getNamespace() ) ) {
4787 $parts = explode( '/', $this->getDBkey() );
4788 $editnotice_base = $editnotice_ns;
4789 while ( count( $parts ) > 0 ) {
4790 $editnotice_base .= '-' . array_shift( $parts );
4791 $editnotice_base_msg = wfMessage( $editnotice_base );
4792 if ( $editnotice_base_msg->exists() ) {
4793 $notices[$editnotice_base] = $editnotice_base_msg->parseAsBlock();
4794 }
4795 }
4796 } else {
4797 # Even if there are no subpages in namespace, we still don't want / in MW ns.
4798 $editnoticeText = $editnotice_ns . '-' . str_replace( '/', '-', $this->getDBkey() );
4799 $editnoticeMsg = wfMessage( $editnoticeText );
4800 if ( $editnoticeMsg->exists() ) {
4801 $notices[$editnoticeText] = $editnoticeMsg->parseAsBlock();
4802 }
4803 }
4804 return $notices;
4805 }
4806 }