* Removed exifReader.inc and added a function which does roughly the same
[lhc/web/wiklou.git] / includes / Title.php
1 <?php
2 /**
3 * See title.txt
4 *
5 * @package MediaWiki
6 */
7
8 /** */
9 require_once( 'normal/UtfNormal.php' );
10
11 $wgTitleInterwikiCache = array();
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 /**
22 * Title class
23 * - Represents a title, which may contain an interwiki designation or namespace
24 * - Can fetch various kinds of data from the database, albeit inefficiently.
25 *
26 * @package MediaWiki
27 */
28 class Title {
29 /**
30 * All member variables should be considered private
31 * Please use the accessor functions
32 */
33
34 /**#@+
35 * @access private
36 */
37
38 var $mTextform; # Text form (spaces not underscores) of the main part
39 var $mUrlform; # URL-encoded form of the main part
40 var $mDbkeyform; # Main part with underscores
41 var $mNamespace; # Namespace index, i.e. one of the NS_xxxx constants
42 var $mInterwiki; # Interwiki prefix (or null string)
43 var $mFragment; # Title fragment (i.e. the bit after the #)
44 var $mArticleID; # Article ID, fetched from the link cache on demand
45 var $mRestrictions; # Array of groups allowed to edit this article
46 # Only null or "sysop" are supported
47 var $mRestrictionsLoaded; # Boolean for initialisation on demand
48 var $mPrefixedText; # Text form including namespace/interwiki, initialised on demand
49 var $mDefaultNamespace; # Namespace index when there is no namespace
50 # Zero except in {{transclusion}} tags
51 /**#@-*/
52
53
54 /**
55 * Constructor
56 * @access private
57 */
58 /* private */ function Title() {
59 $this->mInterwiki = $this->mUrlform =
60 $this->mTextform = $this->mDbkeyform = '';
61 $this->mArticleID = -1;
62 $this->mNamespace = NS_MAIN;
63 $this->mRestrictionsLoaded = false;
64 $this->mRestrictions = array();
65 # Dont change the following, NS_MAIN is hardcoded in several place
66 # See bug #696
67 $this->mDefaultNamespace = NS_MAIN;
68 }
69
70 /**
71 * Create a new Title from a prefixed DB key
72 * @param string $key The database key, which has underscores
73 * instead of spaces, possibly including namespace and
74 * interwiki prefixes
75 * @return Title the new object, or NULL on an error
76 * @static
77 * @access public
78 */
79 /* static */ function newFromDBkey( $key ) {
80 $t = new Title();
81 $t->mDbkeyform = $key;
82 if( $t->secureAndSplit() )
83 return $t;
84 else
85 return NULL;
86 }
87
88 /**
89 * Create a new Title from text, such as what one would
90 * find in a link. Decodes any HTML entities in the text.
91 *
92 * @param string $text the link text; spaces, prefixes,
93 * and an initial ':' indicating the main namespace
94 * are accepted
95 * @param int $defaultNamespace the namespace to use if
96 * none is specified by a prefix
97 * @return Title the new object, or NULL on an error
98 * @static
99 * @access public
100 */
101 function &newFromText( $text, $defaultNamespace = NS_MAIN ) {
102 $fname = 'Title::newFromText';
103 wfProfileIn( $fname );
104
105 if( is_object( $text ) ) {
106 wfDebugDieBacktrace( 'Title::newFromText given an object' );
107 }
108
109 /**
110 * Wiki pages often contain multiple links to the same page.
111 * Title normalization and parsing can become expensive on
112 * pages with many links, so we can save a little time by
113 * caching them.
114 *
115 * In theory these are value objects and won't get changed...
116 */
117 static $titleCache = array();
118 if( $defaultNamespace == NS_MAIN && isset( $titleCache[$text] ) ) {
119 wfProfileOut( $fname );
120 return $titleCache[$text];
121 }
122
123 /**
124 * Convert things like &eacute; into real text...
125 */
126 global $wgInputEncoding;
127 $filteredText = do_html_entity_decode( $text, ENT_COMPAT, $wgInputEncoding );
128
129 /**
130 * Convert things like &#257; or &#x3017; into real text...
131 * WARNING: Not friendly to internal links on a latin-1 wiki.
132 */
133 $filteredText = wfMungeToUtf8( $filteredText );
134
135 # What was this for? TS 2004-03-03
136 # $text = urldecode( $text );
137
138 $t =& new Title();
139 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
140 $t->mDefaultNamespace = $defaultNamespace;
141
142 if( $t->secureAndSplit() ) {
143 if( $defaultNamespace == NS_MAIN ) {
144 if( count( $titleCache ) >= MW_TITLECACHE_MAX ) {
145 # Avoid memory leaks on mass operations...
146 $titleCache = array();
147 }
148 $titleCache[$text] =& $t;
149 }
150 wfProfileOut( $fname );
151 return $t;
152 } else {
153 wfProfileOut( $fname );
154 return NULL;
155 }
156 }
157
158 /**
159 * Create a new Title from URL-encoded text. Ensures that
160 * the given title's length does not exceed the maximum.
161 * @param string $url the title, as might be taken from a URL
162 * @return Title the new object, or NULL on an error
163 * @static
164 * @access public
165 */
166 /* static */ function newFromURL( $url ) {
167 global $wgLang, $wgServer;
168 $t = new Title();
169
170 # For compatibility with old buggy URLs. "+" is not valid in titles,
171 # but some URLs used it as a space replacement and they still come
172 # from some external search tools.
173 $s = str_replace( '+', ' ', $url );
174
175 $t->mDbkeyform = str_replace( ' ', '_', $s );
176 if( $t->secureAndSplit() ) {
177 return $t;
178 } else {
179 return NULL;
180 }
181 }
182
183 /**
184 * Create a new Title from an article ID
185 * @todo This is inefficiently implemented, the page row is requested
186 * but not used for anything else
187 * @param int $id the page_id corresponding to the Title to create
188 * @return Title the new object, or NULL on an error
189 * @access public
190 */
191 /* static */ function newFromID( $id ) {
192 $fname = 'Title::newFromID';
193 $dbr =& wfGetDB( DB_SLAVE );
194 $row = $dbr->selectRow( 'page', array( 'page_namespace', 'page_title' ),
195 array( 'page_id' => $id ), $fname );
196 if ( $row !== false ) {
197 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
198 } else {
199 $title = NULL;
200 }
201 return $title;
202 }
203
204 /**
205 * Create a new Title from a namespace index and a DB key.
206 * It's assumed that $ns and $title are *valid*, for instance when
207 * they came directly from the database or a special page name.
208 * For convenience, spaces are converted to underscores so that
209 * eg user_text fields can be used directly.
210 *
211 * @param int $ns the namespace of the article
212 * @param string $title the unprefixed database key form
213 * @return Title the new object
214 * @static
215 * @access public
216 */
217 /* static */ function &makeTitle( $ns, $title ) {
218 $t =& new Title();
219 $t->mInterwiki = '';
220 $t->mFragment = '';
221 $t->mNamespace = IntVal( $ns );
222 $t->mDbkeyform = str_replace( ' ', '_', $title );
223 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
224 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
225 $t->mTextform = str_replace( '_', ' ', $title );
226 return $t;
227 }
228
229 /**
230 * Create a new Title frrom a namespace index and a DB key.
231 * The parameters will be checked for validity, which is a bit slower
232 * than makeTitle() but safer for user-provided data.
233 * @param int $ns the namespace of the article
234 * @param string $title the database key form
235 * @return Title the new object, or NULL on an error
236 * @static
237 * @access public
238 */
239 /* static */ function makeTitleSafe( $ns, $title ) {
240 $t = new Title();
241 $t->mDbkeyform = Title::makeName( $ns, $title );
242 if( $t->secureAndSplit() ) {
243 return $t;
244 } else {
245 return NULL;
246 }
247 }
248
249 /**
250 * Create a new Title for the Main Page
251 * @static
252 * @return Title the new object
253 * @access public
254 */
255 /* static */ function newMainPage() {
256 return Title::newFromText( wfMsgForContent( 'mainpage' ) );
257 }
258
259 /**
260 * Create a new Title for a redirect
261 * @param string $text the redirect title text
262 * @return Title the new object, or NULL if the text is not a
263 * valid redirect
264 * @static
265 * @access public
266 */
267 /* static */ function newFromRedirect( $text ) {
268 global $wgMwRedir;
269 $rt = NULL;
270 if ( $wgMwRedir->matchStart( $text ) ) {
271 if ( preg_match( '/\\[\\[([^\\]\\|]+)[\\]\\|]/', $text, $m ) ) {
272 # categories are escaped using : for example one can enter:
273 # #REDIRECT [[:Category:Music]]. Need to remove it.
274 if ( substr($m[1],0,1) == ':') {
275 # We don't want to keep the ':'
276 $m[1] = substr( $m[1], 1 );
277 }
278
279 $rt = Title::newFromText( $m[1] );
280 # Disallow redirects to Special:Userlogout
281 if ( !is_null($rt) && $rt->getNamespace() == NS_SPECIAL && preg_match( '/^Userlogout/i', $rt->getText() ) ) {
282 $rt = NULL;
283 }
284 }
285 }
286 return $rt;
287 }
288
289 #----------------------------------------------------------------------------
290 # Static functions
291 #----------------------------------------------------------------------------
292
293 /**
294 * Get the prefixed DB key associated with an ID
295 * @param int $id the page_id of the article
296 * @return Title an object representing the article, or NULL
297 * if no such article was found
298 * @static
299 * @access public
300 */
301 /* static */ function nameOf( $id ) {
302 $fname = 'Title::nameOf';
303 $dbr =& wfGetDB( DB_SLAVE );
304
305 $s = $dbr->selectRow( 'page', array( 'page_namespace','page_title' ), array( 'page_id' => $id ), $fname );
306 if ( $s === false ) { return NULL; }
307
308 $n = Title::makeName( $s->page_namespace, $s->page_title );
309 return $n;
310 }
311
312 /**
313 * Get a regex character class describing the legal characters in a link
314 * @return string the list of characters, not delimited
315 * @static
316 * @access public
317 */
318 /* static */ function legalChars() {
319 # Missing characters:
320 # * []|# Needed for link syntax
321 # * % and + are corrupted by Apache when they appear in the path
322 #
323 # % seems to work though
324 #
325 # The problem with % is that URLs are double-unescaped: once by Apache's
326 # path conversion code, and again by PHP. So %253F, for example, becomes "?".
327 # Our code does not double-escape to compensate for this, indeed double escaping
328 # would break if the double-escaped title was passed in the query string
329 # rather than the path. This is a minor security issue because articles can be
330 # created such that they are hard to view or edit. -- TS
331 #
332 # Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
333 # this breaks interlanguage links
334
335 $set = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF";
336 return $set;
337 }
338
339 /**
340 * Get a string representation of a title suitable for
341 * including in a search index
342 *
343 * @param int $ns a namespace index
344 * @param string $title text-form main part
345 * @return string a stripped-down title string ready for the
346 * search index
347 */
348 /* static */ function indexTitle( $ns, $title ) {
349 global $wgDBminWordLen, $wgContLang;
350 require_once( 'SearchEngine.php' );
351
352 $lc = SearchEngine::legalSearchChars() . '&#;';
353 $t = $wgContLang->stripForSearch( $title );
354 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
355 $t = strtolower( $t );
356
357 # Handle 's, s'
358 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
359 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
360
361 $t = preg_replace( "/\\s+/", ' ', $t );
362
363 if ( $ns == NS_IMAGE ) {
364 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
365 }
366 return trim( $t );
367 }
368
369 /*
370 * Make a prefixed DB key from a DB key and a namespace index
371 * @param int $ns numerical representation of the namespace
372 * @param string $title the DB key form the title
373 * @return string the prefixed form of the title
374 */
375 /* static */ function makeName( $ns, $title ) {
376 global $wgContLang;
377
378 $n = $wgContLang->getNsText( $ns );
379 if ( '' == $n ) { return $title; }
380 else { return $n.':'.$title; }
381 }
382
383 /**
384 * Returns the URL associated with an interwiki prefix
385 * @param string $key the interwiki prefix (e.g. "MeatBall")
386 * @return the associated URL, containing "$1", which should be
387 * replaced by an article title
388 * @static (arguably)
389 * @access public
390 */
391 function getInterwikiLink( $key ) {
392 global $wgMemc, $wgDBname, $wgInterwikiExpiry, $wgTitleInterwikiCache;
393 $fname = 'Title::getInterwikiLink';
394
395 wfProfileIn( $fname );
396
397 $k = $wgDBname.':interwiki:'.$key;
398 if( array_key_exists( $k, $wgTitleInterwikiCache ) ) {
399 wfProfileOut( $fname );
400 return $wgTitleInterwikiCache[$k]->iw_url;
401 }
402
403 $s = $wgMemc->get( $k );
404 # Ignore old keys with no iw_local
405 if( $s && isset( $s->iw_local ) ) {
406 $wgTitleInterwikiCache[$k] = $s;
407 wfProfileOut( $fname );
408 return $s->iw_url;
409 }
410
411 $dbr =& wfGetDB( DB_SLAVE );
412 $res = $dbr->select( 'interwiki',
413 array( 'iw_url', 'iw_local' ),
414 array( 'iw_prefix' => $key ), $fname );
415 if( !$res ) {
416 wfProfileOut( $fname );
417 return '';
418 }
419
420 $s = $dbr->fetchObject( $res );
421 if( !$s ) {
422 # Cache non-existence: create a blank object and save it to memcached
423 $s = (object)false;
424 $s->iw_url = '';
425 $s->iw_local = 0;
426 }
427 $wgMemc->set( $k, $s, $wgInterwikiExpiry );
428 $wgTitleInterwikiCache[$k] = $s;
429
430 wfProfileOut( $fname );
431 return $s->iw_url;
432 }
433
434 /**
435 * Determine whether the object refers to a page within
436 * this project.
437 *
438 * @return bool TRUE if this is an in-project interwiki link
439 * or a wikilink, FALSE otherwise
440 * @access public
441 */
442 function isLocal() {
443 global $wgTitleInterwikiCache, $wgDBname;
444
445 if ( $this->mInterwiki != '' ) {
446 # Make sure key is loaded into cache
447 $this->getInterwikiLink( $this->mInterwiki );
448 $k = $wgDBname.':interwiki:' . $this->mInterwiki;
449 return (bool)($wgTitleInterwikiCache[$k]->iw_local);
450 } else {
451 return true;
452 }
453 }
454
455 /**
456 * Update the page_touched field for an array of title objects
457 * @todo Inefficient unless the IDs are already loaded into the
458 * link cache
459 * @param array $titles an array of Title objects to be touched
460 * @param string $timestamp the timestamp to use instead of the
461 * default current time
462 * @static
463 * @access public
464 */
465 /* static */ function touchArray( $titles, $timestamp = '' ) {
466 if ( count( $titles ) == 0 ) {
467 return;
468 }
469 $dbw =& wfGetDB( DB_MASTER );
470 if ( $timestamp == '' ) {
471 $timestamp = $dbw->timestamp();
472 }
473 $page = $dbw->tableName( 'page' );
474 $sql = "UPDATE $page SET page_touched='{$timestamp}' WHERE page_id IN (";
475 $first = true;
476
477 foreach ( $titles as $title ) {
478 if ( ! $first ) {
479 $sql .= ',';
480 }
481 $first = false;
482 $sql .= $title->getArticleID();
483 }
484 $sql .= ')';
485 if ( ! $first ) {
486 $dbw->query( $sql, 'Title::touchArray' );
487 }
488 }
489
490 #----------------------------------------------------------------------------
491 # Other stuff
492 #----------------------------------------------------------------------------
493
494 /** Simple accessors */
495 /**
496 * Get the text form (spaces not underscores) of the main part
497 * @return string
498 * @access public
499 */
500 function getText() { return $this->mTextform; }
501 /**
502 * Get the URL-encoded form of the main part
503 * @return string
504 * @access public
505 */
506 function getPartialURL() { return $this->mUrlform; }
507 /**
508 * Get the main part with underscores
509 * @return string
510 * @access public
511 */
512 function getDBkey() { return $this->mDbkeyform; }
513 /**
514 * Get the namespace index, i.e. one of the NS_xxxx constants
515 * @return int
516 * @access public
517 */
518 function getNamespace() { return $this->mNamespace; }
519 /**
520 * Get the interwiki prefix (or null string)
521 * @return string
522 * @access public
523 */
524 function getInterwiki() { return $this->mInterwiki; }
525 /**
526 * Get the Title fragment (i.e. the bit after the #)
527 * @return string
528 * @access public
529 */
530 function getFragment() { return $this->mFragment; }
531 /**
532 * Get the default namespace index, for when there is no namespace
533 * @return int
534 * @access public
535 */
536 function getDefaultNamespace() { return $this->mDefaultNamespace; }
537
538 /**
539 * Get title for search index
540 * @return string a stripped-down title string ready for the
541 * search index
542 */
543 function getIndexTitle() {
544 return Title::indexTitle( $this->mNamespace, $this->mTextform );
545 }
546
547 /**
548 * Get the prefixed database key form
549 * @return string the prefixed title, with underscores and
550 * any interwiki and namespace prefixes
551 * @access public
552 */
553 function getPrefixedDBkey() {
554 $s = $this->prefix( $this->mDbkeyform );
555 $s = str_replace( ' ', '_', $s );
556 return $s;
557 }
558
559 /**
560 * Get the prefixed title with spaces.
561 * This is the form usually used for display
562 * @return string the prefixed title, with spaces
563 * @access public
564 */
565 function getPrefixedText() {
566 global $wgContLang;
567 if ( empty( $this->mPrefixedText ) ) {
568 $s = $this->prefix( $this->mTextform );
569 $s = str_replace( '_', ' ', $s );
570 $this->mPrefixedText = $s;
571 }
572 return $this->mPrefixedText;
573 }
574
575 /**
576 * Get the prefixed title with spaces, plus any fragment
577 * (part beginning with '#')
578 * @return string the prefixed title, with spaces and
579 * the fragment, including '#'
580 * @access public
581 */
582 function getFullText() {
583 global $wgContLang;
584 $text = $this->getPrefixedText();
585 if( '' != $this->mFragment ) {
586 $text .= '#' . $this->mFragment;
587 }
588 return $text;
589 }
590
591 /**
592 * Get a URL-encoded title (not an actual URL) including interwiki
593 * @return string the URL-encoded form
594 * @access public
595 */
596 function getPrefixedURL() {
597 $s = $this->prefix( $this->mDbkeyform );
598 $s = str_replace( ' ', '_', $s );
599
600 $s = wfUrlencode ( $s ) ;
601
602 # Cleaning up URL to make it look nice -- is this safe?
603 $s = str_replace( '%28', '(', $s );
604 $s = str_replace( '%29', ')', $s );
605
606 return $s;
607 }
608
609 /**
610 * Get a real URL referring to this title, with interwiki link and
611 * fragment
612 *
613 * @param string $query an optional query string, not used
614 * for interwiki links
615 * @return string the URL
616 * @access public
617 */
618 function getFullURL( $query = '' ) {
619 global $wgContLang, $wgServer, $wgScript;
620
621 if ( '' == $this->mInterwiki ) {
622 return $wgServer . $this->getLocalUrl( $query );
623 } else {
624 $baseUrl = $this->getInterwikiLink( $this->mInterwiki );
625 $namespace = $wgContLang->getNsText( $this->mNamespace );
626 if ( '' != $namespace ) {
627 # Can this actually happen? Interwikis shouldn't be parsed.
628 $namepace .= ':';
629 }
630 $url = str_replace( '$1', $namespace . $this->mUrlform, $baseUrl );
631 if( $query != '' ) {
632 if( false === strpos( $url, '?' ) ) {
633 $url .= '?';
634 } else {
635 $url .= '&';
636 }
637 $url .= $query;
638 }
639 if ( '' != $this->mFragment ) {
640 $url .= '#' . $this->mFragment;
641 }
642 return $url;
643 }
644 }
645
646 /**
647 * Get a relative directory for putting an HTML version of this article into
648 */
649 function getHashedDirectory() {
650 $dbkey = $this->getPrefixedDBkey();
651 if ( strlen( $dbkey ) < 2 ) {
652 $dbkey = sprintf( "%2s", $dbkey );
653 }
654 $dir = '';
655 for ( $i=0; $i<=1; $i++ ) {
656 if ( $i ) {
657 $dir .= '/';
658 }
659 if ( ord( $dbkey{$i} ) < 128 && ord( $dbkey{$i} ) > 32 ) {
660 $dir .= strtolower( $dbkey{$i} );
661 } else {
662 $dir .= sprintf( "%02X", ord( $dbkey{$i} ) );
663 }
664 }
665 return $dir;
666 }
667
668 function getHashedFilename() {
669 $dbkey = $this->getPrefixedDBkey();
670 $dir = $this->getHashedDirectory();
671 $friendlyName = strtr( $dbkey, '/\\:*?"<>|', '_________' );
672 return "$dir/$friendlyName.html";
673 }
674
675 /**
676 * Get a URL with no fragment or server name
677 * @param string $query an optional query string; if not specified,
678 * $wgArticlePath will be used.
679 * @return string the URL
680 * @access public
681 */
682 function getLocalURL( $query = '' ) {
683 global $wgLang, $wgArticlePath, $wgScript, $wgMakeDumpLinks;
684
685 if ( $this->isExternal() ) {
686 return $this->getFullURL();
687 }
688
689 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
690 if ( $wgMakeDumpLinks ) {
691 $url = str_replace( '$1', wfUrlencode( $this->getHashedFilename() ), $wgArticlePath );
692 } elseif ( $query == '' ) {
693 $url = str_replace( '$1', $dbkey, $wgArticlePath );
694 } else {
695 if( preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) ) {
696 global $wgActionPaths;
697 $action = urldecode( $matches[2] );
698 if( isset( $wgActionPaths[$action] ) ) {
699 $query = $matches[1];
700 if( isset( $matches[4] ) ) $query .= $matches[4];
701 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
702 if( $query != '' ) $url .= '?' . $query;
703 return $url;
704 }
705 }
706 if ( $query == '-' ) {
707 $query = '';
708 }
709 $url = "{$wgScript}?title={$dbkey}&{$query}";
710 }
711 return $url;
712 }
713
714 /**
715 * Get an HTML-escaped version of the URL form, suitable for
716 * using in a link, without a server name or fragment
717 * @param string $query an optional query string
718 * @return string the URL
719 * @access public
720 */
721 function escapeLocalURL( $query = '' ) {
722 return htmlspecialchars( $this->getLocalURL( $query ) );
723 }
724
725 /**
726 * Get an HTML-escaped version of the URL form, suitable for
727 * using in a link, including the server name and fragment
728 *
729 * @return string the URL
730 * @param string $query an optional query string
731 * @access public
732 */
733 function escapeFullURL( $query = '' ) {
734 return htmlspecialchars( $this->getFullURL( $query ) );
735 }
736
737 /**
738 * Get the URL form for an internal link.
739 * - Used in various Squid-related code, in case we have a different
740 * internal hostname for the server from the exposed one.
741 *
742 * @param string $query an optional query string
743 * @return string the URL
744 * @access public
745 */
746 function getInternalURL( $query = '' ) {
747 global $wgInternalServer;
748 return $wgInternalServer . $this->getLocalURL( $query );
749 }
750
751 /**
752 * Get the edit URL for this Title
753 * @return string the URL, or a null string if this is an
754 * interwiki link
755 * @access public
756 */
757 function getEditURL() {
758 global $wgServer, $wgScript;
759
760 if ( '' != $this->mInterwiki ) { return ''; }
761 $s = $this->getLocalURL( 'action=edit' );
762
763 return $s;
764 }
765
766 /**
767 * Get the HTML-escaped displayable text form.
768 * Used for the title field in <a> tags.
769 * @return string the text, including any prefixes
770 * @access public
771 */
772 function getEscapedText() {
773 return htmlspecialchars( $this->getPrefixedText() );
774 }
775
776 /**
777 * Is this Title interwiki?
778 * @return boolean
779 * @access public
780 */
781 function isExternal() { return ( '' != $this->mInterwiki ); }
782
783 /**
784 * Does the title correspond to a protected article?
785 * @param string $what the action the page is protected from,
786 * by default checks move and edit
787 * @return boolean
788 * @access public
789 */
790 function isProtected($action = '') {
791 if ( -1 == $this->mNamespace ) { return true; }
792 if($action == 'edit' || $action == '') {
793 $a = $this->getRestrictions("edit");
794 if ( in_array( 'sysop', $a ) ) { return true; }
795 }
796 if($action == 'move' || $action == '') {
797 $a = $this->getRestrictions("move");
798 if ( in_array( 'sysop', $a ) ) { return true; }
799 }
800 return false;
801 }
802
803 /**
804 * Is $wgUser is watching this page?
805 * @return boolean
806 * @access public
807 */
808 function userIsWatching() {
809 global $wgUser;
810
811 if ( -1 == $this->mNamespace ) { return false; }
812 if ( 0 == $wgUser->getID() ) { return false; }
813
814 return $wgUser->isWatched( $this );
815 }
816
817 /**
818 * Is $wgUser perform $action this page?
819 * @param string $action action that permission needs to be checked for
820 * @return boolean
821 * @access private
822 */
823 function userCan($action) {
824 $fname = 'Title::userCanEdit';
825 wfProfileIn( $fname );
826
827 global $wgUser;
828 if( NS_SPECIAL == $this->mNamespace ) {
829 wfProfileOut( $fname );
830 return false;
831 }
832 if( NS_MEDIAWIKI == $this->mNamespace &&
833 !$wgUser->isAllowed('editinterface') ) {
834 wfProfileOut( $fname );
835 return false;
836 }
837 if( $this->mDbkeyform == '_' ) {
838 # FIXME: Is this necessary? Shouldn't be allowed anyway...
839 wfProfileOut( $fname );
840 return false;
841 }
842
843 # protect global styles and js
844 if ( NS_MEDIAWIKI == $this->mNamespace
845 && preg_match("/\\.(css|js)$/", $this->mTextform )
846 && !$wgUser->isAllowed('editinterface') ) {
847 wfProfileOut( $fname );
848 return false;
849 }
850
851 # protect css/js subpages of user pages
852 # XXX: this might be better using restrictions
853 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
854 if( NS_USER == $this->mNamespace
855 && preg_match("/\\.(css|js)$/", $this->mTextform )
856 && !$wgUser->isAllowed('editinterface')
857 && !preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) ) {
858 wfProfileOut( $fname );
859 return false;
860 }
861
862 foreach( $this->getRestrictions($action) as $right ) {
863 if( '' != $right && !$wgUser->isAllowed( $right ) ) {
864 wfProfileOut( $fname );
865 return false;
866 }
867 }
868 wfProfileOut( $fname );
869 return true;
870 }
871
872 /**
873 * Can $wgUser edit this page?
874 * @return boolean
875 * @access public
876 */
877 function userCanEdit() {
878 return $this->userCan('edit');
879 }
880
881 /**
882 * Can $wgUser move this page?
883 * @return boolean
884 * @access public
885 */
886 function userCanMove() {
887 return $this->userCan('move');
888 }
889
890 /**
891 * Can $wgUser read this page?
892 * @return boolean
893 * @access public
894 */
895 function userCanRead() {
896 global $wgUser;
897
898 if( $wgUser->isAllowed('read') ) {
899 return true;
900 } else {
901 global $wgWhitelistRead;
902
903 /** If anon users can create an account,
904 they need to reach the login page first! */
905 if( $wgUser->isAllowed( 'createaccount' )
906 && $this->mId == NS_SPECIAL
907 && $this->getText() == 'Userlogin' ) {
908 return true;
909 }
910
911 /** some pages are explicitly allowed */
912 $name = $this->getPrefixedText();
913 if( in_array( $name, $wgWhitelistRead ) ) {
914 return true;
915 }
916
917 # Compatibility with old settings
918 if( $this->getNamespace() == NS_MAIN ) {
919 if( in_array( ':' . $name, $wgWhitelistRead ) ) {
920 return true;
921 }
922 }
923 }
924 return false;
925 }
926
927 /**
928 * Is this a talk page of some sort?
929 * @return bool
930 * @access public
931 */
932 function isTalkPage() {
933 return Namespace::isTalk( $this->getNamespace() );
934 }
935
936 /**
937 * Is this a .css or .js subpage of a user page?
938 * @return bool
939 * @access public
940 */
941 function isCssJsSubpage() {
942 return ( NS_USER == $this->mNamespace and preg_match("/\\.(css|js)$/", $this->mTextform ) );
943 }
944 /**
945 * Is this a .css subpage of a user page?
946 * @return bool
947 * @access public
948 */
949 function isCssSubpage() {
950 return ( NS_USER == $this->mNamespace and preg_match("/\\.css$/", $this->mTextform ) );
951 }
952 /**
953 * Is this a .js subpage of a user page?
954 * @return bool
955 * @access public
956 */
957 function isJsSubpage() {
958 return ( NS_USER == $this->mNamespace and preg_match("/\\.js$/", $this->mTextform ) );
959 }
960 /**
961 * Protect css/js subpages of user pages: can $wgUser edit
962 * this page?
963 *
964 * @return boolean
965 * @todo XXX: this might be better using restrictions
966 * @access public
967 */
968 function userCanEditCssJsSubpage() {
969 global $wgUser;
970 return ( $wgUser->isAllowed('editinterface') or preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) );
971 }
972
973 /**
974 * Loads a string into mRestrictions array
975 * @param string $res restrictions in string format
976 * @access public
977 */
978 function loadRestrictions( $res ) {
979 foreach( explode( ':', trim( $res ) ) as $restrict ) {
980 $temp = explode( '=', trim( $restrict ) );
981 if(count($temp) == 1) {
982 // old format should be treated as edit/move restriction
983 $this->mRestrictions["edit"] = explode( ',', trim( $temp[0] ) );
984 $this->mRestrictions["move"] = explode( ',', trim( $temp[0] ) );
985 } else {
986 $this->mRestrictions[$temp[0]] = explode( ',', trim( $temp[1] ) );
987 }
988 }
989 $this->mRestrictionsLoaded = true;
990 }
991
992 /**
993 * Accessor/initialisation for mRestrictions
994 * @param string $action action that permission needs to be checked for
995 * @return array the array of groups allowed to edit this article
996 * @access public
997 */
998 function getRestrictions($action) {
999 $id = $this->getArticleID();
1000 if ( 0 == $id ) { return array(); }
1001
1002 if ( ! $this->mRestrictionsLoaded ) {
1003 $dbr =& wfGetDB( DB_SLAVE );
1004 $res = $dbr->selectField( 'page', 'page_restrictions', 'page_id='.$id );
1005 $this->loadRestrictions( $res );
1006 }
1007 if( isset( $this->mRestrictions[$action] ) ) {
1008 return $this->mRestrictions[$action];
1009 }
1010 return array();
1011 }
1012
1013 /**
1014 * Is there a version of this page in the deletion archive?
1015 * @return int the number of archived revisions
1016 * @access public
1017 */
1018 function isDeleted() {
1019 $fname = 'Title::isDeleted';
1020 $dbr =& wfGetDB( DB_SLAVE );
1021 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1022 'ar_title' => $this->getDBkey() ), $fname );
1023 return (int)$n;
1024 }
1025
1026 /**
1027 * Get the article ID for this Title from the link cache,
1028 * adding it if necessary
1029 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select
1030 * for update
1031 * @return int the ID
1032 * @access public
1033 */
1034 function getArticleID( $flags = 0 ) {
1035 global $wgLinkCache;
1036
1037 if ( $flags & GAID_FOR_UPDATE ) {
1038 $oldUpdate = $wgLinkCache->forUpdate( true );
1039 $this->mArticleID = $wgLinkCache->addLinkObj( $this );
1040 $wgLinkCache->forUpdate( $oldUpdate );
1041 } else {
1042 if ( -1 == $this->mArticleID ) {
1043 $this->mArticleID = $wgLinkCache->addLinkObj( $this );
1044 }
1045 }
1046 return $this->mArticleID;
1047 }
1048
1049 /**
1050 * This clears some fields in this object, and clears any associated
1051 * keys in the "bad links" section of $wgLinkCache.
1052 *
1053 * - This is called from Article::insertNewArticle() to allow
1054 * loading of the new page_id. It's also called from
1055 * Article::doDeleteArticle()
1056 *
1057 * @param int $newid the new Article ID
1058 * @access public
1059 */
1060 function resetArticleID( $newid ) {
1061 global $wgLinkCache;
1062 $wgLinkCache->clearBadLink( $this->getPrefixedDBkey() );
1063
1064 if ( 0 == $newid ) { $this->mArticleID = -1; }
1065 else { $this->mArticleID = $newid; }
1066 $this->mRestrictionsLoaded = false;
1067 $this->mRestrictions = array();
1068 }
1069
1070 /**
1071 * Updates page_touched for this page; called from LinksUpdate.php
1072 * @return bool true if the update succeded
1073 * @access public
1074 */
1075 function invalidateCache() {
1076 if ( wfReadOnly() ) {
1077 return;
1078 }
1079
1080 $now = wfTimestampNow();
1081 $dbw =& wfGetDB( DB_MASTER );
1082 $success = $dbw->update( 'page',
1083 array( /* SET */
1084 'page_touched' => $dbw->timestamp()
1085 ), array( /* WHERE */
1086 'page_namespace' => $this->getNamespace() ,
1087 'page_title' => $this->getDBkey()
1088 ), 'Title::invalidateCache'
1089 );
1090 return $success;
1091 }
1092
1093 /**
1094 * Prefix some arbitrary text with the namespace or interwiki prefix
1095 * of this object
1096 *
1097 * @param string $name the text
1098 * @return string the prefixed text
1099 * @access private
1100 */
1101 /* private */ function prefix( $name ) {
1102 global $wgContLang;
1103
1104 $p = '';
1105 if ( '' != $this->mInterwiki ) {
1106 $p = $this->mInterwiki . ':';
1107 }
1108 if ( 0 != $this->mNamespace ) {
1109 $p .= $wgContLang->getNsText( $this->mNamespace ) . ':';
1110 }
1111 return $p . $name;
1112 }
1113
1114 /**
1115 * Secure and split - main initialisation function for this object
1116 *
1117 * Assumes that mDbkeyform has been set, and is urldecoded
1118 * and uses underscores, but not otherwise munged. This function
1119 * removes illegal characters, splits off the interwiki and
1120 * namespace prefixes, sets the other forms, and canonicalizes
1121 * everything.
1122 * @return bool true on success
1123 * @access private
1124 */
1125 /* private */ function secureAndSplit() {
1126 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
1127 $fname = 'Title::secureAndSplit';
1128 wfProfileIn( $fname );
1129
1130 # Initialisation
1131 static $rxTc = false;
1132 if( !$rxTc ) {
1133 # % is needed as well
1134 $rxTc = '/[^' . Title::legalChars() . ']|%[0-9A-Fa-f]{2}/S';
1135 }
1136
1137 $this->mInterwiki = $this->mFragment = '';
1138 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
1139
1140 # Clean up whitespace
1141 #
1142 $t = preg_replace( '/[ _]+/', '_', $this->mDbkeyform );
1143 $t = trim( $t, '_' );
1144
1145 if ( '' == $t ) {
1146 wfProfileOut( $fname );
1147 return false;
1148 }
1149
1150 if( false !== strpos( $t, UTF8_REPLACEMENT ) ) {
1151 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
1152 wfProfileOut( $fname );
1153 return false;
1154 }
1155
1156 $this->mDbkeyform = $t;
1157
1158 # Initial colon indicating main namespace
1159 if ( ':' == $t{0} ) {
1160 $r = substr( $t, 1 );
1161 $this->mNamespace = NS_MAIN;
1162 } else {
1163 # Namespace or interwiki prefix
1164 $firstPass = true;
1165 do {
1166 if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $t, $m ) ) {
1167 $p = $m[1];
1168 $lowerNs = strtolower( $p );
1169 if ( $ns = Namespace::getCanonicalIndex( $lowerNs ) ) {
1170 # Canonical namespace
1171 $t = $m[2];
1172 $this->mNamespace = $ns;
1173 } elseif ( $ns = $wgContLang->getNsIndex( $lowerNs )) {
1174 # Ordinary namespace
1175 $t = $m[2];
1176 $this->mNamespace = $ns;
1177 } elseif( $this->getInterwikiLink( $p ) ) {
1178 if( !$firstPass ) {
1179 # Can't make a local interwiki link to an interwiki link.
1180 # That's just crazy!
1181 wfProfileOut( $fname );
1182 return false;
1183 }
1184
1185 # Interwiki link
1186 $t = $m[2];
1187 $this->mInterwiki = $p;
1188
1189 # Redundant interwiki prefix to the local wiki
1190 if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
1191 if( $t == '' ) {
1192 # Can't have an empty self-link
1193 wfProfileOut( $fname );
1194 return false;
1195 }
1196 $this->mInterwiki = '';
1197 $firstPass = false;
1198 # Do another namespace split...
1199 continue;
1200 }
1201 }
1202 # If there's no recognized interwiki or namespace,
1203 # then let the colon expression be part of the title.
1204 }
1205 break;
1206 } while( true );
1207 $r = $t;
1208 }
1209
1210 # We already know that some pages won't be in the database!
1211 #
1212 if ( '' != $this->mInterwiki || -1 == $this->mNamespace ) {
1213 $this->mArticleID = 0;
1214 }
1215 $f = strstr( $r, '#' );
1216 if ( false !== $f ) {
1217 $this->mFragment = substr( $f, 1 );
1218 $r = substr( $r, 0, strlen( $r ) - strlen( $f ) );
1219 # remove whitespace again: prevents "Foo_bar_#"
1220 # becoming "Foo_bar_"
1221 $r = preg_replace( '/_*$/', '', $r );
1222 }
1223
1224 # Reject illegal characters.
1225 #
1226 if( preg_match( $rxTc, $r ) ) {
1227 wfProfileOut( $fname );
1228 return false;
1229 }
1230
1231 /**
1232 * Pages with "/./" or "/../" appearing in the URLs will
1233 * often be unreachable due to the way web browsers deal
1234 * with 'relative' URLs. Forbid them explicitly.
1235 */
1236 if ( strpos( $r, '.' ) !== false &&
1237 ( $r === '.' || $r === '..' ||
1238 strpos( $r, './' ) === 0 ||
1239 strpos( $r, '../' ) === 0 ||
1240 strpos( $r, '/./' ) !== false ||
1241 strpos( $r, '/../' ) !== false ) )
1242 {
1243 wfProfileOut( $fname );
1244 return false;
1245 }
1246
1247 # We shouldn't need to query the DB for the size.
1248 #$maxSize = $dbr->textFieldSize( 'page', 'page_title' );
1249 if ( strlen( $r ) > 255 ) {
1250 wfProfileOut( $fname );
1251 return false;
1252 }
1253
1254 /**
1255 * Normally, all wiki links are forced to have
1256 * an initial capital letter so [[foo]] and [[Foo]]
1257 * point to the same place.
1258 *
1259 * Don't force it for interwikis, since the other
1260 * site might be case-sensitive.
1261 */
1262 if( $wgCapitalLinks && $this->mInterwiki == '') {
1263 $t = $wgContLang->ucfirst( $r );
1264 } else {
1265 $t = $r;
1266 }
1267
1268 /**
1269 * Can't make a link to a namespace alone...
1270 * "empty" local links can only be self-links
1271 * with a fragment identifier.
1272 */
1273 if( $t == '' &&
1274 $this->mInterwiki == '' &&
1275 $this->mNamespace != NS_MAIN ) {
1276 wfProfileOut( $fname );
1277 return false;
1278 }
1279
1280 # Fill fields
1281 $this->mDbkeyform = $t;
1282 $this->mUrlform = wfUrlencode( $t );
1283
1284 $this->mTextform = str_replace( '_', ' ', $t );
1285
1286 wfProfileOut( $fname );
1287 return true;
1288 }
1289
1290 /**
1291 * Get a Title object associated with the talk page of this article
1292 * @return Title the object for the talk page
1293 * @access public
1294 */
1295 function getTalkPage() {
1296 return Title::makeTitle( Namespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1297 }
1298
1299 /**
1300 * Get a title object associated with the subject page of this
1301 * talk page
1302 *
1303 * @return Title the object for the subject page
1304 * @access public
1305 */
1306 function getSubjectPage() {
1307 return Title::makeTitle( Namespace::getSubject( $this->getNamespace() ), $this->getDBkey() );
1308 }
1309
1310 /**
1311 * Get an array of Title objects linking to this Title
1312 * - Also stores the IDs in the link cache.
1313 *
1314 * @param string $options may be FOR UPDATE
1315 * @return array the Title objects linking here
1316 * @access public
1317 */
1318 function getLinksTo( $options = '' ) {
1319 global $wgLinkCache;
1320 $id = $this->getArticleID();
1321
1322 if ( $options ) {
1323 $db =& wfGetDB( DB_MASTER );
1324 } else {
1325 $db =& wfGetDB( DB_SLAVE );
1326 }
1327 $page = $db->tableName( 'page' );
1328 $links = $db->tableName( 'links' );
1329
1330 $sql = "SELECT page_namespace,page_title,page_id FROM $page,$links WHERE l_from=page_id AND l_to={$id} $options";
1331 $res = $db->query( $sql, 'Title::getLinksTo' );
1332 $retVal = array();
1333 if ( $db->numRows( $res ) ) {
1334 while ( $row = $db->fetchObject( $res ) ) {
1335 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
1336 $wgLinkCache->addGoodLink( $row->page_id, $titleObj->getPrefixedDBkey() );
1337 $retVal[] = $titleObj;
1338 }
1339 }
1340 }
1341 $db->freeResult( $res );
1342 return $retVal;
1343 }
1344
1345 /**
1346 * Get an array of Title objects linking to this non-existent title.
1347 * - Also stores the IDs in the link cache.
1348 *
1349 * @param string $options may be FOR UPDATE
1350 * @return array the Title objects linking here
1351 * @access public
1352 */
1353 function getBrokenLinksTo( $options = '' ) {
1354 global $wgLinkCache;
1355
1356 if ( $options ) {
1357 $db =& wfGetDB( DB_MASTER );
1358 } else {
1359 $db =& wfGetDB( DB_SLAVE );
1360 }
1361 $page = $db->tableName( 'page' );
1362 $brokenlinks = $db->tableName( 'brokenlinks' );
1363 $encTitle = $db->strencode( $this->getPrefixedDBkey() );
1364
1365 $sql = "SELECT page_namespace,page_title,page_id FROM $brokenlinks,$page " .
1366 "WHERE bl_from=page_id AND bl_to='$encTitle' $options";
1367 $res = $db->query( $sql, "Title::getBrokenLinksTo" );
1368 $retVal = array();
1369 if ( $db->numRows( $res ) ) {
1370 while ( $row = $db->fetchObject( $res ) ) {
1371 $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title );
1372 $wgLinkCache->addGoodLink( $row->page_id, $titleObj->getPrefixedDBkey() );
1373 $retVal[] = $titleObj;
1374 }
1375 }
1376 $db->freeResult( $res );
1377 return $retVal;
1378 }
1379
1380 /**
1381 * Get a list of URLs to purge from the Squid cache when this
1382 * page changes
1383 *
1384 * @return array the URLs
1385 * @access public
1386 */
1387 function getSquidURLs() {
1388 return array(
1389 $this->getInternalURL(),
1390 $this->getInternalURL( 'action=history' )
1391 );
1392 }
1393
1394 /**
1395 * Move this page without authentication
1396 * @param Title &$nt the new page Title
1397 * @access public
1398 */
1399 function moveNoAuth( &$nt ) {
1400 return $this->moveTo( $nt, false );
1401 }
1402
1403 /**
1404 * Move a title to a new location
1405 * @param Title &$nt the new title
1406 * @param bool $auth indicates whether $wgUser's permissions
1407 * should be checked
1408 * @return mixed true on success, message name on failure
1409 * @access public
1410 */
1411 function moveTo( &$nt, $auth = true, $reason = '' ) {
1412 global $wgUser;
1413 if( !$this or !$nt ) {
1414 return 'badtitletext';
1415 }
1416
1417 $fname = 'Title::move';
1418 $oldid = $this->getArticleID();
1419 $newid = $nt->getArticleID();
1420
1421 if ( strlen( $nt->getDBkey() ) < 1 ) {
1422 return 'articleexists';
1423 }
1424 if ( ( ! Namespace::isMovable( $this->getNamespace() ) ) ||
1425 ( '' == $this->getDBkey() ) ||
1426 ( '' != $this->getInterwiki() ) ||
1427 ( !$oldid ) ||
1428 ( ! Namespace::isMovable( $nt->getNamespace() ) ) ||
1429 ( '' == $nt->getDBkey() ) ||
1430 ( '' != $nt->getInterwiki() ) ) {
1431 return 'badarticleerror';
1432 }
1433
1434 if ( $auth && (
1435 !$this->userCanEdit() || !$nt->userCanEdit() ||
1436 !$this->userCanMove() || !$nt->userCanMove() ) ) {
1437 return 'protectedpage';
1438 }
1439
1440 # The move is allowed only if (1) the target doesn't exist, or
1441 # (2) the target is a redirect to the source, and has no history
1442 # (so we can undo bad moves right after they're done).
1443
1444 if ( 0 != $newid ) { # Target exists; check for validity
1445 if ( ! $this->isValidMoveTarget( $nt ) ) {
1446 return 'articleexists';
1447 }
1448 $this->moveOverExistingRedirect( $nt, $reason );
1449 } else { # Target didn't exist, do normal move.
1450 $this->moveToNewTitle( $nt, $newid, $reason );
1451 }
1452
1453 # Fixing category links (those without piped 'alternate' names) to be sorted under the new title
1454
1455 $dbw =& wfGetDB( DB_MASTER );
1456 $categorylinks = $dbw->tableName( 'categorylinks' );
1457 $sql = "UPDATE $categorylinks SET cl_sortkey=" . $dbw->addQuotes( $nt->getPrefixedText() ) .
1458 " WHERE cl_from=" . $dbw->addQuotes( $this->getArticleID() ) .
1459 " AND cl_sortkey=" . $dbw->addQuotes( $this->getPrefixedText() );
1460 $dbw->query( $sql, 'SpecialMovepage::doSubmit' );
1461
1462 # Update watchlists
1463
1464 $oldnamespace = $this->getNamespace() & ~1;
1465 $newnamespace = $nt->getNamespace() & ~1;
1466 $oldtitle = $this->getDBkey();
1467 $newtitle = $nt->getDBkey();
1468
1469 if( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
1470 WatchedItem::duplicateEntries( $this, $nt );
1471 }
1472
1473 # Update search engine
1474 $u = new SearchUpdate( $oldid, $nt->getPrefixedDBkey() );
1475 $u->doUpdate();
1476 $u = new SearchUpdate( $newid, $this->getPrefixedDBkey(), '' );
1477 $u->doUpdate();
1478
1479 wfRunHooks( 'TitleMoveComplete', array(&$this, &$nt, &$wgUser, $oldid, $newid) );
1480 return true;
1481 }
1482
1483 /**
1484 * Move page to a title which is at present a redirect to the
1485 * source page
1486 *
1487 * @param Title &$nt the page to move to, which should currently
1488 * be a redirect
1489 * @access private
1490 */
1491 /* private */ function moveOverExistingRedirect( &$nt, $reason = '' ) {
1492 global $wgUser, $wgLinkCache, $wgUseSquid, $wgMwRedir;
1493 $fname = 'Title::moveOverExistingRedirect';
1494 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
1495
1496 if ( $reason ) {
1497 $comment .= ": $reason";
1498 }
1499
1500 $now = wfTimestampNow();
1501 $rand = wfRandom();
1502 $newid = $nt->getArticleID();
1503 $oldid = $this->getArticleID();
1504 $dbw =& wfGetDB( DB_MASTER );
1505 $links = $dbw->tableName( 'links' );
1506
1507 # Delete the old redirect. We don't save it to history since
1508 # by definition if we've got here it's rather uninteresting.
1509 # We have to remove it so that the next step doesn't trigger
1510 # a conflict on the unique namespace+title index...
1511 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
1512
1513 # Save a null revision in the page's history notifying of the move
1514 $nullRevision = Revision::newNullRevision( $dbw, $oldid,
1515 wfMsg( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() ),
1516 true );
1517 $nullRevId = $nullRevision->insertOn( $dbw );
1518
1519 # Change the name of the target page:
1520 $dbw->update( 'page',
1521 /* SET */ array(
1522 'page_touched' => $dbw->timestamp($now),
1523 'page_namespace' => $nt->getNamespace(),
1524 'page_title' => $nt->getDBkey(),
1525 'page_latest' => $nullRevId,
1526 ),
1527 /* WHERE */ array( 'page_id' => $oldid ),
1528 $fname
1529 );
1530 $wgLinkCache->clearLink( $nt->getPrefixedDBkey() );
1531
1532 # Recreate the redirect, this time in the other direction.
1533 $redirectText = $wgMwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
1534 $redirectArticle = new Article( $this );
1535 $newid = $redirectArticle->insertOn( $dbw );
1536 $redirectRevision = new Revision( array(
1537 'page' => $newid,
1538 'comment' => $comment,
1539 'text' => $redirectText ) );
1540 $revid = $redirectRevision->insertOn( $dbw );
1541 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
1542 $wgLinkCache->clearLink( $this->getPrefixedDBkey() );
1543
1544 # Log the move
1545 $log = new LogPage( 'move' );
1546 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
1547
1548 # Swap links
1549
1550 # Load titles and IDs
1551 $linksToOld = $this->getLinksTo( 'FOR UPDATE' );
1552 $linksToNew = $nt->getLinksTo( 'FOR UPDATE' );
1553
1554 # Delete them all
1555 $sql = "DELETE FROM $links WHERE l_to=$oldid OR l_to=$newid";
1556 $dbw->query( $sql, $fname );
1557
1558 # Reinsert
1559 if ( count( $linksToOld ) || count( $linksToNew )) {
1560 $sql = "INSERT INTO $links (l_from,l_to) VALUES ";
1561 $first = true;
1562
1563 # Insert links to old title
1564 foreach ( $linksToOld as $linkTitle ) {
1565 if ( $first ) {
1566 $first = false;
1567 } else {
1568 $sql .= ',';
1569 }
1570 $id = $linkTitle->getArticleID();
1571 $sql .= "($id,$newid)";
1572 }
1573
1574 # Insert links to new title
1575 foreach ( $linksToNew as $linkTitle ) {
1576 if ( $first ) {
1577 $first = false;
1578 } else {
1579 $sql .= ',';
1580 }
1581 $id = $linkTitle->getArticleID();
1582 $sql .= "($id, $oldid)";
1583 }
1584
1585 $dbw->query( $sql, $fname );
1586 }
1587
1588 # Now, we record the link from the redirect to the new title.
1589 # It should have no other outgoing links...
1590 $dbw->delete( 'links', array( 'l_from' => $newid ) );
1591 $dbw->insert( 'links', array( 'l_from' => $newid, 'l_to' => $oldid ) );
1592
1593 # Clear linkscc
1594 LinkCache::linksccClearLinksTo( $oldid );
1595 LinkCache::linksccClearLinksTo( $newid );
1596
1597 # Purge squid
1598 if ( $wgUseSquid ) {
1599 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
1600 $u = new SquidUpdate( $urls );
1601 $u->doUpdate();
1602 }
1603 }
1604
1605 /**
1606 * Move page to non-existing title.
1607 * @param Title &$nt the new Title
1608 * @param int &$newid set to be the new article ID
1609 * @access private
1610 */
1611 /* private */ function moveToNewTitle( &$nt, &$newid, $reason = '' ) {
1612 global $wgUser, $wgLinkCache, $wgUseSquid;
1613 global $wgMwRedir;
1614 $fname = 'MovePageForm::moveToNewTitle';
1615 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
1616 if ( $reason ) {
1617 $comment .= ": $reason";
1618 }
1619
1620 $newid = $nt->getArticleID();
1621 $oldid = $this->getArticleID();
1622 $dbw =& wfGetDB( DB_MASTER );
1623 $now = $dbw->timestamp();
1624 wfSeedRandom();
1625 $rand = wfRandom();
1626
1627 # Save a null revision in the page's history notifying of the move
1628 $nullRevision = Revision::newNullRevision( $dbw, $oldid,
1629 wfMsg( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() ),
1630 true );
1631 $nullRevId = $nullRevision->insertOn( $dbw );
1632
1633 # Rename cur entry
1634 $dbw->update( 'page',
1635 /* SET */ array(
1636 'page_touched' => $now,
1637 'page_namespace' => $nt->getNamespace(),
1638 'page_title' => $nt->getDBkey(),
1639 'page_latest' => $nullRevId,
1640 ),
1641 /* WHERE */ array( 'page_id' => $oldid ),
1642 $fname
1643 );
1644
1645 $wgLinkCache->clearLink( $nt->getPrefixedDBkey() );
1646
1647 # Insert redirect
1648 $redirectText = $wgMwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
1649 $redirectArticle = new Article( $this );
1650 $newid = $redirectArticle->insertOn( $dbw );
1651 $redirectRevision = new Revision( array(
1652 'page' => $newid,
1653 'comment' => $comment,
1654 'text' => $redirectText ) );
1655 $revid = $redirectRevision->insertOn( $dbw );
1656 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
1657 $wgLinkCache->clearLink( $this->getPrefixedDBkey() );
1658
1659 # Log the move
1660 $log = new LogPage( 'move' );
1661 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
1662
1663 # Purge squid and linkscc as per article creation
1664 Article::onArticleCreate( $nt );
1665
1666 # Any text links to the old title must be reassigned to the redirect
1667 $dbw->update( 'links', array( 'l_to' => $newid ), array( 'l_to' => $oldid ), $fname );
1668 LinkCache::linksccClearLinksTo( $oldid );
1669
1670 # Record the just-created redirect's linking to the page
1671 $dbw->insert( 'links', array( 'l_from' => $newid, 'l_to' => $oldid ), $fname );
1672
1673 # Non-existent target may have had broken links to it; these must
1674 # now be removed and made into good links.
1675 $update = new LinksUpdate( $oldid, $nt->getPrefixedDBkey() );
1676 $update->fixBrokenLinks();
1677
1678 # Purge old title from squid
1679 # The new title, and links to the new title, are purged in Article::onArticleCreate()
1680 $titles = $nt->getLinksTo();
1681 if ( $wgUseSquid ) {
1682 $urls = $this->getSquidURLs();
1683 foreach ( $titles as $linkTitle ) {
1684 $urls[] = $linkTitle->getInternalURL();
1685 }
1686 $u = new SquidUpdate( $urls );
1687 $u->doUpdate();
1688 }
1689 }
1690
1691 /**
1692 * Checks if $this can be moved to a given Title
1693 * - Selects for update, so don't call it unless you mean business
1694 *
1695 * @param Title &$nt the new title to check
1696 * @access public
1697 */
1698 function isValidMoveTarget( $nt ) {
1699
1700 $fname = 'Title::isValidMoveTarget';
1701 $dbw =& wfGetDB( DB_MASTER );
1702
1703 # Is it a redirect?
1704 $id = $nt->getArticleID();
1705 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
1706 array( 'page_is_redirect','old_text' ),
1707 array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
1708 $fname, 'FOR UPDATE' );
1709
1710 if ( !$obj || 0 == $obj->page_is_redirect ) {
1711 # Not a redirect
1712 return false;
1713 }
1714
1715 # Does the redirect point to the source?
1716 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $obj->old_text, $m ) ) {
1717 $redirTitle = Title::newFromText( $m[1] );
1718 if( !is_object( $redirTitle ) ||
1719 $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() ) {
1720 return false;
1721 }
1722 }
1723
1724 # Does the article have a history?
1725 $row = $dbw->selectRow( array( 'page', 'revision'),
1726 array( 'rev_id' ),
1727 array( 'page_namespace' => $nt->getNamespace(),
1728 'page_title' => $nt->getDBkey(),
1729 'page_id=rev_page AND page_latest != rev_id'
1730 ), $fname, 'FOR UPDATE'
1731 );
1732
1733 # Return true if there was no history
1734 return $row === false;
1735 }
1736
1737 /**
1738 * Create a redirect; fails if the title already exists; does
1739 * not notify RC
1740 *
1741 * @param Title $dest the destination of the redirect
1742 * @param string $comment the comment string describing the move
1743 * @return bool true on success
1744 * @access public
1745 */
1746 function createRedirect( $dest, $comment ) {
1747 global $wgUser;
1748 if ( $this->getArticleID() ) {
1749 return false;
1750 }
1751
1752 $fname = 'Title::createRedirect';
1753 $dbw =& wfGetDB( DB_MASTER );
1754
1755 $article = new Article( $this );
1756 $newid = $article->insertOn( $dbw );
1757 $revision = new Revision( array(
1758 'page' => $newid,
1759 'comment' => $comment,
1760 'text' => "#REDIRECT [[" . $dest->getPrefixedText() . "]]\n",
1761 ) );
1762 $revisionId = $revision->insertOn( $dbw );
1763 $article->updateRevisionOn( $dbw, $revision, 0 );
1764
1765 # Link table
1766 if ( $dest->getArticleID() ) {
1767 $dbw->insert( 'links',
1768 array(
1769 'l_to' => $dest->getArticleID(),
1770 'l_from' => $newid
1771 ), $fname
1772 );
1773 } else {
1774 $dbw->insert( 'brokenlinks',
1775 array(
1776 'bl_to' => $dest->getPrefixedDBkey(),
1777 'bl_from' => $newid
1778 ), $fname
1779 );
1780 }
1781
1782 Article::onArticleCreate( $this );
1783 return true;
1784 }
1785
1786 /**
1787 * Get categories to which this Title belongs and return an array of
1788 * categories' names.
1789 *
1790 * @return array an array of parents in the form:
1791 * $parent => $currentarticle
1792 * @access public
1793 */
1794 function getParentCategories() {
1795 global $wgContLang,$wgUser;
1796
1797 $titlekey = $this->getArticleId();
1798 $sk =& $wgUser->getSkin();
1799 $parents = array();
1800 $dbr =& wfGetDB( DB_SLAVE );
1801 $categorylinks = $dbr->tableName( 'categorylinks' );
1802
1803 # NEW SQL
1804 $sql = "SELECT * FROM $categorylinks"
1805 ." WHERE cl_from='$titlekey'"
1806 ." AND cl_from <> '0'"
1807 ." ORDER BY cl_sortkey";
1808
1809 $res = $dbr->query ( $sql ) ;
1810
1811 if($dbr->numRows($res) > 0) {
1812 while ( $x = $dbr->fetchObject ( $res ) )
1813 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
1814 $data[$wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to] = $this->getFullText();
1815 $dbr->freeResult ( $res ) ;
1816 } else {
1817 $data = '';
1818 }
1819 return $data;
1820 }
1821
1822 /**
1823 * Get a tree of parent categories
1824 * @param array $children an array with the children in the keys, to check for circular refs
1825 * @return array
1826 * @access public
1827 */
1828 function getParentCategoryTree( $children = array() ) {
1829 $parents = $this->getParentCategories();
1830
1831 if($parents != '') {
1832 foreach($parents as $parent => $current)
1833 {
1834 if ( array_key_exists( $parent, $children ) ) {
1835 # Circular reference
1836 $stack[$parent] = array();
1837 } else {
1838 $nt = Title::newFromText($parent);
1839 $stack[$parent] = $nt->getParentCategoryTree( $children + array($parent => 1) );
1840 }
1841 }
1842 return $stack;
1843 } else {
1844 return array();
1845 }
1846 }
1847
1848
1849 /**
1850 * Get an associative array for selecting this title from
1851 * the "cur" table
1852 *
1853 * @return array
1854 * @access public
1855 */
1856 function curCond() {
1857 wfDebugDieBacktrace( 'curCond called' );
1858 return array( 'cur_namespace' => $this->mNamespace, 'cur_title' => $this->mDbkeyform );
1859 }
1860
1861 /**
1862 * Get an associative array for selecting this title from the
1863 * "old" table
1864 *
1865 * @return array
1866 * @access public
1867 */
1868 function oldCond() {
1869 wfDebugDieBacktrace( 'oldCond called' );
1870 return array( 'old_namespace' => $this->mNamespace, 'old_title' => $this->mDbkeyform );
1871 }
1872
1873 /**
1874 * Get the revision ID of the previous revision
1875 *
1876 * @param integer $revision Revision ID. Get the revision that was before this one.
1877 * @return interger $oldrevision|false
1878 */
1879 function getPreviousRevisionID( $revision ) {
1880 $dbr =& wfGetDB( DB_SLAVE );
1881 return $dbr->selectField( 'revision', 'rev_id',
1882 'rev_page=' . IntVal( $this->getArticleId() ) .
1883 ' AND rev_id<' . IntVal( $revision ) . ' ORDER BY rev_id DESC' );
1884 }
1885
1886 /**
1887 * Get the revision ID of the next revision
1888 *
1889 * @param integer $revision Revision ID. Get the revision that was after this one.
1890 * @return interger $oldrevision|false
1891 */
1892 function getNextRevisionID( $revision ) {
1893 $dbr =& wfGetDB( DB_SLAVE );
1894 return $dbr->selectField( 'revision', 'rev_id',
1895 'rev_page=' . IntVal( $this->getArticleId() ) .
1896 ' AND rev_id>' . IntVal( $revision ) . ' ORDER BY rev_id' );
1897 }
1898
1899 /**
1900 * Compare with another title.
1901 *
1902 * @param Title $title
1903 * @return bool
1904 */
1905 function equals( &$title ) {
1906 return $this->getInterwiki() == $title->getInterwiki()
1907 && $this->getNamespace() == $title->getNamespace()
1908 && $this->getDbkey() == $title->getDbkey();
1909 }
1910
1911 }
1912 ?>