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