fea8588bd733855f20bdedf56197a64ec40a621f
[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 array_pop( $titles );
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 ) === 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 ( $user->isBlockedFrom( $this ) && $action != 'read' && $action != 'createaccount' ) {
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 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1162 */
1163 private function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true ) {
1164 wfProfileIn( __METHOD__ );
1165
1166 $errors = array();
1167
1168 // Use getUserPermissionsErrors instead
1169 if( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1170 wfProfileOut( __METHOD__ );
1171 return $result ? array() : array( array( 'badaccess-group0' ) );
1172 }
1173
1174 if( !wfRunHooks( 'getUserPermissionsErrors', array(&$this,&$user,$action,&$result) ) ) {
1175 if( is_array($result) && count($result) && !is_array($result[0]) )
1176 $errors[] = $result; # A single array representing an error
1177 else if( is_array($result) && is_array($result[0]) )
1178 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1179 else if( $result !== '' && is_string($result) )
1180 $errors[] = array($result); # A string representing a message-id
1181 else if( $result === false )
1182 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1183 }
1184 if( $doExpensiveQueries && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array(&$this,&$user,$action,&$result) ) ) {
1185 if( is_array($result) && count($result) && !is_array($result[0]) )
1186 $errors[] = $result; # A single array representing an error
1187 else if( is_array($result) && is_array($result[0]) )
1188 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1189 else if( $result !== '' && is_string($result) )
1190 $errors[] = array($result); # A string representing a message-id
1191 else if( $result === false )
1192 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1193 }
1194
1195 // TODO: document
1196 $specialOKActions = array( 'createaccount', 'execute' );
1197 if( NS_SPECIAL == $this->mNamespace && !in_array( $action, $specialOKActions) ) {
1198 $errors[] = array('ns-specialprotected');
1199 }
1200
1201 if( $this->isNamespaceProtected() ) {
1202 $ns = $this->getNamespace() == NS_MAIN ?
1203 wfMsg( 'nstab-main' ) : $this->getNsText();
1204 $errors[] = NS_MEDIAWIKI == $this->mNamespace ?
1205 array('protectedinterface') : array( 'namespaceprotected', $ns );
1206 }
1207
1208 # protect css/js subpages of user pages
1209 # XXX: this might be better using restrictions
1210 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1211 if( $this->isCssJsSubpage() && !$user->isAllowed('editusercssjs')
1212 && !preg_match('/^'.preg_quote($user->getName(), '/').'\//', $this->mTextform) )
1213 {
1214 $errors[] = array('customcssjsprotected');
1215 }
1216
1217 if( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1218 # We /could/ use the protection level on the source page, but it's fairly ugly
1219 # as we have to establish a precedence hierarchy for pages included by multiple
1220 # cascade-protected pages. So just restrict it to people with 'protect' permission,
1221 # as they could remove the protection anyway.
1222 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1223 # Cascading protection depends on more than this page...
1224 # Several cascading protected pages may include this page...
1225 # Check each cascading level
1226 # This is only for protection restrictions, not for all actions
1227 if( $cascadingSources > 0 && isset($restrictions[$action]) ) {
1228 foreach( $restrictions[$action] as $right ) {
1229 $right = ( $right == 'sysop' ) ? 'protect' : $right;
1230 if( '' != $right && !$user->isAllowed( $right ) ) {
1231 $pages = '';
1232 foreach( $cascadingSources as $page )
1233 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1234 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1235 }
1236 }
1237 }
1238 }
1239
1240 foreach( $this->getRestrictions($action) as $right ) {
1241 // Backwards compatibility, rewrite sysop -> protect
1242 if( $right == 'sysop' ) {
1243 $right = 'protect';
1244 }
1245 if( '' != $right && !$user->isAllowed( $right ) ) {
1246 // Users with 'editprotected' permission can edit protected pages
1247 if( $action=='edit' && $user->isAllowed( 'editprotected' ) ) {
1248 // Users with 'editprotected' permission cannot edit protected pages
1249 // with cascading option turned on.
1250 if( $this->mCascadeRestriction ) {
1251 $errors[] = array( 'protectedpagetext', $right );
1252 } else {
1253 // Nothing, user can edit!
1254 }
1255 } else {
1256 $errors[] = array( 'protectedpagetext', $right );
1257 }
1258 }
1259 }
1260
1261 if( $action == 'protect' ) {
1262 if( $this->getUserPermissionsErrors('edit', $user) != array() ) {
1263 $errors[] = array( 'protect-cantedit' ); // If they can't edit, they shouldn't protect.
1264 }
1265 }
1266
1267 if( $action == 'create' ) {
1268 $title_protection = $this->getTitleProtection();
1269 if( is_array($title_protection) ) {
1270 extract($title_protection); // is this extract() really needed?
1271
1272 if( $pt_create_perm == 'sysop' ) {
1273 $pt_create_perm = 'protect'; // B/C
1274 }
1275 if( $pt_create_perm == '' || !$user->isAllowed($pt_create_perm) ) {
1276 $errors[] = array( 'titleprotected', User::whoIs($pt_user), $pt_reason );
1277 }
1278 }
1279
1280 if( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1281 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) )
1282 {
1283 $errors[] = $user->isAnon() ? array ('nocreatetext') : array ('nocreate-loggedin');
1284 }
1285 } elseif( $action == 'move' ) {
1286 if( !$user->isAllowed( 'move' ) ) {
1287 // User can't move anything
1288 $errors[] = $user->isAnon() ? array ( 'movenologintext' ) : array ('movenotallowed');
1289 } elseif( !$user->isAllowed( 'move-rootuserpages' )
1290 && $this->getNamespace() == NS_USER && !$this->isSubpage() )
1291 {
1292 // Show user page-specific message only if the user can move other pages
1293 $errors[] = array( 'cant-move-user-page' );
1294 }
1295 // Check if user is allowed to move files if it's a file
1296 if( $this->getNamespace() == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
1297 $errors[] = array( 'movenotallowedfile' );
1298 }
1299 // Check for immobile pages
1300 if( !MWNamespace::isMovable( $this->getNamespace() ) ) {
1301 // Specific message for this case
1302 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1303 } elseif( !$this->isMovable() ) {
1304 // Less specific message for rarer cases
1305 $errors[] = array( 'immobile-page' );
1306 }
1307 } elseif( $action == 'move-target' ) {
1308 if( !$user->isAllowed( 'move' ) ) {
1309 // User can't move anything
1310 $errors[] = $user->isAnon() ? array ( 'movenologintext' ) : array ('movenotallowed');
1311 } elseif( !$user->isAllowed( 'move-rootuserpages' )
1312 && $this->getNamespace() == NS_USER && !$this->isSubpage() )
1313 {
1314 // Show user page-specific message only if the user can move other pages
1315 $errors[] = array( 'cant-move-to-user-page' );
1316 }
1317 if( !MWNamespace::isMovable( $this->getNamespace() ) ) {
1318 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1319 } elseif( !$this->isMovable() ) {
1320 $errors[] = array( 'immobile-target-page' );
1321 }
1322 } elseif( !$user->isAllowed( $action ) ) {
1323 $return = null;
1324 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1325 User::getGroupsWithPermission( $action ) );
1326 if( $groups ) {
1327 $return = array( 'badaccess-groups',
1328 array( implode( ', ', $groups ), count( $groups ) ) );
1329 } else {
1330 $return = array( "badaccess-group0" );
1331 }
1332 $errors[] = $return;
1333 }
1334
1335 wfProfileOut( __METHOD__ );
1336 return $errors;
1337 }
1338
1339 /**
1340 * Is this title subject to title protection?
1341 * @return \type{\mixed} An associative array representing any existent title
1342 * protection, or false if there's none.
1343 */
1344 private function getTitleProtection() {
1345 // Can't protect pages in special namespaces
1346 if ( $this->getNamespace() < 0 ) {
1347 return false;
1348 }
1349
1350 $dbr = wfGetDB( DB_SLAVE );
1351 $res = $dbr->select( 'protected_titles', '*',
1352 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1353 __METHOD__ );
1354
1355 if ($row = $dbr->fetchRow( $res )) {
1356 return $row;
1357 } else {
1358 return false;
1359 }
1360 }
1361
1362 /**
1363 * Update the title protection status
1364 * @param $create_perm \type{\string} Permission required for creation
1365 * @param $reason \type{\string} Reason for protection
1366 * @param $expiry \type{\string} Expiry timestamp
1367 */
1368 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1369 global $wgUser,$wgContLang;
1370
1371 if ($create_perm == implode(',',$this->getRestrictions('create'))
1372 && $expiry == $this->mRestrictionsExpiry['create']) {
1373 // No change
1374 return true;
1375 }
1376
1377 list ($namespace, $title) = array( $this->getNamespace(), $this->getDBkey() );
1378
1379 $dbw = wfGetDB( DB_MASTER );
1380
1381 $encodedExpiry = Block::encodeExpiry($expiry, $dbw );
1382
1383 $expiry_description = '';
1384 if ( $encodedExpiry != 'infinity' ) {
1385 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ) , $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ).')';
1386 }
1387 else {
1388 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ).')';
1389 }
1390
1391 # Update protection table
1392 if ($create_perm != '' ) {
1393 $dbw->replace( 'protected_titles', array(array('pt_namespace', 'pt_title')),
1394 array( 'pt_namespace' => $namespace, 'pt_title' => $title
1395 , 'pt_create_perm' => $create_perm
1396 , 'pt_timestamp' => Block::encodeExpiry(wfTimestampNow(), $dbw)
1397 , 'pt_expiry' => $encodedExpiry
1398 , 'pt_user' => $wgUser->getId(), 'pt_reason' => $reason ), __METHOD__ );
1399 } else {
1400 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1401 'pt_title' => $title ), __METHOD__ );
1402 }
1403 # Update the protection log
1404 $log = new LogPage( 'protect' );
1405
1406 if( $create_perm ) {
1407 $params = array("[create=$create_perm] $expiry_description",'');
1408 $log->addEntry( $this->mRestrictions['create'] ? 'modify' : 'protect', $this, trim( $reason ), $params );
1409 } else {
1410 $log->addEntry( 'unprotect', $this, $reason );
1411 }
1412
1413 return true;
1414 }
1415
1416 /**
1417 * Remove any title protection due to page existing
1418 */
1419 public function deleteTitleProtection() {
1420 $dbw = wfGetDB( DB_MASTER );
1421
1422 $dbw->delete( 'protected_titles',
1423 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1424 __METHOD__ );
1425 }
1426
1427 /**
1428 * Can $wgUser edit this page?
1429 * @return \type{\bool} TRUE or FALSE
1430 * @deprecated use userCan('edit')
1431 */
1432 public function userCanEdit( $doExpensiveQueries = true ) {
1433 return $this->userCan( 'edit', $doExpensiveQueries );
1434 }
1435
1436 /**
1437 * Can $wgUser create this page?
1438 * @return \type{\bool} TRUE or FALSE
1439 * @deprecated use userCan('create')
1440 */
1441 public function userCanCreate( $doExpensiveQueries = true ) {
1442 return $this->userCan( 'create', $doExpensiveQueries );
1443 }
1444
1445 /**
1446 * Can $wgUser move this page?
1447 * @return \type{\bool} TRUE or FALSE
1448 * @deprecated use userCan('move')
1449 */
1450 public function userCanMove( $doExpensiveQueries = true ) {
1451 return $this->userCan( 'move', $doExpensiveQueries );
1452 }
1453
1454 /**
1455 * Would anybody with sufficient privileges be able to move this page?
1456 * Some pages just aren't movable.
1457 *
1458 * @return \type{\bool} TRUE or FALSE
1459 */
1460 public function isMovable() {
1461 return MWNamespace::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
1462 }
1463
1464 /**
1465 * Can $wgUser read this page?
1466 * @return \type{\bool} TRUE or FALSE
1467 * @todo fold these checks into userCan()
1468 */
1469 public function userCanRead() {
1470 global $wgUser, $wgGroupPermissions;
1471
1472 $result = null;
1473 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1474 if ( $result !== null ) {
1475 return $result;
1476 }
1477
1478 # Shortcut for public wikis, allows skipping quite a bit of code
1479 if ($wgGroupPermissions['*']['read'])
1480 return true;
1481
1482 if( $wgUser->isAllowed( 'read' ) ) {
1483 return true;
1484 } else {
1485 global $wgWhitelistRead;
1486
1487 /**
1488 * Always grant access to the login page.
1489 * Even anons need to be able to log in.
1490 */
1491 if( $this->isSpecial( 'Userlogin' ) || $this->isSpecial( 'Resetpass' ) ) {
1492 return true;
1493 }
1494
1495 /**
1496 * Bail out if there isn't whitelist
1497 */
1498 if( !is_array($wgWhitelistRead) ) {
1499 return false;
1500 }
1501
1502 /**
1503 * Check for explicit whitelisting
1504 */
1505 $name = $this->getPrefixedText();
1506 $dbName = $this->getPrefixedDBKey();
1507 // Check with and without underscores
1508 if( in_array($name,$wgWhitelistRead,true) || in_array($dbName,$wgWhitelistRead,true) )
1509 return true;
1510
1511 /**
1512 * Old settings might have the title prefixed with
1513 * a colon for main-namespace pages
1514 */
1515 if( $this->getNamespace() == NS_MAIN ) {
1516 if( in_array( ':' . $name, $wgWhitelistRead ) )
1517 return true;
1518 }
1519
1520 /**
1521 * If it's a special page, ditch the subpage bit
1522 * and check again
1523 */
1524 if( $this->getNamespace() == NS_SPECIAL ) {
1525 $name = $this->getDBkey();
1526 list( $name, /* $subpage */) = SpecialPage::resolveAliasWithSubpage( $name );
1527 if ( $name === false ) {
1528 # Invalid special page, but we show standard login required message
1529 return false;
1530 }
1531
1532 $pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
1533 if( in_array( $pure, $wgWhitelistRead, true ) )
1534 return true;
1535 }
1536
1537 }
1538 return false;
1539 }
1540
1541 /**
1542 * Is this a talk page of some sort?
1543 * @return \type{\bool} TRUE or FALSE
1544 */
1545 public function isTalkPage() {
1546 return MWNamespace::isTalk( $this->getNamespace() );
1547 }
1548
1549 /**
1550 * Is this a subpage?
1551 * @return \type{\bool} TRUE or FALSE
1552 */
1553 public function isSubpage() {
1554 return MWNamespace::hasSubpages( $this->mNamespace )
1555 ? strpos( $this->getText(), '/' ) !== false
1556 : false;
1557 }
1558
1559 /**
1560 * Does this have subpages? (Warning, usually requires an extra DB query.)
1561 * @return \type{\bool} TRUE or FALSE
1562 */
1563 public function hasSubpages() {
1564 if( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
1565 # Duh
1566 return false;
1567 }
1568
1569 # We dynamically add a member variable for the purpose of this method
1570 # alone to cache the result. There's no point in having it hanging
1571 # around uninitialized in every Title object; therefore we only add it
1572 # if needed and don't declare it statically.
1573 if( isset( $this->mHasSubpages ) ) {
1574 return $this->mHasSubpages;
1575 }
1576
1577 $db = wfGetDB( DB_SLAVE );
1578 return $this->mHasSubpages = (bool)$db->selectField( 'page', '1',
1579 "page_namespace = {$this->mNamespace} AND page_title LIKE '"
1580 . $db->escapeLike( $this->mDbkeyform ) . "/%'",
1581 __METHOD__
1582 );
1583 }
1584
1585 /**
1586 * Could this page contain custom CSS or JavaScript, based
1587 * on the title?
1588 *
1589 * @return \type{\bool} TRUE or FALSE
1590 */
1591 public function isCssOrJsPage() {
1592 return $this->mNamespace == NS_MEDIAWIKI
1593 && preg_match( '!\.(?:css|js)$!u', $this->mTextform ) > 0;
1594 }
1595
1596 /**
1597 * Is this a .css or .js subpage of a user page?
1598 * @return \type{\bool} TRUE or FALSE
1599 */
1600 public function isCssJsSubpage() {
1601 return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.(?:css|js)$/", $this->mTextform ) );
1602 }
1603 /**
1604 * Is this a *valid* .css or .js subpage of a user page?
1605 * Check that the corresponding skin exists
1606 * @return \type{\bool} TRUE or FALSE
1607 */
1608 public function isValidCssJsSubpage() {
1609 if ( $this->isCssJsSubpage() ) {
1610 $skinNames = Skin::getSkinNames();
1611 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1612 } else {
1613 return false;
1614 }
1615 }
1616 /**
1617 * Trim down a .css or .js subpage title to get the corresponding skin name
1618 */
1619 public function getSkinFromCssJsSubpage() {
1620 $subpage = explode( '/', $this->mTextform );
1621 $subpage = $subpage[ count( $subpage ) - 1 ];
1622 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1623 }
1624 /**
1625 * Is this a .css subpage of a user page?
1626 * @return \type{\bool} TRUE or FALSE
1627 */
1628 public function isCssSubpage() {
1629 return ( NS_USER == $this->mNamespace && preg_match("/\\/.*\\.css$/", $this->mTextform ) );
1630 }
1631 /**
1632 * Is this a .js subpage of a user page?
1633 * @return \type{\bool} TRUE or FALSE
1634 */
1635 public function isJsSubpage() {
1636 return ( NS_USER == $this->mNamespace && preg_match("/\\/.*\\.js$/", $this->mTextform ) );
1637 }
1638 /**
1639 * Protect css/js subpages of user pages: can $wgUser edit
1640 * this page?
1641 *
1642 * @return \type{\bool} TRUE or FALSE
1643 * @todo XXX: this might be better using restrictions
1644 */
1645 public function userCanEditCssJsSubpage() {
1646 global $wgUser;
1647 return ( $wgUser->isAllowed('editusercssjs') || preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) );
1648 }
1649
1650 /**
1651 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1652 *
1653 * @return \type{\bool} If the page is subject to cascading restrictions.
1654 */
1655 public function isCascadeProtected() {
1656 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1657 return ( $sources > 0 );
1658 }
1659
1660 /**
1661 * Cascading protection: Get the source of any cascading restrictions on this page.
1662 *
1663 * @param $get_pages \type{\bool} Whether or not to retrieve the actual pages that the restrictions have come from.
1664 * @return \type{\arrayof{mixed title array, restriction array}} Array of the Title objects of the pages from
1665 * which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set.
1666 * The restriction array is an array of each type, each of which contains an array of unique groups.
1667 */
1668 public function getCascadeProtectionSources( $get_pages = true ) {
1669 global $wgRestrictionTypes;
1670
1671 # Define our dimension of restrictions types
1672 $pagerestrictions = array();
1673 foreach( $wgRestrictionTypes as $action )
1674 $pagerestrictions[$action] = array();
1675
1676 if ( isset( $this->mCascadeSources ) && $get_pages ) {
1677 return array( $this->mCascadeSources, $this->mCascadingRestrictions );
1678 } else if ( isset( $this->mHasCascadingRestrictions ) && !$get_pages ) {
1679 return array( $this->mHasCascadingRestrictions, $pagerestrictions );
1680 }
1681
1682 wfProfileIn( __METHOD__ );
1683
1684 $dbr = wfGetDB( DB_SLAVE );
1685
1686 if ( $this->getNamespace() == NS_FILE ) {
1687 $tables = array ('imagelinks', 'page_restrictions');
1688 $where_clauses = array(
1689 'il_to' => $this->getDBkey(),
1690 'il_from=pr_page',
1691 'pr_cascade' => 1 );
1692 } else {
1693 $tables = array ('templatelinks', 'page_restrictions');
1694 $where_clauses = array(
1695 'tl_namespace' => $this->getNamespace(),
1696 'tl_title' => $this->getDBkey(),
1697 'tl_from=pr_page',
1698 'pr_cascade' => 1 );
1699 }
1700
1701 if ( $get_pages ) {
1702 $cols = array('pr_page', 'page_namespace', 'page_title', 'pr_expiry', 'pr_type', 'pr_level' );
1703 $where_clauses[] = 'page_id=pr_page';
1704 $tables[] = 'page';
1705 } else {
1706 $cols = array( 'pr_expiry' );
1707 }
1708
1709 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
1710
1711 $sources = $get_pages ? array() : false;
1712 $now = wfTimestampNow();
1713 $purgeExpired = false;
1714
1715 foreach( $res as $row ) {
1716 $expiry = Block::decodeExpiry( $row->pr_expiry );
1717 if( $expiry > $now ) {
1718 if ($get_pages) {
1719 $page_id = $row->pr_page;
1720 $page_ns = $row->page_namespace;
1721 $page_title = $row->page_title;
1722 $sources[$page_id] = Title::makeTitle($page_ns, $page_title);
1723 # Add groups needed for each restriction type if its not already there
1724 # Make sure this restriction type still exists
1725 if ( isset($pagerestrictions[$row->pr_type]) && !in_array($row->pr_level, $pagerestrictions[$row->pr_type]) ) {
1726 $pagerestrictions[$row->pr_type][]=$row->pr_level;
1727 }
1728 } else {
1729 $sources = true;
1730 }
1731 } else {
1732 // Trigger lazy purge of expired restrictions from the db
1733 $purgeExpired = true;
1734 }
1735 }
1736 if( $purgeExpired ) {
1737 Title::purgeExpiredRestrictions();
1738 }
1739
1740 wfProfileOut( __METHOD__ );
1741
1742 if ( $get_pages ) {
1743 $this->mCascadeSources = $sources;
1744 $this->mCascadingRestrictions = $pagerestrictions;
1745 } else {
1746 $this->mHasCascadingRestrictions = $sources;
1747 }
1748 return array( $sources, $pagerestrictions );
1749 }
1750
1751 function areRestrictionsCascading() {
1752 if (!$this->mRestrictionsLoaded) {
1753 $this->loadRestrictions();
1754 }
1755
1756 return $this->mCascadeRestriction;
1757 }
1758
1759 /**
1760 * Loads a string into mRestrictions array
1761 * @param $res \type{Resource} restrictions as an SQL result.
1762 */
1763 private function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) {
1764 global $wgRestrictionTypes;
1765 $dbr = wfGetDB( DB_SLAVE );
1766
1767 foreach( $wgRestrictionTypes as $type ){
1768 $this->mRestrictions[$type] = array();
1769 $this->mRestrictionsExpiry[$type] = Block::decodeExpiry('');
1770 }
1771
1772 $this->mCascadeRestriction = false;
1773
1774 # Backwards-compatibility: also load the restrictions from the page record (old format).
1775
1776 if ( $oldFashionedRestrictions === NULL ) {
1777 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
1778 array( 'page_id' => $this->getArticleId() ), __METHOD__ );
1779 }
1780
1781 if ($oldFashionedRestrictions != '') {
1782
1783 foreach( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
1784 $temp = explode( '=', trim( $restrict ) );
1785 if(count($temp) == 1) {
1786 // old old format should be treated as edit/move restriction
1787 $this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
1788 $this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
1789 } else {
1790 $this->mRestrictions[$temp[0]] = explode( ',', trim( $temp[1] ) );
1791 }
1792 }
1793
1794 $this->mOldRestrictions = true;
1795
1796 }
1797
1798 if( $dbr->numRows( $res ) ) {
1799 # Current system - load second to make them override.
1800 $now = wfTimestampNow();
1801 $purgeExpired = false;
1802
1803 foreach( $res as $row ) {
1804 # Cycle through all the restrictions.
1805
1806 // Don't take care of restrictions types that aren't in $wgRestrictionTypes
1807 if( !in_array( $row->pr_type, $wgRestrictionTypes ) )
1808 continue;
1809
1810 // This code should be refactored, now that it's being used more generally,
1811 // But I don't really see any harm in leaving it in Block for now -werdna
1812 $expiry = Block::decodeExpiry( $row->pr_expiry );
1813
1814 // Only apply the restrictions if they haven't expired!
1815 if ( !$expiry || $expiry > $now ) {
1816 $this->mRestrictionsExpiry[$row->pr_type] = $expiry;
1817 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
1818
1819 $this->mCascadeRestriction |= $row->pr_cascade;
1820 } else {
1821 // Trigger a lazy purge of expired restrictions
1822 $purgeExpired = true;
1823 }
1824 }
1825
1826 if( $purgeExpired ) {
1827 Title::purgeExpiredRestrictions();
1828 }
1829 }
1830
1831 $this->mRestrictionsLoaded = true;
1832 }
1833
1834 /**
1835 * Load restrictions from the page_restrictions table
1836 */
1837 public function loadRestrictions( $oldFashionedRestrictions = NULL ) {
1838 if( !$this->mRestrictionsLoaded ) {
1839 if ($this->exists()) {
1840 $dbr = wfGetDB( DB_SLAVE );
1841
1842 $res = $dbr->select( 'page_restrictions', '*',
1843 array ( 'pr_page' => $this->getArticleId() ), __METHOD__ );
1844
1845 $this->loadRestrictionsFromRow( $res, $oldFashionedRestrictions );
1846 } else {
1847 $title_protection = $this->getTitleProtection();
1848
1849 if (is_array($title_protection)) {
1850 extract($title_protection);
1851
1852 $now = wfTimestampNow();
1853 $expiry = Block::decodeExpiry($pt_expiry);
1854
1855 if (!$expiry || $expiry > $now) {
1856 // Apply the restrictions
1857 $this->mRestrictionsExpiry['create'] = $expiry;
1858 $this->mRestrictions['create'] = explode(',', trim($pt_create_perm) );
1859 } else { // Get rid of the old restrictions
1860 Title::purgeExpiredRestrictions();
1861 }
1862 } else {
1863 $this->mRestrictionsExpiry['create'] = Block::decodeExpiry('');
1864 }
1865 $this->mRestrictionsLoaded = true;
1866 }
1867 }
1868 }
1869
1870 /**
1871 * Purge expired restrictions from the page_restrictions table
1872 */
1873 static function purgeExpiredRestrictions() {
1874 $dbw = wfGetDB( DB_MASTER );
1875 $dbw->delete( 'page_restrictions',
1876 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1877 __METHOD__ );
1878
1879 $dbw->delete( 'protected_titles',
1880 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1881 __METHOD__ );
1882 }
1883
1884 /**
1885 * Accessor/initialisation for mRestrictions
1886 *
1887 * @param $action \type{\string} action that permission needs to be checked for
1888 * @return \type{\arrayof{\string}} the array of groups allowed to edit this article
1889 */
1890 public function getRestrictions( $action ) {
1891 if( !$this->mRestrictionsLoaded ) {
1892 $this->loadRestrictions();
1893 }
1894 return isset( $this->mRestrictions[$action] )
1895 ? $this->mRestrictions[$action]
1896 : array();
1897 }
1898
1899 /**
1900 * Get the expiry time for the restriction against a given action
1901 * @return 14-char timestamp, or 'infinity' if the page is protected forever
1902 * or not protected at all, or false if the action is not recognised.
1903 */
1904 public function getRestrictionExpiry( $action ) {
1905 if( !$this->mRestrictionsLoaded ) {
1906 $this->loadRestrictions();
1907 }
1908 return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
1909 }
1910
1911 /**
1912 * Is there a version of this page in the deletion archive?
1913 * @return \type{\int} the number of archived revisions
1914 */
1915 public function isDeleted() {
1916 $fname = 'Title::isDeleted';
1917 if ( $this->getNamespace() < 0 ) {
1918 $n = 0;
1919 } else {
1920 $dbr = wfGetDB( DB_SLAVE );
1921 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1922 'ar_title' => $this->getDBkey() ), $fname );
1923 if( $this->getNamespace() == NS_FILE ) {
1924 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
1925 array( 'fa_name' => $this->getDBkey() ), $fname );
1926 }
1927 }
1928 return (int)$n;
1929 }
1930
1931 /**
1932 * Get the article ID for this Title from the link cache,
1933 * adding it if necessary
1934 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select
1935 * for update
1936 * @return \type{\int} the ID
1937 */
1938 public function getArticleID( $flags = 0 ) {
1939 if( $this->getNamespace() < 0 ) {
1940 return $this->mArticleID = 0;
1941 }
1942 $linkCache = LinkCache::singleton();
1943 if( $flags & GAID_FOR_UPDATE ) {
1944 $oldUpdate = $linkCache->forUpdate( true );
1945 $linkCache->clearLink( $this );
1946 $this->mArticleID = $linkCache->addLinkObj( $this );
1947 $linkCache->forUpdate( $oldUpdate );
1948 } else {
1949 if( -1 == $this->mArticleID ) {
1950 $this->mArticleID = $linkCache->addLinkObj( $this );
1951 }
1952 }
1953 return $this->mArticleID;
1954 }
1955
1956 /**
1957 * Is this an article that is a redirect page?
1958 * Uses link cache, adding it if necessary
1959 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1960 * @return \type{\bool}
1961 */
1962 public function isRedirect( $flags = 0 ) {
1963 if( !is_null($this->mRedirect) )
1964 return $this->mRedirect;
1965 # Calling getArticleID() loads the field from cache as needed
1966 if( !$this->getArticleID($flags) ) {
1967 return $this->mRedirect = false;
1968 }
1969 $linkCache = LinkCache::singleton();
1970 $this->mRedirect = (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
1971
1972 return $this->mRedirect;
1973 }
1974
1975 /**
1976 * What is the length of this page?
1977 * Uses link cache, adding it if necessary
1978 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1979 * @return \type{\bool}
1980 */
1981 public function getLength( $flags = 0 ) {
1982 if( $this->mLength != -1 )
1983 return $this->mLength;
1984 # Calling getArticleID() loads the field from cache as needed
1985 if( !$this->getArticleID($flags) ) {
1986 return $this->mLength = 0;
1987 }
1988 $linkCache = LinkCache::singleton();
1989 $this->mLength = intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
1990
1991 return $this->mLength;
1992 }
1993
1994 /**
1995 * What is the page_latest field for this page?
1996 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
1997 * @return \type{\int}
1998 */
1999 public function getLatestRevID( $flags = 0 ) {
2000 if( $this->mLatestID !== false )
2001 return $this->mLatestID;
2002
2003 $db = ($flags & GAID_FOR_UPDATE) ? wfGetDB(DB_MASTER) : wfGetDB(DB_SLAVE);
2004 $this->mLatestID = $db->selectField( 'page', 'page_latest', $this->pageCond(), __METHOD__ );
2005 return $this->mLatestID;
2006 }
2007
2008 /**
2009 * This clears some fields in this object, and clears any associated
2010 * keys in the "bad links" section of the link cache.
2011 *
2012 * - This is called from Article::insertNewArticle() to allow
2013 * loading of the new page_id. It's also called from
2014 * Article::doDeleteArticle()
2015 *
2016 * @param $newid \type{\int} the new Article ID
2017 */
2018 public function resetArticleID( $newid ) {
2019 $linkCache = LinkCache::singleton();
2020 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2021
2022 if ( 0 == $newid ) { $this->mArticleID = -1; }
2023 else { $this->mArticleID = $newid; }
2024 $this->mRestrictionsLoaded = false;
2025 $this->mRestrictions = array();
2026 }
2027
2028 /**
2029 * Updates page_touched for this page; called from LinksUpdate.php
2030 * @return \type{\bool} true if the update succeded
2031 */
2032 public function invalidateCache() {
2033 if( wfReadOnly() ) {
2034 return;
2035 }
2036 $dbw = wfGetDB( DB_MASTER );
2037 $success = $dbw->update( 'page',
2038 array( 'page_touched' => $dbw->timestamp() ),
2039 $this->pageCond(),
2040 __METHOD__
2041 );
2042 HTMLFileCache::clearFileCache( $this );
2043 return $success;
2044 }
2045
2046 /**
2047 * Prefix some arbitrary text with the namespace or interwiki prefix
2048 * of this object
2049 *
2050 * @param $name \type{\string} the text
2051 * @return \type{\string} the prefixed text
2052 * @private
2053 */
2054 /* private */ function prefix( $name ) {
2055 $p = '';
2056 if ( '' != $this->mInterwiki ) {
2057 $p = $this->mInterwiki . ':';
2058 }
2059 if ( 0 != $this->mNamespace ) {
2060 $p .= $this->getNsText() . ':';
2061 }
2062 return $p . $name;
2063 }
2064
2065 /**
2066 * Secure and split - main initialisation function for this object
2067 *
2068 * Assumes that mDbkeyform has been set, and is urldecoded
2069 * and uses underscores, but not otherwise munged. This function
2070 * removes illegal characters, splits off the interwiki and
2071 * namespace prefixes, sets the other forms, and canonicalizes
2072 * everything.
2073 * @return \type{\bool} true on success
2074 */
2075 private function secureAndSplit() {
2076 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
2077
2078 # Initialisation
2079 static $rxTc = false;
2080 if( !$rxTc ) {
2081 # Matching titles will be held as illegal.
2082 $rxTc = '/' .
2083 # Any character not allowed is forbidden...
2084 '[^' . Title::legalChars() . ']' .
2085 # URL percent encoding sequences interfere with the ability
2086 # to round-trip titles -- you can't link to them consistently.
2087 '|%[0-9A-Fa-f]{2}' .
2088 # XML/HTML character references produce similar issues.
2089 '|&[A-Za-z0-9\x80-\xff]+;' .
2090 '|&#[0-9]+;' .
2091 '|&#x[0-9A-Fa-f]+;' .
2092 '/S';
2093 }
2094
2095 $this->mInterwiki = $this->mFragment = '';
2096 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
2097
2098 $dbkey = $this->mDbkeyform;
2099
2100 # Strip Unicode bidi override characters.
2101 # Sometimes they slip into cut-n-pasted page titles, where the
2102 # override chars get included in list displays.
2103 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2104
2105 # Clean up whitespace
2106 #
2107 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
2108 $dbkey = trim( $dbkey, '_' );
2109
2110 if ( '' == $dbkey ) {
2111 return false;
2112 }
2113
2114 if( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
2115 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2116 return false;
2117 }
2118
2119 $this->mDbkeyform = $dbkey;
2120
2121 # Initial colon indicates main namespace rather than specified default
2122 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2123 if ( ':' == $dbkey{0} ) {
2124 $this->mNamespace = NS_MAIN;
2125 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2126 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2127 }
2128
2129 # Namespace or interwiki prefix
2130 $firstPass = true;
2131 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2132 do {
2133 $m = array();
2134 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2135 $p = $m[1];
2136 if ( $ns = $wgContLang->getNsIndex( $p ) ) {
2137 # Ordinary namespace
2138 $dbkey = $m[2];
2139 $this->mNamespace = $ns;
2140 # For Talk:X pages, check if X has a "namespace" prefix
2141 if( $ns == NS_TALK && preg_match( $prefixRegexp, $dbkey, $x ) ) {
2142 if( $wgContLang->getNsIndex( $x[1] ) )
2143 return false; # Disallow Talk:File:x type titles...
2144 else if( Interwiki::isValidInterwiki( $x[1] ) )
2145 return false; # Disallow Talk:Interwiki:x type titles...
2146 }
2147 } elseif( Interwiki::isValidInterwiki( $p ) ) {
2148 if( !$firstPass ) {
2149 # Can't make a local interwiki link to an interwiki link.
2150 # That's just crazy!
2151 return false;
2152 }
2153
2154 # Interwiki link
2155 $dbkey = $m[2];
2156 $this->mInterwiki = $wgContLang->lc( $p );
2157
2158 # Redundant interwiki prefix to the local wiki
2159 if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
2160 if( $dbkey == '' ) {
2161 # Can't have an empty self-link
2162 return false;
2163 }
2164 $this->mInterwiki = '';
2165 $firstPass = false;
2166 # Do another namespace split...
2167 continue;
2168 }
2169
2170 # If there's an initial colon after the interwiki, that also
2171 # resets the default namespace
2172 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2173 $this->mNamespace = NS_MAIN;
2174 $dbkey = substr( $dbkey, 1 );
2175 }
2176 }
2177 # If there's no recognized interwiki or namespace,
2178 # then let the colon expression be part of the title.
2179 }
2180 break;
2181 } while( true );
2182
2183 # We already know that some pages won't be in the database!
2184 #
2185 if ( '' != $this->mInterwiki || NS_SPECIAL == $this->mNamespace ) {
2186 $this->mArticleID = 0;
2187 }
2188 $fragment = strstr( $dbkey, '#' );
2189 if ( false !== $fragment ) {
2190 $this->setFragment( $fragment );
2191 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2192 # remove whitespace again: prevents "Foo_bar_#"
2193 # becoming "Foo_bar_"
2194 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2195 }
2196
2197 # Reject illegal characters.
2198 #
2199 if( preg_match( $rxTc, $dbkey ) ) {
2200 return false;
2201 }
2202
2203 /**
2204 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2205 * reachable due to the way web browsers deal with 'relative' URLs.
2206 * Also, they conflict with subpage syntax. Forbid them explicitly.
2207 */
2208 if ( strpos( $dbkey, '.' ) !== false &&
2209 ( $dbkey === '.' || $dbkey === '..' ||
2210 strpos( $dbkey, './' ) === 0 ||
2211 strpos( $dbkey, '../' ) === 0 ||
2212 strpos( $dbkey, '/./' ) !== false ||
2213 strpos( $dbkey, '/../' ) !== false ||
2214 substr( $dbkey, -2 ) == '/.' ||
2215 substr( $dbkey, -3 ) == '/..' ) )
2216 {
2217 return false;
2218 }
2219
2220 /**
2221 * Magic tilde sequences? Nu-uh!
2222 */
2223 if( strpos( $dbkey, '~~~' ) !== false ) {
2224 return false;
2225 }
2226
2227 /**
2228 * Limit the size of titles to 255 bytes.
2229 * This is typically the size of the underlying database field.
2230 * We make an exception for special pages, which don't need to be stored
2231 * in the database, and may edge over 255 bytes due to subpage syntax
2232 * for long titles, e.g. [[Special:Block/Long name]]
2233 */
2234 if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) ||
2235 strlen( $dbkey ) > 512 )
2236 {
2237 return false;
2238 }
2239
2240 /**
2241 * Normally, all wiki links are forced to have
2242 * an initial capital letter so [[foo]] and [[Foo]]
2243 * point to the same place.
2244 *
2245 * Don't force it for interwikis, since the other
2246 * site might be case-sensitive.
2247 */
2248 $this->mUserCaseDBKey = $dbkey;
2249 if( $wgCapitalLinks && $this->mInterwiki == '') {
2250 $dbkey = $wgContLang->ucfirst( $dbkey );
2251 }
2252
2253 /**
2254 * Can't make a link to a namespace alone...
2255 * "empty" local links can only be self-links
2256 * with a fragment identifier.
2257 */
2258 if( $dbkey == '' &&
2259 $this->mInterwiki == '' &&
2260 $this->mNamespace != NS_MAIN ) {
2261 return false;
2262 }
2263 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2264 // IP names are not allowed for accounts, and can only be referring to
2265 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2266 // there are numerous ways to present the same IP. Having sp:contribs scan
2267 // them all is silly and having some show the edits and others not is
2268 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2269 $dbkey = ($this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK) ?
2270 IP::sanitizeIP( $dbkey ) : $dbkey;
2271 // Any remaining initial :s are illegal.
2272 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
2273 return false;
2274 }
2275
2276 # Fill fields
2277 $this->mDbkeyform = $dbkey;
2278 $this->mUrlform = wfUrlencode( $dbkey );
2279
2280 $this->mTextform = str_replace( '_', ' ', $dbkey );
2281
2282 return true;
2283 }
2284
2285 /**
2286 * Set the fragment for this title. Removes the first character from the
2287 * specified fragment before setting, so it assumes you're passing it with
2288 * an initial "#".
2289 *
2290 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2291 * Still in active use privately.
2292 *
2293 * @param $fragment \type{\string} text
2294 */
2295 public function setFragment( $fragment ) {
2296 $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
2297 }
2298
2299 /**
2300 * Get a Title object associated with the talk page of this article
2301 * @return \type{Title} the object for the talk page
2302 */
2303 public function getTalkPage() {
2304 return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
2305 }
2306
2307 /**
2308 * Get a title object associated with the subject page of this
2309 * talk page
2310 *
2311 * @return \type{Title} the object for the subject page
2312 */
2313 public function getSubjectPage() {
2314 // Is this the same title?
2315 $subjectNS = MWNamespace::getSubject( $this->getNamespace() );
2316 if( $this->getNamespace() == $subjectNS ) {
2317 return $this;
2318 }
2319 return Title::makeTitle( $subjectNS, $this->getDBkey() );
2320 }
2321
2322 /**
2323 * Get an array of Title objects linking to this Title
2324 * Also stores the IDs in the link cache.
2325 *
2326 * WARNING: do not use this function on arbitrary user-supplied titles!
2327 * On heavily-used templates it will max out the memory.
2328 *
2329 * @param $options \type{\string} may be FOR UPDATE
2330 * @return \type{\arrayof{Title}} the Title objects linking here
2331 */
2332 public function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
2333 $linkCache = LinkCache::singleton();
2334
2335 if ( $options ) {
2336 $db = wfGetDB( DB_MASTER );
2337 } else {
2338 $db = wfGetDB( DB_SLAVE );
2339 }
2340
2341 $res = $db->select( array( 'page', $table ),
2342 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect' ),
2343 array(
2344 "{$prefix}_from=page_id",
2345 "{$prefix}_namespace" => $this->getNamespace(),
2346 "{$prefix}_title" => $this->getDBkey() ),
2347 __METHOD__,
2348 $options );
2349
2350 $retVal = array();
2351 if ( $db->numRows( $res ) ) {
2352 foreach( $res as $row ) {
2353 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
2354 $linkCache->addGoodLinkObj( $row->page_id, $titleObj, $row->page_len, $row->page_is_redirect );
2355 $retVal[] = $titleObj;
2356 }
2357 }
2358 }
2359 $db->freeResult( $res );
2360 return $retVal;
2361 }
2362
2363 /**
2364 * Get an array of Title objects using this Title as a template
2365 * Also stores the IDs in the link cache.
2366 *
2367 * WARNING: do not use this function on arbitrary user-supplied titles!
2368 * On heavily-used templates it will max out the memory.
2369 *
2370 * @param $options \type{\string} may be FOR UPDATE
2371 * @return \type{\arrayof{Title}} the Title objects linking here
2372 */
2373 public function getTemplateLinksTo( $options = '' ) {
2374 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2375 }
2376
2377 /**
2378 * Get an array of Title objects referring to non-existent articles linked from this page
2379 *
2380 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2381 * @param $options \type{\string} may be FOR UPDATE
2382 * @return \type{\arrayof{Title}} the Title objects
2383 */
2384 public function getBrokenLinksFrom( $options = '' ) {
2385 if ( $this->getArticleId() == 0 ) {
2386 # All links from article ID 0 are false positives
2387 return array();
2388 }
2389
2390 if ( $options ) {
2391 $db = wfGetDB( DB_MASTER );
2392 } else {
2393 $db = wfGetDB( DB_SLAVE );
2394 }
2395
2396 $res = $db->safeQuery(
2397 "SELECT pl_namespace, pl_title
2398 FROM !
2399 LEFT JOIN !
2400 ON pl_namespace=page_namespace
2401 AND pl_title=page_title
2402 WHERE pl_from=?
2403 AND page_namespace IS NULL
2404 !",
2405 $db->tableName( 'pagelinks' ),
2406 $db->tableName( 'page' ),
2407 $this->getArticleId(),
2408 $options );
2409
2410 $retVal = array();
2411 if ( $db->numRows( $res ) ) {
2412 foreach( $res as $row ) {
2413 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
2414 }
2415 }
2416 $db->freeResult( $res );
2417 return $retVal;
2418 }
2419
2420
2421 /**
2422 * Get a list of URLs to purge from the Squid cache when this
2423 * page changes
2424 *
2425 * @return \type{\arrayof{\string}} the URLs
2426 */
2427 public function getSquidURLs() {
2428 global $wgContLang;
2429
2430 $urls = array(
2431 $this->getInternalURL(),
2432 $this->getInternalURL( 'action=history' )
2433 );
2434
2435 // purge variant urls as well
2436 if($wgContLang->hasVariants()){
2437 $variants = $wgContLang->getVariants();
2438 foreach($variants as $vCode){
2439 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
2440 $urls[] = $this->getInternalURL('',$vCode);
2441 }
2442 }
2443
2444 return $urls;
2445 }
2446
2447 /**
2448 * Purge all applicable Squid URLs
2449 */
2450 public function purgeSquid() {
2451 global $wgUseSquid;
2452 if ( $wgUseSquid ) {
2453 $urls = $this->getSquidURLs();
2454 $u = new SquidUpdate( $urls );
2455 $u->doUpdate();
2456 }
2457 }
2458
2459 /**
2460 * Move this page without authentication
2461 * @param &$nt \type{Title} the new page Title
2462 */
2463 public function moveNoAuth( &$nt ) {
2464 return $this->moveTo( $nt, false );
2465 }
2466
2467 /**
2468 * Check whether a given move operation would be valid.
2469 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2470 * @param &$nt \type{Title} the new title
2471 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2472 * should be checked
2473 * @param $reason \type{\string} is the log summary of the move, used for spam checking
2474 * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure
2475 */
2476 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2477 global $wgUser;
2478
2479 $errors = array();
2480 if( !$nt ) {
2481 // Normally we'd add this to $errors, but we'll get
2482 // lots of syntax errors if $nt is not an object
2483 return array(array('badtitletext'));
2484 }
2485 if( $this->equals( $nt ) ) {
2486 $errors[] = array('selfmove');
2487 }
2488 if( !$this->isMovable() ) {
2489 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2490 }
2491 if ( $nt->getInterwiki() != '' ) {
2492 $errors[] = array( 'immobile-target-namespace-iw' );
2493 }
2494 if ( !$nt->isMovable() ) {
2495 $errors[] = array('immobile-target-namespace', $nt->getNsText() );
2496 }
2497
2498 $oldid = $this->getArticleID();
2499 $newid = $nt->getArticleID();
2500
2501 if ( strlen( $nt->getDBkey() ) < 1 ) {
2502 $errors[] = array('articleexists');
2503 }
2504 if ( ( '' == $this->getDBkey() ) ||
2505 ( !$oldid ) ||
2506 ( '' == $nt->getDBkey() ) ) {
2507 $errors[] = array('badarticleerror');
2508 }
2509
2510 // Image-specific checks
2511 if( $this->getNamespace() == NS_FILE ) {
2512 $file = wfLocalFile( $this );
2513 if( $file->exists() ) {
2514 if( $nt->getNamespace() != NS_FILE ) {
2515 $errors[] = array('imagenocrossnamespace');
2516 }
2517 if( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
2518 $errors[] = array('imageinvalidfilename');
2519 }
2520 if( !File::checkExtensionCompatibility( $file, $nt->getDBKey() ) ) {
2521 $errors[] = array('imagetypemismatch');
2522 }
2523 }
2524 }
2525
2526 if ( $auth ) {
2527 $errors = wfMergeErrorArrays( $errors,
2528 $this->getUserPermissionsErrors('move', $wgUser),
2529 $this->getUserPermissionsErrors('edit', $wgUser),
2530 $nt->getUserPermissionsErrors('move-target', $wgUser),
2531 $nt->getUserPermissionsErrors('edit', $wgUser) );
2532 }
2533
2534 $match = EditPage::matchSpamRegex( $reason );
2535 if( $match !== false ) {
2536 // This is kind of lame, won't display nice
2537 $errors[] = array('spamprotectiontext');
2538 }
2539
2540 $err = null;
2541 if( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
2542 $errors[] = array('hookaborted', $err);
2543 }
2544
2545 # The move is allowed only if (1) the target doesn't exist, or
2546 # (2) the target is a redirect to the source, and has no history
2547 # (so we can undo bad moves right after they're done).
2548
2549 if ( 0 != $newid ) { # Target exists; check for validity
2550 if ( ! $this->isValidMoveTarget( $nt ) ) {
2551 $errors[] = array('articleexists');
2552 }
2553 } else {
2554 $tp = $nt->getTitleProtection();
2555 $right = ( $tp['pt_create_perm'] == 'sysop' ) ? 'protect' : $tp['pt_create_perm'];
2556 if ( $tp and !$wgUser->isAllowed( $right ) ) {
2557 $errors[] = array('cantmove-titleprotected');
2558 }
2559 }
2560 if(empty($errors))
2561 return true;
2562 return $errors;
2563 }
2564
2565 /**
2566 * Move a title to a new location
2567 * @param &$nt \type{Title} the new title
2568 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2569 * should be checked
2570 * @param $reason \type{\string} The reason for the move
2571 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title.
2572 * Ignored if the user doesn't have the suppressredirect right.
2573 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2574 */
2575 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
2576 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
2577 if( is_array( $err ) ) {
2578 return $err;
2579 }
2580
2581 $pageid = $this->getArticleID();
2582 $protected = $this->isProtected();
2583 if( $nt->exists() ) {
2584 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
2585 $pageCountChange = ($createRedirect ? 0 : -1);
2586 } else { # Target didn't exist, do normal move.
2587 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
2588 $pageCountChange = ($createRedirect ? 1 : 0);
2589 }
2590
2591 if( is_array( $err ) ) {
2592 return $err;
2593 }
2594 $redirid = $this->getArticleID();
2595
2596 // Category memberships include a sort key which may be customized.
2597 // If it's left as the default (the page title), we need to update
2598 // the sort key to match the new title.
2599 //
2600 // Be careful to avoid resetting cl_timestamp, which may disturb
2601 // time-based lists on some sites.
2602 //
2603 // Warning -- if the sort key is *explicitly* set to the old title,
2604 // we can't actually distinguish it from a default here, and it'll
2605 // be set to the new title even though it really shouldn't.
2606 // It'll get corrected on the next edit, but resetting cl_timestamp.
2607 $dbw = wfGetDB( DB_MASTER );
2608 $dbw->update( 'categorylinks',
2609 array(
2610 'cl_sortkey' => $nt->getPrefixedText(),
2611 'cl_timestamp=cl_timestamp' ),
2612 array(
2613 'cl_from' => $pageid,
2614 'cl_sortkey' => $this->getPrefixedText() ),
2615 __METHOD__ );
2616
2617 if( $protected ) {
2618 # Protect the redirect title as the title used to be...
2619 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
2620 array(
2621 'pr_page' => $redirid,
2622 'pr_type' => 'pr_type',
2623 'pr_level' => 'pr_level',
2624 'pr_cascade' => 'pr_cascade',
2625 'pr_user' => 'pr_user',
2626 'pr_expiry' => 'pr_expiry'
2627 ),
2628 array( 'pr_page' => $pageid ),
2629 __METHOD__,
2630 array( 'IGNORE' )
2631 );
2632 # Update the protection log
2633 $log = new LogPage( 'protect' );
2634 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2635 if( $reason ) $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
2636 $log->addEntry( 'move_prot', $nt, $comment, array($this->getPrefixedText()) ); // FIXME: $params?
2637 }
2638
2639 # Update watchlists
2640 $oldnamespace = $this->getNamespace() & ~1;
2641 $newnamespace = $nt->getNamespace() & ~1;
2642 $oldtitle = $this->getDBkey();
2643 $newtitle = $nt->getDBkey();
2644
2645 if( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
2646 WatchedItem::duplicateEntries( $this, $nt );
2647 }
2648
2649 # Update search engine
2650 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2651 $u->doUpdate();
2652 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2653 $u->doUpdate();
2654
2655 # Update site_stats
2656 if( $this->isContentPage() && !$nt->isContentPage() ) {
2657 # No longer a content page
2658 # Not viewed, edited, removing
2659 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2660 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2661 # Now a content page
2662 # Not viewed, edited, adding
2663 $u = new SiteStatsUpdate( 0, 1, +1, $pageCountChange );
2664 } elseif( $pageCountChange ) {
2665 # Redirect added
2666 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2667 } else {
2668 # Nothing special
2669 $u = false;
2670 }
2671 if( $u )
2672 $u->doUpdate();
2673 # Update message cache for interface messages
2674 if( $nt->getNamespace() == NS_MEDIAWIKI ) {
2675 global $wgMessageCache;
2676 $oldarticle = new Article( $this );
2677 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
2678 $newarticle = new Article( $nt );
2679 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
2680 }
2681
2682 global $wgUser;
2683 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2684 return true;
2685 }
2686
2687 /**
2688 * Move page to a title which is at present a redirect to the
2689 * source page
2690 *
2691 * @param &$nt \type{Title} the page to move to, which should currently
2692 * be a redirect
2693 * @param $reason \type{\string} The reason for the move
2694 * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title.
2695 * Ignored if the user doesn't have the suppressredirect right
2696 */
2697 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
2698 global $wgUseSquid, $wgUser;
2699 $fname = 'Title::moveOverExistingRedirect';
2700 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
2701
2702 if ( $reason ) {
2703 $comment .= ": $reason";
2704 }
2705
2706 $now = wfTimestampNow();
2707 $newid = $nt->getArticleID();
2708 $oldid = $this->getArticleID();
2709 $latest = $this->getLatestRevID();
2710
2711 $dbw = wfGetDB( DB_MASTER );
2712
2713 # Delete the old redirect. We don't save it to history since
2714 # by definition if we've got here it's rather uninteresting.
2715 # We have to remove it so that the next step doesn't trigger
2716 # a conflict on the unique namespace+title index...
2717 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2718 if ( !$dbw->cascadingDeletes() ) {
2719 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__ );
2720 global $wgUseTrackbacks;
2721 if ($wgUseTrackbacks)
2722 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__ );
2723 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__ );
2724 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__ );
2725 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__ );
2726 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__ );
2727 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__ );
2728 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__ );
2729 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__ );
2730 }
2731
2732 # Save a null revision in the page's history notifying of the move
2733 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
2734 $nullRevId = $nullRevision->insertOn( $dbw );
2735
2736 $article = new Article( $this );
2737 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $wgUser) );
2738
2739 # Change the name of the target page:
2740 $dbw->update( 'page',
2741 /* SET */ array(
2742 'page_touched' => $dbw->timestamp($now),
2743 'page_namespace' => $nt->getNamespace(),
2744 'page_title' => $nt->getDBkey(),
2745 'page_latest' => $nullRevId,
2746 ),
2747 /* WHERE */ array( 'page_id' => $oldid ),
2748 $fname
2749 );
2750 $nt->resetArticleID( $oldid );
2751
2752 # Recreate the redirect, this time in the other direction.
2753 if( $createRedirect || !$wgUser->isAllowed('suppressredirect') ) {
2754 $mwRedir = MagicWord::get( 'redirect' );
2755 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2756 $redirectArticle = new Article( $this );
2757 $newid = $redirectArticle->insertOn( $dbw );
2758 $redirectRevision = new Revision( array(
2759 'page' => $newid,
2760 'comment' => $comment,
2761 'text' => $redirectText ) );
2762 $redirectRevision->insertOn( $dbw );
2763 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2764
2765 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false, $wgUser) );
2766
2767 # Now, we record the link from the redirect to the new title.
2768 # It should have no other outgoing links...
2769 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2770 $dbw->insert( 'pagelinks',
2771 array(
2772 'pl_from' => $newid,
2773 'pl_namespace' => $nt->getNamespace(),
2774 'pl_title' => $nt->getDBkey() ),
2775 $fname );
2776 $redirectSuppressed = false;
2777 } else {
2778 $this->resetArticleID( 0 );
2779 $redirectSuppressed = true;
2780 }
2781
2782 # Move an image if this is a file
2783 if( $this->getNamespace() == NS_FILE ) {
2784 $file = wfLocalFile( $this );
2785 if( $file->exists() ) {
2786 $status = $file->move( $nt );
2787 if( !$status->isOk() ) {
2788 $dbw->rollback();
2789 return $status->getErrorsArray();
2790 }
2791 }
2792 }
2793
2794 # Log the move
2795 $log = new LogPage( 'move' );
2796 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2797
2798 # Purge squid
2799 if ( $wgUseSquid ) {
2800 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2801 $u = new SquidUpdate( $urls );
2802 $u->doUpdate();
2803 }
2804
2805 }
2806
2807 /**
2808 * Move page to non-existing title.
2809 * @param &$nt \type{Title} the new Title
2810 * @param $reason \type{\string} The reason for the move
2811 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title
2812 * Ignored if the user doesn't have the suppressredirect right
2813 */
2814 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
2815 global $wgUseSquid, $wgUser;
2816 $fname = 'MovePageForm::moveToNewTitle';
2817 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2818 if ( $reason ) {
2819 $comment .= wfMsgExt( 'colon-separator',
2820 array( 'escapenoentities', 'content' ) );
2821 $comment .= $reason;
2822 }
2823
2824 $newid = $nt->getArticleID();
2825 $oldid = $this->getArticleID();
2826 $latest = $this->getLatestRevId();
2827
2828 $dbw = wfGetDB( DB_MASTER );
2829 $now = $dbw->timestamp();
2830
2831 # Save a null revision in the page's history notifying of the move
2832 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
2833 $nullRevId = $nullRevision->insertOn( $dbw );
2834
2835 $article = new Article( $this );
2836 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $wgUser) );
2837
2838 # Rename page entry
2839 $dbw->update( 'page',
2840 /* SET */ array(
2841 'page_touched' => $now,
2842 'page_namespace' => $nt->getNamespace(),
2843 'page_title' => $nt->getDBkey(),
2844 'page_latest' => $nullRevId,
2845 ),
2846 /* WHERE */ array( 'page_id' => $oldid ),
2847 $fname
2848 );
2849 $nt->resetArticleID( $oldid );
2850
2851 if( $createRedirect || !$wgUser->isAllowed('suppressredirect') ) {
2852 # Insert redirect
2853 $mwRedir = MagicWord::get( 'redirect' );
2854 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2855 $redirectArticle = new Article( $this );
2856 $newid = $redirectArticle->insertOn( $dbw );
2857 $redirectRevision = new Revision( array(
2858 'page' => $newid,
2859 'comment' => $comment,
2860 'text' => $redirectText ) );
2861 $redirectRevision->insertOn( $dbw );
2862 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2863
2864 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false, $wgUser) );
2865
2866 # Record the just-created redirect's linking to the page
2867 $dbw->insert( 'pagelinks',
2868 array(
2869 'pl_from' => $newid,
2870 'pl_namespace' => $nt->getNamespace(),
2871 'pl_title' => $nt->getDBkey() ),
2872 $fname );
2873 $redirectSuppressed = false;
2874 } else {
2875 $this->resetArticleID( 0 );
2876 $redirectSuppressed = true;
2877 }
2878
2879 # Move an image if this is a file
2880 if( $this->getNamespace() == NS_FILE ) {
2881 $file = wfLocalFile( $this );
2882 if( $file->exists() ) {
2883 $status = $file->move( $nt );
2884 if( !$status->isOk() ) {
2885 $dbw->rollback();
2886 return $status->getErrorsArray();
2887 }
2888 }
2889 }
2890
2891 # Log the move
2892 $log = new LogPage( 'move' );
2893 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2894
2895 # Purge caches as per article creation
2896 Article::onArticleCreate( $nt );
2897
2898 # Purge old title from squid
2899 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2900 $this->purgeSquid();
2901
2902 }
2903
2904 /**
2905 * Checks if this page is just a one-rev redirect.
2906 * Adds lock, so don't use just for light purposes.
2907 *
2908 * @return \type{\bool} TRUE or FALSE
2909 */
2910 public function isSingleRevRedirect() {
2911 $dbw = wfGetDB( DB_MASTER );
2912 # Is it a redirect?
2913 $row = $dbw->selectRow( 'page',
2914 array( 'page_is_redirect', 'page_latest', 'page_id' ),
2915 $this->pageCond(),
2916 __METHOD__,
2917 'FOR UPDATE'
2918 );
2919 # Cache some fields we may want
2920 $this->mArticleID = $row ? intval($row->page_id) : 0;
2921 $this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
2922 $this->mLatestID = $row ? intval($row->page_latest) : false;
2923 if( !$this->mRedirect ) {
2924 return false;
2925 }
2926 # Does the article have a history?
2927 $row = $dbw->selectField( array( 'page', 'revision'),
2928 'rev_id',
2929 array( 'page_namespace' => $this->getNamespace(),
2930 'page_title' => $this->getDBkey(),
2931 'page_id=rev_page',
2932 'page_latest != rev_id'
2933 ),
2934 __METHOD__,
2935 'FOR UPDATE'
2936 );
2937 # Return true if there was no history
2938 return ($row === false);
2939 }
2940
2941 /**
2942 * Checks if $this can be moved to a given Title
2943 * - Selects for update, so don't call it unless you mean business
2944 *
2945 * @param &$nt \type{Title} the new title to check
2946 * @return \type{\bool} TRUE or FALSE
2947 */
2948 public function isValidMoveTarget( $nt ) {
2949 $dbw = wfGetDB( DB_MASTER );
2950 # Is it an existsing file?
2951 if( $nt->getNamespace() == NS_FILE ) {
2952 $file = wfLocalFile( $nt );
2953 if( $file->exists() ) {
2954 wfDebug( __METHOD__ . ": file exists\n" );
2955 return false;
2956 }
2957 }
2958 # Is it a redirect with no history?
2959 if( !$nt->isSingleRevRedirect() ) {
2960 wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
2961 return false;
2962 }
2963 # Get the article text
2964 $rev = Revision::newFromTitle( $nt );
2965 $text = $rev->getText();
2966 # Does the redirect point to the source?
2967 # Or is it a broken self-redirect, usually caused by namespace collisions?
2968 $m = array();
2969 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2970 $redirTitle = Title::newFromText( $m[1] );
2971 if( !is_object( $redirTitle ) ||
2972 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2973 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2974 wfDebug( __METHOD__ . ": redirect points to other page\n" );
2975 return false;
2976 }
2977 } else {
2978 # Fail safe
2979 wfDebug( __METHOD__ . ": failsafe\n" );
2980 return false;
2981 }
2982 return true;
2983 }
2984
2985 /**
2986 * Can this title be added to a user's watchlist?
2987 *
2988 * @return \type{\bool} TRUE or FALSE
2989 */
2990 public function isWatchable() {
2991 return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() );
2992 }
2993
2994 /**
2995 * Get categories to which this Title belongs and return an array of
2996 * categories' names.
2997 *
2998 * @return \type{\array} array an array of parents in the form:
2999 * $parent => $currentarticle
3000 */
3001 public function getParentCategories() {
3002 global $wgContLang;
3003
3004 $titlekey = $this->getArticleId();
3005 $dbr = wfGetDB( DB_SLAVE );
3006 $categorylinks = $dbr->tableName( 'categorylinks' );
3007
3008 # NEW SQL
3009 $sql = "SELECT * FROM $categorylinks"
3010 ." WHERE cl_from='$titlekey'"
3011 ." AND cl_from <> '0'"
3012 ." ORDER BY cl_sortkey";
3013
3014 $res = $dbr->query( $sql );
3015
3016 if( $dbr->numRows( $res ) > 0 ) {
3017 foreach( $res as $row )
3018 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3019 $data[$wgContLang->getNSText( NS_CATEGORY ).':'.$row->cl_to] = $this->getFullText();
3020 $dbr->freeResult( $res );
3021 } else {
3022 $data = array();
3023 }
3024 return $data;
3025 }
3026
3027 /**
3028 * Get a tree of parent categories
3029 * @param $children \type{\array} an array with the children in the keys, to check for circular refs
3030 * @return \type{\array} Tree of parent categories
3031 */
3032 public function getParentCategoryTree( $children = array() ) {
3033 $stack = array();
3034 $parents = $this->getParentCategories();
3035
3036 if( $parents ) {
3037 foreach( $parents as $parent => $current ) {
3038 if ( array_key_exists( $parent, $children ) ) {
3039 # Circular reference
3040 $stack[$parent] = array();
3041 } else {
3042 $nt = Title::newFromText($parent);
3043 if ( $nt ) {
3044 $stack[$parent] = $nt->getParentCategoryTree( $children + array($parent => 1) );
3045 }
3046 }
3047 }
3048 return $stack;
3049 } else {
3050 return array();
3051 }
3052 }
3053
3054
3055 /**
3056 * Get an associative array for selecting this title from
3057 * the "page" table
3058 *
3059 * @return \type{\array} Selection array
3060 */
3061 public function pageCond() {
3062 if( $this->mArticleID > 0 ) {
3063 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3064 return array( 'page_id' => $this->mArticleID );
3065 } else {
3066 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
3067 }
3068 }
3069
3070 /**
3071 * Get the revision ID of the previous revision
3072 *
3073 * @param $revId \type{\int} Revision ID. Get the revision that was before this one.
3074 * @param $flags \type{\int} GAID_FOR_UPDATE
3075 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3076 */
3077 public function getPreviousRevisionID( $revId, $flags=0 ) {
3078 $db = ($flags & GAID_FOR_UPDATE) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3079 return $db->selectField( 'revision', 'rev_id',
3080 array(
3081 'rev_page' => $this->getArticleId($flags),
3082 'rev_id < ' . intval( $revId )
3083 ),
3084 __METHOD__,
3085 array( 'ORDER BY' => 'rev_id DESC' )
3086 );
3087 }
3088
3089 /**
3090 * Get the revision ID of the next revision
3091 *
3092 * @param $revId \type{\int} Revision ID. Get the revision that was after this one.
3093 * @param $flags \type{\int} GAID_FOR_UPDATE
3094 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3095 */
3096 public function getNextRevisionID( $revId, $flags=0 ) {
3097 $db = ($flags & GAID_FOR_UPDATE) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3098 return $db->selectField( 'revision', 'rev_id',
3099 array(
3100 'rev_page' => $this->getArticleId($flags),
3101 'rev_id > ' . intval( $revId )
3102 ),
3103 __METHOD__,
3104 array( 'ORDER BY' => 'rev_id' )
3105 );
3106 }
3107
3108 /**
3109 * Get the first revision of the page
3110 *
3111 * @param $flags \type{\int} GAID_FOR_UPDATE
3112 * @return Revision (or NULL if page doesn't exist)
3113 */
3114 public function getFirstRevision( $flags=0 ) {
3115 $db = ($flags & GAID_FOR_UPDATE) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
3116 $pageId = $this->getArticleId($flags);
3117 if( !$pageId ) return NULL;
3118 $row = $db->selectRow( 'revision', '*',
3119 array( 'rev_page' => $pageId ),
3120 __METHOD__,
3121 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3122 );
3123 if( !$row ) {
3124 return NULL;
3125 } else {
3126 return new Revision( $row );
3127 }
3128 }
3129
3130 /**
3131 * Check if this is a new page
3132 *
3133 * @return bool
3134 */
3135 public function isNewPage() {
3136 $dbr = wfGetDB( DB_SLAVE );
3137 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
3138 }
3139
3140 /**
3141 * Get the oldest revision timestamp of this page
3142 *
3143 * @return string, MW timestamp
3144 */
3145 public function getEarliestRevTime() {
3146 $dbr = wfGetDB( DB_SLAVE );
3147 if( $this->exists() ) {
3148 $min = $dbr->selectField( 'revision',
3149 'MIN(rev_timestamp)',
3150 array( 'rev_page' => $this->getArticleId() ),
3151 __METHOD__ );
3152 return wfTimestampOrNull( TS_MW, $min );
3153 }
3154 return null;
3155 }
3156
3157 /**
3158 * Get the number of revisions between the given revision IDs.
3159 * Used for diffs and other things that really need it.
3160 *
3161 * @param $old \type{\int} Revision ID.
3162 * @param $new \type{\int} Revision ID.
3163 * @return \type{\int} Number of revisions between these IDs.
3164 */
3165 public function countRevisionsBetween( $old, $new ) {
3166 $dbr = wfGetDB( DB_SLAVE );
3167 return $dbr->selectField( 'revision', 'count(*)',
3168 'rev_page = ' . intval( $this->getArticleId() ) .
3169 ' AND rev_id > ' . intval( $old ) .
3170 ' AND rev_id < ' . intval( $new ),
3171 __METHOD__,
3172 array( 'USE INDEX' => 'PRIMARY' ) );
3173 }
3174
3175 /**
3176 * Compare with another title.
3177 *
3178 * @param \type{Title} $title
3179 * @return \type{\bool} TRUE or FALSE
3180 */
3181 public function equals( Title $title ) {
3182 // Note: === is necessary for proper matching of number-like titles.
3183 return $this->getInterwiki() === $title->getInterwiki()
3184 && $this->getNamespace() == $title->getNamespace()
3185 && $this->getDBkey() === $title->getDBkey();
3186 }
3187
3188 /**
3189 * Callback for usort() to do title sorts by (namespace, title)
3190 */
3191 static function compare( $a, $b ) {
3192 if( $a->getNamespace() == $b->getNamespace() ) {
3193 return strcmp( $a->getText(), $b->getText() );
3194 } else {
3195 return $a->getNamespace() - $b->getNamespace();
3196 }
3197 }
3198
3199 /**
3200 * Return a string representation of this title
3201 *
3202 * @return \type{\string} String representation of this title
3203 */
3204 public function __toString() {
3205 return $this->getPrefixedText();
3206 }
3207
3208 /**
3209 * Check if page exists. For historical reasons, this function simply
3210 * checks for the existence of the title in the page table, and will
3211 * thus return false for interwiki links, special pages and the like.
3212 * If you want to know if a title can be meaningfully viewed, you should
3213 * probably call the isKnown() method instead.
3214 *
3215 * @return \type{\bool} TRUE or FALSE
3216 */
3217 public function exists() {
3218 return $this->getArticleId() != 0;
3219 }
3220
3221 /**
3222 * Should links to this title be shown as potentially viewable (i.e. as
3223 * "bluelinks"), even if there's no record by this title in the page
3224 * table?
3225 *
3226 * This function is semi-deprecated for public use, as well as somewhat
3227 * misleadingly named. You probably just want to call isKnown(), which
3228 * calls this function internally.
3229 *
3230 * (ISSUE: Most of these checks are cheap, but the file existence check
3231 * can potentially be quite expensive. Including it here fixes a lot of
3232 * existing code, but we might want to add an optional parameter to skip
3233 * it and any other expensive checks.)
3234 *
3235 * @return \type{\bool} TRUE or FALSE
3236 */
3237 public function isAlwaysKnown() {
3238 if( $this->mInterwiki != '' ) {
3239 return true; // any interwiki link might be viewable, for all we know
3240 }
3241 switch( $this->mNamespace ) {
3242 case NS_MEDIA:
3243 case NS_FILE:
3244 return wfFindFile( $this ); // file exists, possibly in a foreign repo
3245 case NS_SPECIAL:
3246 return SpecialPage::exists( $this->getDBKey() ); // valid special page
3247 case NS_MAIN:
3248 return $this->mDbkeyform == ''; // selflink, possibly with fragment
3249 case NS_MEDIAWIKI:
3250 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3251 // the full l10n of that language to be loaded. That takes much memory and
3252 // isn't needed. So we strip the language part away.
3253 // Also, extension messages which are not loaded, are shown as red, because
3254 // we don't call MessageCache::loadAllMessages.
3255 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform, 2 );
3256 return wfMsgWeirdKey( $basename ); // known system message
3257 default:
3258 return false;
3259 }
3260 }
3261
3262 /**
3263 * Does this title refer to a page that can (or might) be meaningfully
3264 * viewed? In particular, this function may be used to determine if
3265 * links to the title should be rendered as "bluelinks" (as opposed to
3266 * "redlinks" to non-existent pages).
3267 *
3268 * @return \type{\bool} TRUE or FALSE
3269 */
3270 public function isKnown() {
3271 return $this->exists() || $this->isAlwaysKnown();
3272 }
3273
3274 /**
3275 * Is this in a namespace that allows actual pages?
3276 *
3277 * @return \type{\bool} TRUE or FALSE
3278 */
3279 public function canExist() {
3280 return $this->mNamespace >= 0 && $this->mNamespace != NS_MEDIA;
3281 }
3282
3283 /**
3284 * Update page_touched timestamps and send squid purge messages for
3285 * pages linking to this title. May be sent to the job queue depending
3286 * on the number of links. Typically called on create and delete.
3287 */
3288 public function touchLinks() {
3289 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3290 $u->doUpdate();
3291
3292 if ( $this->getNamespace() == NS_CATEGORY ) {
3293 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3294 $u->doUpdate();
3295 }
3296 }
3297
3298 /**
3299 * Get the last touched timestamp
3300 * @param Database $db, optional db
3301 * @return \type{\string} Last touched timestamp
3302 */
3303 public function getTouched( $db = NULL ) {
3304 $db = isset($db) ? $db : wfGetDB( DB_SLAVE );
3305 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
3306 return $touched;
3307 }
3308
3309 /**
3310 * Get the timestamp when this page was updated since the user last saw it.
3311 * @param User $user
3312 * @return mixed string/NULL
3313 */
3314 public function getNotificationTimestamp( $user = NULL ) {
3315 global $wgUser, $wgShowUpdatedMarker;
3316 // Assume current user if none given
3317 if( !$user ) $user = $wgUser;
3318 // Check cache first
3319 $uid = $user->getId();
3320 if( isset($this->mNotificationTimestamp[$uid]) ) {
3321 return $this->mNotificationTimestamp[$uid];
3322 }
3323 if( !$uid || !$wgShowUpdatedMarker ) {
3324 return $this->mNotificationTimestamp[$uid] = false;
3325 }
3326 // Don't cache too much!
3327 if( count($this->mNotificationTimestamp) >= self::CACHE_MAX ) {
3328 $this->mNotificationTimestamp = array();
3329 }
3330 $dbr = wfGetDB( DB_SLAVE );
3331 $this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
3332 'wl_notificationtimestamp',
3333 array( 'wl_namespace' => $this->getNamespace(),
3334 'wl_title' => $this->getDBkey(),
3335 'wl_user' => $user->getId()
3336 ),
3337 __METHOD__
3338 );
3339 return $this->mNotificationTimestamp[$uid];
3340 }
3341
3342 /**
3343 * Get the trackback URL for this page
3344 * @return \type{\string} Trackback URL
3345 */
3346 public function trackbackURL() {
3347 global $wgScriptPath, $wgServer;
3348
3349 return "$wgServer$wgScriptPath/trackback.php?article="
3350 . htmlspecialchars(urlencode($this->getPrefixedDBkey()));
3351 }
3352
3353 /**
3354 * Get the trackback RDF for this page
3355 * @return \type{\string} Trackback RDF
3356 */
3357 public function trackbackRDF() {
3358 $url = htmlspecialchars($this->getFullURL());
3359 $title = htmlspecialchars($this->getText());
3360 $tburl = $this->trackbackURL();
3361
3362 // Autodiscovery RDF is placed in comments so HTML validator
3363 // won't barf. This is a rather icky workaround, but seems
3364 // frequently used by this kind of RDF thingy.
3365 //
3366 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3367 return "<!--
3368 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3369 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3370 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3371 <rdf:Description
3372 rdf:about=\"$url\"
3373 dc:identifier=\"$url\"
3374 dc:title=\"$title\"
3375 trackback:ping=\"$tburl\" />
3376 </rdf:RDF>
3377 -->";
3378 }
3379
3380 /**
3381 * Generate strings used for xml 'id' names in monobook tabs
3382 * @return \type{\string} XML 'id' name
3383 */
3384 public function getNamespaceKey() {
3385 global $wgContLang;
3386 switch ($this->getNamespace()) {
3387 case NS_MAIN:
3388 case NS_TALK:
3389 return 'nstab-main';
3390 case NS_USER:
3391 case NS_USER_TALK:
3392 return 'nstab-user';
3393 case NS_MEDIA:
3394 return 'nstab-media';
3395 case NS_SPECIAL:
3396 return 'nstab-special';
3397 case NS_PROJECT:
3398 case NS_PROJECT_TALK:
3399 return 'nstab-project';
3400 case NS_FILE:
3401 case NS_FILE_TALK:
3402 return 'nstab-image';
3403 case NS_MEDIAWIKI:
3404 case NS_MEDIAWIKI_TALK:
3405 return 'nstab-mediawiki';
3406 case NS_TEMPLATE:
3407 case NS_TEMPLATE_TALK:
3408 return 'nstab-template';
3409 case NS_HELP:
3410 case NS_HELP_TALK:
3411 return 'nstab-help';
3412 case NS_CATEGORY:
3413 case NS_CATEGORY_TALK:
3414 return 'nstab-category';
3415 default:
3416 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
3417 }
3418 }
3419
3420 /**
3421 * Returns true if this title resolves to the named special page
3422 * @param $name \type{\string} The special page name
3423 */
3424 public function isSpecial( $name ) {
3425 if ( $this->getNamespace() == NS_SPECIAL ) {
3426 list( $thisName, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $this->getDBkey() );
3427 if ( $name == $thisName ) {
3428 return true;
3429 }
3430 }
3431 return false;
3432 }
3433
3434 /**
3435 * If the Title refers to a special page alias which is not the local default,
3436 * @return \type{Title} A new Title which points to the local default. Otherwise, returns $this.
3437 */
3438 public function fixSpecialName() {
3439 if ( $this->getNamespace() == NS_SPECIAL ) {
3440 $canonicalName = SpecialPage::resolveAlias( $this->mDbkeyform );
3441 if ( $canonicalName ) {
3442 $localName = SpecialPage::getLocalNameFor( $canonicalName );
3443 if ( $localName != $this->mDbkeyform ) {
3444 return Title::makeTitle( NS_SPECIAL, $localName );
3445 }
3446 }
3447 }
3448 return $this;
3449 }
3450
3451 /**
3452 * Is this Title in a namespace which contains content?
3453 * In other words, is this a content page, for the purposes of calculating
3454 * statistics, etc?
3455 *
3456 * @return \type{\bool} TRUE or FALSE
3457 */
3458 public function isContentPage() {
3459 return MWNamespace::isContent( $this->getNamespace() );
3460 }
3461
3462 /**
3463 * Get all extant redirects to this Title
3464 *
3465 * @param $ns \twotypes{\int,\null} Single namespace to consider;
3466 * NULL to consider all namespaces
3467 * @return \type{\arrayof{Title}} Redirects to this title
3468 */
3469 public function getRedirectsHere( $ns = null ) {
3470 $redirs = array();
3471
3472 $dbr = wfGetDB( DB_SLAVE );
3473 $where = array(
3474 'rd_namespace' => $this->getNamespace(),
3475 'rd_title' => $this->getDBkey(),
3476 'rd_from = page_id'
3477 );
3478 if ( !is_null($ns) ) $where['page_namespace'] = $ns;
3479
3480 $res = $dbr->select(
3481 array( 'redirect', 'page' ),
3482 array( 'page_namespace', 'page_title' ),
3483 $where,
3484 __METHOD__
3485 );
3486
3487
3488 foreach( $res as $row ) {
3489 $redirs[] = self::newFromRow( $row );
3490 }
3491 return $redirs;
3492 }
3493
3494 /**
3495 * Check if this Title is a valid redirect target
3496 *
3497 * @return \type{\bool} TRUE or FALSE
3498 */
3499 public function isValidRedirectTarget() {
3500 global $wgInvalidRedirectTargets;
3501
3502 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
3503 if( $this->isSpecial( 'Userlogout' ) ) {
3504 return false;
3505 }
3506
3507 foreach( $wgInvalidRedirectTargets as $target ) {
3508 if( $this->isSpecial( $target ) ) {
3509 return false;
3510 }
3511 }
3512
3513 return true;
3514 }
3515 }