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