7 if ( !class_exists( 'UtfNormal' ) ) {
8 require_once( dirname(__FILE__
) . '/normal/UtfNormal.php' );
11 define ( 'GAID_FOR_UPDATE', 1 );
15 * Constants for pr_cascade bitfield
17 define( 'CASCADE', 1 );
20 * Represents a title within MediaWiki.
21 * Optionally may contain an interwiki designation or namespace.
22 * @note This class can fetch various kinds of data from the database;
23 * however, it does so inefficiently.
26 /** @name Static cache variables */
28 static private $titleCache=array();
29 static private $interwikiCache=array();
33 * Title::newFromText maintains a cache to avoid expensive re-normalization of
34 * commonly used titles. On a batch operation this can become a memory leak
35 * if not bounded. After hitting this many titles reset the cache.
37 const CACHE_MAX
= 1000;
41 * @name Private member variables
42 * Please use the accessor functions instead.
47 var $mTextform = ''; ///< Text form (spaces not underscores) of the main part
48 var $mUrlform = ''; ///< URL-encoded form of the main part
49 var $mDbkeyform = ''; ///< Main part with underscores
50 var $mUserCaseDBKey; ///< DB key with the initial letter in the case specified by the user
51 var $mNamespace = NS_MAIN
; ///< Namespace index, i.e. one of the NS_xxxx constants
52 var $mInterwiki = ''; ///< Interwiki prefix (or null string)
53 var $mFragment; ///< Title fragment (i.e. the bit after the #)
54 var $mArticleID = -1; ///< Article ID, fetched from the link cache on demand
55 var $mLatestID = false; ///< ID of most recent revision
56 var $mRestrictions = array(); ///< Array of groups allowed to edit this article
57 var $mOldRestrictions = false;
58 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
59 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
60 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
61 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
62 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
63 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
64 # Don't change the following default, NS_MAIN is hardcoded in several
65 # places. See bug 696.
66 var $mDefaultNamespace = NS_MAIN
; ///< Namespace index when there is no namespace
67 # Zero except in {{transclusion}} tags
68 var $mWatched = null; ///< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
69 var $mLength = -1; ///< The page length, 0 for special pages
70 var $mRedirect = null; ///< Is the article at this title a redirect?
71 var $mNotificationTimestamp = array(); ///< Associative array of user ID -> timestamp/false
72 var $mBacklinkCache = null; ///< Cache of links to this title
80 /* private */ function __construct() {}
83 * Create a new Title from a prefixed DB key
84 * @param $key \type{\string} The database key, which has underscores
85 * instead of spaces, possibly including namespace and
87 * @return \type{Title} the new object, or NULL on an error
89 public static function newFromDBkey( $key ) {
91 $t->mDbkeyform
= $key;
92 if( $t->secureAndSplit() )
99 * Create a new Title from text, such as what one would find in a link. De-
100 * codes any HTML entities in the text.
102 * @param $text string The link text; spaces, prefixes, and an
103 * initial ':' indicating the main namespace are accepted.
104 * @param $defaultNamespace int The namespace to use if none is speci-
105 * fied by a prefix. If you want to force a specific namespace even if
106 * $text might begin with a namespace prefix, use makeTitle() or
108 * @return Title The new object, or null on an error.
110 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
111 if( is_object( $text ) ) {
112 throw new MWException( 'Title::newFromText given an object' );
116 * Wiki pages often contain multiple links to the same page.
117 * Title normalization and parsing can become expensive on
118 * pages with many links, so we can save a little time by
121 * In theory these are value objects and won't get changed...
123 if( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
124 return Title
::$titleCache[$text];
128 * Convert things like é ā or 〗 into real text...
130 $filteredText = Sanitizer
::decodeCharReferences( $text );
133 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
134 $t->mDefaultNamespace
= $defaultNamespace;
136 static $cachedcount = 0 ;
137 if( $t->secureAndSplit() ) {
138 if( $defaultNamespace == NS_MAIN
) {
139 if( $cachedcount >= self
::CACHE_MAX
) {
140 # Avoid memory leaks on mass operations...
141 Title
::$titleCache = array();
145 Title
::$titleCache[$text] =& $t;
155 * Create a new Title from URL-encoded text. Ensures that
156 * the given title's length does not exceed the maximum.
157 * @param $url \type{\string} the title, as might be taken from a URL
158 * @return \type{Title} the new object, or NULL on an error
160 public static function newFromURL( $url ) {
161 global $wgLegalTitleChars;
164 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
165 # but some URLs used it as a space replacement and they still come
166 # from some external search tools.
167 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
168 $url = str_replace( '+', ' ', $url );
171 $t->mDbkeyform
= str_replace( ' ', '_', $url );
172 if( $t->secureAndSplit() ) {
180 * Create a new Title from an article ID
182 * @param $id \type{\int} the page_id corresponding to the Title to create
183 * @param $flags \type{\int} use GAID_FOR_UPDATE to use master
184 * @return \type{Title} the new object, or NULL on an error
186 public static function newFromID( $id, $flags = 0 ) {
187 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
188 $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__
);
189 if( $row !== false ) {
190 $title = Title
::newFromRow( $row );
198 * Make an array of titles from an array of IDs
199 * @param $ids \type{\arrayof{\int}} Array of IDs
200 * @return \type{\arrayof{Title}} Array of Titles
202 public static function newFromIDs( $ids ) {
203 if ( !count( $ids ) ) {
206 $dbr = wfGetDB( DB_SLAVE
);
207 $res = $dbr->select( 'page', array( 'page_namespace', 'page_title' ),
208 'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__
);
211 foreach( $res as $row ) {
212 $titles[] = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
218 * Make a Title object from a DB row
219 * @param $row \type{Row} (needs at least page_title,page_namespace)
220 * @return \type{Title} corresponding Title
222 public static function newFromRow( $row ) {
223 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
225 $t->mArticleID
= isset($row->page_id
) ?
intval($row->page_id
) : -1;
226 $t->mLength
= isset($row->page_len
) ?
intval($row->page_len
) : -1;
227 $t->mRedirect
= isset($row->page_is_redirect
) ?
(bool)$row->page_is_redirect
: NULL;
228 $t->mLatestID
= isset($row->page_latest
) ?
$row->page_latest
: false;
234 * Create a new Title from a namespace index and a DB key.
235 * It's assumed that $ns and $title are *valid*, for instance when
236 * they came directly from the database or a special page name.
237 * For convenience, spaces are converted to underscores so that
238 * eg user_text fields can be used directly.
240 * @param $ns \type{\int} the namespace of the article
241 * @param $title \type{\string} the unprefixed database key form
242 * @param $fragment \type{\string} The link fragment (after the "#")
243 * @return \type{Title} the new object
245 public static function &makeTitle( $ns, $title, $fragment = '' ) {
248 $t->mFragment
= $fragment;
249 $t->mNamespace
= $ns = intval( $ns );
250 $t->mDbkeyform
= str_replace( ' ', '_', $title );
251 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
252 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
253 $t->mTextform
= str_replace( '_', ' ', $title );
258 * Create a new Title from a namespace index and a DB key.
259 * The parameters will be checked for validity, which is a bit slower
260 * than makeTitle() but safer for user-provided data.
262 * @param $ns \type{\int} the namespace of the article
263 * @param $title \type{\string} the database key form
264 * @param $fragment \type{\string} The link fragment (after the "#")
265 * @return \type{Title} the new object, or NULL on an error
267 public static function makeTitleSafe( $ns, $title, $fragment = '' ) {
269 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment );
270 if( $t->secureAndSplit() ) {
278 * Create a new Title for the Main Page
279 * @return \type{Title} the new object
281 public static function newMainPage() {
282 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
283 // Don't give fatal errors if the message is broken
285 $title = Title
::newFromText( 'Main Page' );
291 * Extract a redirect destination from a string and return the
292 * Title, or null if the text doesn't contain a valid redirect
293 * This will only return the very next target, useful for
294 * the redirect table and other checks that don't need full recursion
296 * @param $text \type{\string} Text with possible redirect
297 * @return \type{Title} The corresponding Title
299 public static function newFromRedirect( $text ) {
300 return self
::newFromRedirectInternal( $text );
304 * Extract a redirect destination from a string and return the
305 * Title, or null if the text doesn't contain a valid redirect
306 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
307 * in order to provide (hopefully) the Title of the final destination instead of another redirect
309 * @param $text \type{\string} Text with possible redirect
310 * @return \type{Title} The corresponding Title
312 public static function newFromRedirectRecurse( $text ) {
313 $titles = self
::newFromRedirectArray( $text );
314 return $titles ?
array_pop( $titles ) : null;
318 * Extract a redirect destination from a string and return an
319 * array of Titles, or null if the text doesn't contain a valid redirect
320 * The last element in the array is the final destination after all redirects
321 * have been resolved (up to $wgMaxRedirects times)
323 * @param $text \type{\string} Text with possible redirect
324 * @return \type{\array} Array of Titles, with the destination last
326 public static function newFromRedirectArray( $text ) {
327 global $wgMaxRedirects;
328 // are redirects disabled?
329 if( $wgMaxRedirects < 1 )
331 $title = self
::newFromRedirectInternal( $text );
332 if( is_null( $title ) )
334 // recursive check to follow double redirects
335 $recurse = $wgMaxRedirects;
336 $titles = array( $title );
337 while( --$recurse > 0 ) {
338 if( $title->isRedirect() ) {
339 $article = new Article( $title, 0 );
340 $newtitle = $article->getRedirectTarget();
344 // Redirects to some special pages are not permitted
345 if( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
346 // the new title passes the checks, so make that our current title so that further recursion can be checked
348 $titles[] = $newtitle;
357 * Really extract the redirect destination
358 * Do not call this function directly, use one of the newFromRedirect* functions above
360 * @param $text \type{\string} Text with possible redirect
361 * @return \type{Title} The corresponding Title
363 protected static function newFromRedirectInternal( $text ) {
364 $redir = MagicWord
::get( 'redirect' );
366 if( $redir->matchStartAndRemove( $text ) ) {
367 // Extract the first link and see if it's usable
368 // Ensure that it really does come directly after #REDIRECT
369 // Some older redirects included a colon, so don't freak about that!
371 if( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
372 // Strip preceding colon used to "escape" categories, etc.
373 // and URL-decode links
374 if( strpos( $m[1], '%' ) !== false ) {
375 // Match behavior of inline link parsing here;
376 // don't interpret + as " " most of the time!
377 // It might be safe to just use rawurldecode instead, though.
378 $m[1] = urldecode( ltrim( $m[1], ':' ) );
380 $title = Title
::newFromText( $m[1] );
381 // If the title is a redirect to bad special pages or is invalid, return null
382 if( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
391 #----------------------------------------------------------------------------
393 #----------------------------------------------------------------------------
396 * Get the prefixed DB key associated with an ID
397 * @param $id \type{\int} the page_id of the article
398 * @return \type{Title} an object representing the article, or NULL
399 * if no such article was found
401 public static function nameOf( $id ) {
402 $dbr = wfGetDB( DB_SLAVE
);
404 $s = $dbr->selectRow( 'page',
405 array( 'page_namespace','page_title' ),
406 array( 'page_id' => $id ),
408 if ( $s === false ) { return NULL; }
410 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
415 * Get a regex character class describing the legal characters in a link
416 * @return \type{\string} the list of characters, not delimited
418 public static function legalChars() {
419 global $wgLegalTitleChars;
420 return $wgLegalTitleChars;
424 * Get a string representation of a title suitable for
425 * including in a search index
427 * @param $ns \type{\int} a namespace index
428 * @param $title \type{\string} text-form main part
429 * @return \type{\string} a stripped-down title string ready for the
432 public static function indexTitle( $ns, $title ) {
435 $lc = SearchEngine
::legalSearchChars() . '&#;';
436 $t = $wgContLang->stripForSearch( $title );
437 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
438 $t = $wgContLang->lc( $t );
441 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
442 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
444 $t = preg_replace( "/\\s+/", ' ', $t );
446 if ( $ns == NS_FILE
) {
447 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
453 * Make a prefixed DB key from a DB key and a namespace index
454 * @param $ns \type{\int} numerical representation of the namespace
455 * @param $title \type{\string} the DB key form the title
456 * @param $fragment \type{\string} The link fragment (after the "#")
457 * @return \type{\string} the prefixed form of the title
459 public static function makeName( $ns, $title, $fragment = '' ) {
462 $namespace = $wgContLang->getNsText( $ns );
463 $name = $namespace == '' ?
$title : "$namespace:$title";
464 if ( strval( $fragment ) != '' ) {
465 $name .= '#' . $fragment;
471 * Returns the URL associated with an interwiki prefix
472 * @param $key \type{\string} the interwiki prefix (e.g. "MeatBall")
473 * @return \type{\string} the associated URL, containing "$1",
474 * which should be replaced by an article title
476 * @deprecated See Interwiki class
478 public function getInterwikiLink( $key ) {
479 return Interwiki
::fetch( $key )->getURL( );
483 * Determine whether the object refers to a page within
486 * @return \type{\bool} TRUE if this is an in-project interwiki link
487 * or a wikilink, FALSE otherwise
489 public function isLocal() {
490 if ( $this->mInterwiki
!= '' ) {
491 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
498 * Determine whether the object refers to a page within
499 * this project and is transcludable.
501 * @return \type{\bool} TRUE if this is transcludable
503 public function isTrans() {
504 if ($this->mInterwiki
== '')
507 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
511 * Escape a text fragment, say from a link, for a URL
513 static function escapeFragmentForURL( $fragment ) {
514 global $wgEnforceHtmlIds;
515 # Note that we don't urlencode the fragment. urlencoded Unicode
516 # fragments appear not to work in IE (at least up to 7) or in at least
517 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
518 # to care if they aren't encoded.
519 return Sanitizer
::escapeId( $fragment,
520 $wgEnforceHtmlIds ?
'noninitial' : 'xml' );
523 #----------------------------------------------------------------------------
525 #----------------------------------------------------------------------------
527 /** Simple accessors */
529 * Get the text form (spaces not underscores) of the main part
530 * @return \type{\string} Main part of the title
532 public function getText() { return $this->mTextform
; }
534 * Get the URL-encoded form of the main part
535 * @return \type{\string} Main part of the title, URL-encoded
537 public function getPartialURL() { return $this->mUrlform
; }
539 * Get the main part with underscores
540 * @return \type{\string} Main part of the title, with underscores
542 public function getDBkey() { return $this->mDbkeyform
; }
544 * Get the namespace index, i.e.\ one of the NS_xxxx constants.
545 * @return \type{\int} Namespace index
547 public function getNamespace() { return $this->mNamespace
; }
549 * Get the namespace text
550 * @return \type{\string} Namespace text
552 public function getNsText() {
553 global $wgContLang, $wgCanonicalNamespaceNames;
555 if ( '' != $this->mInterwiki
) {
556 // This probably shouldn't even happen. ohh man, oh yuck.
557 // But for interwiki transclusion it sometimes does.
558 // Shit. Shit shit shit.
560 // Use the canonical namespaces if possible to try to
561 // resolve a foreign namespace.
562 if( isset( $wgCanonicalNamespaceNames[$this->mNamespace
] ) ) {
563 return $wgCanonicalNamespaceNames[$this->mNamespace
];
566 return $wgContLang->getNsText( $this->mNamespace
);
569 * Get the DB key with the initial letter case as specified by the user
570 * @return \type{\string} DB key
572 function getUserCaseDBKey() {
573 return $this->mUserCaseDBKey
;
576 * Get the namespace text of the subject (rather than talk) page
577 * @return \type{\string} Namespace text
579 public function getSubjectNsText() {
581 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
584 * Get the namespace text of the talk page
585 * @return \type{\string} Namespace text
587 public function getTalkNsText() {
589 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
592 * Could this title have a corresponding talk page?
593 * @return \type{\bool} TRUE or FALSE
595 public function canTalk() {
596 return( MWNamespace
::canTalk( $this->mNamespace
) );
599 * Get the interwiki prefix (or null string)
600 * @return \type{\string} Interwiki prefix
602 public function getInterwiki() { return $this->mInterwiki
; }
604 * Get the Title fragment (i.e.\ the bit after the #) in text form
605 * @return \type{\string} Title fragment
607 public function getFragment() { return $this->mFragment
; }
609 * Get the fragment in URL form, including the "#" character if there is one
610 * @return \type{\string} Fragment in URL form
612 public function getFragmentForURL() {
613 if ( $this->mFragment
== '' ) {
616 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
620 * Get the default namespace index, for when there is no namespace
621 * @return \type{\int} Default namespace index
623 public function getDefaultNamespace() { return $this->mDefaultNamespace
; }
626 * Get title for search index
627 * @return \type{\string} a stripped-down title string ready for the
630 public function getIndexTitle() {
631 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
635 * Get the prefixed database key form
636 * @return \type{\string} the prefixed title, with underscores and
637 * any interwiki and namespace prefixes
639 public function getPrefixedDBkey() {
640 $s = $this->prefix( $this->mDbkeyform
);
641 $s = str_replace( ' ', '_', $s );
646 * Get the prefixed title with spaces.
647 * This is the form usually used for display
648 * @return \type{\string} the prefixed title, with spaces
650 public function getPrefixedText() {
651 if ( empty( $this->mPrefixedText
) ) { // FIXME: bad usage of empty() ?
652 $s = $this->prefix( $this->mTextform
);
653 $s = str_replace( '_', ' ', $s );
654 $this->mPrefixedText
= $s;
656 return $this->mPrefixedText
;
660 * Get the prefixed title with spaces, plus any fragment
661 * (part beginning with '#')
662 * @return \type{\string} the prefixed title, with spaces and
663 * the fragment, including '#'
665 public function getFullText() {
666 $text = $this->getPrefixedText();
667 if( '' != $this->mFragment
) {
668 $text .= '#' . $this->mFragment
;
674 * Get the base name, i.e. the leftmost parts before the /
675 * @return \type{\string} Base name
677 public function getBaseText() {
678 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
679 return $this->getText();
682 $parts = explode( '/', $this->getText() );
683 # Don't discard the real title if there's no subpage involved
684 if( count( $parts ) > 1 )
685 unset( $parts[ count( $parts ) - 1 ] );
686 return implode( '/', $parts );
690 * Get the lowest-level subpage name, i.e. the rightmost part after /
691 * @return \type{\string} Subpage name
693 public function getSubpageText() {
694 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
695 return( $this->mTextform
);
697 $parts = explode( '/', $this->mTextform
);
698 return( $parts[ count( $parts ) - 1 ] );
702 * Get a URL-encoded form of the subpage text
703 * @return \type{\string} URL-encoded subpage name
705 public function getSubpageUrlForm() {
706 $text = $this->getSubpageText();
707 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
712 * Get a URL-encoded title (not an actual URL) including interwiki
713 * @return \type{\string} the URL-encoded form
715 public function getPrefixedURL() {
716 $s = $this->prefix( $this->mDbkeyform
);
717 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
722 * Get a real URL referring to this title, with interwiki link and
725 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
726 * links. Can be specified as an associative array as well, e.g.,
727 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
728 * @param $variant \type{\string} language variant of url (for sr, zh..)
729 * @return \type{\string} the URL
731 public function getFullURL( $query = '', $variant = false ) {
732 global $wgContLang, $wgServer, $wgRequest;
734 if( is_array( $query ) ) {
735 $query = wfArrayToCGI( $query );
738 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
740 $url = $this->getLocalUrl( $query, $variant );
742 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
743 // Correct fix would be to move the prepending elsewhere.
744 if ($wgRequest->getVal('action') != 'render') {
745 $url = $wgServer . $url;
748 $baseUrl = $interwiki->getURL( );
750 $namespace = wfUrlencode( $this->getNsText() );
751 if ( '' != $namespace ) {
752 # Can this actually happen? Interwikis shouldn't be parsed.
753 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
756 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
757 $url = wfAppendQuery( $url, $query );
760 # Finally, add the fragment.
761 $url .= $this->getFragmentForURL();
763 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
768 * Get a URL with no fragment or server name. If this page is generated
769 * with action=render, $wgServer is prepended.
770 * @param mixed $query an optional query string; if not specified,
771 * $wgArticlePath will be used. Can be specified as an associative array
772 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
774 * @param $variant \type{\string} language variant of url (for sr, zh..)
775 * @return \type{\string} the URL
777 public function getLocalURL( $query = '', $variant = false ) {
778 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
779 global $wgVariantArticlePath, $wgContLang, $wgUser;
781 if( is_array( $query ) ) {
782 $query = wfArrayToCGI( $query );
785 // internal links should point to same variant as current page (only anonymous users)
786 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
787 $pref = $wgContLang->getPreferredVariant(false);
788 if($pref != $wgContLang->getCode())
792 if ( $this->isExternal() ) {
793 $url = $this->getFullURL();
795 // This is currently only used for edit section links in the
796 // context of interwiki transclusion. In theory we should
797 // append the query to the end of any existing query string,
798 // but interwiki transclusion is already broken in that case.
802 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
803 if ( $query == '' ) {
804 if( $variant != false && $wgContLang->hasVariants() ) {
805 if( $wgVariantArticlePath == false ) {
806 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
808 $variantArticlePath = $wgVariantArticlePath;
810 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
811 $url = str_replace( '$1', $dbkey, $url );
813 $url = str_replace( '$1', $dbkey, $wgArticlePath );
816 global $wgActionPaths;
819 if( !empty( $wgActionPaths ) &&
820 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
822 $action = urldecode( $matches[2] );
823 if( isset( $wgActionPaths[$action] ) ) {
824 $query = $matches[1];
825 if( isset( $matches[4] ) ) $query .= $matches[4];
826 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
828 $url = wfAppendQuery( $url, $query );
832 if ( $url === false ) {
833 if ( $query == '-' ) {
836 $url = "{$wgScript}?title={$dbkey}&{$query}";
840 // FIXME: this causes breakage in various places when we
841 // actually expected a local URL and end up with dupe prefixes.
842 if ($wgRequest->getVal('action') == 'render') {
843 $url = $wgServer . $url;
846 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
851 * Get a URL that's the simplest URL that will be valid to link, locally,
852 * to the current Title. It includes the fragment, but does not include
853 * the server unless action=render is used (or the link is external). If
854 * there's a fragment but the prefixed text is empty, we just return a link
857 * The result obviously should not be URL-escaped, but does need to be
858 * HTML-escaped if it's being output in HTML.
860 * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the
861 * query string. Keys and values will be escaped.
862 * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
863 * for external links. Default is "false" (same variant as current page,
864 * for anonymous users).
865 * @return \type{\string} the URL
867 public function getLinkUrl( $query = array(), $variant = false ) {
868 wfProfileIn( __METHOD__
);
869 if( !is_array( $query ) ) {
870 wfProfileOut( __METHOD__
);
871 throw new MWException( 'Title::getLinkUrl passed a non-array for '.
874 if( $this->isExternal() ) {
875 $ret = $this->getFullURL( $query );
876 } elseif( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
877 $ret = $this->getFragmentForURL();
879 $ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
881 wfProfileOut( __METHOD__
);
886 * Get an HTML-escaped version of the URL form, suitable for
887 * using in a link, without a server name or fragment
888 * @param $query \type{\string} an optional query string
889 * @return \type{\string} the URL
891 public function escapeLocalURL( $query = '' ) {
892 return htmlspecialchars( $this->getLocalURL( $query ) );
896 * Get an HTML-escaped version of the URL form, suitable for
897 * using in a link, including the server name and fragment
899 * @param $query \type{\string} an optional query string
900 * @return \type{\string} the URL
902 public function escapeFullURL( $query = '' ) {
903 return htmlspecialchars( $this->getFullURL( $query ) );
907 * Get the URL form for an internal link.
908 * - Used in various Squid-related code, in case we have a different
909 * internal hostname for the server from the exposed one.
911 * @param $query \type{\string} an optional query string
912 * @param $variant \type{\string} language variant of url (for sr, zh..)
913 * @return \type{\string} the URL
915 public function getInternalURL( $query = '', $variant = false ) {
916 global $wgInternalServer;
917 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
918 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
923 * Get the edit URL for this Title
924 * @return \type{\string} the URL, or a null string if this is an
927 public function getEditURL() {
928 if ( '' != $this->mInterwiki
) { return ''; }
929 $s = $this->getLocalURL( 'action=edit' );
935 * Get the HTML-escaped displayable text form.
936 * Used for the title field in <a> tags.
937 * @return \type{\string} the text, including any prefixes
939 public function getEscapedText() {
940 return htmlspecialchars( $this->getPrefixedText() );
944 * Is this Title interwiki?
945 * @return \type{\bool}
947 public function isExternal() { return ( '' != $this->mInterwiki
); }
950 * Is this page "semi-protected" - the *only* protection is autoconfirm?
952 * @param @action \type{\string} Action to check (default: edit)
953 * @return \type{\bool}
955 public function isSemiProtected( $action = 'edit' ) {
956 if( $this->exists() ) {
957 $restrictions = $this->getRestrictions( $action );
958 if( count( $restrictions ) > 0 ) {
959 foreach( $restrictions as $restriction ) {
960 if( strtolower( $restriction ) != 'autoconfirmed' )
969 # If it doesn't exist, it can't be protected
975 * Does the title correspond to a protected article?
976 * @param $what \type{\string} the action the page is protected from,
977 * by default checks move and edit
978 * @return \type{\bool}
980 public function isProtected( $action = '' ) {
981 global $wgRestrictionLevels, $wgRestrictionTypes;
983 # Special pages have inherent protection
984 if( $this->getNamespace() == NS_SPECIAL
)
987 # Check regular protection levels
988 foreach( $wgRestrictionTypes as $type ){
989 if( $action == $type ||
$action == '' ) {
990 $r = $this->getRestrictions( $type );
991 foreach( $wgRestrictionLevels as $level ) {
992 if( in_array( $level, $r ) && $level != '' ) {
1003 * Is $wgUser watching this page?
1004 * @return \type{\bool}
1006 public function userIsWatching() {
1009 if ( is_null( $this->mWatched
) ) {
1010 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn()) {
1011 $this->mWatched
= false;
1013 $this->mWatched
= $wgUser->isWatched( $this );
1016 return $this->mWatched
;
1020 * Can $wgUser perform $action on this page?
1021 * This skips potentially expensive cascading permission checks.
1023 * Suitable for use for nonessential UI controls in common cases, but
1024 * _not_ for functional access control.
1026 * May provide false positives, but should never provide a false negative.
1028 * @param $action \type{\string} action that permission needs to be checked for
1029 * @return \type{\bool}
1031 public function quickUserCan( $action ) {
1032 return $this->userCan( $action, false );
1036 * Determines if $wgUser is unable to edit this page because it has been protected
1037 * by $wgNamespaceProtection.
1039 * @return \type{\bool}
1041 public function isNamespaceProtected() {
1042 global $wgNamespaceProtection, $wgUser;
1043 if( isset( $wgNamespaceProtection[ $this->mNamespace
] ) ) {
1044 foreach( (array)$wgNamespaceProtection[ $this->mNamespace
] as $right ) {
1045 if( $right != '' && !$wgUser->isAllowed( $right ) )
1053 * Can $wgUser perform $action on this page?
1054 * @param $action \type{\string} action that permission needs to be checked for
1055 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1056 * @return \type{\bool}
1058 public function userCan( $action, $doExpensiveQueries = true ) {
1060 return ($this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries, true ) === array());
1064 * Can $user perform $action on this page?
1066 * FIXME: This *does not* check throttles (User::pingLimiter()).
1068 * @param $action \type{\string}action that permission needs to be checked for
1069 * @param $user \type{User} user to check
1070 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1071 * @param $ignoreErrors \type{\arrayof{\string}} Set this to a list of message keys whose corresponding errors may be ignored.
1072 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1074 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1075 if( !StubObject
::isRealObject( $user ) ) {
1076 //Since StubObject is always used on globals, we can unstub $wgUser here and set $user = $wgUser
1078 $wgUser->_unstub( '', 5 );
1081 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1085 global $wgEmailConfirmToEdit;
1087 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1088 $errors[] = array( 'confirmedittext' );
1091 // Edit blocks should not affect reading. Account creation blocks handled at userlogin.
1092 if ( $action != 'read' && $action != 'createaccount' && $user->isBlockedFrom( $this ) ) {
1093 $block = $user->mBlock
;
1095 // This is from OutputPage::blockedPage
1096 // Copied at r23888 by werdna
1098 $id = $user->blockedBy();
1099 $reason = $user->blockedFor();
1100 if( $reason == '' ) {
1101 $reason = wfMsg( 'blockednoreason' );
1105 if ( is_numeric( $id ) ) {
1106 $name = User
::whoIs( $id );
1111 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1112 $blockid = $block->mId
;
1113 $blockExpiry = $user->mBlock
->mExpiry
;
1114 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1116 if ( $blockExpiry == 'infinity' ) {
1117 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1118 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1120 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1121 if ( strpos( $option, ':' ) == false )
1124 list ($show, $value) = explode( ":", $option );
1126 if ( $value == 'infinite' ||
$value == 'indefinite' ) {
1127 $blockExpiry = $show;
1132 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1135 $intended = $user->mBlock
->mAddress
;
1137 $errors[] = array( ($block->mAuto ?
'autoblockedtext' : 'blockedtext'), $link, $reason, $ip, $name,
1138 $blockid, $blockExpiry, $intended, $blockTimestamp );
1141 // Remove the errors being ignored.
1143 foreach( $errors as $index => $error ) {
1144 $error_key = is_array($error) ?
$error[0] : $error;
1146 if (in_array( $error_key, $ignoreErrors )) {
1147 unset($errors[$index]);
1155 * Can $user perform $action on this page? This is an internal function,
1156 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1157 * checks on wfReadOnly() and blocks)
1159 * @param $action \type{\string} action that permission needs to be checked for
1160 * @param $user \type{User} user to check
1161 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1162 * @param $short \type{\bool} Set this to true to stop after the first permission error.
1163 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1165 private function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries=true, $short=false ) {
1166 wfProfileIn( __METHOD__
);
1170 // First stop is permissions checks, which fail most often, and which are easiest to test.
1171 if ( $action == 'move' ) {
1172 if( !$user->isAllowed( 'move-rootuserpages' )
1173 && $this->getNamespace() == NS_USER
&& !$this->isSubpage() )
1175 // Show user page-specific message only if the user can move other pages
1176 $errors[] = array( 'cant-move-user-page' );
1179 // Check if user is allowed to move files if it's a file
1180 if( $this->getNamespace() == NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1181 $errors[] = array( 'movenotallowedfile' );
1184 if( !$user->isAllowed( 'move' ) ) {
1185 // User can't move anything
1186 $errors[] = $user->isAnon() ?
array ( 'movenologintext' ) : array ('movenotallowed');
1188 } elseif ( $action == 'create' ) {
1189 if( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1190 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) )
1192 $errors[] = $user->isAnon() ?
array ('nocreatetext') : array ('nocreate-loggedin');
1194 } elseif( $action == 'move-target' ) {
1195 if( !$user->isAllowed( 'move' ) ) {
1196 // User can't move anything
1197 $errors[] = $user->isAnon() ?
array ( 'movenologintext' ) : array ('movenotallowed');
1198 } elseif( !$user->isAllowed( 'move-rootuserpages' )
1199 && $this->getNamespace() == NS_USER
&& !$this->isSubpage() )
1201 // Show user page-specific message only if the user can move other pages
1202 $errors[] = array( 'cant-move-to-user-page' );
1204 } elseif( !$user->isAllowed( $action ) ) {
1206 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1207 User
::getGroupsWithPermission( $action ) );
1209 $return = array( 'badaccess-groups',
1210 array( implode( ', ', $groups ), count( $groups ) ) );
1212 $return = array( "badaccess-group0" );
1214 $errors[] = $return;
1217 # Short-circuit point
1218 if( $short && count($errors) > 0 ) {
1219 wfProfileOut( __METHOD__
);
1223 // Use getUserPermissionsErrors instead
1224 if( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1225 wfProfileOut( __METHOD__
);
1226 return $result ?
array() : array( array( 'badaccess-group0' ) );
1228 // Check getUserPermissionsErrors hook
1229 if( !wfRunHooks( 'getUserPermissionsErrors', array(&$this,&$user,$action,&$result) ) ) {
1230 if( is_array($result) && count($result) && !is_array($result[0]) )
1231 $errors[] = $result; # A single array representing an error
1232 else if( is_array($result) && is_array($result[0]) )
1233 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1234 else if( $result !== '' && is_string($result) )
1235 $errors[] = array($result); # A string representing a message-id
1236 else if( $result === false )
1237 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1239 # Short-circuit point
1240 if( $short && count($errors) > 0 ) {
1241 wfProfileOut( __METHOD__
);
1244 // Check getUserPermissionsErrorsExpensive hook
1245 if( $doExpensiveQueries && !wfRunHooks( 'getUserPermissionsErrorsExpensive', array(&$this,&$user,$action,&$result) ) ) {
1246 if( is_array($result) && count($result) && !is_array($result[0]) )
1247 $errors[] = $result; # A single array representing an error
1248 else if( is_array($result) && is_array($result[0]) )
1249 $errors = array_merge( $errors, $result ); # A nested array representing multiple errors
1250 else if( $result !== '' && is_string($result) )
1251 $errors[] = array($result); # A string representing a message-id
1252 else if( $result === false )
1253 $errors[] = array('badaccess-group0'); # a generic "We don't want them to do that"
1255 # Short-circuit point
1256 if( $short && count($errors) > 0 ) {
1257 wfProfileOut( __METHOD__
);
1261 # Only 'createaccount' and 'execute' can be performed on
1262 # special pages, which don't actually exist in the DB.
1263 $specialOKActions = array( 'createaccount', 'execute' );
1264 if( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions) ) {
1265 $errors[] = array('ns-specialprotected');
1268 # Check $wgNamespaceProtection for restricted namespaces
1269 if( $this->isNamespaceProtected() ) {
1270 $ns = $this->getNamespace() == NS_MAIN ?
1271 wfMsg( 'nstab-main' ) : $this->getNsText();
1272 $errors[] = NS_MEDIAWIKI
== $this->mNamespace ?
1273 array('protectedinterface') : array( 'namespaceprotected', $ns );
1276 # Protect css/js subpages of user pages
1277 # XXX: this might be better using restrictions
1278 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
1279 if( $this->isCssJsSubpage() && !$user->isAllowed('editusercssjs')
1280 && !preg_match('/^'.preg_quote($user->getName(), '/').'\//', $this->mTextform
) )
1282 $errors[] = array('customcssjsprotected');
1285 # Check against page_restrictions table requirements on this
1286 # page. The user must possess all required rights for this action.
1287 foreach( $this->getRestrictions($action) as $right ) {
1288 // Backwards compatibility, rewrite sysop -> protect
1289 if( $right == 'sysop' ) {
1292 if( '' != $right && !$user->isAllowed( $right ) ) {
1293 // Users with 'editprotected' permission can edit protected pages
1294 if( $action=='edit' && $user->isAllowed( 'editprotected' ) ) {
1295 // Users with 'editprotected' permission cannot edit protected pages
1296 // with cascading option turned on.
1297 if( $this->mCascadeRestriction
) {
1298 $errors[] = array( 'protectedpagetext', $right );
1301 $errors[] = array( 'protectedpagetext', $right );
1305 # Short-circuit point
1306 if( $short && count($errors) > 0 ) {
1307 wfProfileOut( __METHOD__
);
1311 if( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1312 # We /could/ use the protection level on the source page, but it's fairly ugly
1313 # as we have to establish a precedence hierarchy for pages included by multiple
1314 # cascade-protected pages. So just restrict it to people with 'protect' permission,
1315 # as they could remove the protection anyway.
1316 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1317 # Cascading protection depends on more than this page...
1318 # Several cascading protected pages may include this page...
1319 # Check each cascading level
1320 # This is only for protection restrictions, not for all actions
1321 if( $cascadingSources > 0 && isset($restrictions[$action]) ) {
1322 foreach( $restrictions[$action] as $right ) {
1323 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1324 if( '' != $right && !$user->isAllowed( $right ) ) {
1326 foreach( $cascadingSources as $page )
1327 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1328 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1333 # Short-circuit point
1334 if( $short && count($errors) > 0 ) {
1335 wfProfileOut( __METHOD__
);
1339 if( $action == 'protect' ) {
1340 if( $this->getUserPermissionsErrors('edit', $user) != array() ) {
1341 $errors[] = array( 'protect-cantedit' ); // If they can't edit, they shouldn't protect.
1345 if( $action == 'create' ) {
1346 $title_protection = $this->getTitleProtection();
1347 if( is_array($title_protection) ) {
1348 extract($title_protection); // is this extract() really needed?
1350 if( $pt_create_perm == 'sysop' ) {
1351 $pt_create_perm = 'protect'; // B/C
1353 if( $pt_create_perm == '' ||
!$user->isAllowed($pt_create_perm) ) {
1354 $errors[] = array( 'titleprotected', User
::whoIs($pt_user), $pt_reason );
1357 } elseif( $action == 'move' ) {
1358 // Check for immobile pages
1359 if( !MWNamespace
::isMovable( $this->getNamespace() ) ) {
1360 // Specific message for this case
1361 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1362 } elseif( !$this->isMovable() ) {
1363 // Less specific message for rarer cases
1364 $errors[] = array( 'immobile-page' );
1366 } elseif( $action == 'move-target' ) {
1367 if( !MWNamespace
::isMovable( $this->getNamespace() ) ) {
1368 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1369 } elseif( !$this->isMovable() ) {
1370 $errors[] = array( 'immobile-target-page' );
1374 wfProfileOut( __METHOD__
);
1379 * Is this title subject to title protection?
1380 * @return \type{\mixed} An associative array representing any existent title
1381 * protection, or false if there's none.
1383 private function getTitleProtection() {
1384 // Can't protect pages in special namespaces
1385 if ( $this->getNamespace() < 0 ) {
1389 $dbr = wfGetDB( DB_SLAVE
);
1390 $res = $dbr->select( 'protected_titles', '*',
1391 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1394 if ($row = $dbr->fetchRow( $res )) {
1402 * Update the title protection status
1403 * @param $create_perm \type{\string} Permission required for creation
1404 * @param $reason \type{\string} Reason for protection
1405 * @param $expiry \type{\string} Expiry timestamp
1407 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1408 global $wgUser,$wgContLang;
1410 if ($create_perm == implode(',',$this->getRestrictions('create'))
1411 && $expiry == $this->mRestrictionsExpiry
['create']) {
1416 list ($namespace, $title) = array( $this->getNamespace(), $this->getDBkey() );
1418 $dbw = wfGetDB( DB_MASTER
);
1420 $encodedExpiry = Block
::encodeExpiry($expiry, $dbw );
1422 $expiry_description = '';
1423 if ( $encodedExpiry != 'infinity' ) {
1424 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ) , $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ).')';
1427 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ).')';
1430 # Update protection table
1431 if ($create_perm != '' ) {
1432 $dbw->replace( 'protected_titles', array(array('pt_namespace', 'pt_title')),
1433 array( 'pt_namespace' => $namespace, 'pt_title' => $title
1434 , 'pt_create_perm' => $create_perm
1435 , 'pt_timestamp' => Block
::encodeExpiry(wfTimestampNow(), $dbw)
1436 , 'pt_expiry' => $encodedExpiry
1437 , 'pt_user' => $wgUser->getId(), 'pt_reason' => $reason ), __METHOD__
);
1439 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1440 'pt_title' => $title ), __METHOD__
);
1442 # Update the protection log
1443 $log = new LogPage( 'protect' );
1445 if( $create_perm ) {
1446 $params = array("[create=$create_perm] $expiry_description",'');
1447 $log->addEntry( $this->mRestrictions
['create'] ?
'modify' : 'protect', $this, trim( $reason ), $params );
1449 $log->addEntry( 'unprotect', $this, $reason );
1456 * Remove any title protection due to page existing
1458 public function deleteTitleProtection() {
1459 $dbw = wfGetDB( DB_MASTER
);
1461 $dbw->delete( 'protected_titles',
1462 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1467 * Can $wgUser edit this page?
1468 * @return \type{\bool} TRUE or FALSE
1469 * @deprecated use userCan('edit')
1471 public function userCanEdit( $doExpensiveQueries = true ) {
1472 return $this->userCan( 'edit', $doExpensiveQueries );
1476 * Can $wgUser create this page?
1477 * @return \type{\bool} TRUE or FALSE
1478 * @deprecated use userCan('create')
1480 public function userCanCreate( $doExpensiveQueries = true ) {
1481 return $this->userCan( 'create', $doExpensiveQueries );
1485 * Can $wgUser move this page?
1486 * @return \type{\bool} TRUE or FALSE
1487 * @deprecated use userCan('move')
1489 public function userCanMove( $doExpensiveQueries = true ) {
1490 return $this->userCan( 'move', $doExpensiveQueries );
1494 * Would anybody with sufficient privileges be able to move this page?
1495 * Some pages just aren't movable.
1497 * @return \type{\bool} TRUE or FALSE
1499 public function isMovable() {
1500 return MWNamespace
::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
1504 * Can $wgUser read this page?
1505 * @return \type{\bool} TRUE or FALSE
1506 * @todo fold these checks into userCan()
1508 public function userCanRead() {
1509 global $wgUser, $wgGroupPermissions;
1512 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1513 if ( $result !== null ) {
1517 # Shortcut for public wikis, allows skipping quite a bit of code
1518 if ( !empty( $wgGroupPermissions['*']['read'] ) )
1521 if( $wgUser->isAllowed( 'read' ) ) {
1524 global $wgWhitelistRead;
1527 * Always grant access to the login page.
1528 * Even anons need to be able to log in.
1530 if( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'Resetpass' ) ) {
1535 * Bail out if there isn't whitelist
1537 if( !is_array($wgWhitelistRead) ) {
1542 * Check for explicit whitelisting
1544 $name = $this->getPrefixedText();
1545 $dbName = $this->getPrefixedDBKey();
1546 // Check with and without underscores
1547 if( in_array($name,$wgWhitelistRead,true) ||
in_array($dbName,$wgWhitelistRead,true) )
1551 * Old settings might have the title prefixed with
1552 * a colon for main-namespace pages
1554 if( $this->getNamespace() == NS_MAIN
) {
1555 if( in_array( ':' . $name, $wgWhitelistRead ) )
1560 * If it's a special page, ditch the subpage bit
1563 if( $this->getNamespace() == NS_SPECIAL
) {
1564 $name = $this->getDBkey();
1565 list( $name, /* $subpage */) = SpecialPage
::resolveAliasWithSubpage( $name );
1566 if ( $name === false ) {
1567 # Invalid special page, but we show standard login required message
1571 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1572 if( in_array( $pure, $wgWhitelistRead, true ) )
1581 * Is this a talk page of some sort?
1582 * @return \type{\bool} TRUE or FALSE
1584 public function isTalkPage() {
1585 return MWNamespace
::isTalk( $this->getNamespace() );
1589 * Is this a subpage?
1590 * @return \type{\bool} TRUE or FALSE
1592 public function isSubpage() {
1593 return MWNamespace
::hasSubpages( $this->mNamespace
)
1594 ?
strpos( $this->getText(), '/' ) !== false
1599 * Does this have subpages? (Warning, usually requires an extra DB query.)
1600 * @return \type{\bool} TRUE or FALSE
1602 public function hasSubpages() {
1603 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1608 # We dynamically add a member variable for the purpose of this method
1609 # alone to cache the result. There's no point in having it hanging
1610 # around uninitialized in every Title object; therefore we only add it
1611 # if needed and don't declare it statically.
1612 if( isset( $this->mHasSubpages
) ) {
1613 return $this->mHasSubpages
;
1616 $subpages = $this->getSubpages( 1 );
1617 if( $subpages instanceof TitleArray
)
1618 return $this->mHasSubpages
= (bool)$subpages->count();
1619 return $this->mHasSubpages
= false;
1623 * Get all subpages of this page.
1624 * @param $limit Maximum number of subpages to fetch; -1 for no limit
1625 * @return mixed TitleArray, or empty array if this page's namespace
1626 * doesn't allow subpages
1628 public function getSubpages( $limit = -1 ) {
1629 if( !MWNamespace
::hasSubpages( $this->getNamespace() ) )
1632 $dbr = wfGetDB( DB_SLAVE
);
1633 $conds['page_namespace'] = $this->getNamespace();
1634 $conds[] = 'page_title LIKE ' . $dbr->addQuotes(
1635 $dbr->escapeLike( $this->getDBkey() ) . '/%' );
1638 $options['LIMIT'] = $limit;
1639 return $this->mSubpages
= TitleArray
::newFromResult(
1640 $dbr->select( 'page',
1641 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
1650 * Could this page contain custom CSS or JavaScript, based
1653 * @return \type{\bool} TRUE or FALSE
1655 public function isCssOrJsPage() {
1656 return $this->mNamespace
== NS_MEDIAWIKI
1657 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1661 * Is this a .css or .js subpage of a user page?
1662 * @return \type{\bool} TRUE or FALSE
1664 public function isCssJsSubpage() {
1665 return ( NS_USER
== $this->mNamespace
and preg_match("/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
1668 * Is this a *valid* .css or .js subpage of a user page?
1669 * Check that the corresponding skin exists
1670 * @return \type{\bool} TRUE or FALSE
1672 public function isValidCssJsSubpage() {
1673 if ( $this->isCssJsSubpage() ) {
1674 $skinNames = Skin
::getSkinNames();
1675 return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
1681 * Trim down a .css or .js subpage title to get the corresponding skin name
1683 public function getSkinFromCssJsSubpage() {
1684 $subpage = explode( '/', $this->mTextform
);
1685 $subpage = $subpage[ count( $subpage ) - 1 ];
1686 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1689 * Is this a .css subpage of a user page?
1690 * @return \type{\bool} TRUE or FALSE
1692 public function isCssSubpage() {
1693 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.css$/", $this->mTextform
) );
1696 * Is this a .js subpage of a user page?
1697 * @return \type{\bool} TRUE or FALSE
1699 public function isJsSubpage() {
1700 return ( NS_USER
== $this->mNamespace
&& preg_match("/\\/.*\\.js$/", $this->mTextform
) );
1703 * Protect css/js subpages of user pages: can $wgUser edit
1706 * @return \type{\bool} TRUE or FALSE
1707 * @todo XXX: this might be better using restrictions
1709 public function userCanEditCssJsSubpage() {
1711 return ( $wgUser->isAllowed('editusercssjs') ||
preg_match('/^'.preg_quote($wgUser->getName(), '/').'\//', $this->mTextform
) );
1715 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1717 * @return \type{\bool} If the page is subject to cascading restrictions.
1719 public function isCascadeProtected() {
1720 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1721 return ( $sources > 0 );
1725 * Cascading protection: Get the source of any cascading restrictions on this page.
1727 * @param $get_pages \type{\bool} Whether or not to retrieve the actual pages that the restrictions have come from.
1728 * @return \type{\arrayof{mixed title array, restriction array}} Array of the Title objects of the pages from
1729 * which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set.
1730 * The restriction array is an array of each type, each of which contains an array of unique groups.
1732 public function getCascadeProtectionSources( $get_pages = true ) {
1733 global $wgRestrictionTypes;
1735 # Define our dimension of restrictions types
1736 $pagerestrictions = array();
1737 foreach( $wgRestrictionTypes as $action )
1738 $pagerestrictions[$action] = array();
1740 if ( isset( $this->mCascadeSources
) && $get_pages ) {
1741 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
1742 } else if ( isset( $this->mHasCascadingRestrictions
) && !$get_pages ) {
1743 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
1746 wfProfileIn( __METHOD__
);
1748 $dbr = wfGetDB( DB_SLAVE
);
1750 if ( $this->getNamespace() == NS_FILE
) {
1751 $tables = array ('imagelinks', 'page_restrictions');
1752 $where_clauses = array(
1753 'il_to' => $this->getDBkey(),
1755 'pr_cascade' => 1 );
1757 $tables = array ('templatelinks', 'page_restrictions');
1758 $where_clauses = array(
1759 'tl_namespace' => $this->getNamespace(),
1760 'tl_title' => $this->getDBkey(),
1762 'pr_cascade' => 1 );
1766 $cols = array('pr_page', 'page_namespace', 'page_title', 'pr_expiry', 'pr_type', 'pr_level' );
1767 $where_clauses[] = 'page_id=pr_page';
1770 $cols = array( 'pr_expiry' );
1773 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
1775 $sources = $get_pages ?
array() : false;
1776 $now = wfTimestampNow();
1777 $purgeExpired = false;
1779 foreach( $res as $row ) {
1780 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1781 if( $expiry > $now ) {
1783 $page_id = $row->pr_page
;
1784 $page_ns = $row->page_namespace
;
1785 $page_title = $row->page_title
;
1786 $sources[$page_id] = Title
::makeTitle($page_ns, $page_title);
1787 # Add groups needed for each restriction type if its not already there
1788 # Make sure this restriction type still exists
1789 if ( isset($pagerestrictions[$row->pr_type
]) && !in_array($row->pr_level
, $pagerestrictions[$row->pr_type
]) ) {
1790 $pagerestrictions[$row->pr_type
][]=$row->pr_level
;
1796 // Trigger lazy purge of expired restrictions from the db
1797 $purgeExpired = true;
1800 if( $purgeExpired ) {
1801 Title
::purgeExpiredRestrictions();
1804 wfProfileOut( __METHOD__
);
1807 $this->mCascadeSources
= $sources;
1808 $this->mCascadingRestrictions
= $pagerestrictions;
1810 $this->mHasCascadingRestrictions
= $sources;
1812 return array( $sources, $pagerestrictions );
1815 function areRestrictionsCascading() {
1816 if (!$this->mRestrictionsLoaded
) {
1817 $this->loadRestrictions();
1820 return $this->mCascadeRestriction
;
1824 * Loads a string into mRestrictions array
1825 * @param $res \type{Resource} restrictions as an SQL result.
1827 private function loadRestrictionsFromRow( $res, $oldFashionedRestrictions = NULL ) {
1828 global $wgRestrictionTypes;
1829 $dbr = wfGetDB( DB_SLAVE
);
1831 foreach( $wgRestrictionTypes as $type ){
1832 $this->mRestrictions
[$type] = array();
1833 $this->mRestrictionsExpiry
[$type] = Block
::decodeExpiry('');
1836 $this->mCascadeRestriction
= false;
1838 # Backwards-compatibility: also load the restrictions from the page record (old format).
1840 if ( $oldFashionedRestrictions === NULL ) {
1841 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
1842 array( 'page_id' => $this->getArticleId() ), __METHOD__
);
1845 if ($oldFashionedRestrictions != '') {
1847 foreach( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
1848 $temp = explode( '=', trim( $restrict ) );
1849 if(count($temp) == 1) {
1850 // old old format should be treated as edit/move restriction
1851 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
1852 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
1854 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
1858 $this->mOldRestrictions
= true;
1862 if( $dbr->numRows( $res ) ) {
1863 # Current system - load second to make them override.
1864 $now = wfTimestampNow();
1865 $purgeExpired = false;
1867 foreach( $res as $row ) {
1868 # Cycle through all the restrictions.
1870 // Don't take care of restrictions types that aren't in $wgRestrictionTypes
1871 if( !in_array( $row->pr_type
, $wgRestrictionTypes ) )
1874 // This code should be refactored, now that it's being used more generally,
1875 // But I don't really see any harm in leaving it in Block for now -werdna
1876 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
1878 // Only apply the restrictions if they haven't expired!
1879 if ( !$expiry ||
$expiry > $now ) {
1880 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
1881 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
1883 $this->mCascadeRestriction |
= $row->pr_cascade
;
1885 // Trigger a lazy purge of expired restrictions
1886 $purgeExpired = true;
1890 if( $purgeExpired ) {
1891 Title
::purgeExpiredRestrictions();
1895 $this->mRestrictionsLoaded
= true;
1899 * Load restrictions from the page_restrictions table
1901 public function loadRestrictions( $oldFashionedRestrictions = NULL ) {
1902 if( !$this->mRestrictionsLoaded
) {
1903 if ($this->exists()) {
1904 $dbr = wfGetDB( DB_SLAVE
);
1906 $res = $dbr->select( 'page_restrictions', '*',
1907 array ( 'pr_page' => $this->getArticleId() ), __METHOD__
);
1909 $this->loadRestrictionsFromRow( $res, $oldFashionedRestrictions );
1911 $title_protection = $this->getTitleProtection();
1913 if (is_array($title_protection)) {
1914 extract($title_protection);
1916 $now = wfTimestampNow();
1917 $expiry = Block
::decodeExpiry($pt_expiry);
1919 if (!$expiry ||
$expiry > $now) {
1920 // Apply the restrictions
1921 $this->mRestrictionsExpiry
['create'] = $expiry;
1922 $this->mRestrictions
['create'] = explode(',', trim($pt_create_perm) );
1923 } else { // Get rid of the old restrictions
1924 Title
::purgeExpiredRestrictions();
1927 $this->mRestrictionsExpiry
['create'] = Block
::decodeExpiry('');
1929 $this->mRestrictionsLoaded
= true;
1935 * Purge expired restrictions from the page_restrictions table
1937 static function purgeExpiredRestrictions() {
1938 $dbw = wfGetDB( DB_MASTER
);
1939 $dbw->delete( 'page_restrictions',
1940 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1943 $dbw->delete( 'protected_titles',
1944 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
1949 * Accessor/initialisation for mRestrictions
1951 * @param $action \type{\string} action that permission needs to be checked for
1952 * @return \type{\arrayof{\string}} the array of groups allowed to edit this article
1954 public function getRestrictions( $action ) {
1955 if( !$this->mRestrictionsLoaded
) {
1956 $this->loadRestrictions();
1958 return isset( $this->mRestrictions
[$action] )
1959 ?
$this->mRestrictions
[$action]
1964 * Get the expiry time for the restriction against a given action
1965 * @return 14-char timestamp, or 'infinity' if the page is protected forever
1966 * or not protected at all, or false if the action is not recognised.
1968 public function getRestrictionExpiry( $action ) {
1969 if( !$this->mRestrictionsLoaded
) {
1970 $this->loadRestrictions();
1972 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
1976 * Is there a version of this page in the deletion archive?
1977 * @return \type{\int} the number of archived revisions
1979 public function isDeleted() {
1980 if( $this->getNamespace() < 0 ) {
1983 $dbr = wfGetDB( DB_SLAVE
);
1984 $n = $dbr->selectField( 'archive', 'COUNT(*)',
1985 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
1988 if( $this->getNamespace() == NS_FILE
) {
1989 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
1990 array( 'fa_name' => $this->getDBkey() ),
1999 * Is there a version of this page in the deletion archive?
2002 public function isDeletedQuick() {
2003 if( $this->getNamespace() < 0 ) {
2006 $dbr = wfGetDB( DB_SLAVE
);
2007 $deleted = (bool)$dbr->selectField( 'archive', '1',
2008 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2011 if( !$deleted && $this->getNamespace() == NS_FILE
) {
2012 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2013 array( 'fa_name' => $this->getDBkey() ),
2021 * Get the article ID for this Title from the link cache,
2022 * adding it if necessary
2023 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select
2025 * @return \type{\int} the ID
2027 public function getArticleID( $flags = 0 ) {
2028 if( $this->getNamespace() < 0 ) {
2029 return $this->mArticleID
= 0;
2031 $linkCache = LinkCache
::singleton();
2032 if( $flags & GAID_FOR_UPDATE
) {
2033 $oldUpdate = $linkCache->forUpdate( true );
2034 $linkCache->clearLink( $this );
2035 $this->mArticleID
= $linkCache->addLinkObj( $this );
2036 $linkCache->forUpdate( $oldUpdate );
2038 if( -1 == $this->mArticleID
) {
2039 $this->mArticleID
= $linkCache->addLinkObj( $this );
2042 return $this->mArticleID
;
2046 * Is this an article that is a redirect page?
2047 * Uses link cache, adding it if necessary
2048 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2049 * @return \type{\bool}
2051 public function isRedirect( $flags = 0 ) {
2052 if( !is_null($this->mRedirect
) )
2053 return $this->mRedirect
;
2054 # Calling getArticleID() loads the field from cache as needed
2055 if( !$this->getArticleID($flags) ) {
2056 return $this->mRedirect
= false;
2058 $linkCache = LinkCache
::singleton();
2059 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2061 return $this->mRedirect
;
2065 * What is the length of this page?
2066 * Uses link cache, adding it if necessary
2067 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2068 * @return \type{\bool}
2070 public function getLength( $flags = 0 ) {
2071 if( $this->mLength
!= -1 )
2072 return $this->mLength
;
2073 # Calling getArticleID() loads the field from cache as needed
2074 if( !$this->getArticleID($flags) ) {
2075 return $this->mLength
= 0;
2077 $linkCache = LinkCache
::singleton();
2078 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2080 return $this->mLength
;
2084 * What is the page_latest field for this page?
2085 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2086 * @return \type{\int}
2088 public function getLatestRevID( $flags = 0 ) {
2089 if( $this->mLatestID
!== false )
2090 return $this->mLatestID
;
2092 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB(DB_MASTER
) : wfGetDB(DB_SLAVE
);
2093 $this->mLatestID
= $db->selectField( 'page', 'page_latest', $this->pageCond(), __METHOD__
);
2094 return $this->mLatestID
;
2098 * This clears some fields in this object, and clears any associated
2099 * keys in the "bad links" section of the link cache.
2101 * - This is called from Article::insertNewArticle() to allow
2102 * loading of the new page_id. It's also called from
2103 * Article::doDeleteArticle()
2105 * @param $newid \type{\int} the new Article ID
2107 public function resetArticleID( $newid ) {
2108 $linkCache = LinkCache
::singleton();
2109 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2111 if ( $newid === false ) { $this->mArticleID
= -1; }
2112 else { $this->mArticleID
= $newid; }
2113 $this->mRestrictionsLoaded
= false;
2114 $this->mRestrictions
= array();
2118 * Updates page_touched for this page; called from LinksUpdate.php
2119 * @return \type{\bool} true if the update succeded
2121 public function invalidateCache() {
2122 if( wfReadOnly() ) {
2125 $dbw = wfGetDB( DB_MASTER
);
2126 $success = $dbw->update( 'page',
2127 array( 'page_touched' => $dbw->timestamp() ),
2131 HTMLFileCache
::clearFileCache( $this );
2136 * Prefix some arbitrary text with the namespace or interwiki prefix
2139 * @param $name \type{\string} the text
2140 * @return \type{\string} the prefixed text
2143 /* private */ function prefix( $name ) {
2145 if ( '' != $this->mInterwiki
) {
2146 $p = $this->mInterwiki
. ':';
2148 if ( 0 != $this->mNamespace
) {
2149 $p .= $this->getNsText() . ':';
2155 * Secure and split - main initialisation function for this object
2157 * Assumes that mDbkeyform has been set, and is urldecoded
2158 * and uses underscores, but not otherwise munged. This function
2159 * removes illegal characters, splits off the interwiki and
2160 * namespace prefixes, sets the other forms, and canonicalizes
2162 * @return \type{\bool} true on success
2164 private function secureAndSplit() {
2165 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
2168 static $rxTc = false;
2170 # Matching titles will be held as illegal.
2172 # Any character not allowed is forbidden...
2173 '[^' . Title
::legalChars() . ']' .
2174 # URL percent encoding sequences interfere with the ability
2175 # to round-trip titles -- you can't link to them consistently.
2176 '|%[0-9A-Fa-f]{2}' .
2177 # XML/HTML character references produce similar issues.
2178 '|&[A-Za-z0-9\x80-\xff]+;' .
2180 '|&#x[0-9A-Fa-f]+;' .
2184 $this->mInterwiki
= $this->mFragment
= '';
2185 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2187 $dbkey = $this->mDbkeyform
;
2189 # Strip Unicode bidi override characters.
2190 # Sometimes they slip into cut-n-pasted page titles, where the
2191 # override chars get included in list displays.
2192 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2194 # Clean up whitespace
2196 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
2197 $dbkey = trim( $dbkey, '_' );
2199 if ( '' == $dbkey ) {
2203 if( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2204 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2208 $this->mDbkeyform
= $dbkey;
2210 # Initial colon indicates main namespace rather than specified default
2211 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2212 if ( ':' == $dbkey{0} ) {
2213 $this->mNamespace
= NS_MAIN
;
2214 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2215 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2218 # Namespace or interwiki prefix
2220 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2223 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2225 if ( $ns = $wgContLang->getNsIndex( $p ) ) {
2226 # Ordinary namespace
2228 $this->mNamespace
= $ns;
2229 # For Talk:X pages, check if X has a "namespace" prefix
2230 if( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2231 if( $wgContLang->getNsIndex( $x[1] ) )
2232 return false; # Disallow Talk:File:x type titles...
2233 else if( Interwiki
::isValidInterwiki( $x[1] ) )
2234 return false; # Disallow Talk:Interwiki:x type titles...
2236 } elseif( Interwiki
::isValidInterwiki( $p ) ) {
2238 # Can't make a local interwiki link to an interwiki link.
2239 # That's just crazy!
2245 $this->mInterwiki
= $wgContLang->lc( $p );
2247 # Redundant interwiki prefix to the local wiki
2248 if ( 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) ) {
2249 if( $dbkey == '' ) {
2250 # Can't have an empty self-link
2253 $this->mInterwiki
= '';
2255 # Do another namespace split...
2259 # If there's an initial colon after the interwiki, that also
2260 # resets the default namespace
2261 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2262 $this->mNamespace
= NS_MAIN
;
2263 $dbkey = substr( $dbkey, 1 );
2266 # If there's no recognized interwiki or namespace,
2267 # then let the colon expression be part of the title.
2272 # We already know that some pages won't be in the database!
2274 if ( '' != $this->mInterwiki || NS_SPECIAL
== $this->mNamespace
) {
2275 $this->mArticleID
= 0;
2277 $fragment = strstr( $dbkey, '#' );
2278 if ( false !== $fragment ) {
2279 $this->setFragment( $fragment );
2280 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2281 # remove whitespace again: prevents "Foo_bar_#"
2282 # becoming "Foo_bar_"
2283 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2286 # Reject illegal characters.
2288 if( preg_match( $rxTc, $dbkey ) ) {
2293 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2294 * reachable due to the way web browsers deal with 'relative' URLs.
2295 * Also, they conflict with subpage syntax. Forbid them explicitly.
2297 if ( strpos( $dbkey, '.' ) !== false &&
2298 ( $dbkey === '.' ||
$dbkey === '..' ||
2299 strpos( $dbkey, './' ) === 0 ||
2300 strpos( $dbkey, '../' ) === 0 ||
2301 strpos( $dbkey, '/./' ) !== false ||
2302 strpos( $dbkey, '/../' ) !== false ||
2303 substr( $dbkey, -2 ) == '/.' ||
2304 substr( $dbkey, -3 ) == '/..' ) )
2310 * Magic tilde sequences? Nu-uh!
2312 if( strpos( $dbkey, '~~~' ) !== false ) {
2317 * Limit the size of titles to 255 bytes.
2318 * This is typically the size of the underlying database field.
2319 * We make an exception for special pages, which don't need to be stored
2320 * in the database, and may edge over 255 bytes due to subpage syntax
2321 * for long titles, e.g. [[Special:Block/Long name]]
2323 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2324 strlen( $dbkey ) > 512 )
2330 * Normally, all wiki links are forced to have
2331 * an initial capital letter so [[foo]] and [[Foo]]
2332 * point to the same place.
2334 * Don't force it for interwikis, since the other
2335 * site might be case-sensitive.
2337 $this->mUserCaseDBKey
= $dbkey;
2338 if( $wgCapitalLinks && $this->mInterwiki
== '') {
2339 $dbkey = $wgContLang->ucfirst( $dbkey );
2343 * Can't make a link to a namespace alone...
2344 * "empty" local links can only be self-links
2345 * with a fragment identifier.
2348 $this->mInterwiki
== '' &&
2349 $this->mNamespace
!= NS_MAIN
) {
2352 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2353 // IP names are not allowed for accounts, and can only be referring to
2354 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2355 // there are numerous ways to present the same IP. Having sp:contribs scan
2356 // them all is silly and having some show the edits and others not is
2357 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2358 $dbkey = ($this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
) ?
2359 IP
::sanitizeIP( $dbkey ) : $dbkey;
2360 // Any remaining initial :s are illegal.
2361 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
2366 $this->mDbkeyform
= $dbkey;
2367 $this->mUrlform
= wfUrlencode( $dbkey );
2369 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2375 * Set the fragment for this title. Removes the first character from the
2376 * specified fragment before setting, so it assumes you're passing it with
2379 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2380 * Still in active use privately.
2382 * @param $fragment \type{\string} text
2384 public function setFragment( $fragment ) {
2385 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2389 * Get a Title object associated with the talk page of this article
2390 * @return \type{Title} the object for the talk page
2392 public function getTalkPage() {
2393 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2397 * Get a title object associated with the subject page of this
2400 * @return \type{Title} the object for the subject page
2402 public function getSubjectPage() {
2403 // Is this the same title?
2404 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
2405 if( $this->getNamespace() == $subjectNS ) {
2408 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
2412 * Get an array of Title objects linking to this Title
2413 * Also stores the IDs in the link cache.
2415 * WARNING: do not use this function on arbitrary user-supplied titles!
2416 * On heavily-used templates it will max out the memory.
2418 * @param array $options may be FOR UPDATE
2419 * @return \type{\arrayof{Title}} the Title objects linking here
2421 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
2422 $linkCache = LinkCache
::singleton();
2424 if ( count( $options ) > 0 ) {
2425 $db = wfGetDB( DB_MASTER
);
2427 $db = wfGetDB( DB_SLAVE
);
2430 $res = $db->select( array( 'page', $table ),
2431 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect' ),
2433 "{$prefix}_from=page_id",
2434 "{$prefix}_namespace" => $this->getNamespace(),
2435 "{$prefix}_title" => $this->getDBkey() ),
2440 if ( $db->numRows( $res ) ) {
2441 foreach( $res as $row ) {
2442 if ( $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
) ) {
2443 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
);
2444 $retVal[] = $titleObj;
2448 $db->freeResult( $res );
2453 * Get an array of Title objects using this Title as a template
2454 * Also stores the IDs in the link cache.
2456 * WARNING: do not use this function on arbitrary user-supplied titles!
2457 * On heavily-used templates it will max out the memory.
2459 * @param array $options may be FOR UPDATE
2460 * @return \type{\arrayof{Title}} the Title objects linking here
2462 public function getTemplateLinksTo( $options = array() ) {
2463 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2467 * Get an array of Title objects referring to non-existent articles linked from this page
2469 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2470 * @return \type{\arrayof{Title}} the Title objects
2472 public function getBrokenLinksFrom() {
2473 if ( $this->getArticleId() == 0 ) {
2474 # All links from article ID 0 are false positives
2478 $dbr = wfGetDB( DB_SLAVE
);
2479 $res = $dbr->select(
2480 array( 'page', 'pagelinks' ),
2481 array( 'pl_namespace', 'pl_title' ),
2483 'pl_from' => $this->getArticleId(),
2484 'page_namespace IS NULL'
2486 __METHOD__
, array(),
2490 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
2496 foreach( $res as $row ) {
2497 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2504 * Get a list of URLs to purge from the Squid cache when this
2507 * @return \type{\arrayof{\string}} the URLs
2509 public function getSquidURLs() {
2513 $this->getInternalURL(),
2514 $this->getInternalURL( 'action=history' )
2517 // purge variant urls as well
2518 if($wgContLang->hasVariants()){
2519 $variants = $wgContLang->getVariants();
2520 foreach($variants as $vCode){
2521 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
2522 $urls[] = $this->getInternalURL('',$vCode);
2530 * Purge all applicable Squid URLs
2532 public function purgeSquid() {
2534 if ( $wgUseSquid ) {
2535 $urls = $this->getSquidURLs();
2536 $u = new SquidUpdate( $urls );
2542 * Move this page without authentication
2543 * @param &$nt \type{Title} the new page Title
2545 public function moveNoAuth( &$nt ) {
2546 return $this->moveTo( $nt, false );
2550 * Check whether a given move operation would be valid.
2551 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2552 * @param &$nt \type{Title} the new title
2553 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2555 * @param $reason \type{\string} is the log summary of the move, used for spam checking
2556 * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure
2558 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2563 // Normally we'd add this to $errors, but we'll get
2564 // lots of syntax errors if $nt is not an object
2565 return array(array('badtitletext'));
2567 if( $this->equals( $nt ) ) {
2568 $errors[] = array('selfmove');
2570 if( !$this->isMovable() ) {
2571 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2573 if ( $nt->getInterwiki() != '' ) {
2574 $errors[] = array( 'immobile-target-namespace-iw' );
2576 if ( !$nt->isMovable() ) {
2577 $errors[] = array('immobile-target-namespace', $nt->getNsText() );
2580 $oldid = $this->getArticleID();
2581 $newid = $nt->getArticleID();
2583 if ( strlen( $nt->getDBkey() ) < 1 ) {
2584 $errors[] = array('articleexists');
2586 if ( ( '' == $this->getDBkey() ) ||
2588 ( '' == $nt->getDBkey() ) ) {
2589 $errors[] = array('badarticleerror');
2592 // Image-specific checks
2593 if( $this->getNamespace() == NS_FILE
) {
2594 $file = wfLocalFile( $this );
2595 if( $file->exists() ) {
2596 if( $nt->getNamespace() != NS_FILE
) {
2597 $errors[] = array('imagenocrossnamespace');
2599 if( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
2600 $errors[] = array('imageinvalidfilename');
2602 if( !File
::checkExtensionCompatibility( $file, $nt->getDBKey() ) ) {
2603 $errors[] = array('imagetypemismatch');
2609 $errors = wfMergeErrorArrays( $errors,
2610 $this->getUserPermissionsErrors('move', $wgUser),
2611 $this->getUserPermissionsErrors('edit', $wgUser),
2612 $nt->getUserPermissionsErrors('move-target', $wgUser),
2613 $nt->getUserPermissionsErrors('edit', $wgUser) );
2616 $match = EditPage
::matchSummarySpamRegex( $reason );
2617 if( $match !== false ) {
2618 // This is kind of lame, won't display nice
2619 $errors[] = array('spamprotectiontext');
2623 if( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
2624 $errors[] = array('hookaborted', $err);
2627 # The move is allowed only if (1) the target doesn't exist, or
2628 # (2) the target is a redirect to the source, and has no history
2629 # (so we can undo bad moves right after they're done).
2631 if ( 0 != $newid ) { # Target exists; check for validity
2632 if ( ! $this->isValidMoveTarget( $nt ) ) {
2633 $errors[] = array('articleexists');
2636 $tp = $nt->getTitleProtection();
2637 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
2638 if ( $tp and !$wgUser->isAllowed( $right ) ) {
2639 $errors[] = array('cantmove-titleprotected');
2648 * Move a title to a new location
2649 * @param &$nt \type{Title} the new title
2650 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2652 * @param $reason \type{\string} The reason for the move
2653 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title.
2654 * Ignored if the user doesn't have the suppressredirect right.
2655 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2657 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
2658 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
2659 if( is_array( $err ) ) {
2663 // If it is a file, more it first. It is done before all other moving stuff is done because it's hard to revert
2664 $dbw = wfGetDB( DB_MASTER
);
2665 if( $this->getNamespace() == NS_FILE
) {
2666 $file = wfLocalFile( $this );
2667 if( $file->exists() ) {
2668 $status = $file->move( $nt );
2669 if( !$status->isOk() ) {
2670 return $status->getErrorsArray();
2675 $pageid = $this->getArticleID();
2676 $protected = $this->isProtected();
2677 if( $nt->exists() ) {
2678 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
2679 $pageCountChange = ($createRedirect ?
0 : -1);
2680 } else { # Target didn't exist, do normal move.
2681 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
2682 $pageCountChange = ($createRedirect ?
1 : 0);
2685 if( is_array( $err ) ) {
2688 $redirid = $this->getArticleID();
2690 // Category memberships include a sort key which may be customized.
2691 // If it's left as the default (the page title), we need to update
2692 // the sort key to match the new title.
2694 // Be careful to avoid resetting cl_timestamp, which may disturb
2695 // time-based lists on some sites.
2697 // Warning -- if the sort key is *explicitly* set to the old title,
2698 // we can't actually distinguish it from a default here, and it'll
2699 // be set to the new title even though it really shouldn't.
2700 // It'll get corrected on the next edit, but resetting cl_timestamp.
2701 $dbw->update( 'categorylinks',
2703 'cl_sortkey' => $nt->getPrefixedText(),
2704 'cl_timestamp=cl_timestamp' ),
2706 'cl_from' => $pageid,
2707 'cl_sortkey' => $this->getPrefixedText() ),
2711 # Protect the redirect title as the title used to be...
2712 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
2714 'pr_page' => $redirid,
2715 'pr_type' => 'pr_type',
2716 'pr_level' => 'pr_level',
2717 'pr_cascade' => 'pr_cascade',
2718 'pr_user' => 'pr_user',
2719 'pr_expiry' => 'pr_expiry'
2721 array( 'pr_page' => $pageid ),
2725 # Update the protection log
2726 $log = new LogPage( 'protect' );
2727 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2728 if( $reason ) $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
2729 $log->addEntry( 'move_prot', $nt, $comment, array($this->getPrefixedText()) ); // FIXME: $params?
2733 $oldnamespace = $this->getNamespace() & ~
1;
2734 $newnamespace = $nt->getNamespace() & ~
1;
2735 $oldtitle = $this->getDBkey();
2736 $newtitle = $nt->getDBkey();
2738 if( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
2739 WatchedItem
::duplicateEntries( $this, $nt );
2742 # Update search engine
2743 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2745 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2749 if( $this->isContentPage() && !$nt->isContentPage() ) {
2750 # No longer a content page
2751 # Not viewed, edited, removing
2752 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2753 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2754 # Now a content page
2755 # Not viewed, edited, adding
2756 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
2757 } elseif( $pageCountChange ) {
2759 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2766 # Update message cache for interface messages
2767 if( $nt->getNamespace() == NS_MEDIAWIKI
) {
2768 global $wgMessageCache;
2770 # @bug 17860: old article can be deleted, if this the case,
2771 # delete it from message cache
2772 if ( $this->getArticleID() === 0 ) {
2773 $wgMessageCache->replace( $this->getDBkey(), false );
2775 $oldarticle = new Article( $this );
2776 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
2779 $newarticle = new Article( $nt );
2780 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
2784 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2789 * Move page to a title which is at present a redirect to the
2792 * @param &$nt \type{Title} the page to move to, which should currently
2794 * @param $reason \type{\string} The reason for the move
2795 * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title.
2796 * Ignored if the user doesn't have the suppressredirect right
2798 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
2799 global $wgUseSquid, $wgUser;
2800 $fname = 'Title::moveOverExistingRedirect';
2801 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
2804 $comment .= ": $reason";
2807 $now = wfTimestampNow();
2808 $newid = $nt->getArticleID();
2809 $oldid = $this->getArticleID();
2810 $latest = $this->getLatestRevID();
2812 $dbw = wfGetDB( DB_MASTER
);
2814 # Delete the old redirect. We don't save it to history since
2815 # by definition if we've got here it's rather uninteresting.
2816 # We have to remove it so that the next step doesn't trigger
2817 # a conflict on the unique namespace+title index...
2818 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2819 if ( !$dbw->cascadingDeletes() ) {
2820 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
2821 global $wgUseTrackbacks;
2822 if ($wgUseTrackbacks)
2823 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
2824 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
2825 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
2826 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
2827 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
2828 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
2829 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
2830 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
2833 # Save a null revision in the page's history notifying of the move
2834 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2835 $nullRevId = $nullRevision->insertOn( $dbw );
2837 $article = new Article( $this );
2838 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $wgUser) );
2840 # Change the name of the target page:
2841 $dbw->update( 'page',
2843 'page_touched' => $dbw->timestamp($now),
2844 'page_namespace' => $nt->getNamespace(),
2845 'page_title' => $nt->getDBkey(),
2846 'page_latest' => $nullRevId,
2848 /* WHERE */ array( 'page_id' => $oldid ),
2851 $nt->resetArticleID( $oldid );
2853 # Recreate the redirect, this time in the other direction.
2854 if( $createRedirect ||
!$wgUser->isAllowed('suppressredirect') ) {
2855 $mwRedir = MagicWord
::get( 'redirect' );
2856 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2857 $redirectArticle = new Article( $this );
2858 $newid = $redirectArticle->insertOn( $dbw );
2859 $redirectRevision = new Revision( array(
2861 'comment' => $comment,
2862 'text' => $redirectText ) );
2863 $redirectRevision->insertOn( $dbw );
2864 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2866 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false, $wgUser) );
2868 # Now, we record the link from the redirect to the new title.
2869 # It should have no other outgoing links...
2870 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2871 $dbw->insert( 'pagelinks',
2873 'pl_from' => $newid,
2874 'pl_namespace' => $nt->getNamespace(),
2875 'pl_title' => $nt->getDBkey() ),
2877 $redirectSuppressed = false;
2879 $this->resetArticleID( 0 );
2880 $redirectSuppressed = true;
2884 $log = new LogPage( 'move' );
2885 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2888 if ( $wgUseSquid ) {
2889 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2890 $u = new SquidUpdate( $urls );
2897 * Move page to non-existing title.
2898 * @param &$nt \type{Title} the new Title
2899 * @param $reason \type{\string} The reason for the move
2900 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title
2901 * Ignored if the user doesn't have the suppressredirect right
2903 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
2904 global $wgUseSquid, $wgUser;
2905 $fname = 'MovePageForm::moveToNewTitle';
2906 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2908 $comment .= wfMsgExt( 'colon-separator',
2909 array( 'escapenoentities', 'content' ) );
2910 $comment .= $reason;
2913 $newid = $nt->getArticleID();
2914 $oldid = $this->getArticleID();
2915 $latest = $this->getLatestRevId();
2917 $dbw = wfGetDB( DB_MASTER
);
2918 $now = $dbw->timestamp();
2920 # Save a null revision in the page's history notifying of the move
2921 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2922 $nullRevId = $nullRevision->insertOn( $dbw );
2924 $article = new Article( $this );
2925 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $wgUser) );
2928 $dbw->update( 'page',
2930 'page_touched' => $now,
2931 'page_namespace' => $nt->getNamespace(),
2932 'page_title' => $nt->getDBkey(),
2933 'page_latest' => $nullRevId,
2935 /* WHERE */ array( 'page_id' => $oldid ),
2938 $nt->resetArticleID( $oldid );
2940 if( $createRedirect ||
!$wgUser->isAllowed('suppressredirect') ) {
2942 $mwRedir = MagicWord
::get( 'redirect' );
2943 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2944 $redirectArticle = new Article( $this );
2945 $newid = $redirectArticle->insertOn( $dbw );
2946 $redirectRevision = new Revision( array(
2948 'comment' => $comment,
2949 'text' => $redirectText ) );
2950 $redirectRevision->insertOn( $dbw );
2951 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2953 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false, $wgUser) );
2955 # Record the just-created redirect's linking to the page
2956 $dbw->insert( 'pagelinks',
2958 'pl_from' => $newid,
2959 'pl_namespace' => $nt->getNamespace(),
2960 'pl_title' => $nt->getDBkey() ),
2962 $redirectSuppressed = false;
2964 $this->resetArticleID( 0 );
2965 $redirectSuppressed = true;
2969 $log = new LogPage( 'move' );
2970 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2972 # Purge caches as per article creation
2973 Article
::onArticleCreate( $nt );
2975 # Purge old title from squid
2976 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2977 $this->purgeSquid();
2982 * Move this page's subpages to be subpages of $nt
2983 * @param $nt Title Move target
2984 * @param $auth bool Whether $wgUser's permissions should be checked
2985 * @param $reason string The reason for the move
2986 * @param $createRedirect bool Whether to create redirects from the old subpages to the new ones
2987 * Ignored if the user doesn't have the 'suppressredirect' right
2988 * @return mixed array with old page titles as keys, and strings (new page titles) or
2989 * arrays (errors) as values, or an error array with numeric indices if no pages were moved
2991 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
2992 global $wgMaximumMovedPages;
2993 // Check permissions
2994 if( !$this->userCan( 'move-subpages' ) )
2995 return array( 'cant-move-subpages' );
2996 // Do the source and target namespaces support subpages?
2997 if( !MWNamespace
::hasSubpages( $this->getNamespace() ) )
2998 return array( 'namespace-nosubpages',
2999 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3000 if( !MWNamespace
::hasSubpages( $nt->getNamespace() ) )
3001 return array( 'namespace-nosubpages',
3002 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3004 $subpages = $this->getSubpages($wgMaximumMovedPages +
1);
3007 foreach( $subpages as $oldSubpage ) {
3009 if( $count > $wgMaximumMovedPages ) {
3010 $retval[$oldSubpage->getPrefixedTitle()] =
3011 array( 'movepage-max-pages',
3012 $wgMaximumMovedPages );
3016 if( $oldSubpage->getArticleId() == $this->getArticleId() )
3017 // When moving a page to a subpage of itself,
3018 // don't move it twice
3020 $newPageName = preg_replace(
3021 '#^'.preg_quote( $this->getDBKey(), '#' ).'#',
3022 $nt->getDBKey(), $oldSubpage->getDBKey() );
3023 if( $oldSubpage->isTalkPage() ) {
3024 $newNs = $nt->getTalkPage()->getNamespace();
3026 $newNs = $nt->getSubjectPage()->getNamespace();
3028 # Bug 14385: we need makeTitleSafe because the new page names may
3029 # be longer than 255 characters.
3030 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3032 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3033 if( $success === true ) {
3034 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3036 $retval[$oldSubpage->getPrefixedText()] = $success;
3043 * Checks if this page is just a one-rev redirect.
3044 * Adds lock, so don't use just for light purposes.
3046 * @return \type{\bool} TRUE or FALSE
3048 public function isSingleRevRedirect() {
3049 $dbw = wfGetDB( DB_MASTER
);
3051 $row = $dbw->selectRow( 'page',
3052 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3055 array( 'FOR UPDATE' )
3057 # Cache some fields we may want
3058 $this->mArticleID
= $row ?
intval($row->page_id
) : 0;
3059 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3060 $this->mLatestID
= $row ?
intval($row->page_latest
) : false;
3061 if( !$this->mRedirect
) {
3064 # Does the article have a history?
3065 $row = $dbw->selectField( array( 'page', 'revision'),
3067 array( 'page_namespace' => $this->getNamespace(),
3068 'page_title' => $this->getDBkey(),
3070 'page_latest != rev_id'
3073 array( 'FOR UPDATE' )
3075 # Return true if there was no history
3076 return ($row === false);
3080 * Checks if $this can be moved to a given Title
3081 * - Selects for update, so don't call it unless you mean business
3083 * @param &$nt \type{Title} the new title to check
3084 * @return \type{\bool} TRUE or FALSE
3086 public function isValidMoveTarget( $nt ) {
3087 $dbw = wfGetDB( DB_MASTER
);
3088 # Is it an existsing file?
3089 if( $nt->getNamespace() == NS_FILE
) {
3090 $file = wfLocalFile( $nt );
3091 if( $file->exists() ) {
3092 wfDebug( __METHOD__
. ": file exists\n" );
3096 # Is it a redirect with no history?
3097 if( !$nt->isSingleRevRedirect() ) {
3098 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3101 # Get the article text
3102 $rev = Revision
::newFromTitle( $nt );
3103 $text = $rev->getText();
3104 # Does the redirect point to the source?
3105 # Or is it a broken self-redirect, usually caused by namespace collisions?
3107 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3108 $redirTitle = Title
::newFromText( $m[1] );
3109 if( !is_object( $redirTitle ) ||
3110 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3111 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3112 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3117 wfDebug( __METHOD__
. ": failsafe\n" );
3124 * Can this title be added to a user's watchlist?
3126 * @return \type{\bool} TRUE or FALSE
3128 public function isWatchable() {
3129 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
3133 * Get categories to which this Title belongs and return an array of
3134 * categories' names.
3136 * @return \type{\array} array an array of parents in the form:
3137 * $parent => $currentarticle
3139 public function getParentCategories() {
3142 $titlekey = $this->getArticleId();
3143 $dbr = wfGetDB( DB_SLAVE
);
3144 $categorylinks = $dbr->tableName( 'categorylinks' );
3147 $sql = "SELECT * FROM $categorylinks"
3148 ." WHERE cl_from='$titlekey'"
3149 ." AND cl_from <> '0'"
3150 ." ORDER BY cl_sortkey";
3152 $res = $dbr->query( $sql );
3154 if( $dbr->numRows( $res ) > 0 ) {
3155 foreach( $res as $row )
3156 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3157 $data[$wgContLang->getNSText( NS_CATEGORY
).':'.$row->cl_to
] = $this->getFullText();
3158 $dbr->freeResult( $res );
3166 * Get a tree of parent categories
3167 * @param $children \type{\array} an array with the children in the keys, to check for circular refs
3168 * @return \type{\array} Tree of parent categories
3170 public function getParentCategoryTree( $children = array() ) {
3172 $parents = $this->getParentCategories();
3175 foreach( $parents as $parent => $current ) {
3176 if ( array_key_exists( $parent, $children ) ) {
3177 # Circular reference
3178 $stack[$parent] = array();
3180 $nt = Title
::newFromText($parent);
3182 $stack[$parent] = $nt->getParentCategoryTree( $children +
array($parent => 1) );
3194 * Get an associative array for selecting this title from
3197 * @return \type{\array} Selection array
3199 public function pageCond() {
3200 if( $this->mArticleID
> 0 ) {
3201 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3202 return array( 'page_id' => $this->mArticleID
);
3204 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3209 * Get the revision ID of the previous revision
3211 * @param $revId \type{\int} Revision ID. Get the revision that was before this one.
3212 * @param $flags \type{\int} GAID_FOR_UPDATE
3213 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3215 public function getPreviousRevisionID( $revId, $flags=0 ) {
3216 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3217 return $db->selectField( 'revision', 'rev_id',
3219 'rev_page' => $this->getArticleId($flags),
3220 'rev_id < ' . intval( $revId )
3223 array( 'ORDER BY' => 'rev_id DESC' )
3228 * Get the revision ID of the next revision
3230 * @param $revId \type{\int} Revision ID. Get the revision that was after this one.
3231 * @param $flags \type{\int} GAID_FOR_UPDATE
3232 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3234 public function getNextRevisionID( $revId, $flags=0 ) {
3235 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3236 return $db->selectField( 'revision', 'rev_id',
3238 'rev_page' => $this->getArticleId($flags),
3239 'rev_id > ' . intval( $revId )
3242 array( 'ORDER BY' => 'rev_id' )
3247 * Get the first revision of the page
3249 * @param $flags \type{\int} GAID_FOR_UPDATE
3250 * @return Revision (or NULL if page doesn't exist)
3252 public function getFirstRevision( $flags=0 ) {
3253 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3254 $pageId = $this->getArticleId($flags);
3255 if( !$pageId ) return NULL;
3256 $row = $db->selectRow( 'revision', '*',
3257 array( 'rev_page' => $pageId ),
3259 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3264 return new Revision( $row );
3269 * Check if this is a new page
3273 public function isNewPage() {
3274 $dbr = wfGetDB( DB_SLAVE
);
3275 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3279 * Get the oldest revision timestamp of this page
3281 * @return string, MW timestamp
3283 public function getEarliestRevTime() {
3284 $dbr = wfGetDB( DB_SLAVE
);
3285 if( $this->exists() ) {
3286 $min = $dbr->selectField( 'revision',
3287 'MIN(rev_timestamp)',
3288 array( 'rev_page' => $this->getArticleId() ),
3290 return wfTimestampOrNull( TS_MW
, $min );
3296 * Get the number of revisions between the given revision IDs.
3297 * Used for diffs and other things that really need it.
3299 * @param $old \type{\int} Revision ID.
3300 * @param $new \type{\int} Revision ID.
3301 * @return \type{\int} Number of revisions between these IDs.
3303 public function countRevisionsBetween( $old, $new ) {
3304 $dbr = wfGetDB( DB_SLAVE
);
3305 return $dbr->selectField( 'revision', 'count(*)',
3306 'rev_page = ' . intval( $this->getArticleId() ) .
3307 ' AND rev_id > ' . intval( $old ) .
3308 ' AND rev_id < ' . intval( $new ),
3314 * Compare with another title.
3316 * @param \type{Title} $title
3317 * @return \type{\bool} TRUE or FALSE
3319 public function equals( Title
$title ) {
3320 // Note: === is necessary for proper matching of number-like titles.
3321 return $this->getInterwiki() === $title->getInterwiki()
3322 && $this->getNamespace() == $title->getNamespace()
3323 && $this->getDBkey() === $title->getDBkey();
3327 * Callback for usort() to do title sorts by (namespace, title)
3329 public static function compare( $a, $b ) {
3330 if( $a->getNamespace() == $b->getNamespace() ) {
3331 return strcmp( $a->getText(), $b->getText() );
3333 return $a->getNamespace() - $b->getNamespace();
3338 * Return a string representation of this title
3340 * @return \type{\string} String representation of this title
3342 public function __toString() {
3343 return $this->getPrefixedText();
3347 * Check if page exists. For historical reasons, this function simply
3348 * checks for the existence of the title in the page table, and will
3349 * thus return false for interwiki links, special pages and the like.
3350 * If you want to know if a title can be meaningfully viewed, you should
3351 * probably call the isKnown() method instead.
3353 * @return \type{\bool} TRUE or FALSE
3355 public function exists() {
3356 return $this->getArticleId() != 0;
3360 * Should links to this title be shown as potentially viewable (i.e. as
3361 * "bluelinks"), even if there's no record by this title in the page
3364 * This function is semi-deprecated for public use, as well as somewhat
3365 * misleadingly named. You probably just want to call isKnown(), which
3366 * calls this function internally.
3368 * (ISSUE: Most of these checks are cheap, but the file existence check
3369 * can potentially be quite expensive. Including it here fixes a lot of
3370 * existing code, but we might want to add an optional parameter to skip
3371 * it and any other expensive checks.)
3373 * @return \type{\bool} TRUE or FALSE
3375 public function isAlwaysKnown() {
3376 if( $this->mInterwiki
!= '' ) {
3377 return true; // any interwiki link might be viewable, for all we know
3379 switch( $this->mNamespace
) {
3382 return wfFindFile( $this ); // file exists, possibly in a foreign repo
3384 return SpecialPage
::exists( $this->getDBKey() ); // valid special page
3386 return $this->mDbkeyform
== ''; // selflink, possibly with fragment
3388 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3389 // the full l10n of that language to be loaded. That takes much memory and
3390 // isn't needed. So we strip the language part away.
3391 // Also, extension messages which are not loaded, are shown as red, because
3392 // we don't call MessageCache::loadAllMessages.
3393 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
3394 return wfMsgWeirdKey( $basename ); // known system message
3401 * Does this title refer to a page that can (or might) be meaningfully
3402 * viewed? In particular, this function may be used to determine if
3403 * links to the title should be rendered as "bluelinks" (as opposed to
3404 * "redlinks" to non-existent pages).
3406 * @return \type{\bool} TRUE or FALSE
3408 public function isKnown() {
3409 return $this->exists() ||
$this->isAlwaysKnown();
3413 * Is this in a namespace that allows actual pages?
3415 * @return \type{\bool} TRUE or FALSE
3417 public function canExist() {
3418 return $this->mNamespace
>= 0 && $this->mNamespace
!= NS_MEDIA
;
3422 * Update page_touched timestamps and send squid purge messages for
3423 * pages linking to this title. May be sent to the job queue depending
3424 * on the number of links. Typically called on create and delete.
3426 public function touchLinks() {
3427 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3430 if ( $this->getNamespace() == NS_CATEGORY
) {
3431 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3437 * Get the last touched timestamp
3438 * @param Database $db, optional db
3439 * @return \type{\string} Last touched timestamp
3441 public function getTouched( $db = NULL ) {
3442 $db = isset($db) ?
$db : wfGetDB( DB_SLAVE
);
3443 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
3448 * Get the timestamp when this page was updated since the user last saw it.
3450 * @return mixed string/NULL
3452 public function getNotificationTimestamp( $user = NULL ) {
3453 global $wgUser, $wgShowUpdatedMarker;
3454 // Assume current user if none given
3455 if( !$user ) $user = $wgUser;
3456 // Check cache first
3457 $uid = $user->getId();
3458 if( isset($this->mNotificationTimestamp
[$uid]) ) {
3459 return $this->mNotificationTimestamp
[$uid];
3461 if( !$uid ||
!$wgShowUpdatedMarker ) {
3462 return $this->mNotificationTimestamp
[$uid] = false;
3464 // Don't cache too much!
3465 if( count($this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
3466 $this->mNotificationTimestamp
= array();
3468 $dbr = wfGetDB( DB_SLAVE
);
3469 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
3470 'wl_notificationtimestamp',
3471 array( 'wl_namespace' => $this->getNamespace(),
3472 'wl_title' => $this->getDBkey(),
3473 'wl_user' => $user->getId()
3477 return $this->mNotificationTimestamp
[$uid];
3481 * Get the trackback URL for this page
3482 * @return \type{\string} Trackback URL
3484 public function trackbackURL() {
3485 global $wgScriptPath, $wgServer, $wgScriptExtension;
3487 return "$wgServer$wgScriptPath/trackback$wgScriptExtension?article="
3488 . htmlspecialchars(urlencode($this->getPrefixedDBkey()));
3492 * Get the trackback RDF for this page
3493 * @return \type{\string} Trackback RDF
3495 public function trackbackRDF() {
3496 $url = htmlspecialchars($this->getFullURL());
3497 $title = htmlspecialchars($this->getText());
3498 $tburl = $this->trackbackURL();
3500 // Autodiscovery RDF is placed in comments so HTML validator
3501 // won't barf. This is a rather icky workaround, but seems
3502 // frequently used by this kind of RDF thingy.
3504 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3506 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3507 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3508 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3511 dc:identifier=\"$url\"
3513 trackback:ping=\"$tburl\" />
3519 * Generate strings used for xml 'id' names in monobook tabs
3520 * @return \type{\string} XML 'id' name
3522 public function getNamespaceKey() {
3524 switch ($this->getNamespace()) {
3527 return 'nstab-main';
3530 return 'nstab-user';
3532 return 'nstab-media';
3534 return 'nstab-special';
3536 case NS_PROJECT_TALK
:
3537 return 'nstab-project';
3540 return 'nstab-image';
3542 case NS_MEDIAWIKI_TALK
:
3543 return 'nstab-mediawiki';
3545 case NS_TEMPLATE_TALK
:
3546 return 'nstab-template';
3549 return 'nstab-help';
3551 case NS_CATEGORY_TALK
:
3552 return 'nstab-category';
3554 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
3559 * Returns true if this title resolves to the named special page
3560 * @param $name \type{\string} The special page name
3562 public function isSpecial( $name ) {
3563 if ( $this->getNamespace() == NS_SPECIAL
) {
3564 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
3565 if ( $name == $thisName ) {
3573 * If the Title refers to a special page alias which is not the local default,
3574 * @return \type{Title} A new Title which points to the local default. Otherwise, returns $this.
3576 public function fixSpecialName() {
3577 if ( $this->getNamespace() == NS_SPECIAL
) {
3578 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
3579 if ( $canonicalName ) {
3580 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
3581 if ( $localName != $this->mDbkeyform
) {
3582 return Title
::makeTitle( NS_SPECIAL
, $localName );
3590 * Is this Title in a namespace which contains content?
3591 * In other words, is this a content page, for the purposes of calculating
3594 * @return \type{\bool} TRUE or FALSE
3596 public function isContentPage() {
3597 return MWNamespace
::isContent( $this->getNamespace() );
3601 * Get all extant redirects to this Title
3603 * @param $ns \twotypes{\int,\null} Single namespace to consider;
3604 * NULL to consider all namespaces
3605 * @return \type{\arrayof{Title}} Redirects to this title
3607 public function getRedirectsHere( $ns = null ) {
3610 $dbr = wfGetDB( DB_SLAVE
);
3612 'rd_namespace' => $this->getNamespace(),
3613 'rd_title' => $this->getDBkey(),
3616 if ( !is_null($ns) ) $where['page_namespace'] = $ns;
3618 $res = $dbr->select(
3619 array( 'redirect', 'page' ),
3620 array( 'page_namespace', 'page_title' ),
3626 foreach( $res as $row ) {
3627 $redirs[] = self
::newFromRow( $row );
3633 * Check if this Title is a valid redirect target
3635 * @return \type{\bool} TRUE or FALSE
3637 public function isValidRedirectTarget() {
3638 global $wgInvalidRedirectTargets;
3640 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
3641 if( $this->isSpecial( 'Userlogout' ) ) {
3645 foreach( $wgInvalidRedirectTargets as $target ) {
3646 if( $this->isSpecial( $target ) ) {
3655 * Get a backlink cache object
3657 function getBacklinkCache() {
3658 if ( is_null( $this->mBacklinkCache
) ) {
3659 $this->mBacklinkCache
= new BacklinkCache( $this );
3661 return $this->mBacklinkCache
;