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