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