* (bug 3280) Respect 'move' group permission on page moves
[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 $mLatestID; # ID of most recent revision
46 var $mRestrictions; # Array of groups allowed to edit this article
47 # Only null or "sysop" are supported
48 var $mRestrictionsLoaded; # Boolean for initialisation on demand
49 var $mPrefixedText; # Text form including namespace/interwiki, initialised on demand
50 var $mDefaultNamespace; # Namespace index when there is no namespace
51 # Zero except in {{transclusion}} tags
52 var $mWatched; # Is $wgUser watching this page? NULL if unfilled, accessed through userIsWatching()
53 /**#@-*/
54
55
56 /**
57 * Constructor
58 * @access private
59 */
60 /* private */ function Title() {
61 $this->mInterwiki = $this->mUrlform =
62 $this->mTextform = $this->mDbkeyform = '';
63 $this->mArticleID = -1;
64 $this->mNamespace = NS_MAIN;
65 $this->mRestrictionsLoaded = false;
66 $this->mRestrictions = array();
67 # Dont change the following, NS_MAIN is hardcoded in several place
68 # See bug #696
69 $this->mDefaultNamespace = NS_MAIN;
70 $this->mWatched = NULL;
71 $this->mLatestID = false;
72 }
73
74 /**
75 * Create a new Title from a prefixed DB key
76 * @param string $key The database key, which has underscores
77 * instead of spaces, possibly including namespace and
78 * interwiki prefixes
79 * @return Title the new object, or NULL on an error
80 * @static
81 * @access public
82 */
83 /* static */ function newFromDBkey( $key ) {
84 $t = new Title();
85 $t->mDbkeyform = $key;
86 if( $t->secureAndSplit() )
87 return $t;
88 else
89 return NULL;
90 }
91
92 /**
93 * Create a new Title from text, such as what one would
94 * find in a link. Decodes any HTML entities in the text.
95 *
96 * @param string $text the link text; spaces, prefixes,
97 * and an initial ':' indicating the main namespace
98 * are accepted
99 * @param int $defaultNamespace the namespace to use if
100 * none is specified by a prefix
101 * @return Title the new object, or NULL on an error
102 * @static
103 * @access public
104 */
105 function newFromText( $text, $defaultNamespace = NS_MAIN ) {
106 $fname = 'Title::newFromText';
107 wfProfileIn( $fname );
108
109 if( is_object( $text ) ) {
110 wfDebugDieBacktrace( 'Title::newFromText given an object' );
111 }
112
113 /**
114 * Wiki pages often contain multiple links to the same page.
115 * Title normalization and parsing can become expensive on
116 * pages with many links, so we can save a little time by
117 * caching them.
118 *
119 * In theory these are value objects and won't get changed...
120 */
121 static $titleCache = array();
122 if( $defaultNamespace == NS_MAIN && isset( $titleCache[$text] ) ) {
123 wfProfileOut( $fname );
124 return $titleCache[$text];
125 }
126
127 /**
128 * Convert things like &eacute; &#257; or &#x3017; into real text...
129 */
130 $filteredText = Sanitizer::decodeCharReferences( $text );
131
132 $t =& new Title();
133 $t->mDbkeyform = str_replace( ' ', '_', $filteredText );
134 $t->mDefaultNamespace = $defaultNamespace;
135
136 if( $t->secureAndSplit() ) {
137 if( $defaultNamespace == NS_MAIN ) {
138 if( count( $titleCache ) >= MW_TITLECACHE_MAX ) {
139 # Avoid memory leaks on mass operations...
140 $titleCache = array();
141 }
142 $titleCache[$text] =& $t;
143 }
144 wfProfileOut( $fname );
145 return $t;
146 } else {
147 wfProfileOut( $fname );
148 $ret = NULL;
149 return $ret;
150 }
151 }
152
153 /**
154 * Create a new Title from URL-encoded text. Ensures that
155 * the given title's length does not exceed the maximum.
156 * @param string $url the title, as might be taken from a URL
157 * @return Title the new object, or NULL on an error
158 * @static
159 * @access public
160 */
161 function newFromURL( $url ) {
162 global $wgLang, $wgServer;
163 $t = new Title();
164
165 # For compatibility with old buggy URLs. "+" is not valid in titles,
166 # but some URLs used it as a space replacement and they still come
167 # from some external search tools.
168 $s = str_replace( '+', ' ', $url );
169
170 $t->mDbkeyform = str_replace( ' ', '_', $s );
171 if( $t->secureAndSplit() ) {
172 return $t;
173 } else {
174 return NULL;
175 }
176 }
177
178 /**
179 * Create a new Title from an article ID
180 *
181 * @todo This is inefficiently implemented, the page row is requested
182 * but not used for anything else
183 *
184 * @param int $id the page_id corresponding to the Title to create
185 * @return Title the new object, or NULL on an error
186 * @access public
187 * @static
188 */
189 function newFromID( $id ) {
190 $fname = 'Title::newFromID';
191 $dbr =& wfGetDB( DB_SLAVE );
192 $row = $dbr->selectRow( 'page', array( 'page_namespace', 'page_title' ),
193 array( 'page_id' => $id ), $fname );
194 if ( $row !== false ) {
195 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
196 } else {
197 $title = NULL;
198 }
199 return $title;
200 }
201
202 /**
203 * Create a new Title from a namespace index and a DB key.
204 * It's assumed that $ns and $title are *valid*, for instance when
205 * they came directly from the database or a special page name.
206 * For convenience, spaces are converted to underscores so that
207 * eg user_text fields can be used directly.
208 *
209 * @param int $ns the namespace of the article
210 * @param string $title the unprefixed database key form
211 * @return Title the new object
212 * @static
213 * @access public
214 */
215 function &makeTitle( $ns, $title ) {
216 $t =& new Title();
217 $t->mInterwiki = '';
218 $t->mFragment = '';
219 $t->mNamespace = intval( $ns );
220 $t->mDbkeyform = str_replace( ' ', '_', $title );
221 $t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
222 $t->mUrlform = wfUrlencode( $t->mDbkeyform );
223 $t->mTextform = str_replace( '_', ' ', $title );
224 return $t;
225 }
226
227 /**
228 * Create a new Title frrom a namespace index and a DB key.
229 * The parameters will be checked for validity, which is a bit slower
230 * than makeTitle() but safer for user-provided data.
231 *
232 * @param int $ns the namespace of the article
233 * @param string $title the database key form
234 * @return Title the new object, or NULL on an error
235 * @static
236 * @access public
237 */
238 function makeTitleSafe( $ns, $title ) {
239 $t = new Title();
240 $t->mDbkeyform = Title::makeName( $ns, $title );
241 if( $t->secureAndSplit() ) {
242 return $t;
243 } else {
244 return NULL;
245 }
246 }
247
248 /**
249 * Create a new Title for the Main Page
250 *
251 * @static
252 * @return Title the new object
253 * @access public
254 */
255 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 function newFromRedirect( $text ) {
268 global $wgMwRedir;
269 $rt = NULL;
270 if ( $wgMwRedir->matchStart( $text ) ) {
271 if ( preg_match( '/\[{2}(.*?)(?:\||\]{2})/', $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 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 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 return $n == '' ? $title : "$n:$title";
380 }
381
382 /**
383 * Returns the URL associated with an interwiki prefix
384 * @param string $key the interwiki prefix (e.g. "MeatBall")
385 * @return the associated URL, containing "$1", which should be
386 * replaced by an article title
387 * @static (arguably)
388 * @access public
389 */
390 function getInterwikiLink( $key, $transludeonly = false ) {
391 global $wgMemc, $wgDBname, $wgInterwikiExpiry, $wgTitleInterwikiCache;
392 $fname = 'Title::getInterwikiLink';
393
394 wfProfileIn( $fname );
395
396 $k = $wgDBname.':interwiki:'.$key;
397 if( array_key_exists( $k, $wgTitleInterwikiCache ) ) {
398 wfProfileOut( $fname );
399 return $wgTitleInterwikiCache[$k]->iw_url;
400 }
401
402 $s = $wgMemc->get( $k );
403 # Ignore old keys with no iw_local
404 if( $s && isset( $s->iw_local ) && isset($s->iw_trans)) {
405 $wgTitleInterwikiCache[$k] = $s;
406 wfProfileOut( $fname );
407 return $s->iw_url;
408 }
409
410 $dbr =& wfGetDB( DB_SLAVE );
411 $res = $dbr->select( 'interwiki',
412 array( 'iw_url', 'iw_local', 'iw_trans' ),
413 array( 'iw_prefix' => $key ), $fname );
414 if( !$res ) {
415 wfProfileOut( $fname );
416 return '';
417 }
418
419 $s = $dbr->fetchObject( $res );
420 if( !$s ) {
421 # Cache non-existence: create a blank object and save it to memcached
422 $s = (object)false;
423 $s->iw_url = '';
424 $s->iw_local = 0;
425 $s->iw_trans = 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 * Determine whether the object refers to a page within
457 * this project and is transcludable.
458 *
459 * @return bool TRUE if this is transcludable
460 * @access public
461 */
462 function isTrans() {
463 global $wgTitleInterwikiCache, $wgDBname;
464
465 if ($this->mInterwiki == '' || !$this->isLocal())
466 return false;
467 # Make sure key is loaded into cache
468 $this->getInterwikiLink( $this->mInterwiki );
469 $k = $wgDBname.':interwiki:' . $this->mInterwiki;
470 return (bool)($wgTitleInterwikiCache[$k]->iw_trans);
471 }
472
473 /**
474 * Update the page_touched field for an array of title objects
475 * @todo Inefficient unless the IDs are already loaded into the
476 * link cache
477 * @param array $titles an array of Title objects to be touched
478 * @param string $timestamp the timestamp to use instead of the
479 * default current time
480 * @static
481 * @access public
482 */
483 function touchArray( $titles, $timestamp = '' ) {
484 global $wgUseFileCache;
485
486 if ( count( $titles ) == 0 ) {
487 return;
488 }
489 $dbw =& wfGetDB( DB_MASTER );
490 if ( $timestamp == '' ) {
491 $timestamp = $dbw->timestamp();
492 }
493 $page = $dbw->tableName( 'page' );
494 /*
495 $sql = "UPDATE $page SET page_touched='{$timestamp}' WHERE page_id IN (";
496 $first = true;
497
498 foreach ( $titles as $title ) {
499 if ( $wgUseFileCache ) {
500 $cm = new CacheManager($title);
501 @unlink($cm->fileCacheName());
502 }
503
504 if ( ! $first ) {
505 $sql .= ',';
506 }
507 $first = false;
508 $sql .= $title->getArticleID();
509 }
510 $sql .= ')';
511 if ( ! $first ) {
512 $dbw->query( $sql, 'Title::touchArray' );
513 }
514 */
515 // hack hack hack -- brion 2005-07-11. this was unfriendly to db.
516 // do them in small chunks:
517 $fname = 'Title::touchArray';
518 foreach( $titles as $title ) {
519 $dbw->update( 'page',
520 array( 'page_touched' => $timestamp ),
521 array(
522 'page_namespace' => $title->getNamespace(),
523 'page_title' => $title->getDBkey() ),
524 $fname );
525 }
526 }
527
528 #----------------------------------------------------------------------------
529 # Other stuff
530 #----------------------------------------------------------------------------
531
532 /** Simple accessors */
533 /**
534 * Get the text form (spaces not underscores) of the main part
535 * @return string
536 * @access public
537 */
538 function getText() { return $this->mTextform; }
539 /**
540 * Get the URL-encoded form of the main part
541 * @return string
542 * @access public
543 */
544 function getPartialURL() { return $this->mUrlform; }
545 /**
546 * Get the main part with underscores
547 * @return string
548 * @access public
549 */
550 function getDBkey() { return $this->mDbkeyform; }
551 /**
552 * Get the namespace index, i.e. one of the NS_xxxx constants
553 * @return int
554 * @access public
555 */
556 function getNamespace() { return $this->mNamespace; }
557 /**
558 * Get the interwiki prefix (or null string)
559 * @return string
560 * @access public
561 */
562 function getInterwiki() { return $this->mInterwiki; }
563 /**
564 * Get the Title fragment (i.e. the bit after the #)
565 * @return string
566 * @access public
567 */
568 function getFragment() { return $this->mFragment; }
569 /**
570 * Get the default namespace index, for when there is no namespace
571 * @return int
572 * @access public
573 */
574 function getDefaultNamespace() { return $this->mDefaultNamespace; }
575
576 /**
577 * Get title for search index
578 * @return string a stripped-down title string ready for the
579 * search index
580 */
581 function getIndexTitle() {
582 return Title::indexTitle( $this->mNamespace, $this->mTextform );
583 }
584
585 /**
586 * Get the prefixed database key form
587 * @return string the prefixed title, with underscores and
588 * any interwiki and namespace prefixes
589 * @access public
590 */
591 function getPrefixedDBkey() {
592 $s = $this->prefix( $this->mDbkeyform );
593 $s = str_replace( ' ', '_', $s );
594 return $s;
595 }
596
597 /**
598 * Get the prefixed title with spaces.
599 * This is the form usually used for display
600 * @return string the prefixed title, with spaces
601 * @access public
602 */
603 function getPrefixedText() {
604 global $wgContLang;
605 if ( empty( $this->mPrefixedText ) ) {
606 $s = $this->prefix( $this->mTextform );
607 $s = str_replace( '_', ' ', $s );
608 $this->mPrefixedText = $s;
609 }
610 return $this->mPrefixedText;
611 }
612
613 /**
614 * Get the prefixed title with spaces, plus any fragment
615 * (part beginning with '#')
616 * @return string the prefixed title, with spaces and
617 * the fragment, including '#'
618 * @access public
619 */
620 function getFullText() {
621 global $wgContLang;
622 $text = $this->getPrefixedText();
623 if( '' != $this->mFragment ) {
624 $text .= '#' . $this->mFragment;
625 }
626 return $text;
627 }
628
629 /**
630 * Get a URL-encoded title (not an actual URL) including interwiki
631 * @return string the URL-encoded form
632 * @access public
633 */
634 function getPrefixedURL() {
635 $s = $this->prefix( $this->mDbkeyform );
636 $s = str_replace( ' ', '_', $s );
637
638 $s = wfUrlencode ( $s ) ;
639
640 # Cleaning up URL to make it look nice -- is this safe?
641 $s = str_replace( '%28', '(', $s );
642 $s = str_replace( '%29', ')', $s );
643
644 return $s;
645 }
646
647 /**
648 * Get a real URL referring to this title, with interwiki link and
649 * fragment
650 *
651 * @param string $query an optional query string, not used
652 * for interwiki links
653 * @return string the URL
654 * @access public
655 */
656 function getFullURL( $query = '' ) {
657 global $wgContLang, $wgServer, $wgScript, $wgMakeDumpLinks, $wgArticlePath;
658
659 if ( '' == $this->mInterwiki ) {
660 return $wgServer . $this->getLocalUrl( $query );
661 } elseif ( $wgMakeDumpLinks && $wgContLang->getLanguageName( $this->mInterwiki ) ) {
662 $baseUrl = str_replace( '$1', "../../{$this->mInterwiki}/$1", $wgArticlePath );
663 $baseUrl = str_replace( '$1', $this->getHashedDirectory() . '/$1', $baseUrl );
664 } else {
665 $baseUrl = $this->getInterwikiLink( $this->mInterwiki );
666 }
667
668 $namespace = $wgContLang->getNsText( $this->mNamespace );
669 if ( '' != $namespace ) {
670 # Can this actually happen? Interwikis shouldn't be parsed.
671 $namespace .= ':';
672 }
673 $url = str_replace( '$1', $namespace . $this->mUrlform, $baseUrl );
674 if( $query != '' ) {
675 if( false === strpos( $url, '?' ) ) {
676 $url .= '?';
677 } else {
678 $url .= '&';
679 }
680 $url .= $query;
681 }
682 if ( '' != $this->mFragment ) {
683 $url .= '#' . $this->mFragment;
684 }
685 return $url;
686 }
687
688 /**
689 * Get a relative directory for putting an HTML version of this article into
690 */
691 function getHashedDirectory() {
692 global $wgMakeDumpLinks, $wgInputEncoding;
693 $dbkey = $this->getDBkey();
694
695 # Split into characters
696 if ( $wgInputEncoding == 'UTF-8' ) {
697 preg_match_all( '/./us', $dbkey, $m );
698 } else {
699 preg_match_all( '/./s', $dbkey, $m );
700 }
701 $chars = $m[0];
702 $length = count( $chars );
703 $dir = '';
704
705 for ( $i = 0; $i < $wgMakeDumpLinks; $i++ ) {
706 if ( $i ) {
707 $dir .= '/';
708 }
709 if ( $i >= $length ) {
710 $dir .= '_';
711 } elseif ( ord( $chars[$i] ) > 32 ) {
712 $dir .= strtolower( $chars[$i] );
713 } else {
714 $dir .= sprintf( "%02X", ord( $chars[$i] ) );
715 }
716 }
717 return $dir;
718 }
719
720 function getHashedFilename() {
721 $dbkey = $this->getPrefixedDBkey();
722 $mainPage = Title::newMainPage();
723 if ( $mainPage->getPrefixedDBkey() == $dbkey ) {
724 return 'index.html';
725 }
726
727 $dir = $this->getHashedDirectory();
728
729 # Replace illegal charcters for Windows paths with underscores
730 $friendlyName = strtr( $dbkey, '/\\*?"<>|~', '_________' );
731
732 # Work out lower case form. We assume we're on a system with case-insensitive
733 # filenames, so unless the case is of a special form, we have to disambiguate
734 $lowerCase = $this->prefix( ucfirst( strtolower( $this->getDBkey() ) ) );
735
736 # Make it mostly unique
737 if ( $lowerCase != $friendlyName ) {
738 $friendlyName .= '_' . substr(md5( $dbkey ), 0, 4);
739 }
740 # Handle colon specially by replacing it with tilde
741 # Thus we reduce the number of paths with hashes appended
742 $friendlyName = str_replace( ':', '~', $friendlyName );
743 return "$dir/$friendlyName.html";
744 }
745
746 /**
747 * Get a URL with no fragment or server name. If this page is generated
748 * with action=render, $wgServer is prepended.
749 * @param string $query an optional query string; if not specified,
750 * $wgArticlePath will be used.
751 * @return string the URL
752 * @access public
753 */
754 function getLocalURL( $query = '' ) {
755 global $wgLang, $wgArticlePath, $wgScript, $wgMakeDumpLinks, $wgServer, $action;
756
757 if ( $this->isExternal() ) {
758 return $this->getFullURL();
759 }
760
761 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
762 if ( $wgMakeDumpLinks ) {
763 $url = str_replace( '$1', wfUrlencode( $this->getHashedFilename() ), $wgArticlePath );
764 } elseif ( $query == '' ) {
765 $url = str_replace( '$1', $dbkey, $wgArticlePath );
766 } else {
767 global $wgActionPaths;
768 if( !empty( $wgActionPaths ) &&
769 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) ) {
770 $action = urldecode( $matches[2] );
771 if( isset( $wgActionPaths[$action] ) ) {
772 $query = $matches[1];
773 if( isset( $matches[4] ) ) $query .= $matches[4];
774 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
775 if( $query != '' ) $url .= '?' . $query;
776 return $url;
777 }
778 }
779 if ( $query == '-' ) {
780 $query = '';
781 }
782 $url = "{$wgScript}?title={$dbkey}&{$query}";
783 }
784
785 if ($action == 'render')
786 return $wgServer . $url;
787 else
788 return $url;
789 }
790
791 /**
792 * Get an HTML-escaped version of the URL form, suitable for
793 * using in a link, without a server name or fragment
794 * @param string $query an optional query string
795 * @return string the URL
796 * @access public
797 */
798 function escapeLocalURL( $query = '' ) {
799 return htmlspecialchars( $this->getLocalURL( $query ) );
800 }
801
802 /**
803 * Get an HTML-escaped version of the URL form, suitable for
804 * using in a link, including the server name and fragment
805 *
806 * @return string the URL
807 * @param string $query an optional query string
808 * @access public
809 */
810 function escapeFullURL( $query = '' ) {
811 return htmlspecialchars( $this->getFullURL( $query ) );
812 }
813
814 /**
815 * Get the URL form for an internal link.
816 * - Used in various Squid-related code, in case we have a different
817 * internal hostname for the server from the exposed one.
818 *
819 * @param string $query an optional query string
820 * @return string the URL
821 * @access public
822 */
823 function getInternalURL( $query = '' ) {
824 global $wgInternalServer;
825 return $wgInternalServer . $this->getLocalURL( $query );
826 }
827
828 /**
829 * Get the edit URL for this Title
830 * @return string the URL, or a null string if this is an
831 * interwiki link
832 * @access public
833 */
834 function getEditURL() {
835 global $wgServer, $wgScript;
836
837 if ( '' != $this->mInterwiki ) { return ''; }
838 $s = $this->getLocalURL( 'action=edit' );
839
840 return $s;
841 }
842
843 /**
844 * Get the HTML-escaped displayable text form.
845 * Used for the title field in <a> tags.
846 * @return string the text, including any prefixes
847 * @access public
848 */
849 function getEscapedText() {
850 return htmlspecialchars( $this->getPrefixedText() );
851 }
852
853 /**
854 * Is this Title interwiki?
855 * @return boolean
856 * @access public
857 */
858 function isExternal() { return ( '' != $this->mInterwiki ); }
859
860 /**
861 * Does the title correspond to a protected article?
862 * @param string $what the action the page is protected from,
863 * by default checks move and edit
864 * @return boolean
865 * @access public
866 */
867 function isProtected($action = '') {
868 if ( -1 == $this->mNamespace ) { return true; }
869 if($action == 'edit' || $action == '') {
870 $a = $this->getRestrictions("edit");
871 if ( in_array( 'sysop', $a ) ) { return true; }
872 }
873 if($action == 'move' || $action == '') {
874 $a = $this->getRestrictions("move");
875 if ( in_array( 'sysop', $a ) ) { return true; }
876 }
877 return false;
878 }
879
880 /**
881 * Is $wgUser is watching this page?
882 * @return boolean
883 * @access public
884 */
885 function userIsWatching() {
886 global $wgUser;
887
888 if ( is_null( $this->mWatched ) ) {
889 if ( -1 == $this->mNamespace || 0 == $wgUser->getID()) {
890 $this->mWatched = false;
891 } else {
892 $this->mWatched = $wgUser->isWatched( $this );
893 }
894 }
895 return $this->mWatched;
896 }
897
898 /**
899 * Is $wgUser perform $action this page?
900 * @param string $action action that permission needs to be checked for
901 * @return boolean
902 * @access private
903 */
904 function userCan($action) {
905 $fname = 'Title::userCanEdit';
906 wfProfileIn( $fname );
907
908 global $wgUser;
909 if( NS_SPECIAL == $this->mNamespace ) {
910 wfProfileOut( $fname );
911 return false;
912 }
913 if( NS_MEDIAWIKI == $this->mNamespace &&
914 !$wgUser->isAllowed('editinterface') ) {
915 wfProfileOut( $fname );
916 return false;
917 }
918 if( $this->mDbkeyform == '_' ) {
919 # FIXME: Is this necessary? Shouldn't be allowed anyway...
920 wfProfileOut( $fname );
921 return false;
922 }
923
924 # protect global styles and js
925 if ( NS_MEDIAWIKI == $this->mNamespace
926 && preg_match("/\\.(css|js)$/", $this->mTextform )
927 && !$wgUser->isAllowed('editinterface') ) {
928 wfProfileOut( $fname );
929 return false;
930 }
931
932 # protect css/js subpages of user pages
933 # XXX: this might be better using restrictions
934 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
935 if( NS_USER == $this->mNamespace
936 && preg_match("/\\.(css|js)$/", $this->mTextform )
937 && !$wgUser->isAllowed('editinterface')
938 && !preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) ) {
939 wfProfileOut( $fname );
940 return false;
941 }
942
943 foreach( $this->getRestrictions($action) as $right ) {
944 // Backwards compatibility, rewrite sysop -> protect
945 if ( $right == 'sysop' ) {
946 $right = 'protect';
947 }
948 if( '' != $right && !$wgUser->isAllowed( $right ) ) {
949 wfProfileOut( $fname );
950 return false;
951 }
952 }
953
954 if( $action == 'move' &&
955 !( $this->isMovable() && $wgUser->isAllowed( 'move' ) ) ) {
956 wfProfileOut( $fname );
957 return false;
958 }
959
960 wfProfileOut( $fname );
961 return true;
962 }
963
964 /**
965 * Can $wgUser edit this page?
966 * @return boolean
967 * @access public
968 */
969 function userCanEdit() {
970 return $this->userCan('edit');
971 }
972
973 /**
974 * Can $wgUser move this page?
975 * @return boolean
976 * @access public
977 */
978 function userCanMove() {
979 return $this->userCan('move');
980 }
981
982 /**
983 * Would anybody with sufficient privileges be able to move this page?
984 * Some pages just aren't movable.
985 *
986 * @return boolean
987 * @access public
988 */
989 function isMovable() {
990 return Namespace::isMovable( $this->getNamespace() )
991 && $this->getInterwiki() == '';
992 }
993
994 /**
995 * Can $wgUser read this page?
996 * @return boolean
997 * @access public
998 */
999 function userCanRead() {
1000 global $wgUser;
1001
1002 if( $wgUser->isAllowed('read') ) {
1003 return true;
1004 } else {
1005 global $wgWhitelistRead;
1006
1007 /** If anon users can create an account,
1008 they need to reach the login page first! */
1009 if( $wgUser->isAllowed( 'createaccount' )
1010 && $this->getNamespace() == NS_SPECIAL
1011 && $this->getText() == 'Userlogin' ) {
1012 return true;
1013 }
1014
1015 /** some pages are explicitly allowed */
1016 $name = $this->getPrefixedText();
1017 if( $wgWhitelistRead && in_array( $name, $wgWhitelistRead ) ) {
1018 return true;
1019 }
1020
1021 # Compatibility with old settings
1022 if( $wgWhitelistRead && $this->getNamespace() == NS_MAIN ) {
1023 if( in_array( ':' . $name, $wgWhitelistRead ) ) {
1024 return true;
1025 }
1026 }
1027 }
1028 return false;
1029 }
1030
1031 /**
1032 * Is this a talk page of some sort?
1033 * @return bool
1034 * @access public
1035 */
1036 function isTalkPage() {
1037 return Namespace::isTalk( $this->getNamespace() );
1038 }
1039
1040 /**
1041 * Is this a .css or .js subpage of a user page?
1042 * @return bool
1043 * @access public
1044 */
1045 function isCssJsSubpage() {
1046 return ( NS_USER == $this->mNamespace and preg_match("/\\.(css|js)$/", $this->mTextform ) );
1047 }
1048 /**
1049 * Is this a .css subpage of a user page?
1050 * @return bool
1051 * @access public
1052 */
1053 function isCssSubpage() {
1054 return ( NS_USER == $this->mNamespace and preg_match("/\\.css$/", $this->mTextform ) );
1055 }
1056 /**
1057 * Is this a .js subpage of a user page?
1058 * @return bool
1059 * @access public
1060 */
1061 function isJsSubpage() {
1062 return ( NS_USER == $this->mNamespace and preg_match("/\\.js$/", $this->mTextform ) );
1063 }
1064 /**
1065 * Protect css/js subpages of user pages: can $wgUser edit
1066 * this page?
1067 *
1068 * @return boolean
1069 * @todo XXX: this might be better using restrictions
1070 * @access public
1071 */
1072 function userCanEditCssJsSubpage() {
1073 global $wgUser;
1074 return ( $wgUser->isAllowed('editinterface') or preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform) );
1075 }
1076
1077 /**
1078 * Loads a string into mRestrictions array
1079 * @param string $res restrictions in string format
1080 * @access public
1081 */
1082 function loadRestrictions( $res ) {
1083 foreach( explode( ':', trim( $res ) ) as $restrict ) {
1084 $temp = explode( '=', trim( $restrict ) );
1085 if(count($temp) == 1) {
1086 // old format should be treated as edit/move restriction
1087 $this->mRestrictions["edit"] = explode( ',', trim( $temp[0] ) );
1088 $this->mRestrictions["move"] = explode( ',', trim( $temp[0] ) );
1089 } else {
1090 $this->mRestrictions[$temp[0]] = explode( ',', trim( $temp[1] ) );
1091 }
1092 }
1093 $this->mRestrictionsLoaded = true;
1094 }
1095
1096 /**
1097 * Accessor/initialisation for mRestrictions
1098 * @param string $action action that permission needs to be checked for
1099 * @return array the array of groups allowed to edit this article
1100 * @access public
1101 */
1102 function getRestrictions($action) {
1103 $id = $this->getArticleID();
1104 if ( 0 == $id ) { return array(); }
1105
1106 if ( ! $this->mRestrictionsLoaded ) {
1107 $dbr =& wfGetDB( DB_SLAVE );
1108 $res = $dbr->selectField( 'page', 'page_restrictions', 'page_id='.$id );
1109 $this->loadRestrictions( $res );
1110 }
1111 if( isset( $this->mRestrictions[$action] ) ) {
1112 return $this->mRestrictions[$action];
1113 }
1114 return array();
1115 }
1116
1117 /**
1118 * Is there a version of this page in the deletion archive?
1119 * @return int the number of archived revisions
1120 * @access public
1121 */
1122 function isDeleted() {
1123 $fname = 'Title::isDeleted';
1124 if ( $this->getNamespace() < 0 ) {
1125 $n = 0;
1126 } else {
1127 $dbr =& wfGetDB( DB_SLAVE );
1128 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1129 'ar_title' => $this->getDBkey() ), $fname );
1130 }
1131 return (int)$n;
1132 }
1133
1134 /**
1135 * Get the article ID for this Title from the link cache,
1136 * adding it if necessary
1137 * @param int $flags a bit field; may be GAID_FOR_UPDATE to select
1138 * for update
1139 * @return int the ID
1140 * @access public
1141 */
1142 function getArticleID( $flags = 0 ) {
1143 global $wgLinkCache;
1144 if ( $flags & GAID_FOR_UPDATE ) {
1145 $oldUpdate = $wgLinkCache->forUpdate( true );
1146 $this->mArticleID = $wgLinkCache->addLinkObj( $this );
1147 $wgLinkCache->forUpdate( $oldUpdate );
1148 } else {
1149 if ( -1 == $this->mArticleID ) {
1150 $this->mArticleID = $wgLinkCache->addLinkObj( $this );
1151 }
1152 }
1153 return $this->mArticleID;
1154 }
1155
1156 function getLatestRevID() {
1157 if ($this->mLatestID !== false)
1158 return $this->mLatestID;
1159
1160 $db =& wfGetDB(DB_SLAVE);
1161 return $this->mLatestID = $db->selectField( 'revision',
1162 "max(rev_id)",
1163 array('rev_page' => $this->getArticleID()),
1164 'Title::getLatestRevID' );
1165 }
1166
1167 /**
1168 * This clears some fields in this object, and clears any associated
1169 * keys in the "bad links" section of $wgLinkCache.
1170 *
1171 * - This is called from Article::insertNewArticle() to allow
1172 * loading of the new page_id. It's also called from
1173 * Article::doDeleteArticle()
1174 *
1175 * @param int $newid the new Article ID
1176 * @access public
1177 */
1178 function resetArticleID( $newid ) {
1179 global $wgLinkCache;
1180 $wgLinkCache->clearBadLink( $this->getPrefixedDBkey() );
1181
1182 if ( 0 == $newid ) { $this->mArticleID = -1; }
1183 else { $this->mArticleID = $newid; }
1184 $this->mRestrictionsLoaded = false;
1185 $this->mRestrictions = array();
1186 }
1187
1188 /**
1189 * Updates page_touched for this page; called from LinksUpdate.php
1190 * @return bool true if the update succeded
1191 * @access public
1192 */
1193 function invalidateCache() {
1194 global $wgUseFileCache;
1195
1196 if ( wfReadOnly() ) {
1197 return;
1198 }
1199
1200 $now = wfTimestampNow();
1201 $dbw =& wfGetDB( DB_MASTER );
1202 $success = $dbw->update( 'page',
1203 array( /* SET */
1204 'page_touched' => $dbw->timestamp()
1205 ), array( /* WHERE */
1206 'page_namespace' => $this->getNamespace() ,
1207 'page_title' => $this->getDBkey()
1208 ), 'Title::invalidateCache'
1209 );
1210
1211 if ($wgUseFileCache) {
1212 $cache = new CacheManager($this);
1213 @unlink($cache->fileCacheName());
1214 }
1215
1216 return $success;
1217 }
1218
1219 /**
1220 * Prefix some arbitrary text with the namespace or interwiki prefix
1221 * of this object
1222 *
1223 * @param string $name the text
1224 * @return string the prefixed text
1225 * @access private
1226 */
1227 /* private */ function prefix( $name ) {
1228 global $wgContLang;
1229
1230 $p = '';
1231 if ( '' != $this->mInterwiki ) {
1232 $p = $this->mInterwiki . ':';
1233 }
1234 if ( 0 != $this->mNamespace ) {
1235 $p .= $wgContLang->getNsText( $this->mNamespace ) . ':';
1236 }
1237 return $p . $name;
1238 }
1239
1240 /**
1241 * Secure and split - main initialisation function for this object
1242 *
1243 * Assumes that mDbkeyform has been set, and is urldecoded
1244 * and uses underscores, but not otherwise munged. This function
1245 * removes illegal characters, splits off the interwiki and
1246 * namespace prefixes, sets the other forms, and canonicalizes
1247 * everything.
1248 * @return bool true on success
1249 * @access private
1250 */
1251 /* private */ function secureAndSplit() {
1252 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
1253 $fname = 'Title::secureAndSplit';
1254 wfProfileIn( $fname );
1255
1256 # Initialisation
1257 static $rxTc = false;
1258 if( !$rxTc ) {
1259 # % is needed as well
1260 $rxTc = '/[^' . Title::legalChars() . ']|%[0-9A-Fa-f]{2}/S';
1261 }
1262
1263 $this->mInterwiki = $this->mFragment = '';
1264 $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
1265
1266 # Clean up whitespace
1267 #
1268 $t = preg_replace( '/[ _]+/', '_', $this->mDbkeyform );
1269 $t = trim( $t, '_' );
1270
1271 if ( '' == $t ) {
1272 wfProfileOut( $fname );
1273 return false;
1274 }
1275
1276 if( false !== strpos( $t, UTF8_REPLACEMENT ) ) {
1277 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
1278 wfProfileOut( $fname );
1279 return false;
1280 }
1281
1282 $this->mDbkeyform = $t;
1283
1284 # Initial colon indicates main namespace rather than specified default
1285 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
1286 if ( ':' == $t{0} ) {
1287 $this->mNamespace = NS_MAIN;
1288 $t = substr( $t, 1 ); # remove the colon but continue processing
1289 }
1290
1291 # Namespace or interwiki prefix
1292 $firstPass = true;
1293 do {
1294 if ( preg_match( "/^(.+?)_*:_*(.*)$/S", $t, $m ) ) {
1295 $p = $m[1];
1296 $lowerNs = strtolower( $p );
1297 if ( $ns = Namespace::getCanonicalIndex( $lowerNs ) ) {
1298 # Canonical namespace
1299 $t = $m[2];
1300 $this->mNamespace = $ns;
1301 } elseif ( $ns = $wgContLang->getNsIndex( $lowerNs )) {
1302 # Ordinary namespace
1303 $t = $m[2];
1304 $this->mNamespace = $ns;
1305 } elseif( $this->getInterwikiLink( $p ) ) {
1306 if( !$firstPass ) {
1307 # Can't make a local interwiki link to an interwiki link.
1308 # That's just crazy!
1309 wfProfileOut( $fname );
1310 return false;
1311 }
1312
1313 # Interwiki link
1314 $t = $m[2];
1315 $this->mInterwiki = $p;
1316
1317 # Redundant interwiki prefix to the local wiki
1318 if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
1319 if( $t == '' ) {
1320 # Can't have an empty self-link
1321 wfProfileOut( $fname );
1322 return false;
1323 }
1324 $this->mInterwiki = '';
1325 $firstPass = false;
1326 # Do another namespace split...
1327 continue;
1328 }
1329 }
1330 # If there's no recognized interwiki or namespace,
1331 # then let the colon expression be part of the title.
1332 }
1333 break;
1334 } while( true );
1335 $r = $t;
1336
1337 # We already know that some pages won't be in the database!
1338 #
1339 if ( '' != $this->mInterwiki || -1 == $this->mNamespace ) {
1340 $this->mArticleID = 0;
1341 }
1342 $f = strstr( $r, '#' );
1343 if ( false !== $f ) {
1344 $this->mFragment = substr( $f, 1 );
1345 $r = substr( $r, 0, strlen( $r ) - strlen( $f ) );
1346 # remove whitespace again: prevents "Foo_bar_#"
1347 # becoming "Foo_bar_"
1348 $r = preg_replace( '/_*$/', '', $r );
1349 }
1350
1351 # Reject illegal characters.
1352 #
1353 if( preg_match( $rxTc, $r ) ) {
1354 wfProfileOut( $fname );
1355 return false;
1356 }
1357
1358 /**
1359 * Pages with "/./" or "/../" appearing in the URLs will
1360 * often be unreachable due to the way web browsers deal
1361 * with 'relative' URLs. Forbid them explicitly.
1362 */
1363 if ( strpos( $r, '.' ) !== false &&
1364 ( $r === '.' || $r === '..' ||
1365 strpos( $r, './' ) === 0 ||
1366 strpos( $r, '../' ) === 0 ||
1367 strpos( $r, '/./' ) !== false ||
1368 strpos( $r, '/../' ) !== false ) )
1369 {
1370 wfProfileOut( $fname );
1371 return false;
1372 }
1373
1374 # We shouldn't need to query the DB for the size.
1375 #$maxSize = $dbr->textFieldSize( 'page', 'page_title' );
1376 if ( strlen( $r ) > 255 ) {
1377 wfProfileOut( $fname );
1378 return false;
1379 }
1380
1381 /**
1382 * Normally, all wiki links are forced to have
1383 * an initial capital letter so [[foo]] and [[Foo]]
1384 * point to the same place.
1385 *
1386 * Don't force it for interwikis, since the other
1387 * site might be case-sensitive.
1388 */
1389 if( $wgCapitalLinks && $this->mInterwiki == '') {
1390 $t = $wgContLang->ucfirst( $r );
1391 } else {
1392 $t = $r;
1393 }
1394
1395 /**
1396 * Can't make a link to a namespace alone...
1397 * "empty" local links can only be self-links
1398 * with a fragment identifier.
1399 */
1400 if( $t == '' &&
1401 $this->mInterwiki == '' &&
1402 $this->mNamespace != NS_MAIN ) {
1403 wfProfileOut( $fname );
1404 return false;
1405 }
1406
1407 # Fill fields
1408 $this->mDbkeyform = $t;
1409 $this->mUrlform = wfUrlencode( $t );
1410
1411 $this->mTextform = str_replace( '_', ' ', $t );
1412
1413 wfProfileOut( $fname );
1414 return true;
1415 }
1416
1417 /**
1418 * Get a Title object associated with the talk page of this article
1419 * @return Title the object for the talk page
1420 * @access public
1421 */
1422 function getTalkPage() {
1423 return Title::makeTitle( Namespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
1424 }
1425
1426 /**
1427 * Get a title object associated with the subject page of this
1428 * talk page
1429 *
1430 * @return Title the object for the subject page
1431 * @access public
1432 */
1433 function getSubjectPage() {
1434 return Title::makeTitle( Namespace::getSubject( $this->getNamespace() ), $this->getDBkey() );
1435 }
1436
1437 /**
1438 * Get an array of Title objects linking to this Title
1439 * Also stores the IDs in the link cache.
1440 *
1441 * @param string $options may be FOR UPDATE
1442 * @return array the Title objects linking here
1443 * @access public
1444 */
1445 function getLinksTo( $options = '' ) {
1446 global $wgLinkCache;
1447 $id = $this->getArticleID();
1448
1449 if ( $options ) {
1450 $db =& wfGetDB( DB_MASTER );
1451 } else {
1452 $db =& wfGetDB( DB_SLAVE );
1453 }
1454
1455 $res = $db->select( array( 'page', 'pagelinks' ),
1456 array( 'page_namespace', 'page_title', 'page_id' ),
1457 array(
1458 'pl_from=page_id',
1459 'pl_namespace' => $this->getNamespace(),
1460 'pl_title' => $this->getDbKey() ),
1461 'Title::getLinksTo',
1462 $options );
1463
1464 $retVal = array();
1465 if ( $db->numRows( $res ) ) {
1466 while ( $row = $db->fetchObject( $res ) ) {
1467 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
1468 $wgLinkCache->addGoodLinkObj( $row->page_id, $titleObj );
1469 $retVal[] = $titleObj;
1470 }
1471 }
1472 }
1473 $db->freeResult( $res );
1474 return $retVal;
1475 }
1476
1477 /**
1478 * Get an array of Title objects referring to non-existent articles linked from this page
1479 *
1480 * @param string $options may be FOR UPDATE
1481 * @return array the Title objects
1482 * @access public
1483 */
1484 function getBrokenLinksFrom( $options = '' ) {
1485 global $wgLinkCache;
1486
1487 if ( $options ) {
1488 $db =& wfGetDB( DB_MASTER );
1489 } else {
1490 $db =& wfGetDB( DB_SLAVE );
1491 }
1492
1493 $res = $db->safeQuery(
1494 "SELECT pl_namespace, pl_title
1495 FROM !
1496 LEFT JOIN !
1497 ON pl_namespace=page_namespace
1498 AND pl_title=page_title
1499 WHERE pl_from=?
1500 AND page_namespace IS NULL
1501 !",
1502 $db->tableName( 'pagelinks' ),
1503 $db->tableName( 'page' ),
1504 $this->getArticleId(),
1505 $options );
1506
1507 $retVal = array();
1508 if ( $db->numRows( $res ) ) {
1509 while ( $row = $db->fetchObject( $res ) ) {
1510 $retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
1511 }
1512 }
1513 $db->freeResult( $res );
1514 return $retVal;
1515 }
1516
1517
1518 /**
1519 * Get a list of URLs to purge from the Squid cache when this
1520 * page changes
1521 *
1522 * @return array the URLs
1523 * @access public
1524 */
1525 function getSquidURLs() {
1526 return array(
1527 $this->getInternalURL(),
1528 $this->getInternalURL( 'action=history' )
1529 );
1530 }
1531
1532 /**
1533 * Move this page without authentication
1534 * @param Title &$nt the new page Title
1535 * @access public
1536 */
1537 function moveNoAuth( &$nt ) {
1538 return $this->moveTo( $nt, false );
1539 }
1540
1541 /**
1542 * Check whether a given move operation would be valid.
1543 * Returns true if ok, or a message key string for an error message
1544 * if invalid. (Scarrrrry ugly interface this.)
1545 * @param Title &$nt the new title
1546 * @param bool $auth indicates whether $wgUser's permissions
1547 * should be checked
1548 * @return mixed true on success, message name on failure
1549 * @access public
1550 */
1551 function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
1552 global $wgUser;
1553 if( !$this or !$nt ) {
1554 return 'badtitletext';
1555 }
1556 if( $this->equals( $nt ) ) {
1557 return 'selfmove';
1558 }
1559 if( !$this->isMovable() || !$nt->isMovable() ) {
1560 return 'immobile_namespace';
1561 }
1562
1563 $fname = 'Title::move';
1564 $oldid = $this->getArticleID();
1565 $newid = $nt->getArticleID();
1566
1567 if ( strlen( $nt->getDBkey() ) < 1 ) {
1568 return 'articleexists';
1569 }
1570 if ( ( '' == $this->getDBkey() ) ||
1571 ( !$oldid ) ||
1572 ( '' == $nt->getDBkey() ) ) {
1573 return 'badarticleerror';
1574 }
1575
1576 if ( $auth && (
1577 !$this->userCanEdit() || !$nt->userCanEdit() ||
1578 !$this->userCanMove() || !$nt->userCanMove() ) ) {
1579 return 'protectedpage';
1580 }
1581
1582 # The move is allowed only if (1) the target doesn't exist, or
1583 # (2) the target is a redirect to the source, and has no history
1584 # (so we can undo bad moves right after they're done).
1585
1586 if ( 0 != $newid ) { # Target exists; check for validity
1587 if ( ! $this->isValidMoveTarget( $nt ) ) {
1588 return 'articleexists';
1589 }
1590 }
1591 return true;
1592 }
1593
1594 /**
1595 * Move a title to a new location
1596 * @param Title &$nt the new title
1597 * @param bool $auth indicates whether $wgUser's permissions
1598 * should be checked
1599 * @return mixed true on success, message name on failure
1600 * @access public
1601 */
1602 function moveTo( &$nt, $auth = true, $reason = '' ) {
1603 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
1604 if( is_string( $err ) ) {
1605 return $err;
1606 }
1607
1608 $pageid = $this->getArticleID();
1609 if( $nt->exists() ) {
1610 $this->moveOverExistingRedirect( $nt, $reason );
1611 $pageCountChange = 0;
1612 } else { # Target didn't exist, do normal move.
1613 $this->moveToNewTitle( $nt, $newid, $reason );
1614 $pageCountChange = 1;
1615 }
1616 $redirid = $this->getArticleID();
1617
1618 # Fixing category links (those without piped 'alternate' names) to be sorted under the new title
1619 $dbw =& wfGetDB( DB_MASTER );
1620 $categorylinks = $dbw->tableName( 'categorylinks' );
1621 $sql = "UPDATE $categorylinks SET cl_sortkey=" . $dbw->addQuotes( $nt->getPrefixedText() ) .
1622 " WHERE cl_from=" . $dbw->addQuotes( $pageid ) .
1623 " AND cl_sortkey=" . $dbw->addQuotes( $this->getPrefixedText() );
1624 $dbw->query( $sql, 'SpecialMovepage::doSubmit' );
1625
1626 # Update watchlists
1627
1628 $oldnamespace = $this->getNamespace() & ~1;
1629 $newnamespace = $nt->getNamespace() & ~1;
1630 $oldtitle = $this->getDBkey();
1631 $newtitle = $nt->getDBkey();
1632
1633 if( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
1634 WatchedItem::duplicateEntries( $this, $nt );
1635 }
1636
1637 # Update search engine
1638 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
1639 $u->doUpdate();
1640 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
1641 $u->doUpdate();
1642
1643 # Update site_stats
1644 if ( $this->getNamespace() == NS_MAIN and $nt->getNamespace() != NS_MAIN ) {
1645 # Moved out of main namespace
1646 # not viewed, edited, removing
1647 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange);
1648 } elseif ( $this->getNamespace() != NS_MAIN and $nt->getNamespace() == NS_MAIN ) {
1649 # Moved into main namespace
1650 # not viewed, edited, adding
1651 $u = new SiteStatsUpdate( 0, 1, +1, $pageCountChange );
1652 } elseif ( $pageCountChange ) {
1653 # Added redirect
1654 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
1655 } else{
1656 $u = false;
1657 }
1658 if ( $u ) {
1659 $u->doUpdate();
1660 }
1661
1662 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
1663 return true;
1664 }
1665
1666 /**
1667 * Move page to a title which is at present a redirect to the
1668 * source page
1669 *
1670 * @param Title &$nt the page to move to, which should currently
1671 * be a redirect
1672 * @access private
1673 */
1674 function moveOverExistingRedirect( &$nt, $reason = '' ) {
1675 global $wgUser, $wgLinkCache, $wgUseSquid, $wgMwRedir;
1676 $fname = 'Title::moveOverExistingRedirect';
1677 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
1678
1679 if ( $reason ) {
1680 $comment .= ": $reason";
1681 }
1682
1683 $now = wfTimestampNow();
1684 $rand = wfRandom();
1685 $newid = $nt->getArticleID();
1686 $oldid = $this->getArticleID();
1687 $dbw =& wfGetDB( DB_MASTER );
1688 $links = $dbw->tableName( 'links' );
1689
1690 # Delete the old redirect. We don't save it to history since
1691 # by definition if we've got here it's rather uninteresting.
1692 # We have to remove it so that the next step doesn't trigger
1693 # a conflict on the unique namespace+title index...
1694 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
1695
1696 # Save a null revision in the page's history notifying of the move
1697 $nullRevision = Revision::newNullRevision( $dbw, $oldid,
1698 wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() ),
1699 true );
1700 $nullRevId = $nullRevision->insertOn( $dbw );
1701
1702 # Change the name of the target page:
1703 $dbw->update( 'page',
1704 /* SET */ array(
1705 'page_touched' => $dbw->timestamp($now),
1706 'page_namespace' => $nt->getNamespace(),
1707 'page_title' => $nt->getDBkey(),
1708 'page_latest' => $nullRevId,
1709 ),
1710 /* WHERE */ array( 'page_id' => $oldid ),
1711 $fname
1712 );
1713 $wgLinkCache->clearLink( $nt->getPrefixedDBkey() );
1714
1715 # Recreate the redirect, this time in the other direction.
1716 $redirectText = $wgMwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
1717 $redirectArticle = new Article( $this );
1718 $newid = $redirectArticle->insertOn( $dbw );
1719 $redirectRevision = new Revision( array(
1720 'page' => $newid,
1721 'comment' => $comment,
1722 'text' => $redirectText ) );
1723 $revid = $redirectRevision->insertOn( $dbw );
1724 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
1725 $wgLinkCache->clearLink( $this->getPrefixedDBkey() );
1726
1727 # Log the move
1728 $log = new LogPage( 'move' );
1729 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ) );
1730
1731 # Now, we record the link from the redirect to the new title.
1732 # It should have no other outgoing links...
1733 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
1734 $dbw->insert( 'pagelinks',
1735 array(
1736 'pl_from' => $newid,
1737 'pl_namespace' => $nt->getNamespace(),
1738 'pl_title' => $nt->getDbKey() ),
1739 $fname );
1740
1741 # Purge squid
1742 if ( $wgUseSquid ) {
1743 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
1744 $u = new SquidUpdate( $urls );
1745 $u->doUpdate();
1746 }
1747 }
1748
1749 /**
1750 * Move page to non-existing title.
1751 * @param Title &$nt the new Title
1752 * @param int &$newid set to be the new article ID
1753 * @access private
1754 */
1755 function moveToNewTitle( &$nt, &$newid, $reason = '' ) {
1756 global $wgUser, $wgLinkCache, $wgUseSquid;
1757 global $wgMwRedir;
1758 $fname = 'MovePageForm::moveToNewTitle';
1759 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
1760 if ( $reason ) {
1761 $comment .= ": $reason";
1762 }
1763
1764 $newid = $nt->getArticleID();
1765 $oldid = $this->getArticleID();
1766 $dbw =& wfGetDB( DB_MASTER );
1767 $now = $dbw->timestamp();
1768 wfSeedRandom();
1769 $rand = wfRandom();
1770
1771 # Save a null revision in the page's history notifying of the move
1772 $nullRevision = Revision::newNullRevision( $dbw, $oldid,
1773 wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() ),
1774 true );
1775 $nullRevId = $nullRevision->insertOn( $dbw );
1776
1777 # Rename cur entry
1778 $dbw->update( 'page',
1779 /* SET */ array(
1780 'page_touched' => $now,
1781 'page_namespace' => $nt->getNamespace(),
1782 'page_title' => $nt->getDBkey(),
1783 'page_latest' => $nullRevId,
1784 ),
1785 /* WHERE */ array( 'page_id' => $oldid ),
1786 $fname
1787 );
1788
1789 $wgLinkCache->clearLink( $nt->getPrefixedDBkey() );
1790
1791 # Insert redirect
1792 $redirectText = $wgMwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
1793 $redirectArticle = new Article( $this );
1794 $newid = $redirectArticle->insertOn( $dbw );
1795 $redirectRevision = new Revision( array(
1796 'page' => $newid,
1797 'comment' => $comment,
1798 'text' => $redirectText ) );
1799 $revid = $redirectRevision->insertOn( $dbw );
1800 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
1801 $wgLinkCache->clearLink( $this->getPrefixedDBkey() );
1802
1803 # Log the move
1804 $log = new LogPage( 'move' );
1805 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText()) );
1806
1807 # Purge caches as per article creation
1808 Article::onArticleCreate( $nt );
1809
1810 # Record the just-created redirect's linking to the page
1811 $dbw->insert( 'pagelinks',
1812 array(
1813 'pl_from' => $newid,
1814 'pl_namespace' => $nt->getNamespace(),
1815 'pl_title' => $nt->getDBkey() ),
1816 $fname );
1817
1818 # Non-existent target may have had broken links to it; these must
1819 # now be touched to update link coloring.
1820 $nt->touchLinks();
1821
1822 # Purge old title from squid
1823 # The new title, and links to the new title, are purged in Article::onArticleCreate()
1824 $titles = $nt->getLinksTo();
1825 if ( $wgUseSquid ) {
1826 $urls = $this->getSquidURLs();
1827 foreach ( $titles as $linkTitle ) {
1828 $urls[] = $linkTitle->getInternalURL();
1829 }
1830 $u = new SquidUpdate( $urls );
1831 $u->doUpdate();
1832 }
1833 }
1834
1835 /**
1836 * Checks if $this can be moved to a given Title
1837 * - Selects for update, so don't call it unless you mean business
1838 *
1839 * @param Title &$nt the new title to check
1840 * @access public
1841 */
1842 function isValidMoveTarget( $nt ) {
1843
1844 $fname = 'Title::isValidMoveTarget';
1845 $dbw =& wfGetDB( DB_MASTER );
1846
1847 # Is it a redirect?
1848 $id = $nt->getArticleID();
1849 $obj = $dbw->selectRow( array( 'page', 'revision', 'text'),
1850 array( 'page_is_redirect','old_text' ),
1851 array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
1852 $fname, 'FOR UPDATE' );
1853
1854 if ( !$obj || 0 == $obj->page_is_redirect ) {
1855 # Not a redirect
1856 return false;
1857 }
1858
1859 # Does the redirect point to the source?
1860 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $obj->old_text, $m ) ) {
1861 $redirTitle = Title::newFromText( $m[1] );
1862 if( !is_object( $redirTitle ) ||
1863 $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() ) {
1864 return false;
1865 }
1866 }
1867
1868 # Does the article have a history?
1869 $row = $dbw->selectRow( array( 'page', 'revision'),
1870 array( 'rev_id' ),
1871 array( 'page_namespace' => $nt->getNamespace(),
1872 'page_title' => $nt->getDBkey(),
1873 'page_id=rev_page AND page_latest != rev_id'
1874 ), $fname, 'FOR UPDATE'
1875 );
1876
1877 # Return true if there was no history
1878 return $row === false;
1879 }
1880
1881 /**
1882 * Create a redirect; fails if the title already exists; does
1883 * not notify RC
1884 *
1885 * @param Title $dest the destination of the redirect
1886 * @param string $comment the comment string describing the move
1887 * @return bool true on success
1888 * @access public
1889 */
1890 function createRedirect( $dest, $comment ) {
1891 global $wgUser;
1892 if ( $this->getArticleID() ) {
1893 return false;
1894 }
1895
1896 $fname = 'Title::createRedirect';
1897 $dbw =& wfGetDB( DB_MASTER );
1898
1899 $article = new Article( $this );
1900 $newid = $article->insertOn( $dbw );
1901 $revision = new Revision( array(
1902 'page' => $newid,
1903 'comment' => $comment,
1904 'text' => "#REDIRECT [[" . $dest->getPrefixedText() . "]]\n",
1905 ) );
1906 $revisionId = $revision->insertOn( $dbw );
1907 $article->updateRevisionOn( $dbw, $revision, 0 );
1908
1909 # Link table
1910 $dbw->insert( 'pagelinks',
1911 array(
1912 'pl_from' => $newid,
1913 'pl_namespace' => $dest->getNamespace(),
1914 'pl_title' => $dest->getDbKey()
1915 ), $fname
1916 );
1917
1918 Article::onArticleCreate( $this );
1919 return true;
1920 }
1921
1922 /**
1923 * Get categories to which this Title belongs and return an array of
1924 * categories' names.
1925 *
1926 * @return array an array of parents in the form:
1927 * $parent => $currentarticle
1928 * @access public
1929 */
1930 function getParentCategories() {
1931 global $wgContLang,$wgUser;
1932
1933 $titlekey = $this->getArticleId();
1934 $sk =& $wgUser->getSkin();
1935 $parents = array();
1936 $dbr =& wfGetDB( DB_SLAVE );
1937 $categorylinks = $dbr->tableName( 'categorylinks' );
1938
1939 # NEW SQL
1940 $sql = "SELECT * FROM $categorylinks"
1941 ." WHERE cl_from='$titlekey'"
1942 ." AND cl_from <> '0'"
1943 ." ORDER BY cl_sortkey";
1944
1945 $res = $dbr->query ( $sql ) ;
1946
1947 if($dbr->numRows($res) > 0) {
1948 while ( $x = $dbr->fetchObject ( $res ) )
1949 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
1950 $data[$wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to] = $this->getFullText();
1951 $dbr->freeResult ( $res ) ;
1952 } else {
1953 $data = '';
1954 }
1955 return $data;
1956 }
1957
1958 /**
1959 * Get a tree of parent categories
1960 * @param array $children an array with the children in the keys, to check for circular refs
1961 * @return array
1962 * @access public
1963 */
1964 function getParentCategoryTree( $children = array() ) {
1965 $parents = $this->getParentCategories();
1966
1967 if($parents != '') {
1968 foreach($parents as $parent => $current)
1969 {
1970 if ( array_key_exists( $parent, $children ) ) {
1971 # Circular reference
1972 $stack[$parent] = array();
1973 } else {
1974 $nt = Title::newFromText($parent);
1975 $stack[$parent] = $nt->getParentCategoryTree( $children + array($parent => 1) );
1976 }
1977 }
1978 return $stack;
1979 } else {
1980 return array();
1981 }
1982 }
1983
1984
1985 /**
1986 * Get an associative array for selecting this title from
1987 * the "cur" table
1988 *
1989 * @return array
1990 * @access public
1991 */
1992 function curCond() {
1993 wfDebugDieBacktrace( 'curCond called' );
1994 return array( 'cur_namespace' => $this->mNamespace, 'cur_title' => $this->mDbkeyform );
1995 }
1996
1997 /**
1998 * Get an associative array for selecting this title from the
1999 * "old" table
2000 *
2001 * @return array
2002 * @access public
2003 */
2004 function oldCond() {
2005 wfDebugDieBacktrace( 'oldCond called' );
2006 return array( 'old_namespace' => $this->mNamespace, 'old_title' => $this->mDbkeyform );
2007 }
2008
2009 /**
2010 * Get the revision ID of the previous revision
2011 *
2012 * @param integer $revision Revision ID. Get the revision that was before this one.
2013 * @return interger $oldrevision|false
2014 */
2015 function getPreviousRevisionID( $revision ) {
2016 $dbr =& wfGetDB( DB_SLAVE );
2017 return $dbr->selectField( 'revision', 'rev_id',
2018 'rev_page=' . intval( $this->getArticleId() ) .
2019 ' AND rev_id<' . intval( $revision ) . ' ORDER BY rev_id DESC' );
2020 }
2021
2022 /**
2023 * Get the revision ID of the next revision
2024 *
2025 * @param integer $revision Revision ID. Get the revision that was after this one.
2026 * @return interger $oldrevision|false
2027 */
2028 function getNextRevisionID( $revision ) {
2029 $dbr =& wfGetDB( DB_SLAVE );
2030 return $dbr->selectField( 'revision', 'rev_id',
2031 'rev_page=' . intval( $this->getArticleId() ) .
2032 ' AND rev_id>' . intval( $revision ) . ' ORDER BY rev_id' );
2033 }
2034
2035 /**
2036 * Compare with another title.
2037 *
2038 * @param Title $title
2039 * @return bool
2040 */
2041 function equals( &$title ) {
2042 return $this->getInterwiki() == $title->getInterwiki()
2043 && $this->getNamespace() == $title->getNamespace()
2044 && $this->getDbkey() == $title->getDbkey();
2045 }
2046
2047 /**
2048 * Check if page exists
2049 * @return bool
2050 */
2051 function exists() {
2052 return $this->getArticleId() != 0;
2053 }
2054
2055 /**
2056 * Should a link should be displayed as a known link, just based on its title?
2057 *
2058 * Currently, a self-link with a fragment, special pages and image pages are in
2059 * this category. Special pages never exist in the database. Some images do not
2060 * have description pages in the database, but the description page contains
2061 * useful history information that the user may want to link to.
2062 */
2063 function isAlwaysKnown() {
2064 return $this->isExternal() || ( 0 == $this->mNamespace && "" == $this->mDbkeyform )
2065 || NS_SPECIAL == $this->mNamespace || NS_IMAGE == $this->mNamespace;
2066 }
2067
2068 /**
2069 * Update page_touched timestamps on pages linking to this title.
2070 * In principal, this could be backgrounded and could also do squid
2071 * purging.
2072 */
2073 function touchLinks() {
2074 $fname = 'Title::touchLinks';
2075
2076 $dbw =& wfGetDB( DB_MASTER );
2077
2078 $res = $dbw->select( 'pagelinks',
2079 array( 'pl_from' ),
2080 array(
2081 'pl_namespace' => $this->getNamespace(),
2082 'pl_title' => $this->getDbKey() ),
2083 $fname );
2084 if ( 0 == $dbw->numRows( $res ) ) {
2085 return;
2086 }
2087
2088 $arr = array();
2089 $toucharr = array();
2090 while( $row = $dbw->fetchObject( $res ) ) {
2091 $toucharr[] = $row->pl_from;
2092 }
2093 if (!count($toucharr))
2094 return;
2095 $dbw->update( 'page', /* SET */ array( 'page_touched' => $dbw->timestamp() ),
2096 /* WHERE */ array( 'page_id' => $toucharr ),$fname);
2097 }
2098
2099 function trackbackURL() {
2100 global $wgTitle, $wgScriptPath, $wgServer;
2101
2102 return "$wgServer$wgScriptPath/trackback.php?article="
2103 . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey()));
2104 }
2105
2106 function trackbackRDF() {
2107 $url = htmlspecialchars($this->getFullURL());
2108 $title = htmlspecialchars($this->getText());
2109 $tburl = $this->trackbackURL();
2110
2111 return "
2112 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
2113 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
2114 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
2115 <rdf:Description
2116 rdf:about=\"$url\"
2117 dc:identifier=\"$url\"
2118 dc:title=\"$title\"
2119 trackback:ping=\"$tburl\" />
2120 </rdf:RDF>";
2121 }
2122 }
2123 ?>