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