f74192b164f16396fe7c93a32e83a5e069e1e4dd
[lhc/web/wiklou.git] / includes / Title.php
1 <?php
2 /**
3 * See title.txt
4 *
5 */
6
7 /** */
8 if ( !class_exists( 'UtfNormal' ) ) {
9 require_once( dirname(__FILE__) . '/normal/UtfNormal.php' );
10 }
11
12 define ( 'GAID_FOR_UPDATE', 1 );
13
14 # Title::newFromTitle maintains a cache to avoid
15 # expensive re-normalization of commonly used titles.
16 # On a batch operation this can become a memory leak
17 # if not bounded. After hitting this many titles,
18 # reset the cache.
19 define( 'MW_TITLECACHE_MAX', 1000 );
20
21 # Constants for pr_cascade bitfield
22 define( 'CASCADE', 1 );
23
24 /**
25 * Title class
26 * - Represents a title, which may contain an interwiki designation or namespace
27 * - Can fetch various kinds of data from the database, albeit inefficiently.
28 *
29 */
30 class Title {
31 /**
32 * Static cache variables
33 */
34 static private $titleCache=array();
35 static private $interwikiCache=array();
36
37
38 /**
39 * All member variables should be considered private
40 * Please use the accessor functions
41 */
42
43 /**#@+
44 * @private
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; # 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; # Article ID, fetched from the link cache on demand
55 var $mLatestID; # ID of most recent revision
56 var $mRestrictions; # Array of groups allowed to edit this article
57 var $mCascadeRestriction; # Cascade restrictions on this page to included templates and images?
58 var $mRestrictionsExpiry; # When do the restrictions on this page expire?
59 var $mHasCascadingRestrictions; # Are cascading restrictions in effect on this page?
60 var $mCascadeRestrictionSources;# Where are the cascading restrictions coming from on this page?
61 var $mRestrictionsLoaded; # Boolean for initialisation on demand
62 var $mPrefixedText; # Text form including namespace/interwiki, initialised on demand
63 var $mDefaultNamespace; # Namespace index when there is no namespace
64 # Zero except in {{transclusion}} tags
65 var $mWatched; # Is $wgUser watching this page? NULL if unfilled, accessed through userIsWatching()
66 /**#@-*/
67
68
69 /**
70 * Constructor
71 * @private
72 */
73 /* private */ function __construct() {
74 $this->mInterwiki = $this->mUrlform =
75 $this->mTextform = $this->mDbkeyform = '';
76 $this->mArticleID = -1;
77 $this->mNamespace = NS_MAIN;
78 $this->mRestrictionsLoaded = false;
79 $this->mRestrictions = array();
80 # Dont change the following, NS_MAIN is hardcoded in several place
81 # See bug #696
82 $this->mDefaultNamespace = NS_MAIN;
83 $this->mWatched = NULL;
84 $this->mLatestID = false;
85 $this->mOldRestrictions = false;
86 }
87
88 /**
89 * Create a new Title from a prefixed DB key
90 * @param string $key The database key, which has underscores
91 * instead of spaces, possibly including namespace and
92 * interwiki prefixes
93 * @return Title the new object, or NULL on an error
94 */
95 public static function newFromDBkey( $key ) {
96 $t = new Title();
97 $t->mDbkeyform = $key;
98 if( $t->secureAndSplit() )
99 return $t;
100 else
101 return NULL;
102 }
103
104 /**
105 * Create a new Title from text, such as what one would
106 * find in a link. Decodes any HTML entities in the text.
107 *
108 * @param string $text the link text; spaces, prefixes,
109 * and an initial ':' indicating the main namespace
110 * are accepted
111 * @param int $defaultNamespace the namespace to use if
112 * none is specified by a prefix
113 * @return Title the new object, or NULL on an error
114 */
115 public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
116 if( is_object( $text ) ) {
117 throw new MWException( 'Title::newFromText given an object' );
118 }
119
120 /**
121 * Wiki pages often contain multiple links to the same page.
122 * Title normalization and parsing can become expensive on
123 * pages with many links, so we can save a little time by
124 * caching them.
125 *
126 * In theory these are value objects and won't get changed...
127 */
128 if( $defaultNamespace == NS_MAIN && isset( Title::$titleCache[$text] ) ) {
129 return Title::$titleCache[$text];
130 }
131
132 /**
133 * Convert things like &eacute; &#257; or &#x3017; into real text...
134 */
135 $filteredText = Sanitizer::decodeCharReferences( $text );
136
137 $t = new Title();
138 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
139 $t->mDefaultNamespace = $defaultNamespace;
140
141 static $cachedcount = 0 ;
142 if( $t->secureAndSplit() ) {
143 if( $defaultNamespace == NS_MAIN ) {
144 if( $cachedcount >= MW_TITLECACHE_MAX ) {
145 # Avoid memory leaks on mass operations...
146 Title::$titleCache = array();
147 $cachedcount=0;
148 }
149 $cachedcount++;
150 Title::$titleCache[$text] =& $t;
151 }
152 return $t;
153 } else {
154 $ret = NULL;
155 return $ret;
156 }
157 }
158
159 /**
160 * Create a new Title from URL-encoded text. Ensures that
161 * the given title's length does not exceed the maximum.
162 * @param string $url the title, as might be taken from a URL
163 * @return Title the new object, or NULL on an error
164 */
165 public static function newFromURL( $url ) {
166 global $wgLegalTitleChars;
167 $t = new Title();
168
169 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
170 # but some URLs used it as a space replacement and they still come
171 # from some external search tools.
172 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
173 $url = str_replace( '+', ' ', $url );
174 }
175
176 $t->mDbkeyform = str_replace( ' ', '_', $url );
177 if( $t->secureAndSplit() ) {
178 return $t;
179 } else {
180 return NULL;
181 }
182 }
183
184 /**
185 * Create a new Title from an article ID
186 *
187 * @todo This is inefficiently implemented, the page row is requested
188 * but not used for anything else
189 *
190 * @param int $id the page_id corresponding to the Title to create
191 * @return Title the new object, or NULL on an error
192 */
193 public static function newFromID( $id ) {
194 $fname = 'Title::newFromID';
195 $dbr = wfGetDB( DB_SLAVE );
196 $row = $dbr->selectRow( 'page', array( 'page_namespace', 'page_title' ),
197 array( 'page_id' => $id ), $fname );
198 if ( $row !== false ) {
199 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
200 } else {
201 $title = NULL;
202 }
203 return $title;
204 }
205
206 /**
207 * Make an array of titles from an array of IDs
208 */
209 public static function newFromIDs( $ids ) {
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 while ( $row = $dbr->fetchObject( $res ) ) {
216 $titles[] = Title::makeTitle( $row->page_namespace, $row->page_title );
217 }
218 return $titles;
219 }
220
221 /**
222 * Create a new Title from a namespace index and a DB key.
223 * It's assumed that $ns and $title are *valid*, for instance when
224 * they came directly from the database or a special page name.
225 * For convenience, spaces are converted to underscores so that
226 * eg user_text fields can be used directly.
227 *
228 * @param int $ns the namespace of the article
229 * @param string $title the unprefixed database key form
230 * @return Title the new object
231 */
232 public static function &makeTitle( $ns, $title ) {
233 $t = new Title();
234 $t->mInterwiki = '';
235 $t->mFragment = '';
236 $t->mNamespace = $ns = intval( $ns );
237 $t->mDbkeyform = str_replace( ' ', '_', $title );
238 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
239 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
240 $t->mTextform = str_replace( '_', ' ', $title );
241 return $t;
242 }
243
244 /**
245 * Create a new Title from a namespace index and a DB key.
246 * The parameters will be checked for validity, which is a bit slower
247 * than makeTitle() but safer for user-provided data.
248 *
249 * @param int $ns the namespace of the article
250 * @param string $title the database key form
251 * @return Title the new object, or NULL on an error
252 */
253 public static function makeTitleSafe( $ns, $title ) {
254 $t = new Title();
255 $t->mDbkeyform = Title::makeName( $ns, $title );
256 if( $t->secureAndSplit() ) {
257 return $t;
258 } else {
259 return NULL;
260 }
261 }
262
263 /**
264 * Create a new Title for the Main Page
265 * @return Title the new object
266 */
267 public static function newMainPage() {
268 return Title::newFromText( wfMsgForContent( 'mainpage' ) );
269 }
270
271 /**
272 * Extract a redirect destination from a string and return the
273 * Title, or null if the text doesn't contain a valid redirect
274 *
275 * @param string $text Text with possible redirect
276 * @return Title
277 */
278 public static function newFromRedirect( $text ) {
279 $redir = MagicWord::get( 'redirect' );
280 if( $redir->matchStart( $text ) ) {
281 // Extract the first link and see if it's usable
282 $m = array();
283 if( preg_match( '!\[{2}(.*?)(?:\||\]{2})!', $text, $m ) ) {
284 // Strip preceding colon used to "escape" categories, etc.
285 // and URL-decode links
286 if( strpos( $m[1], '%' ) !== false ) {
287 // Match behavior of inline link parsing here;
288 // don't interpret + as " " most of the time!
289 // It might be safe to just use rawurldecode instead, though.
290 $m[1] = urldecode( ltrim( $m[1], ':' ) );
291 }
292 $title = Title::newFromText( $m[1] );
293 // Redirects to Special:Userlogout are not permitted
294 if( $title instanceof Title && !$title->isSpecial( 'Userlogout' ) )
295 return $title;
296 }
297 }
298 return null;
299 }
300
301 #----------------------------------------------------------------------------
302 # Static functions
303 #----------------------------------------------------------------------------
304
305 /**
306 * Get the prefixed DB key associated with an ID
307 * @param int $id the page_id of the article
308 * @return Title an object representing the article, or NULL
309 * if no such article was found
310 * @static
311 * @access public
312 */
313 function nameOf( $id ) {
314 $fname = 'Title::nameOf';
315 $dbr = wfGetDB( DB_SLAVE );
316
317 $s = $dbr->selectRow( 'page', array( 'page_namespace','page_title' ), array( 'page_id' => $id ), $fname );
318 if ( $s === false ) { return NULL; }
319
320 $n = Title::makeName( $s->page_namespace, $s->page_title );
321 return $n;
322 }
323
324 /**
325 * Get a regex character class describing the legal characters in a link
326 * @return string the list of characters, not delimited
327 */
328 public static function legalChars() {
329 global $wgLegalTitleChars;
330 return $wgLegalTitleChars;
331 }
332
333 /**
334 * Get a string representation of a title suitable for
335 * including in a search index
336 *
337 * @param int $ns a namespace index
338 * @param string $title text-form main part
339 * @return string a stripped-down title string ready for the
340 * search index
341 */
342 public static function indexTitle( $ns, $title ) {
343 global $wgContLang;
344
345 $lc = SearchEngine::legalSearchChars() . '&#;';
346 $t = $wgContLang->stripForSearch( $title );
347 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
348 $t = $wgContLang->lc( $t );
349
350 # Handle 's, s'
351 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
352 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
353
354 $t = preg_replace( "/\\s+/", ' ', $t );
355
356 if ( $ns == NS_IMAGE ) {
357 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
358 }
359 return trim( $t );
360 }
361
362 /*
363 * Make a prefixed DB key from a DB key and a namespace index
364 * @param int $ns numerical representation of the namespace
365 * @param string $title the DB key form the title
366 * @return string the prefixed form of the title
367 */
368 public static function makeName( $ns, $title ) {
369 global $wgContLang;
370
371 $n = $wgContLang->getNsText( $ns );
372 return $n == '' ? $title : "$n:$title";
373 }
374
375 /**
376 * Returns the URL associated with an interwiki prefix
377 * @param string $key the interwiki prefix (e.g. "MeatBall")
378 * @return the associated URL, containing "$1", which should be
379 * replaced by an article title
380 * @static (arguably)
381 */
382 public function getInterwikiLink( $key ) {
383 global $wgMemc, $wgInterwikiExpiry;
384 global $wgInterwikiCache, $wgContLang;
385 $fname = 'Title::getInterwikiLink';
386
387 $key = $wgContLang->lc( $key );
388
389 $k = wfMemcKey( 'interwiki', $key );
390 if( array_key_exists( $k, Title::$interwikiCache ) ) {
391 return Title::$interwikiCache[$k]->iw_url;
392 }
393
394 if ($wgInterwikiCache) {
395 return Title::getInterwikiCached( $key );
396 }
397
398 $s = $wgMemc->get( $k );
399 # Ignore old keys with no iw_local
400 if( $s && isset( $s->iw_local ) && isset($s->iw_trans)) {
401 Title::$interwikiCache[$k] = $s;
402 return $s->iw_url;
403 }
404
405 $dbr = wfGetDB( DB_SLAVE );
406 $res = $dbr->select( 'interwiki',
407 array( 'iw_url', 'iw_local', 'iw_trans' ),
408 array( 'iw_prefix' => $key ), $fname );
409 if( !$res ) {
410 return '';
411 }
412
413 $s = $dbr->fetchObject( $res );
414 if( !$s ) {
415 # Cache non-existence: create a blank object and save it to memcached
416 $s = (object)false;
417 $s->iw_url = '';
418 $s->iw_local = 0;
419 $s->iw_trans = 0;
420 }
421 $wgMemc->set( $k, $s, $wgInterwikiExpiry );
422 Title::$interwikiCache[$k] = $s;
423
424 return $s->iw_url;
425 }
426
427 /**
428 * Fetch interwiki prefix data from local cache in constant database
429 *
430 * More logic is explained in DefaultSettings
431 *
432 * @return string URL of interwiki site
433 */
434 public static function getInterwikiCached( $key ) {
435 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
436 static $db, $site;
437
438 if (!$db)
439 $db=dba_open($wgInterwikiCache,'r','cdb');
440 /* Resolve site name */
441 if ($wgInterwikiScopes>=3 and !$site) {
442 $site = dba_fetch('__sites:' . wfWikiID(), $db);
443 if ($site=="")
444 $site = $wgInterwikiFallbackSite;
445 }
446 $value = dba_fetch( wfMemcKey( $key ), $db);
447 if ($value=='' and $wgInterwikiScopes>=3) {
448 /* try site-level */
449 $value = dba_fetch("_{$site}:{$key}", $db);
450 }
451 if ($value=='' and $wgInterwikiScopes>=2) {
452 /* try globals */
453 $value = dba_fetch("__global:{$key}", $db);
454 }
455 if ($value=='undef')
456 $value='';
457 $s = (object)false;
458 $s->iw_url = '';
459 $s->iw_local = 0;
460 $s->iw_trans = 0;
461 if ($value!='') {
462 list($local,$url)=explode(' ',$value,2);
463 $s->iw_url=$url;
464 $s->iw_local=(int)$local;
465 }
466 Title::$interwikiCache[wfMemcKey( 'interwiki', $key )] = $s;
467 return $s->iw_url;
468 }
469 /**
470 * Determine whether the object refers to a page within
471 * this project.
472 *
473 * @return bool TRUE if this is an in-project interwiki link
474 * or a wikilink, FALSE otherwise
475 */
476 public function isLocal() {
477 if ( $this->mInterwiki != '' ) {
478 # Make sure key is loaded into cache
479 $this->getInterwikiLink( $this->mInterwiki );
480 $k = wfMemcKey( 'interwiki', $this->mInterwiki );
481 return (bool)(Title::$interwikiCache[$k]->iw_local);
482 } else {
483 return true;
484 }
485 }
486
487 /**
488 * Determine whether the object refers to a page within
489 * this project and is transcludable.
490 *
491 * @return bool TRUE if this is transcludable
492 */
493 public function isTrans() {
494 if ($this->mInterwiki == '')
495 return false;
496 # Make sure key is loaded into cache
497 $this->getInterwikiLink( $this->mInterwiki );
498 $k = wfMemcKey( 'interwiki', $this->mInterwiki );
499 return (bool)(Title::$interwikiCache[$k]->iw_trans);
500 }
501
502 /**
503 * Escape a text fragment, say from a link, for a URL
504 */
505 static function escapeFragmentForURL( $fragment ) {
506 $fragment = str_replace( ' ', '_', $fragment );
507 $fragment = urlencode( Sanitizer::decodeCharReferences( $fragment ) );
508 $replaceArray = array(
509 '%3A' => ':',
510 '%' => '.'
511 );
512 return strtr( $fragment, $replaceArray );
513 }
514
515 #----------------------------------------------------------------------------
516 # Other stuff
517 #----------------------------------------------------------------------------
518
519 /** Simple accessors */
520 /**
521 * Get the text form (spaces not underscores) of the main part
522 * @return string
523 */
524 public function getText() { return $this->mTextform; }
525 /**
526 * Get the URL-encoded form of the main part
527 * @return string
528 */
529 public function getPartialURL() { return $this->mUrlform; }
530 /**
531 * Get the main part with underscores
532 * @return string
533 */
534 public function getDBkey() { return $this->mDbkeyform; }
535 /**
536 * Get the namespace index, i.e. one of the NS_xxxx constants
537 * @return int
538 */
539 public function getNamespace() { return $this->mNamespace; }
540 /**
541 * Get the namespace text
542 * @return string
543 */
544 public function getNsText() {
545 global $wgContLang, $wgCanonicalNamespaceNames;
546
547 if ( '' != $this->mInterwiki ) {
548 // This probably shouldn't even happen. ohh man, oh yuck.
549 // But for interwiki transclusion it sometimes does.
550 // Shit. Shit shit shit.
551 //
552 // Use the canonical namespaces if possible to try to
553 // resolve a foreign namespace.
554 if( isset( $wgCanonicalNamespaceNames[$this->mNamespace] ) ) {
555 return $wgCanonicalNamespaceNames[$this->mNamespace];
556 }
557 }
558 return $wgContLang->getNsText( $this->mNamespace );
559 }
560 /**
561 * Get the DB key with the initial letter case as specified by the user
562 */
563 function getUserCaseDBKey() {
564 return $this->mUserCaseDBKey;
565 }
566 /**
567 * Get the namespace text of the subject (rather than talk) page
568 * @return string
569 */
570 public function getSubjectNsText() {
571 global $wgContLang;
572 return $wgContLang->getNsText( Namespace::getSubject( $this->mNamespace ) );
573 }
574
575 /**
576 * Get the namespace text of the talk page
577 * @return string
578 */
579 public function getTalkNsText() {
580 global $wgContLang;
581 return( $wgContLang->getNsText( Namespace::getTalk( $this->mNamespace ) ) );
582 }
583
584 /**
585 * Could this title have a corresponding talk page?
586 * @return bool
587 */
588 public function canTalk() {
589 return( Namespace::canTalk( $this->mNamespace ) );
590 }
591
592 /**
593 * Get the interwiki prefix (or null string)
594 * @return string
595 */
596 public function getInterwiki() { return $this->mInterwiki; }
597 /**
598 * Get the Title fragment (i.e. the bit after the #) in text form
599 * @return string
600 */
601 public function getFragment() { return $this->mFragment; }
602 /**
603 * Get the fragment in URL form, including the "#" character if there is one
604 * @return string
605 */
606 public function getFragmentForURL() {
607 if ( $this->mFragment == '' ) {
608 return '';
609 } else {
610 return '#' . Title::escapeFragmentForURL( $this->mFragment );
611 }
612 }
613 /**
614 * Get the default namespace index, for when there is no namespace
615 * @return int
616 */
617 public function getDefaultNamespace() { return $this->mDefaultNamespace; }
618
619 /**
620 * Get title for search index
621 * @return string a stripped-down title string ready for the
622 * search index
623 */
624 public function getIndexTitle() {
625 return Title::indexTitle( $this->mNamespace, $this->mTextform );
626 }
627
628 /**
629 * Get the prefixed database key form
630 * @return string the prefixed title, with underscores and
631 * any interwiki and namespace prefixes
632 */
633 public function getPrefixedDBkey() {
634 $s = $this->prefix( $this->mDbkeyform );
635 $s = str_replace( ' ', '_', $s );
636 return $s;
637 }
638
639 /**
640 * Get the prefixed title with spaces.
641 * This is the form usually used for display
642 * @return string the prefixed title, with spaces
643 */
644 public function getPrefixedText() {
645 if ( empty( $this->mPrefixedText ) ) { // FIXME: bad usage of empty() ?
646 $s = $this->prefix( $this->mTextform );
647 $s = str_replace( '_', ' ', $s );
648 $this->mPrefixedText = $s;
649 }
650 return $this->mPrefixedText;
651 }
652
653 /**
654 * Get the prefixed title with spaces, plus any fragment
655 * (part beginning with '#')
656 * @return string the prefixed title, with spaces and
657 * the fragment, including '#'
658 */
659 public function getFullText() {
660 $text = $this->getPrefixedText();
661 if( '' != $this->mFragment ) {
662 $text .= '#' . $this->mFragment;
663 }
664 return $text;
665 }
666
667 /**
668 * Get the base name, i.e. the leftmost parts before the /
669 * @return string Base name
670 */
671 public function getBaseText() {
672 global $wgNamespacesWithSubpages;
673 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace ] ) && $wgNamespacesWithSubpages[ $this->mNamespace ] ) {
674 $parts = explode( '/', $this->getText() );
675 # Don't discard the real title if there's no subpage involved
676 if( count( $parts ) > 1 )
677 unset( $parts[ count( $parts ) - 1 ] );
678 return implode( '/', $parts );
679 } else {
680 return $this->getText();
681 }
682 }
683
684 /**
685 * Get the lowest-level subpage name, i.e. the rightmost part after /
686 * @return string Subpage name
687 */
688 public function getSubpageText() {
689 global $wgNamespacesWithSubpages;
690 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace ] ) && $wgNamespacesWithSubpages[ $this->mNamespace ] ) {
691 $parts = explode( '/', $this->mTextform );
692 return( $parts[ count( $parts ) - 1 ] );
693 } else {
694 return( $this->mTextform );
695 }
696 }
697
698 /**
699 * Get a URL-encoded form of the subpage text
700 * @return string URL-encoded subpage name
701 */
702 public function getSubpageUrlForm() {
703 $text = $this->getSubpageText();
704 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
705 $text = str_replace( '%28', '(', str_replace( '%29', ')', $text ) ); # Clean up the URL; per below, this might not be safe
706 return( $text );
707 }
708
709 /**
710 * Get a URL-encoded title (not an actual URL) including interwiki
711 * @return string the URL-encoded form
712 */
713 public function getPrefixedURL() {
714 $s = $this->prefix( $this->mDbkeyform );
715 $s = str_replace( ' ', '_', $s );
716
717 $s = wfUrlencode ( $s ) ;
718
719 # Cleaning up URL to make it look nice -- is this safe?
720 $s = str_replace( '%28', '(', $s );
721 $s = str_replace( '%29', ')', $s );
722
723 return $s;
724 }
725
726 /**
727 * Get a real URL referring to this title, with interwiki link and
728 * fragment
729 *
730 * @param string $query an optional query string, not used
731 * for interwiki links
732 * @param string $variant language variant of url (for sr, zh..)
733 * @return string the URL
734 */
735 public function getFullURL( $query = '', $variant = false ) {
736 global $wgContLang, $wgServer, $wgRequest;
737
738 if ( '' == $this->mInterwiki ) {
739 $url = $this->getLocalUrl( $query, $variant );
740
741 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
742 // Correct fix would be to move the prepending elsewhere.
743 if ($wgRequest->getVal('action') != 'render') {
744 $url = $wgServer . $url;
745 }
746 } else {
747 $baseUrl = $this->getInterwikiLink( $this->mInterwiki );
748
749 $namespace = wfUrlencode( $this->getNsText() );
750 if ( '' != $namespace ) {
751 # Can this actually happen? Interwikis shouldn't be parsed.
752 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
753 $namespace .= ':';
754 }
755 $url = str_replace( '$1', $namespace . $this->mUrlform, $baseUrl );
756 $url = wfAppendQuery( $url, $query );
757 }
758
759 # Finally, add the fragment.
760 $url .= $this->getFragmentForURL();
761
762 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
763 return $url;
764 }
765
766 /**
767 * Get a URL with no fragment or server name. If this page is generated
768 * with action=render, $wgServer is prepended.
769 * @param string $query an optional query string; if not specified,
770 * $wgArticlePath will be used.
771 * @param string $variant language variant of url (for sr, zh..)
772 * @return string the URL
773 */
774 public function getLocalURL( $query = '', $variant = false ) {
775 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
776 global $wgVariantArticlePath, $wgContLang, $wgUser;
777
778 // internal links should point to same variant as current page (only anonymous users)
779 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
780 $pref = $wgContLang->getPreferredVariant(false);
781 if($pref != $wgContLang->getCode())
782 $variant = $pref;
783 }
784
785 if ( $this->isExternal() ) {
786 $url = $this->getFullURL();
787 if ( $query ) {
788 // This is currently only used for edit section links in the
789 // context of interwiki transclusion. In theory we should
790 // append the query to the end of any existing query string,
791 // but interwiki transclusion is already broken in that case.
792 $url .= "?$query";
793 }
794 } else {
795 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
796 if ( $query == '' ) {
797 if($variant!=false && $wgContLang->hasVariants()){
798 if($wgVariantArticlePath==false) {
799 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
800 } else {
801 $variantArticlePath = $wgVariantArticlePath;
802 }
803 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
804 $url = str_replace( '$1', $dbkey, $url );
805 }
806 else {
807 $url = str_replace( '$1', $dbkey, $wgArticlePath );
808 }
809 } else {
810 global $wgActionPaths;
811 $url = false;
812 $matches = array();
813 if( !empty( $wgActionPaths ) &&
814 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
815 {
816 $action = urldecode( $matches[2] );
817 if( isset( $wgActionPaths[$action] ) ) {
818 $query = $matches[1];
819 if( isset( $matches[4] ) ) $query .= $matches[4];
820 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
821 if( $query != '' ) $url .= '?' . $query;
822 }
823 }
824 if ( $url === false ) {
825 if ( $query == '-' ) {
826 $query = '';
827 }
828 $url = "{$wgScript}?title={$dbkey}&{$query}";
829 }
830 }
831
832 // FIXME: this causes breakage in various places when we
833 // actually expected a local URL and end up with dupe prefixes.
834 if ($wgRequest->getVal('action') == 'render') {
835 $url = $wgServer . $url;
836 }
837 }
838 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
839 return $url;
840 }
841
842 /**
843 * Get an HTML-escaped version of the URL form, suitable for
844 * using in a link, without a server name or fragment
845 * @param string $query an optional query string
846 * @return string the URL
847 */
848 public function escapeLocalURL( $query = '' ) {
849 return htmlspecialchars( $this->getLocalURL( $query ) );
850 }
851
852 /**
853 * Get an HTML-escaped version of the URL form, suitable for
854 * using in a link, including the server name and fragment
855 *
856 * @return string the URL
857 * @param string $query an optional query string
858 */
859 public function escapeFullURL( $query = '' ) {
860 return htmlspecialchars( $this->getFullURL( $query ) );
861 }
862
863 /**
864 * Get the URL form for an internal link.
865 * - Used in various Squid-related code, in case we have a different
866 * internal hostname for the server from the exposed one.
867 *
868 * @param string $query an optional query string
869 * @param string $variant language variant of url (for sr, zh..)
870 * @return string the URL
871 */
872 public function getInternalURL( $query = '', $variant = false ) {
873 global $wgInternalServer;
874 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
875 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
876 return $url;
877 }
878
879 /**
880 * Get the edit URL for this Title
881 * @return string the URL, or a null string if this is an
882 * interwiki link
883 */
884 public function getEditURL() {
885 if ( '' != $this->mInterwiki ) { return ''; }
886 $s = $this->getLocalURL( 'action=edit' );
887
888 return $s;
889 }
890
891 /**
892 * Get the HTML-escaped displayable text form.
893 * Used for the title field in <a> tags.
894 * @return string the text, including any prefixes
895 */
896 public function getEscapedText() {
897 return htmlspecialchars( $this->getPrefixedText() );
898 }
899
900 /**
901 * Is this Title interwiki?
902 * @return boolean
903 */
904 public function isExternal() { return ( '' != $this->mInterwiki ); }
905
906 /**
907 * Is this page "semi-protected" - the *only* protection is autoconfirm?
908 *
909 * @param string Action to check (default: edit)
910 * @return bool
911 */
912 public function isSemiProtected( $action = 'edit' ) {
913 if( $this->exists() ) {
914 $restrictions = $this->getRestrictions( $action );
915 if( count( $restrictions ) > 0 ) {
916 foreach( $restrictions as $restriction ) {
917 if( strtolower( $restriction ) != 'autoconfirmed' )
918 return false;
919 }
920 } else {
921 # Not protected
922 return false;
923 }
924 return true;
925 } else {
926 # If it doesn't exist, it can't be protected
927 return false;
928 }
929 }
930
931 /**
932 * Does the title correspond to a protected article?
933 * @param string $what the action the page is protected from,
934 * by default checks move and edit
935 * @return boolean
936 */
937 public function isProtected( $action = '' ) {
938 global $wgRestrictionLevels;
939
940 # Special pages have inherent protection
941 if( $this->getNamespace() == NS_SPECIAL )
942 return true;
943
944 # Check regular protection levels
945 if( $action == 'edit' || $action == '' ) {
946 $r = $this->getRestrictions( 'edit' );
947 foreach( $wgRestrictionLevels as $level ) {
948 if( in_array( $level, $r ) && $level != '' ) {
949 return( true );
950 }
951 }
952 }
953
954 if( $action == 'move' || $action == '' ) {
955 $r = $this->getRestrictions( 'move' );
956 foreach( $wgRestrictionLevels as $level ) {
957 if( in_array( $level, $r ) && $level != '' ) {
958 return( true );
959 }
960 }
961 }
962
963 return false;
964 }
965
966 /**
967 * Is $wgUser is watching this page?
968 * @return boolean
969 */
970 public function userIsWatching() {
971 global $wgUser;
972
973 if ( is_null( $this->mWatched ) ) {
974 if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn()) {
975 $this->mWatched = false;
976 } else {
977 $this->mWatched = $wgUser->isWatched( $this );
978 }
979 }
980 return $this->mWatched;
981 }
982
983 /**
984 * Can $wgUser perform $action on this page?
985 * This skips potentially expensive cascading permission checks.
986 *
987 * Suitable for use for nonessential UI controls in common cases, but
988 * _not_ for functional access control.
989 *
990 * May provide false positives, but should never provide a false negative.
991 *
992 * @param string $action action that permission needs to be checked for
993 * @return boolean
994 */
995 public function quickUserCan( $action ) {
996 return $this->userCan( $action, false );
997 }
998
999 /**
1000 * Determines if $wgUser is unable to edit this page because it has been protected
1001 * by $wgNamespaceProtection.
1002 *
1003 * @return boolean
1004 */
1005 public function isNamespaceProtected() {
1006 global $wgNamespaceProtection, $wgUser;
1007 if( isset( $wgNamespaceProtection[ $this->mNamespace ] ) ) {
1008 foreach( (array)$wgNamespaceProtection[ $this->mNamespace ] as $right ) {
1009 if( $right != '' && !$wgUser->isAllowed( $right ) )
1010 return true;
1011 }
1012 }
1013 return false;
1014 }
1015
1016 /**
1017 * Can $wgUser perform $action on this page?
1018 * @param string $action action that permission needs to be checked for
1019 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1020 * @return boolean
1021 */
1022 public function userCan( $action, $doExpensiveQueries = true ) {
1023 global $wgUser;
1024 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries ) === array());
1025 }
1026
1027 /**
1028 * Can $user perform $action on this page?
1029 * @param string $action action that permission needs to be checked for
1030 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1031 * @return array Array of arrays of the arguments to wfMsg to explain permissions problems.
1032 */
1033 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true ) {
1034 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1035
1036 global $wgContLang;
1037 global $wgLang;
1038
1039 if ( wfReadOnly() && $action != 'read' ) {
1040 $errors[] = array( 'readonlytext' );
1041 }
1042
1043 global $wgEmailConfirmToEdit, $wgUser;
1044
1045 if ( $wgEmailConfirmToEdit && !$wgUser->isEmailConfirmed() )
1046 {
1047 $errors[] = array( 'confirmedittext' );
1048 }
1049
1050 if ( $user->isBlockedFrom( $this ) ) {
1051 $block = $user->mBlock;
1052
1053 // This is from OutputPage::blockedPage
1054 // Copied at r23888 by werdna
1055
1056 $id = $user->blockedBy();
1057 $reason = $user->blockedFor();
1058 $ip = wfGetIP();
1059
1060 if ( is_numeric( $id ) ) {
1061 $name = User::whoIs( $id );
1062 } else {
1063 $name = $id;
1064 }
1065
1066 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
1067 $blockid = $block->mId;
1068 $blockExpiry = $user->mBlock->mExpiry;
1069 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true );
1070
1071 if ( $blockExpiry == 'infinity' ) {
1072 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1073 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1074
1075 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1076 if ( strpos( $option, ':' ) == false )
1077 continue;
1078
1079 list ($show, $value) = explode( ":", $option );
1080
1081 if ( $value == 'infinite' || $value == 'indefinite' ) {
1082 $blockExpiry = $show;
1083 break;
1084 }
1085 }
1086 } else {
1087 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
1088 }
1089
1090 $intended = $user->mBlock->mAddress;
1091
1092 $errors[] = array ( ($block->mAuto ? 'autoblockedtext' : 'blockedtext'), $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp );
1093 }
1094
1095 return $errors;
1096 }
1097
1098 /**
1099 * Can $user perform $action on this page?
1100 * This is an internal function, which checks ONLY that previously checked by userCan (i.e. it leaves out checks on wfReadOnly() and blocks)
1101 * @param string $action action that permission needs to be checked for
1102 * @param bool $doExpensiveQueries Set this to false to avoid doing unnecessary queries.
1103 * @return array Array of arrays of the arguments to wfMsg to explain permissions problems.
1104 */
1105 private function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true ) {
1106 $fname = 'Title::userCan';
1107 wfProfileIn( $fname );
1108
1109 $errors = array();
1110
1111 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1112 return $result ? array() : array( array( 'badaccess-group0' ) );
1113 }
1114
1115 if( NS_SPECIAL == $this->mNamespace ) {
1116 $errors[] = array('ns-specialprotected');
1117 }
1118
1119 if ( $this->isNamespaceProtected() ) {
1120 $ns = $this->getNamespace() == NS_MAIN
1121 ? wfMsg( 'nstab-main' )
1122 : $this->getNsText();
1123 $errors[] = (NS_MEDIAWIKI == $this->mNamespace
1124 ? array('protectedinterface')
1125 : array( 'namespaceprotected', $ns ) );
1126 }
1127
1128 if( $this->mDbkeyform == '_' ) {
1129 # FIXME: Is this necessary? Shouldn't be allowed anyway...
1130 $errors[] = array('badaccess-group0');
1131 }
1132
1133 # protect css/js subpages of user pages
1134 # XXX: this might be better using restrictions
1135 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1136 if( $this->isCssJsSubpage()
1137 && !$user->isAllowed('editinterface')
1138 && !preg_match('/^'.preg_quote($user->getName(), '/').'\//', $this->mTextform) ) {
1139 $errors[] = array('customcssjsprotected');
1140 }
1141
1142 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1143 # We /could/ use the protection level on the source page, but it's fairly ugly
1144 # as we have to establish a precedence hierarchy for pages included by multiple
1145 # cascade-protected pages. So just restrict it to people with 'protect' permission,
1146 # as they could remove the protection anyway.
1147 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1148 # Cascading protection depends on more than this page...
1149 # Several cascading protected pages may include this page...
1150 # Check each cascading level
1151 # This is only for protection restrictions, not for all actions
1152 if( $cascadingSources > 0 && isset($restrictions[$action]) ) {
1153 foreach( $restrictions[$action] as $right ) {
1154 $right = ( $right == 'sysop' ) ? 'protect' : $right;
1155 if( '' != $right && !$user->isAllowed( $right ) ) {
1156 $pages = '';
1157 foreach( $cascadingSources as $page )
1158 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1159 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1160 }
1161 }
1162 }
1163 }
1164
1165 foreach( $this->getRestrictions($action) as $right ) {
1166 // Backwards compatibility, rewrite sysop -> protect
1167 if ( $right == 'sysop' ) {
1168 $right = 'protect';
1169 }
1170 if( '' != $right && !$user->isAllowed( $right ) ) {
1171 $errors[] = array( 'protectedpagetext' );
1172 }
1173 }
1174
1175 if( $action == 'create' ) {
1176 if( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1177 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1178 $errors[] = $user->isAnon() ? array ('nocreatetext') : array ('nocreate-loggedin');
1179 }
1180 } elseif( $action == 'move' &&
1181 !( $this->isMovable() && $user->isAllowed( 'move' ) ) ) {
1182 $errors[] = $user->isAnon() ? array ( 'movenologintext' ) : array ('movenotallowed');
1183 } else if ( !$user->isAllowed( $action ) ) {
1184 $return = null;
1185 $groups = array();
1186 global $wgGroupPermissions;
1187 foreach( $wgGroupPermissions as $key => $value ) {
1188 if( isset( $value[$action] ) && $value[$action] == true ) {
1189 $groupName = User::getGroupName( $key );
1190 $groupPage = User::getGroupPage( $key );
1191 if( $groupPage ) {
1192 $skin = $user->getSkin();
1193 $groups[] = $skin->makeLinkObj( $groupPage, $groupName );
1194 } else {
1195 $groups[] = $groupName;
1196 }
1197 }
1198 }
1199 $n = count( $groups );
1200 $groups = implode( ', ', $groups );
1201 switch( $n ) {
1202 case 0:
1203 case 1:
1204 case 2:
1205 $return = array( "badaccess-group$n", $groups );
1206 break;
1207 default:
1208 $return = array( 'badaccess-groups', $groups );
1209 }
1210 $errors[] = $return;
1211 }
1212
1213 wfProfileOut( $fname );
1214 return $errors;
1215 }
1216
1217 /**
1218 * Can $wgUser edit this page?
1219 * @return boolean
1220 * @deprecated use userCan('edit')
1221 */
1222 public function userCanEdit( $doExpensiveQueries = true ) {
1223 return $this->userCan( 'edit', $doExpensiveQueries );
1224 }
1225
1226 /**
1227 * Can $wgUser create this page?
1228 * @return boolean
1229 * @deprecated use userCan('create')
1230 */
1231 public function userCanCreate( $doExpensiveQueries = true ) {
1232 return $this->userCan( 'create', $doExpensiveQueries );
1233 }
1234
1235 /**
1236 * Can $wgUser move this page?
1237 * @return boolean
1238 * @deprecated use userCan('move')
1239 */
1240 public function userCanMove( $doExpensiveQueries = true ) {
1241 return $this->userCan( 'move', $doExpensiveQueries );
1242 }
1243
1244 /**
1245 * Would anybody with sufficient privileges be able to move this page?
1246 * Some pages just aren't movable.
1247 *
1248 * @return boolean
1249 */
1250 public function isMovable() {
1251 return Namespace::isMovable( $this->getNamespace() )
1252 && $this->getInterwiki() == '';
1253 }
1254
1255 /**
1256 * Can $wgUser read this page?
1257 * @return boolean
1258 * @todo fold these checks into userCan()
1259 */
1260 public function userCanRead() {
1261 global $wgUser;
1262
1263 $result = null;
1264 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1265 if ( $result !== null ) {
1266 return $result;
1267 }
1268
1269 if( $wgUser->isAllowed( 'read' ) ) {
1270 return true;
1271 } else {
1272 global $wgWhitelistRead;
1273
1274 /**
1275 * Always grant access to the login page.
1276 * Even anons need to be able to log in.
1277 */
1278 if( $this->isSpecial( 'Userlogin' ) || $this->isSpecial( 'Resetpass' ) ) {
1279 return true;
1280 }
1281
1282 /**
1283 * Check for explicit whitelisting
1284 */
1285 $name = $this->getPrefixedText();
1286 if( $wgWhitelistRead && in_array( $name, $wgWhitelistRead, true ) )
1287 return true;
1288
1289 /**
1290 * Old settings might have the title prefixed with
1291 * a colon for main-namespace pages
1292 */
1293 if( $wgWhitelistRead && $this->getNamespace() == NS_MAIN ) {
1294 if( in_array( ':' . $name, $wgWhitelistRead ) )
1295 return true;
1296 }
1297
1298 /**
1299 * If it's a special page, ditch the subpage bit
1300 * and check again
1301 */
1302 if( $this->getNamespace() == NS_SPECIAL ) {
1303 $name = $this->getText();
1304 list( $name, /* $subpage */) = SpecialPage::resolveAliasWithSubpage( $name );
1305 $pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
1306 if( in_array( $pure, $wgWhitelistRead, true ) )
1307 return true;
1308 }
1309
1310 }
1311 return false;
1312 }
1313
1314 /**
1315 * Is this a talk page of some sort?
1316 * @return bool
1317 */
1318 public function isTalkPage() {
1319 return Namespace::isTalk( $this->getNamespace() );
1320 }
1321
1322 /**
1323 * Is this a subpage?
1324 * @return bool
1325 */
1326 public function isSubpage() {
1327 global $wgNamespacesWithSubpages;
1328
1329 if( isset( $wgNamespacesWithSubpages[ $this->mNamespace ] ) ) {
1330 return ( strpos( $this->getText(), '/' ) !== false && $wgNamespacesWithSubpages[ $this->mNamespace ] == true );
1331 } else {
1332 return false;
1333 }
1334 }
1335
1336 /**
1337 * Could this page contain custom CSS or JavaScript, based
1338 * on the title?
1339 *
1340 * @return bool
1341 */
1342 public function isCssOrJsPage() {
1343 return $this->mNamespace == NS_MEDIAWIKI
1344 && preg_match( '!\.(?:css|js)$!u', $this->mTextform ) > 0;
1345 }
1346
1347 /**
1348 * Is this a .css or .js subpage of a user page?
1349 * @return bool
1350 */
1351 public function isCssJsSubpage() {
1352 return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.(?:css|js)$/", $this->mTextform ) );
1353 }
1354 /**
1355 * Is this a *valid* .css or .js subpage of a user page?
1356 * Check that the corresponding skin exists
1357 */
1358 public function isValidCssJsSubpage() {
1359 if ( $this->isCssJsSubpage() ) {
1360 $skinNames = Skin::getSkinNames();
1361 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1362 } else {
1363 return false;
1364 }
1365 }
1366 /**
1367 * Trim down a .css or .js subpage title to get the corresponding skin name
1368 */
1369 public function getSkinFromCssJsSubpage() {
1370 $subpage = explode( '/', $this->mTextform );
1371 $subpage = $subpage[ count( $subpage ) - 1 ];
1372 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1373 }
1374 /**
1375 * Is this a .css subpage of a user page?
1376 * @return bool
1377 */
1378 public function isCssSubpage() {
1379 return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.css$/", $this->mTextform ) );
1380 }
1381 /**
1382 * Is this a .js subpage of a user page?
1383 * @return bool
1384 */
1385 public function isJsSubpage() {
1386 return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.js$/", $this->mTextform ) );
1387 }
1388 /**
1389 * Protect css/js subpages of user pages: can $wgUser edit
1390 * this page?
1391 *
1392 * @return boolean
1393 * @todo XXX: this might be better using restrictions
1394 */
1395 public function userCanEditCssJsSubpage() {
1396 global $wgUser;
1397 return ( $wgUser->isAllowed('editinterface') or preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) );
1398 }
1399
1400 /**
1401 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1402 *
1403 * @return bool If the page is subject to cascading restrictions.
1404 */
1405 public function isCascadeProtected() {
1406 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1407 return ( $sources > 0 );
1408 }
1409
1410 /**
1411 * Cascading protection: Get the source of any cascading restrictions on this page.
1412 *
1413 * @param $get_pages bool Whether or not to retrieve the actual pages that the restrictions have come from.
1414 * @return array( mixed title array, restriction array)
1415 * Array of the Title objects of the pages from which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set.
1416 * The restriction array is an array of each type, each of which contains an array of unique groups
1417 */
1418 public function getCascadeProtectionSources( $get_pages = true ) {
1419 global $wgEnableCascadingProtection, $wgRestrictionTypes;
1420
1421 # Define our dimension of restrictions types
1422 $pagerestrictions = array();
1423 foreach( $wgRestrictionTypes as $action )
1424 $pagerestrictions[$action] = array();
1425
1426 if (!$wgEnableCascadingProtection)
1427 return array( false, $pagerestrictions );
1428
1429 if ( isset( $this->mCascadeSources ) && $get_pages ) {
1430 return array( $this->mCascadeSources, $this->mCascadingRestrictions );
1431 } else if ( isset( $this->mHasCascadingRestrictions ) && !$get_pages ) {
1432 return array( $this->mHasCascadingRestrictions, $pagerestrictions );
1433 }
1434
1435 wfProfileIn( __METHOD__ );
1436
1437 $dbr = wfGetDb( DB_SLAVE );
1438
1439 if ( $this->getNamespace() == NS_IMAGE ) {
1440 $tables = array ('imagelinks', 'page_restrictions');
1441 $where_clauses = array(
1442 'il_to' => $this->getDBkey(),
1443 'il_from=pr_page',
1444 'pr_cascade' => 1 );
1445 } else {
1446 $tables = array ('templatelinks', 'page_restrictions');
1447 $where_clauses = array(
1448 'tl_namespace' => $this->getNamespace(),
1449 'tl_title' => $this->getDBkey(),
1450 'tl_from=pr_page',
1451 'pr_cascade' => 1 );
1452 }
1453
1454 if ( $get_pages ) {
1455 $cols = array('pr_page', 'page_namespace', 'page_title', 'pr_expiry', 'pr_type', 'pr_level' );
1456 $where_clauses[] = 'page_id=pr_page';
1457 $tables[] = 'page';
1458 } else {
1459 $cols = array( 'pr_expiry' );
1460 }
1461
1462 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
1463
1464 $sources = $get_pages ? array() : false;
1465 $now = wfTimestampNow();
1466 $purgeExpired = false;
1467
1468 while( $row = $dbr->fetchObject( $res ) ) {
1469 $expiry = Block::decodeExpiry( $row->pr_expiry );
1470 if( $expiry > $now ) {
1471 if ($get_pages) {
1472 $page_id = $row->pr_page;
1473 $page_ns = $row->page_namespace;
1474 $page_title = $row->page_title;
1475 $sources[$page_id] = Title::makeTitle($page_ns, $page_title);
1476 # Add groups needed for each restriction type if its not already there
1477 # Make sure this restriction type still exists
1478 if ( isset($pagerestrictions[$row->pr_type]) && !in_array($row->pr_level, $pagerestrictions[$row->pr_type]) ) {
1479 $pagerestrictions[$row->pr_type][]=$row->pr_level;
1480 }
1481 } else {
1482 $sources = true;
1483 }
1484 } else {
1485 // Trigger lazy purge of expired restrictions from the db
1486 $purgeExpired = true;
1487 }
1488 }
1489 if( $purgeExpired ) {
1490 Title::purgeExpiredRestrictions();
1491 }
1492
1493 wfProfileOut( __METHOD__ );
1494
1495 if ( $get_pages ) {
1496 $this->mCascadeSources = $sources;
1497 $this->mCascadingRestrictions = $pagerestrictions;
1498 } else {
1499 $this->mHasCascadingRestrictions = $sources;
1500 }
1501
1502 return array( $sources, $pagerestrictions );
1503 }
1504
1505 function areRestrictionsCascading() {
1506 if (!$this->mRestrictionsLoaded) {
1507 $this->loadRestrictions();
1508 }
1509
1510 return $this->mCascadeRestriction;
1511 }
1512
1513 /**
1514 * Loads a string into mRestrictions array
1515 * @param resource $res restrictions as an SQL result.
1516 */
1517 private function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) {
1518 $dbr = wfGetDb( DB_SLAVE );
1519
1520 $this->mRestrictions['edit'] = array();
1521 $this->mRestrictions['move'] = array();
1522
1523 # Backwards-compatibility: also load the restrictions from the page record (old format).
1524
1525 if ( $oldFashionedRestrictions == NULL ) {
1526 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions', array( 'page_id' => $this->getArticleId() ), __METHOD__ );
1527 }
1528
1529 if ($oldFashionedRestrictions != '') {
1530
1531 foreach( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
1532 $temp = explode( '=', trim( $restrict ) );
1533 if(count($temp) == 1) {
1534 // old old format should be treated as edit/move restriction
1535 $this->mRestrictions["edit"] = explode( ',', trim( $temp[0] ) );
1536 $this->mRestrictions["move"] = explode( ',', trim( $temp[0] ) );
1537 } else {
1538 $this->mRestrictions[$temp[0]] = explode( ',', trim( $temp[1] ) );
1539 }
1540 }
1541
1542 $this->mOldRestrictions = true;
1543 $this->mCascadeRestriction = false;
1544 $this->mRestrictionsExpiry = Block::decodeExpiry('');
1545
1546 }
1547
1548 if( $dbr->numRows( $res ) ) {
1549 # Current system - load second to make them override.
1550 $now = wfTimestampNow();
1551 $purgeExpired = false;
1552
1553 while ($row = $dbr->fetchObject( $res ) ) {
1554 # Cycle through all the restrictions.
1555
1556 // This code should be refactored, now that it's being used more generally,
1557 // But I don't really see any harm in leaving it in Block for now -werdna
1558 $expiry = Block::decodeExpiry( $row->pr_expiry );
1559
1560 // Only apply the restrictions if they haven't expired!
1561 if ( !$expiry || $expiry > $now ) {
1562 $this->mRestrictionsExpiry = $expiry;
1563 $this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
1564
1565 $this->mCascadeRestriction |= $row->pr_cascade;
1566 } else {
1567 // Trigger a lazy purge of expired restrictions
1568 $purgeExpired = true;
1569 }
1570 }
1571
1572 if( $purgeExpired ) {
1573 Title::purgeExpiredRestrictions();
1574 }
1575 }
1576
1577 $this->mRestrictionsLoaded = true;
1578 }
1579
1580 public function loadRestrictions( $oldFashionedRestrictions = NULL ) {
1581 if( !$this->mRestrictionsLoaded ) {
1582 $dbr = wfGetDB( DB_SLAVE );
1583
1584 $res = $dbr->select( 'page_restrictions', '*',
1585 array ( 'pr_page' => $this->getArticleId() ), __METHOD__ );
1586
1587 $this->loadRestrictionsFromRow( $res, $oldFashionedRestrictions );
1588 }
1589 }
1590
1591 /**
1592 * Purge expired restrictions from the page_restrictions table
1593 */
1594 static function purgeExpiredRestrictions() {
1595 $dbw = wfGetDB( DB_MASTER );
1596 $dbw->delete( 'page_restrictions',
1597 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1598 __METHOD__ );
1599 }
1600
1601 /**
1602 * Accessor/initialisation for mRestrictions
1603 *
1604 * @param string $action action that permission needs to be checked for
1605 * @return array the array of groups allowed to edit this article
1606 */
1607 public function getRestrictions( $action ) {
1608 if( $this->exists() ) {
1609 if( !$this->mRestrictionsLoaded ) {
1610 $this->loadRestrictions();
1611 }
1612 return isset( $this->mRestrictions[$action] )
1613 ? $this->mRestrictions[$action]
1614 : array();
1615 } else {
1616 return array();
1617 }
1618 }
1619
1620 /**
1621 * Is there a version of this page in the deletion archive?
1622 * @return int the number of archived revisions
1623 */
1624 public function isDeleted() {
1625 $fname = 'Title::isDeleted';
1626 if ( $this->getNamespace() < 0 ) {
1627 $n = 0;
1628 } else {
1629 $dbr = wfGetDB( DB_SLAVE );
1630 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1631 'ar_title' => $this->getDBkey() ), $fname );
1632 if( $this->getNamespace() == NS_IMAGE ) {
1633 $n += $dbr->selectField( 'filearchive', 'COUNT(*)',
1634 array( 'fa_name' => $this->getDBkey() ), $fname );
1635 }
1636 }
1637 return (int)$n;
1638 }
1639
1640 /**
1641 * Get the article ID for this Title from the link cache,
1642 * adding it if necessary
1643 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select
1644 * for update
1645 * @return int the ID
1646 */
1647 public function getArticleID( $flags = 0 ) {
1648 $linkCache =& LinkCache::singleton();
1649 if ( $flags & GAID_FOR_UPDATE ) {
1650 $oldUpdate = $linkCache->forUpdate( true );
1651 $this->mArticleID = $linkCache->addLinkObj( $this );
1652 $linkCache->forUpdate( $oldUpdate );
1653 } else {
1654 if ( -1 == $this->mArticleID ) {
1655 $this->mArticleID = $linkCache->addLinkObj( $this );
1656 }
1657 }
1658 return $this->mArticleID;
1659 }
1660
1661 public function getLatestRevID() {
1662 if ($this->mLatestID !== false)
1663 return $this->mLatestID;
1664
1665 $db = wfGetDB(DB_SLAVE);
1666 return $this->mLatestID = $db->selectField( 'revision',
1667 "max(rev_id)",
1668 array('rev_page' => $this->getArticleID()),
1669 'Title::getLatestRevID' );
1670 }
1671
1672 /**
1673 * This clears some fields in this object, and clears any associated
1674 * keys in the "bad links" section of the link cache.
1675 *
1676 * - This is called from Article::insertNewArticle() to allow
1677 * loading of the new page_id. It's also called from
1678 * Article::doDeleteArticle()
1679 *
1680 * @param int $newid the new Article ID
1681 */
1682 public function resetArticleID( $newid ) {
1683 $linkCache =& LinkCache::singleton();
1684 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
1685
1686 if ( 0 == $newid ) { $this->mArticleID = -1; }
1687 else { $this->mArticleID = $newid; }
1688 $this->mRestrictionsLoaded = false;
1689 $this->mRestrictions = array();
1690 }
1691
1692 /**
1693 * Updates page_touched for this page; called from LinksUpdate.php
1694 * @return bool true if the update succeded
1695 */
1696 public function invalidateCache() {
1697 global $wgUseFileCache;
1698
1699 if ( wfReadOnly() ) {
1700 return;
1701 }
1702
1703 $dbw = wfGetDB( DB_MASTER );
1704 $success = $dbw->update( 'page',
1705 array( /* SET */
1706 'page_touched' => $dbw->timestamp()
1707 ), array( /* WHERE */
1708 'page_namespace' => $this->getNamespace() ,
1709 'page_title' => $this->getDBkey()
1710 ), 'Title::invalidateCache'
1711 );
1712
1713 if ($wgUseFileCache) {
1714 $cache = new HTMLFileCache($this);
1715 @unlink($cache->fileCacheName());
1716 }
1717
1718 return $success;
1719 }
1720
1721 /**
1722 * Prefix some arbitrary text with the namespace or interwiki prefix
1723 * of this object
1724 *
1725 * @param string $name the text
1726 * @return string the prefixed text
1727 * @private
1728 */
1729 /* private */ function prefix( $name ) {
1730 $p = '';
1731 if ( '' != $this->mInterwiki ) {
1732 $p = $this->mInterwiki . ':';
1733 }
1734 if ( 0 != $this->mNamespace ) {
1735 $p .= $this->getNsText() . ':';
1736 }
1737 return $p . $name;
1738 }
1739
1740 /**
1741 * Secure and split - main initialisation function for this object
1742 *
1743 * Assumes that mDbkeyform has been set, and is urldecoded
1744 * and uses underscores, but not otherwise munged. This function
1745 * removes illegal characters, splits off the interwiki and
1746 * namespace prefixes, sets the other forms, and canonicalizes
1747 * everything.
1748 * @return bool true on success
1749 */
1750 private function secureAndSplit() {
1751 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
1752
1753 # Initialisation
1754 static $rxTc = false;
1755 if( !$rxTc ) {
1756 # % is needed as well
1757 $rxTc = '/[^' . Title::legalChars() . ']|%[0-9A-Fa-f]{2}/S';
1758 }
1759
1760 $this->mInterwiki = $this->mFragment = '';
1761 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
1762
1763 $dbkey = $this->mDbkeyform;
1764
1765 # Strip Unicode bidi override characters.
1766 # Sometimes they slip into cut-n-pasted page titles, where the
1767 # override chars get included in list displays.
1768 $dbkey = str_replace( "\xE2\x80\x8E", '', $dbkey ); // 200E LEFT-TO-RIGHT MARK
1769 $dbkey = str_replace( "\xE2\x80\x8F", '', $dbkey ); // 200F RIGHT-TO-LEFT MARK
1770
1771 # Clean up whitespace
1772 #
1773 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
1774 $dbkey = trim( $dbkey, '_' );
1775
1776 if ( '' == $dbkey ) {
1777 return false;
1778 }
1779
1780 if( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
1781 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
1782 return false;
1783 }
1784
1785 $this->mDbkeyform = $dbkey;
1786
1787 # Initial colon indicates main namespace rather than specified default
1788 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
1789 if ( ':' == $dbkey{0} ) {
1790 $this->mNamespace = NS_MAIN;
1791 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
1792 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
1793 }
1794
1795 # Namespace or interwiki prefix
1796 $firstPass = true;
1797 do {
1798 $m = array();
1799 if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $dbkey, $m ) ) {
1800 $p = $m[1];
1801 if ( $ns = $wgContLang->getNsIndex( $p )) {
1802 # Ordinary namespace
1803 $dbkey = $m[2];
1804 $this->mNamespace = $ns;
1805 } elseif( $this->getInterwikiLink( $p ) ) {
1806 if( !$firstPass ) {
1807 # Can't make a local interwiki link to an interwiki link.
1808 # That's just crazy!
1809 return false;
1810 }
1811
1812 # Interwiki link
1813 $dbkey = $m[2];
1814 $this->mInterwiki = $wgContLang->lc( $p );
1815
1816 # Redundant interwiki prefix to the local wiki
1817 if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
1818 if( $dbkey == '' ) {
1819 # Can't have an empty self-link
1820 return false;
1821 }
1822 $this->mInterwiki = '';
1823 $firstPass = false;
1824 # Do another namespace split...
1825 continue;
1826 }
1827
1828 # If there's an initial colon after the interwiki, that also
1829 # resets the default namespace
1830 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
1831 $this->mNamespace = NS_MAIN;
1832 $dbkey = substr( $dbkey, 1 );
1833 }
1834 }
1835 # If there's no recognized interwiki or namespace,
1836 # then let the colon expression be part of the title.
1837 }
1838 break;
1839 } while( true );
1840
1841 # We already know that some pages won't be in the database!
1842 #
1843 if ( '' != $this->mInterwiki || NS_SPECIAL == $this->mNamespace ) {
1844 $this->mArticleID = 0;
1845 }
1846 $fragment = strstr( $dbkey, '#' );
1847 if ( false !== $fragment ) {
1848 $this->setFragment( $fragment );
1849 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
1850 # remove whitespace again: prevents "Foo_bar_#"
1851 # becoming "Foo_bar_"
1852 $dbkey = preg_replace( '/_*$/', '', $dbkey );
1853 }
1854
1855 # Reject illegal characters.
1856 #
1857 if( preg_match( $rxTc, $dbkey ) ) {
1858 return false;
1859 }
1860
1861 /**
1862 * Pages with "/./" or "/../" appearing in the URLs will
1863 * often be unreachable due to the way web browsers deal
1864 * with 'relative' URLs. Forbid them explicitly.
1865 */
1866 if ( strpos( $dbkey, '.' ) !== false &&
1867 ( $dbkey === '.' || $dbkey === '..' ||
1868 strpos( $dbkey, './' ) === 0 ||
1869 strpos( $dbkey, '../' ) === 0 ||
1870 strpos( $dbkey, '/./' ) !== false ||
1871 strpos( $dbkey, '/../' ) !== false ) )
1872 {
1873 return false;
1874 }
1875
1876 /**
1877 * Magic tilde sequences? Nu-uh!
1878 */
1879 if( strpos( $dbkey, '~~~' ) !== false ) {
1880 return false;
1881 }
1882
1883 /**
1884 * Limit the size of titles to 255 bytes.
1885 * This is typically the size of the underlying database field.
1886 * We make an exception for special pages, which don't need to be stored
1887 * in the database, and may edge over 255 bytes due to subpage syntax
1888 * for long titles, e.g. [[Special:Block/Long name]]
1889 */
1890 if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) ||
1891 strlen( $dbkey ) > 512 )
1892 {
1893 return false;
1894 }
1895
1896 /**
1897 * Normally, all wiki links are forced to have
1898 * an initial capital letter so [[foo]] and [[Foo]]
1899 * point to the same place.
1900 *
1901 * Don't force it for interwikis, since the other
1902 * site might be case-sensitive.
1903 */
1904 $this->mUserCaseDBKey = $dbkey;
1905 if( $wgCapitalLinks && $this->mInterwiki == '') {
1906 $dbkey = $wgContLang->ucfirst( $dbkey );
1907 }
1908
1909 /**
1910 * Can't make a link to a namespace alone...
1911 * "empty" local links can only be self-links
1912 * with a fragment identifier.
1913 */
1914 if( $dbkey == '' &&
1915 $this->mInterwiki == '' &&
1916 $this->mNamespace != NS_MAIN ) {
1917 return false;
1918 }
1919
1920 // Any remaining initial :s are illegal.
1921 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
1922 return false;
1923 }
1924
1925 # Fill fields
1926 $this->mDbkeyform = $dbkey;
1927 $this->mUrlform = wfUrlencode( $dbkey );
1928
1929 $this->mTextform = str_replace( '_', ' ', $dbkey );
1930
1931 return true;
1932 }
1933
1934 /**
1935 * Set the fragment for this title
1936 * This is kind of bad, since except for this rarely-used function, Title objects
1937 * are immutable. The reason this is here is because it's better than setting the
1938 * members directly, which is what Linker::formatComment was doing previously.
1939 *
1940 * @param string $fragment text
1941 * @todo clarify whether access is supposed to be public (was marked as "kind of public")
1942 */
1943 public function setFragment( $fragment ) {
1944 $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
1945 }
1946
1947 /**
1948 * Get a Title object associated with the talk page of this article
1949 * @return Title the object for the talk page
1950 */
1951 public function getTalkPage() {
1952 return Title::makeTitle( Namespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1953 }
1954
1955 /**
1956 * Get a title object associated with the subject page of this
1957 * talk page
1958 *
1959 * @return Title the object for the subject page
1960 */
1961 public function getSubjectPage() {
1962 return Title::makeTitle( Namespace::getSubject( $this->getNamespace() ), $this->getDBkey() );
1963 }
1964
1965 /**
1966 * Get an array of Title objects linking to this Title
1967 * Also stores the IDs in the link cache.
1968 *
1969 * WARNING: do not use this function on arbitrary user-supplied titles!
1970 * On heavily-used templates it will max out the memory.
1971 *
1972 * @param string $options may be FOR UPDATE
1973 * @return array the Title objects linking here
1974 */
1975 public function getLinksTo( $options = '', $table = 'pagelinks', $prefix = 'pl' ) {
1976 $linkCache =& LinkCache::singleton();
1977
1978 if ( $options ) {
1979 $db = wfGetDB( DB_MASTER );
1980 } else {
1981 $db = wfGetDB( DB_SLAVE );
1982 }
1983
1984 $res = $db->select( array( 'page', $table ),
1985 array( 'page_namespace', 'page_title', 'page_id' ),
1986 array(
1987 "{$prefix}_from=page_id",
1988 "{$prefix}_namespace" => $this->getNamespace(),
1989 "{$prefix}_title" => $this->getDbKey() ),
1990 'Title::getLinksTo',
1991 $options );
1992
1993 $retVal = array();
1994 if ( $db->numRows( $res ) ) {
1995 while ( $row = $db->fetchObject( $res ) ) {
1996 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
1997 $linkCache->addGoodLinkObj( $row->page_id, $titleObj );
1998 $retVal[] = $titleObj;
1999 }
2000 }
2001 }
2002 $db->freeResult( $res );
2003 return $retVal;
2004 }
2005
2006 /**
2007 * Get an array of Title objects using this Title as a template
2008 * Also stores the IDs in the link cache.
2009 *
2010 * WARNING: do not use this function on arbitrary user-supplied titles!
2011 * On heavily-used templates it will max out the memory.
2012 *
2013 * @param string $options may be FOR UPDATE
2014 * @return array the Title objects linking here
2015 */
2016 public function getTemplateLinksTo( $options = '' ) {
2017 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2018 }
2019
2020 /**
2021 * Get an array of Title objects referring to non-existent articles linked from this page
2022 *
2023 * @param string $options may be FOR UPDATE
2024 * @return array the Title objects
2025 */
2026 public function getBrokenLinksFrom( $options = '' ) {
2027 if ( $options ) {
2028 $db = wfGetDB( DB_MASTER );
2029 } else {
2030 $db = wfGetDB( DB_SLAVE );
2031 }
2032
2033 $res = $db->safeQuery(
2034 "SELECT pl_namespace, pl_title
2035 FROM !
2036 LEFT JOIN !
2037 ON pl_namespace=page_namespace
2038 AND pl_title=page_title
2039 WHERE pl_from=?
2040 AND page_namespace IS NULL
2041 !",
2042 $db->tableName( 'pagelinks' ),
2043 $db->tableName( 'page' ),
2044 $this->getArticleId(),
2045 $options );
2046
2047 $retVal = array();
2048 if ( $db->numRows( $res ) ) {
2049 while ( $row = $db->fetchObject( $res ) ) {
2050 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
2051 }
2052 }
2053 $db->freeResult( $res );
2054 return $retVal;
2055 }
2056
2057
2058 /**
2059 * Get a list of URLs to purge from the Squid cache when this
2060 * page changes
2061 *
2062 * @return array the URLs
2063 */
2064 public function getSquidURLs() {
2065 global $wgContLang;
2066
2067 $urls = array(
2068 $this->getInternalURL(),
2069 $this->getInternalURL( 'action=history' )
2070 );
2071
2072 // purge variant urls as well
2073 if($wgContLang->hasVariants()){
2074 $variants = $wgContLang->getVariants();
2075 foreach($variants as $vCode){
2076 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
2077 $urls[] = $this->getInternalURL('',$vCode);
2078 }
2079 }
2080
2081 return $urls;
2082 }
2083
2084 public function purgeSquid() {
2085 global $wgUseSquid;
2086 if ( $wgUseSquid ) {
2087 $urls = $this->getSquidURLs();
2088 $u = new SquidUpdate( $urls );
2089 $u->doUpdate();
2090 }
2091 }
2092
2093 /**
2094 * Move this page without authentication
2095 * @param Title &$nt the new page Title
2096 */
2097 public function moveNoAuth( &$nt ) {
2098 return $this->moveTo( $nt, false );
2099 }
2100
2101 /**
2102 * Check whether a given move operation would be valid.
2103 * Returns true if ok, or a message key string for an error message
2104 * if invalid. (Scarrrrry ugly interface this.)
2105 * @param Title &$nt the new title
2106 * @param bool $auth indicates whether $wgUser's permissions
2107 * should be checked
2108 * @return mixed true on success, message name on failure
2109 */
2110 public function isValidMoveOperation( &$nt, $auth = true ) {
2111 if( !$this or !$nt ) {
2112 return 'badtitletext';
2113 }
2114 if( $this->equals( $nt ) ) {
2115 return 'selfmove';
2116 }
2117 if( !$this->isMovable() || !$nt->isMovable() ) {
2118 return 'immobile_namespace';
2119 }
2120
2121 $oldid = $this->getArticleID();
2122 $newid = $nt->getArticleID();
2123
2124 if ( strlen( $nt->getDBkey() ) < 1 ) {
2125 return 'articleexists';
2126 }
2127 if ( ( '' == $this->getDBkey() ) ||
2128 ( !$oldid ) ||
2129 ( '' == $nt->getDBkey() ) ) {
2130 return 'badarticleerror';
2131 }
2132
2133 if ( $auth && (
2134 !$this->userCan( 'edit' ) || !$nt->userCan( 'edit' ) ||
2135 !$this->userCan( 'move' ) || !$nt->userCan( 'move' ) ) ) {
2136 return 'protectedpage';
2137 }
2138
2139 # The move is allowed only if (1) the target doesn't exist, or
2140 # (2) the target is a redirect to the source, and has no history
2141 # (so we can undo bad moves right after they're done).
2142
2143 if ( 0 != $newid ) { # Target exists; check for validity
2144 if ( ! $this->isValidMoveTarget( $nt ) ) {
2145 return 'articleexists';
2146 }
2147 }
2148 return true;
2149 }
2150
2151 /**
2152 * Move a title to a new location
2153 * @param Title &$nt the new title
2154 * @param bool $auth indicates whether $wgUser's permissions
2155 * should be checked
2156 * @return mixed true on success, message name on failure
2157 */
2158 public function moveTo( &$nt, $auth = true, $reason = '' ) {
2159 $err = $this->isValidMoveOperation( $nt, $auth );
2160 if( is_string( $err ) ) {
2161 return $err;
2162 }
2163
2164 $pageid = $this->getArticleID();
2165 if( $nt->exists() ) {
2166 $this->moveOverExistingRedirect( $nt, $reason );
2167 $pageCountChange = 0;
2168 } else { # Target didn't exist, do normal move.
2169 $this->moveToNewTitle( $nt, $reason );
2170 $pageCountChange = 1;
2171 }
2172 $redirid = $this->getArticleID();
2173
2174 # Fixing category links (those without piped 'alternate' names) to be sorted under the new title
2175 $dbw = wfGetDB( DB_MASTER );
2176 $categorylinks = $dbw->tableName( 'categorylinks' );
2177 $sql = "UPDATE $categorylinks SET cl_sortkey=" . $dbw->addQuotes( $nt->getPrefixedText() ) .
2178 " WHERE cl_from=" . $dbw->addQuotes( $pageid ) .
2179 " AND cl_sortkey=" . $dbw->addQuotes( $this->getPrefixedText() );
2180 $dbw->query( $sql, 'SpecialMovepage::doSubmit' );
2181
2182 # Update watchlists
2183
2184 $oldnamespace = $this->getNamespace() & ~1;
2185 $newnamespace = $nt->getNamespace() & ~1;
2186 $oldtitle = $this->getDBkey();
2187 $newtitle = $nt->getDBkey();
2188
2189 if( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
2190 WatchedItem::duplicateEntries( $this, $nt );
2191 }
2192
2193 # Update search engine
2194 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2195 $u->doUpdate();
2196 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2197 $u->doUpdate();
2198
2199 # Update site_stats
2200 if( $this->isContentPage() && !$nt->isContentPage() ) {
2201 # No longer a content page
2202 # Not viewed, edited, removing
2203 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2204 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2205 # Now a content page
2206 # Not viewed, edited, adding
2207 $u = new SiteStatsUpdate( 0, 1, +1, $pageCountChange );
2208 } elseif( $pageCountChange ) {
2209 # Redirect added
2210 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2211 } else {
2212 # Nothing special
2213 $u = false;
2214 }
2215 if( $u )
2216 $u->doUpdate();
2217
2218 global $wgUser;
2219 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2220 return true;
2221 }
2222
2223 /**
2224 * Move page to a title which is at present a redirect to the
2225 * source page
2226 *
2227 * @param Title &$nt the page to move to, which should currently
2228 * be a redirect
2229 */
2230 private function moveOverExistingRedirect( &$nt, $reason = '' ) {
2231 global $wgUseSquid;
2232 $fname = 'Title::moveOverExistingRedirect';
2233 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
2234
2235 if ( $reason ) {
2236 $comment .= ": $reason";
2237 }
2238
2239 $now = wfTimestampNow();
2240 $newid = $nt->getArticleID();
2241 $oldid = $this->getArticleID();
2242 $dbw = wfGetDB( DB_MASTER );
2243 $linkCache =& LinkCache::singleton();
2244
2245 # Delete the old redirect. We don't save it to history since
2246 # by definition if we've got here it's rather uninteresting.
2247 # We have to remove it so that the next step doesn't trigger
2248 # a conflict on the unique namespace+title index...
2249 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2250
2251 # Save a null revision in the page's history notifying of the move
2252 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
2253 $nullRevId = $nullRevision->insertOn( $dbw );
2254
2255 # Change the name of the target page:
2256 $dbw->update( 'page',
2257 /* SET */ array(
2258 'page_touched' => $dbw->timestamp($now),
2259 'page_namespace' => $nt->getNamespace(),
2260 'page_title' => $nt->getDBkey(),
2261 'page_latest' => $nullRevId,
2262 ),
2263 /* WHERE */ array( 'page_id' => $oldid ),
2264 $fname
2265 );
2266 $linkCache->clearLink( $nt->getPrefixedDBkey() );
2267
2268 # Recreate the redirect, this time in the other direction.
2269 $mwRedir = MagicWord::get( 'redirect' );
2270 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2271 $redirectArticle = new Article( $this );
2272 $newid = $redirectArticle->insertOn( $dbw );
2273 $redirectRevision = new Revision( array(
2274 'page' => $newid,
2275 'comment' => $comment,
2276 'text' => $redirectText ) );
2277 $redirectRevision->insertOn( $dbw );
2278 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2279 $linkCache->clearLink( $this->getPrefixedDBkey() );
2280
2281 # Log the move
2282 $log = new LogPage( 'move' );
2283 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
2284
2285 # Now, we record the link from the redirect to the new title.
2286 # It should have no other outgoing links...
2287 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2288 $dbw->insert( 'pagelinks',
2289 array(
2290 'pl_from' => $newid,
2291 'pl_namespace' => $nt->getNamespace(),
2292 'pl_title' => $nt->getDbKey() ),
2293 $fname );
2294
2295 # Purge squid
2296 if ( $wgUseSquid ) {
2297 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2298 $u = new SquidUpdate( $urls );
2299 $u->doUpdate();
2300 }
2301 }
2302
2303 /**
2304 * Move page to non-existing title.
2305 * @param Title &$nt the new Title
2306 */
2307 private function moveToNewTitle( &$nt, $reason = '' ) {
2308 global $wgUseSquid;
2309 $fname = 'MovePageForm::moveToNewTitle';
2310 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2311 if ( $reason ) {
2312 $comment .= ": $reason";
2313 }
2314
2315 $newid = $nt->getArticleID();
2316 $oldid = $this->getArticleID();
2317 $dbw = wfGetDB( DB_MASTER );
2318 $now = $dbw->timestamp();
2319 $linkCache =& LinkCache::singleton();
2320
2321 # Save a null revision in the page's history notifying of the move
2322 $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
2323 $nullRevId = $nullRevision->insertOn( $dbw );
2324
2325 # Rename cur entry
2326 $dbw->update( 'page',
2327 /* SET */ array(
2328 'page_touched' => $now,
2329 'page_namespace' => $nt->getNamespace(),
2330 'page_title' => $nt->getDBkey(),
2331 'page_latest' => $nullRevId,
2332 ),
2333 /* WHERE */ array( 'page_id' => $oldid ),
2334 $fname
2335 );
2336
2337 $linkCache->clearLink( $nt->getPrefixedDBkey() );
2338
2339 # Insert redirect
2340 $mwRedir = MagicWord::get( 'redirect' );
2341 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2342 $redirectArticle = new Article( $this );
2343 $newid = $redirectArticle->insertOn( $dbw );
2344 $redirectRevision = new Revision( array(
2345 'page' => $newid,
2346 'comment' => $comment,
2347 'text' => $redirectText ) );
2348 $redirectRevision->insertOn( $dbw );
2349 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2350 $linkCache->clearLink( $this->getPrefixedDBkey() );
2351
2352 # Log the move
2353 $log = new LogPage( 'move' );
2354 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
2355
2356 # Purge caches as per article creation
2357 Article::onArticleCreate( $nt );
2358
2359 # Record the just-created redirect's linking to the page
2360 $dbw->insert( 'pagelinks',
2361 array(
2362 'pl_from' => $newid,
2363 'pl_namespace' => $nt->getNamespace(),
2364 'pl_title' => $nt->getDBkey() ),
2365 $fname );
2366
2367 # Purge old title from squid
2368 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2369 $this->purgeSquid();
2370 }
2371
2372 /**
2373 * Checks if $this can be moved to a given Title
2374 * - Selects for update, so don't call it unless you mean business
2375 *
2376 * @param Title &$nt the new title to check
2377 */
2378 public function isValidMoveTarget( $nt ) {
2379
2380 $fname = 'Title::isValidMoveTarget';
2381 $dbw = wfGetDB( DB_MASTER );
2382
2383 # Is it a redirect?
2384 $id = $nt->getArticleID();
2385 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
2386 array( 'page_is_redirect','old_text','old_flags' ),
2387 array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
2388 $fname, 'FOR UPDATE' );
2389
2390 if ( !$obj || 0 == $obj->page_is_redirect ) {
2391 # Not a redirect
2392 wfDebug( __METHOD__ . ": not a redirect\n" );
2393 return false;
2394 }
2395 $text = Revision::getRevisionText( $obj );
2396
2397 # Does the redirect point to the source?
2398 # Or is it a broken self-redirect, usually caused by namespace collisions?
2399 $m = array();
2400 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
2401 $redirTitle = Title::newFromText( $m[1] );
2402 if( !is_object( $redirTitle ) ||
2403 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
2404 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
2405 wfDebug( __METHOD__ . ": redirect points to other page\n" );
2406 return false;
2407 }
2408 } else {
2409 # Fail safe
2410 wfDebug( __METHOD__ . ": failsafe\n" );
2411 return false;
2412 }
2413
2414 # Does the article have a history?
2415 $row = $dbw->selectRow( array( 'page', 'revision'),
2416 array( 'rev_id' ),
2417 array( 'page_namespace' => $nt->getNamespace(),
2418 'page_title' => $nt->getDBkey(),
2419 'page_id=rev_page AND page_latest != rev_id'
2420 ), $fname, 'FOR UPDATE'
2421 );
2422
2423 # Return true if there was no history
2424 return $row === false;
2425 }
2426
2427 /**
2428 * Can this title be added to a user's watchlist?
2429 *
2430 * @return bool
2431 */
2432 public function isWatchable() {
2433 return !$this->isExternal()
2434 && Namespace::isWatchable( $this->getNamespace() );
2435 }
2436
2437 /**
2438 * Get categories to which this Title belongs and return an array of
2439 * categories' names.
2440 *
2441 * @return array an array of parents in the form:
2442 * $parent => $currentarticle
2443 */
2444 public function getParentCategories() {
2445 global $wgContLang;
2446
2447 $titlekey = $this->getArticleId();
2448 $dbr = wfGetDB( DB_SLAVE );
2449 $categorylinks = $dbr->tableName( 'categorylinks' );
2450
2451 # NEW SQL
2452 $sql = "SELECT * FROM $categorylinks"
2453 ." WHERE cl_from='$titlekey'"
2454 ." AND cl_from <> '0'"
2455 ." ORDER BY cl_sortkey";
2456
2457 $res = $dbr->query ( $sql ) ;
2458
2459 if($dbr->numRows($res) > 0) {
2460 while ( $x = $dbr->fetchObject ( $res ) )
2461 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
2462 $data[$wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to] = $this->getFullText();
2463 $dbr->freeResult ( $res ) ;
2464 } else {
2465 $data = '';
2466 }
2467 return $data;
2468 }
2469
2470 /**
2471 * Get a tree of parent categories
2472 * @param array $children an array with the children in the keys, to check for circular refs
2473 * @return array
2474 */
2475 public function getParentCategoryTree( $children = array() ) {
2476 $parents = $this->getParentCategories();
2477
2478 if($parents != '') {
2479 foreach($parents as $parent => $current) {
2480 if ( array_key_exists( $parent, $children ) ) {
2481 # Circular reference
2482 $stack[$parent] = array();
2483 } else {
2484 $nt = Title::newFromText($parent);
2485 if ( $nt ) {
2486 $stack[$parent] = $nt->getParentCategoryTree( $children + array($parent => 1) );
2487 }
2488 }
2489 }
2490 return $stack;
2491 } else {
2492 return array();
2493 }
2494 }
2495
2496
2497 /**
2498 * Get an associative array for selecting this title from
2499 * the "page" table
2500 *
2501 * @return array
2502 */
2503 public function pageCond() {
2504 return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
2505 }
2506
2507 /**
2508 * Get the revision ID of the previous revision
2509 *
2510 * @param integer $revision Revision ID. Get the revision that was before this one.
2511 * @return integer $oldrevision|false
2512 */
2513 public function getPreviousRevisionID( $revision ) {
2514 $dbr = wfGetDB( DB_SLAVE );
2515 return $dbr->selectField( 'revision', 'rev_id',
2516 'rev_page=' . intval( $this->getArticleId() ) .
2517 ' AND rev_id<' . intval( $revision ) . ' ORDER BY rev_id DESC' );
2518 }
2519
2520 /**
2521 * Get the revision ID of the next revision
2522 *
2523 * @param integer $revision Revision ID. Get the revision that was after this one.
2524 * @return integer $oldrevision|false
2525 */
2526 public function getNextRevisionID( $revision ) {
2527 $dbr = wfGetDB( DB_SLAVE );
2528 return $dbr->selectField( 'revision', 'rev_id',
2529 'rev_page=' . intval( $this->getArticleId() ) .
2530 ' AND rev_id>' . intval( $revision ) . ' ORDER BY rev_id' );
2531 }
2532
2533 /**
2534 * Get the number of revisions between the given revision IDs.
2535 *
2536 * @param integer $old Revision ID.
2537 * @param integer $new Revision ID.
2538 * @return integer Number of revisions between these IDs.
2539 */
2540 public function countRevisionsBetween( $old, $new ) {
2541 $dbr = wfGetDB( DB_SLAVE );
2542 return $dbr->selectField( 'revision', 'count(*)',
2543 'rev_page = ' . intval( $this->getArticleId() ) .
2544 ' AND rev_id > ' . intval( $old ) .
2545 ' AND rev_id < ' . intval( $new ) );
2546 }
2547
2548 /**
2549 * Compare with another title.
2550 *
2551 * @param Title $title
2552 * @return bool
2553 */
2554 public function equals( $title ) {
2555 // Note: === is necessary for proper matching of number-like titles.
2556 return $this->getInterwiki() === $title->getInterwiki()
2557 && $this->getNamespace() == $title->getNamespace()
2558 && $this->getDbkey() === $title->getDbkey();
2559 }
2560
2561 /**
2562 * Return a string representation of this title
2563 *
2564 * @return string
2565 */
2566 public function __toString() {
2567 return $this->getPrefixedText();
2568 }
2569
2570 /**
2571 * Check if page exists
2572 * @return bool
2573 */
2574 public function exists() {
2575 return $this->getArticleId() != 0;
2576 }
2577
2578 /**
2579 * Do we know that this title definitely exists, or should we otherwise
2580 * consider that it exists?
2581 *
2582 * @return bool
2583 */
2584 public function isAlwaysKnown() {
2585 return $this->isExternal()
2586 || ( $this->mNamespace == NS_MAIN && $this->mDbkeyform == '' )
2587 || ( $this->mNamespace == NS_MEDIAWIKI && wfMsgWeirdKey( $this->mDbkeyform ) );
2588 }
2589
2590 /**
2591 * Update page_touched timestamps and send squid purge messages for
2592 * pages linking to this title. May be sent to the job queue depending
2593 * on the number of links. Typically called on create and delete.
2594 */
2595 public function touchLinks() {
2596 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
2597 $u->doUpdate();
2598
2599 if ( $this->getNamespace() == NS_CATEGORY ) {
2600 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
2601 $u->doUpdate();
2602 }
2603 }
2604
2605 /**
2606 * Get the last touched timestamp
2607 */
2608 public function getTouched() {
2609 $dbr = wfGetDB( DB_SLAVE );
2610 $touched = $dbr->selectField( 'page', 'page_touched',
2611 array(
2612 'page_namespace' => $this->getNamespace(),
2613 'page_title' => $this->getDBkey()
2614 ), __METHOD__
2615 );
2616 return $touched;
2617 }
2618
2619 public function trackbackURL() {
2620 global $wgTitle, $wgScriptPath, $wgServer;
2621
2622 return "$wgServer$wgScriptPath/trackback.php?article="
2623 . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey()));
2624 }
2625
2626 public function trackbackRDF() {
2627 $url = htmlspecialchars($this->getFullURL());
2628 $title = htmlspecialchars($this->getText());
2629 $tburl = $this->trackbackURL();
2630
2631 return "
2632 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
2633 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
2634 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
2635 <rdf:Description
2636 rdf:about=\"$url\"
2637 dc:identifier=\"$url\"
2638 dc:title=\"$title\"
2639 trackback:ping=\"$tburl\" />
2640 </rdf:RDF>";
2641 }
2642
2643 /**
2644 * Generate strings used for xml 'id' names in monobook tabs
2645 * @return string
2646 */
2647 public function getNamespaceKey() {
2648 global $wgContLang;
2649 switch ($this->getNamespace()) {
2650 case NS_MAIN:
2651 case NS_TALK:
2652 return 'nstab-main';
2653 case NS_USER:
2654 case NS_USER_TALK:
2655 return 'nstab-user';
2656 case NS_MEDIA:
2657 return 'nstab-media';
2658 case NS_SPECIAL:
2659 return 'nstab-special';
2660 case NS_PROJECT:
2661 case NS_PROJECT_TALK:
2662 return 'nstab-project';
2663 case NS_IMAGE:
2664 case NS_IMAGE_TALK:
2665 return 'nstab-image';
2666 case NS_MEDIAWIKI:
2667 case NS_MEDIAWIKI_TALK:
2668 return 'nstab-mediawiki';
2669 case NS_TEMPLATE:
2670 case NS_TEMPLATE_TALK:
2671 return 'nstab-template';
2672 case NS_HELP:
2673 case NS_HELP_TALK:
2674 return 'nstab-help';
2675 case NS_CATEGORY:
2676 case NS_CATEGORY_TALK:
2677 return 'nstab-category';
2678 default:
2679 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
2680 }
2681 }
2682
2683 /**
2684 * Returns true if this title resolves to the named special page
2685 * @param string $name The special page name
2686 */
2687 public function isSpecial( $name ) {
2688 if ( $this->getNamespace() == NS_SPECIAL ) {
2689 list( $thisName, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $this->getDBkey() );
2690 if ( $name == $thisName ) {
2691 return true;
2692 }
2693 }
2694 return false;
2695 }
2696
2697 /**
2698 * If the Title refers to a special page alias which is not the local default,
2699 * returns a new Title which points to the local default. Otherwise, returns $this.
2700 */
2701 public function fixSpecialName() {
2702 if ( $this->getNamespace() == NS_SPECIAL ) {
2703 $canonicalName = SpecialPage::resolveAlias( $this->mDbkeyform );
2704 if ( $canonicalName ) {
2705 $localName = SpecialPage::getLocalNameFor( $canonicalName );
2706 if ( $localName != $this->mDbkeyform ) {
2707 return Title::makeTitle( NS_SPECIAL, $localName );
2708 }
2709 }
2710 }
2711 return $this;
2712 }
2713
2714 /**
2715 * Is this Title in a namespace which contains content?
2716 * In other words, is this a content page, for the purposes of calculating
2717 * statistics, etc?
2718 *
2719 * @return bool
2720 */
2721 public function isContentPage() {
2722 return Namespace::isContent( $this->getNamespace() );
2723 }
2724
2725 }
2726
2727