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 * @todo This is inefficiently implemented, the page row is requested
183 * but not used for anything else
185 * @param $id \type{\int} the page_id corresponding to the Title to create
186 * @param $flags \type{\int} use GAID_FOR_UPDATE to use master
187 * @return \type{Title} the new object, or NULL on an error
189 public static function newFromID( $id, $flags = 0 ) {
190 $fname = 'Title::newFromID';
191 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
192 $row = $db->selectRow( 'page', array( 'page_namespace', 'page_title' ),
193 array( 'page_id' => $id ), $fname );
194 if ( $row !== false ) {
195 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
203 * Make an array of titles from an array of IDs
204 * @param $ids \type{\arrayof{\int}} Array of IDs
205 * @return \type{\arrayof{Title}} Array of Titles
207 public static function newFromIDs( $ids ) {
208 if ( !count( $ids ) ) {
211 $dbr = wfGetDB( DB_SLAVE
);
212 $res = $dbr->select( 'page', array( 'page_namespace', 'page_title' ),
213 'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__
);
216 foreach( $res as $row ) {
217 $titles[] = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
223 * Make a Title object from a DB row
224 * @param $row \type{Row} (needs at least page_title,page_namespace)
225 * @return \type{Title} corresponding Title
227 public static function newFromRow( $row ) {
228 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
230 $t->mArticleID
= isset($row->page_id
) ?
intval($row->page_id
) : -1;
231 $t->mLength
= isset($row->page_len
) ?
intval($row->page_len
) : -1;
232 $t->mRedirect
= isset($row->page_is_redirect
) ?
(bool)$row->page_is_redirect
: NULL;
233 $t->mLatestID
= isset($row->page_latest
) ?
$row->page_latest
: false;
239 * Create a new Title from a namespace index and a DB key.
240 * It's assumed that $ns and $title are *valid*, for instance when
241 * they came directly from the database or a special page name.
242 * For convenience, spaces are converted to underscores so that
243 * eg user_text fields can be used directly.
245 * @param $ns \type{\int} the namespace of the article
246 * @param $title \type{\string} the unprefixed database key form
247 * @param $fragment \type{\string} The link fragment (after the "#")
248 * @return \type{Title} the new object
250 public static function &makeTitle( $ns, $title, $fragment = '' ) {
253 $t->mFragment
= $fragment;
254 $t->mNamespace
= $ns = intval( $ns );
255 $t->mDbkeyform
= str_replace( ' ', '_', $title );
256 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
257 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
258 $t->mTextform
= str_replace( '_', ' ', $title );
263 * Create a new Title from a namespace index and a DB key.
264 * The parameters will be checked for validity, which is a bit slower
265 * than makeTitle() but safer for user-provided data.
267 * @param $ns \type{\int} the namespace of the article
268 * @param $title \type{\string} the database key form
269 * @param $fragment \type{\string} The link fragment (after the "#")
270 * @return \type{Title} the new object, or NULL on an error
272 public static function makeTitleSafe( $ns, $title, $fragment = '' ) {
274 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment );
275 if( $t->secureAndSplit() ) {
283 * Create a new Title for the Main Page
284 * @return \type{Title} the new object
286 public static function newMainPage() {
287 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
288 // Don't give fatal errors if the message is broken
290 $title = Title
::newFromText( 'Main Page' );
296 * Extract a redirect destination from a string and return the
297 * Title, or null if the text doesn't contain a valid redirect
298 * This will only return the very next target, useful for
299 * the redirect table and other checks that don't need full recursion
301 * @param $text \type{\string} Text with possible redirect
302 * @return \type{Title} The corresponding Title
304 public static function newFromRedirect( $text ) {
305 return self
::newFromRedirectInternal( $text );
309 * Extract a redirect destination from a string and return the
310 * Title, or null if the text doesn't contain a valid redirect
311 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
312 * in order to provide (hopefully) the Title of the final destination instead of another redirect
314 * @param $text \type{\string} Text with possible redirect
315 * @return \type{Title} The corresponding Title
317 public static function newFromRedirectRecurse( $text ) {
318 $titles = self
::newFromRedirectArray( $text );
319 return $titles ?
array_pop( $titles ) : null;
323 * Extract a redirect destination from a string and return an
324 * array of Titles, or null if the text doesn't contain a valid redirect
325 * The last element in the array is the final destination after all redirects
326 * have been resolved (up to $wgMaxRedirects times)
328 * @param $text \type{\string} Text with possible redirect
329 * @return \type{\array} Array of Titles, with the destination last
331 public static function newFromRedirectArray( $text ) {
332 global $wgMaxRedirects;
333 // are redirects disabled?
334 if( $wgMaxRedirects < 1 )
336 $title = self
::newFromRedirectInternal( $text );
337 if( is_null( $title ) )
339 // recursive check to follow double redirects
340 $recurse = $wgMaxRedirects;
341 $titles = array( $title );
342 while( --$recurse >= 0 ) {
343 if( $title->isRedirect() ) {
344 $article = new Article( $title, 0 );
345 $newtitle = $article->getRedirectTarget();
349 // Redirects to some special pages are not permitted
350 if( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
351 // the new title passes the checks, so make that our current title so that further recursion can be checked
353 $titles[] = $newtitle;
362 * Really extract the redirect destination
363 * Do not call this function directly, use one of the newFromRedirect* functions above
365 * @param $text \type{\string} Text with possible redirect
366 * @return \type{Title} The corresponding Title
368 protected static function newFromRedirectInternal( $text ) {
369 $redir = MagicWord
::get( 'redirect' );
371 if( $redir->matchStartAndRemove( $text ) ) {
372 // Extract the first link and see if it's usable
373 // Ensure that it really does come directly after #REDIRECT
374 // Some older redirects included a colon, so don't freak about that!
376 if( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
377 // Strip preceding colon used to "escape" categories, etc.
378 // and URL-decode links
379 if( strpos( $m[1], '%' ) !== false ) {
380 // Match behavior of inline link parsing here;
381 // don't interpret + as " " most of the time!
382 // It might be safe to just use rawurldecode instead, though.
383 $m[1] = urldecode( ltrim( $m[1], ':' ) );
385 $title = Title
::newFromText( $m[1] );
386 // If the title is a redirect to bad special pages or is invalid, return null
387 if( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
396 #----------------------------------------------------------------------------
398 #----------------------------------------------------------------------------
401 * Get the prefixed DB key associated with an ID
402 * @param $id \type{\int} the page_id of the article
403 * @return \type{Title} an object representing the article, or NULL
404 * if no such article was found
406 public static function nameOf( $id ) {
407 $dbr = wfGetDB( DB_SLAVE
);
409 $s = $dbr->selectRow( 'page',
410 array( 'page_namespace','page_title' ),
411 array( 'page_id' => $id ),
413 if ( $s === false ) { return NULL; }
415 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
420 * Get a regex character class describing the legal characters in a link
421 * @return \type{\string} the list of characters, not delimited
423 public static function legalChars() {
424 global $wgLegalTitleChars;
425 return $wgLegalTitleChars;
429 * Get a string representation of a title suitable for
430 * including in a search index
432 * @param $ns \type{\int} a namespace index
433 * @param $title \type{\string} text-form main part
434 * @return \type{\string} a stripped-down title string ready for the
437 public static function indexTitle( $ns, $title ) {
440 $lc = SearchEngine
::legalSearchChars() . '&#;';
441 $t = $wgContLang->stripForSearch( $title );
442 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
443 $t = $wgContLang->lc( $t );
446 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
447 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
449 $t = preg_replace( "/\\s+/", ' ', $t );
451 if ( $ns == NS_FILE
) {
452 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
458 * Make a prefixed DB key from a DB key and a namespace index
459 * @param $ns \type{\int} numerical representation of the namespace
460 * @param $title \type{\string} the DB key form the title
461 * @param $fragment \type{\string} The link fragment (after the "#")
462 * @return \type{\string} the prefixed form of the title
464 public static function makeName( $ns, $title, $fragment = '' ) {
467 $namespace = $wgContLang->getNsText( $ns );
468 $name = $namespace == '' ?
$title : "$namespace:$title";
469 if ( strval( $fragment ) != '' ) {
470 $name .= '#' . $fragment;
476 * Returns the URL associated with an interwiki prefix
477 * @param $key \type{\string} the interwiki prefix (e.g. "MeatBall")
478 * @return \type{\string} the associated URL, containing "$1",
479 * which should be replaced by an article title
481 * @deprecated See Interwiki class
483 public function getInterwikiLink( $key ) {
484 return Interwiki
::fetch( $key )->getURL( );
488 * Determine whether the object refers to a page within
491 * @return \type{\bool} TRUE if this is an in-project interwiki link
492 * or a wikilink, FALSE otherwise
494 public function isLocal() {
495 if ( $this->mInterwiki
!= '' ) {
496 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
503 * Determine whether the object refers to a page within
504 * this project and is transcludable.
506 * @return \type{\bool} TRUE if this is transcludable
508 public function isTrans() {
509 if ($this->mInterwiki
== '')
512 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
516 * Escape a text fragment, say from a link, for a URL
518 static function escapeFragmentForURL( $fragment ) {
519 global $wgEnforceHtmlIds;
520 # Note that we don't urlencode the fragment. urlencoded Unicode
521 # fragments appear not to work in IE (at least up to 7) or in at least
522 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
523 # to care if they aren't encoded.
524 return Sanitizer
::escapeId( $fragment,
525 $wgEnforceHtmlIds ?
'noninitial' : 'xml' );
528 #----------------------------------------------------------------------------
530 #----------------------------------------------------------------------------
532 /** Simple accessors */
534 * Get the text form (spaces not underscores) of the main part
535 * @return \type{\string} Main part of the title
537 public function getText() { return $this->mTextform
; }
539 * Get the URL-encoded form of the main part
540 * @return \type{\string} Main part of the title, URL-encoded
542 public function getPartialURL() { return $this->mUrlform
; }
544 * Get the main part with underscores
545 * @return \type{\string} Main part of the title, with underscores
547 public function getDBkey() { return $this->mDbkeyform
; }
549 * Get the namespace index, i.e.\ one of the NS_xxxx constants.
550 * @return \type{\int} Namespace index
552 public function getNamespace() { return $this->mNamespace
; }
554 * Get the namespace text
555 * @return \type{\string} Namespace text
557 public function getNsText() {
558 global $wgContLang, $wgCanonicalNamespaceNames;
560 if ( '' != $this->mInterwiki
) {
561 // This probably shouldn't even happen. ohh man, oh yuck.
562 // But for interwiki transclusion it sometimes does.
563 // Shit. Shit shit shit.
565 // Use the canonical namespaces if possible to try to
566 // resolve a foreign namespace.
567 if( isset( $wgCanonicalNamespaceNames[$this->mNamespace
] ) ) {
568 return $wgCanonicalNamespaceNames[$this->mNamespace
];
571 return $wgContLang->getNsText( $this->mNamespace
);
574 * Get the DB key with the initial letter case as specified by the user
575 * @return \type{\string} DB key
577 function getUserCaseDBKey() {
578 return $this->mUserCaseDBKey
;
581 * Get the namespace text of the subject (rather than talk) page
582 * @return \type{\string} Namespace text
584 public function getSubjectNsText() {
586 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
589 * Get the namespace text of the talk page
590 * @return \type{\string} Namespace text
592 public function getTalkNsText() {
594 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
597 * Could this title have a corresponding talk page?
598 * @return \type{\bool} TRUE or FALSE
600 public function canTalk() {
601 return( MWNamespace
::canTalk( $this->mNamespace
) );
604 * Get the interwiki prefix (or null string)
605 * @return \type{\string} Interwiki prefix
607 public function getInterwiki() { return $this->mInterwiki
; }
609 * Get the Title fragment (i.e.\ the bit after the #) in text form
610 * @return \type{\string} Title fragment
612 public function getFragment() { return $this->mFragment
; }
614 * Get the fragment in URL form, including the "#" character if there is one
615 * @return \type{\string} Fragment in URL form
617 public function getFragmentForURL() {
618 if ( $this->mFragment
== '' ) {
621 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
625 * Get the default namespace index, for when there is no namespace
626 * @return \type{\int} Default namespace index
628 public function getDefaultNamespace() { return $this->mDefaultNamespace
; }
631 * Get title for search index
632 * @return \type{\string} a stripped-down title string ready for the
635 public function getIndexTitle() {
636 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
640 * Get the prefixed database key form
641 * @return \type{\string} the prefixed title, with underscores and
642 * any interwiki and namespace prefixes
644 public function getPrefixedDBkey() {
645 $s = $this->prefix( $this->mDbkeyform
);
646 $s = str_replace( ' ', '_', $s );
651 * Get the prefixed title with spaces.
652 * This is the form usually used for display
653 * @return \type{\string} the prefixed title, with spaces
655 public function getPrefixedText() {
656 if ( empty( $this->mPrefixedText
) ) { // FIXME: bad usage of empty() ?
657 $s = $this->prefix( $this->mTextform
);
658 $s = str_replace( '_', ' ', $s );
659 $this->mPrefixedText
= $s;
661 return $this->mPrefixedText
;
665 * Get the prefixed title with spaces, plus any fragment
666 * (part beginning with '#')
667 * @return \type{\string} the prefixed title, with spaces and
668 * the fragment, including '#'
670 public function getFullText() {
671 $text = $this->getPrefixedText();
672 if( '' != $this->mFragment
) {
673 $text .= '#' . $this->mFragment
;
679 * Get the base name, i.e. the leftmost parts before the /
680 * @return \type{\string} Base name
682 public function getBaseText() {
683 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
684 return $this->getText();
687 $parts = explode( '/', $this->getText() );
688 # Don't discard the real title if there's no subpage involved
689 if( count( $parts ) > 1 )
690 unset( $parts[ count( $parts ) - 1 ] );
691 return implode( '/', $parts );
695 * Get the lowest-level subpage name, i.e. the rightmost part after /
696 * @return \type{\string} Subpage name
698 public function getSubpageText() {
699 if( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
700 return( $this->mTextform
);
702 $parts = explode( '/', $this->mTextform
);
703 return( $parts[ count( $parts ) - 1 ] );
707 * Get a URL-encoded form of the subpage text
708 * @return \type{\string} URL-encoded subpage name
710 public function getSubpageUrlForm() {
711 $text = $this->getSubpageText();
712 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
717 * Get a URL-encoded title (not an actual URL) including interwiki
718 * @return \type{\string} the URL-encoded form
720 public function getPrefixedURL() {
721 $s = $this->prefix( $this->mDbkeyform
);
722 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
727 * Get a real URL referring to this title, with interwiki link and
730 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
731 * links. Can be specified as an associative array as well, e.g.,
732 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
733 * @param $variant \type{\string} language variant of url (for sr, zh..)
734 * @return \type{\string} the URL
736 public function getFullURL( $query = '', $variant = false ) {
737 global $wgContLang, $wgServer, $wgRequest;
739 if( is_array( $query ) ) {
740 $query = wfArrayToCGI( $query );
743 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
745 $url = $this->getLocalUrl( $query, $variant );
747 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
748 // Correct fix would be to move the prepending elsewhere.
749 if ($wgRequest->getVal('action') != 'render') {
750 $url = $wgServer . $url;
753 $baseUrl = $interwiki->getURL( );
755 $namespace = wfUrlencode( $this->getNsText() );
756 if ( '' != $namespace ) {
757 # Can this actually happen? Interwikis shouldn't be parsed.
758 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
761 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
762 $url = wfAppendQuery( $url, $query );
765 # Finally, add the fragment.
766 $url .= $this->getFragmentForURL();
768 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
773 * Get a URL with no fragment or server name. If this page is generated
774 * with action=render, $wgServer is prepended.
775 * @param mixed $query an optional query string; if not specified,
776 * $wgArticlePath will be used. Can be specified as an associative array
777 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
779 * @param $variant \type{\string} language variant of url (for sr, zh..)
780 * @return \type{\string} the URL
782 public function getLocalURL( $query = '', $variant = false ) {
783 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
784 global $wgVariantArticlePath, $wgContLang, $wgUser;
786 if( is_array( $query ) ) {
787 $query = wfArrayToCGI( $query );
790 // internal links should point to same variant as current page (only anonymous users)
791 if($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()){
792 $pref = $wgContLang->getPreferredVariant(false);
793 if($pref != $wgContLang->getCode())
797 if ( $this->isExternal() ) {
798 $url = $this->getFullURL();
800 // This is currently only used for edit section links in the
801 // context of interwiki transclusion. In theory we should
802 // append the query to the end of any existing query string,
803 // but interwiki transclusion is already broken in that case.
807 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
808 if ( $query == '' ) {
809 if( $variant != false && $wgContLang->hasVariants() ) {
810 if( $wgVariantArticlePath == false ) {
811 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
813 $variantArticlePath = $wgVariantArticlePath;
815 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
816 $url = str_replace( '$1', $dbkey, $url );
818 $url = str_replace( '$1', $dbkey, $wgArticlePath );
821 global $wgActionPaths;
824 if( !empty( $wgActionPaths ) &&
825 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
827 $action = urldecode( $matches[2] );
828 if( isset( $wgActionPaths[$action] ) ) {
829 $query = $matches[1];
830 if( isset( $matches[4] ) ) $query .= $matches[4];
831 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
833 $url = wfAppendQuery( $url, $query );
837 if ( $url === false ) {
838 if ( $query == '-' ) {
841 $url = "{$wgScript}?title={$dbkey}&{$query}";
845 // FIXME: this causes breakage in various places when we
846 // actually expected a local URL and end up with dupe prefixes.
847 if ($wgRequest->getVal('action') == 'render') {
848 $url = $wgServer . $url;
851 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
856 * Get a URL that's the simplest URL that will be valid to link, locally,
857 * to the current Title. It includes the fragment, but does not include
858 * the server unless action=render is used (or the link is external). If
859 * there's a fragment but the prefixed text is empty, we just return a link
862 * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the
863 * query string. Keys and values will be escaped.
864 * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
865 * for external links. Default is "false" (same variant as current page,
866 * for anonymous users).
867 * @return \type{\string} the URL
869 public function getLinkUrl( $query = array(), $variant = false ) {
870 if( !is_array( $query ) ) {
871 throw new MWException( 'Title::getLinkUrl passed a non-array for '.
874 if( $this->isExternal() ) {
875 return $this->getFullURL( $query );
876 } elseif( $this->getPrefixedText() === ''
877 and $this->getFragment() !== '' ) {
878 return $this->getFragmentForURL();
880 return $this->getLocalURL( $query, $variant )
881 . $this->getFragmentForURL();
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' ),
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 $fname = 'Title::isDeleted';
1981 if ( $this->getNamespace() < 0 ) {
1984 $dbr = wfGetDB( DB_SLAVE
);
1985 $n = $dbr->selectField( 'archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
1986 'ar_title' => $this->getDBkey() ), $fname );
1987 if( $this->getNamespace() == NS_FILE
) {
1988 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
1989 array( 'fa_name' => $this->getDBkey() ), $fname );
1996 * Get the article ID for this Title from the link cache,
1997 * adding it if necessary
1998 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select
2000 * @return \type{\int} the ID
2002 public function getArticleID( $flags = 0 ) {
2003 if( $this->getNamespace() < 0 ) {
2004 return $this->mArticleID
= 0;
2006 $linkCache = LinkCache
::singleton();
2007 if( $flags & GAID_FOR_UPDATE
) {
2008 $oldUpdate = $linkCache->forUpdate( true );
2009 $linkCache->clearLink( $this );
2010 $this->mArticleID
= $linkCache->addLinkObj( $this );
2011 $linkCache->forUpdate( $oldUpdate );
2013 if( -1 == $this->mArticleID
) {
2014 $this->mArticleID
= $linkCache->addLinkObj( $this );
2017 return $this->mArticleID
;
2021 * Is this an article that is a redirect page?
2022 * Uses link cache, adding it if necessary
2023 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2024 * @return \type{\bool}
2026 public function isRedirect( $flags = 0 ) {
2027 if( !is_null($this->mRedirect
) )
2028 return $this->mRedirect
;
2029 # Calling getArticleID() loads the field from cache as needed
2030 if( !$this->getArticleID($flags) ) {
2031 return $this->mRedirect
= false;
2033 $linkCache = LinkCache
::singleton();
2034 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2036 return $this->mRedirect
;
2040 * What is the length of this page?
2041 * Uses link cache, adding it if necessary
2042 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2043 * @return \type{\bool}
2045 public function getLength( $flags = 0 ) {
2046 if( $this->mLength
!= -1 )
2047 return $this->mLength
;
2048 # Calling getArticleID() loads the field from cache as needed
2049 if( !$this->getArticleID($flags) ) {
2050 return $this->mLength
= 0;
2052 $linkCache = LinkCache
::singleton();
2053 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2055 return $this->mLength
;
2059 * What is the page_latest field for this page?
2060 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2061 * @return \type{\int}
2063 public function getLatestRevID( $flags = 0 ) {
2064 if( $this->mLatestID
!== false )
2065 return $this->mLatestID
;
2067 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB(DB_MASTER
) : wfGetDB(DB_SLAVE
);
2068 $this->mLatestID
= $db->selectField( 'page', 'page_latest', $this->pageCond(), __METHOD__
);
2069 return $this->mLatestID
;
2073 * This clears some fields in this object, and clears any associated
2074 * keys in the "bad links" section of the link cache.
2076 * - This is called from Article::insertNewArticle() to allow
2077 * loading of the new page_id. It's also called from
2078 * Article::doDeleteArticle()
2080 * @param $newid \type{\int} the new Article ID
2082 public function resetArticleID( $newid ) {
2083 $linkCache = LinkCache
::singleton();
2084 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2086 if ( 0 == $newid ) { $this->mArticleID
= -1; }
2087 else { $this->mArticleID
= $newid; }
2088 $this->mRestrictionsLoaded
= false;
2089 $this->mRestrictions
= array();
2093 * Updates page_touched for this page; called from LinksUpdate.php
2094 * @return \type{\bool} true if the update succeded
2096 public function invalidateCache() {
2097 if( wfReadOnly() ) {
2100 $dbw = wfGetDB( DB_MASTER
);
2101 $success = $dbw->update( 'page',
2102 array( 'page_touched' => $dbw->timestamp() ),
2106 HTMLFileCache
::clearFileCache( $this );
2111 * Prefix some arbitrary text with the namespace or interwiki prefix
2114 * @param $name \type{\string} the text
2115 * @return \type{\string} the prefixed text
2118 /* private */ function prefix( $name ) {
2120 if ( '' != $this->mInterwiki
) {
2121 $p = $this->mInterwiki
. ':';
2123 if ( 0 != $this->mNamespace
) {
2124 $p .= $this->getNsText() . ':';
2130 * Secure and split - main initialisation function for this object
2132 * Assumes that mDbkeyform has been set, and is urldecoded
2133 * and uses underscores, but not otherwise munged. This function
2134 * removes illegal characters, splits off the interwiki and
2135 * namespace prefixes, sets the other forms, and canonicalizes
2137 * @return \type{\bool} true on success
2139 private function secureAndSplit() {
2140 global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
2143 static $rxTc = false;
2145 # Matching titles will be held as illegal.
2147 # Any character not allowed is forbidden...
2148 '[^' . Title
::legalChars() . ']' .
2149 # URL percent encoding sequences interfere with the ability
2150 # to round-trip titles -- you can't link to them consistently.
2151 '|%[0-9A-Fa-f]{2}' .
2152 # XML/HTML character references produce similar issues.
2153 '|&[A-Za-z0-9\x80-\xff]+;' .
2155 '|&#x[0-9A-Fa-f]+;' .
2159 $this->mInterwiki
= $this->mFragment
= '';
2160 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2162 $dbkey = $this->mDbkeyform
;
2164 # Strip Unicode bidi override characters.
2165 # Sometimes they slip into cut-n-pasted page titles, where the
2166 # override chars get included in list displays.
2167 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2169 # Clean up whitespace
2171 $dbkey = preg_replace( '/[ _]+/', '_', $dbkey );
2172 $dbkey = trim( $dbkey, '_' );
2174 if ( '' == $dbkey ) {
2178 if( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2179 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2183 $this->mDbkeyform
= $dbkey;
2185 # Initial colon indicates main namespace rather than specified default
2186 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2187 if ( ':' == $dbkey{0} ) {
2188 $this->mNamespace
= NS_MAIN
;
2189 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2190 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2193 # Namespace or interwiki prefix
2195 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2198 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2200 if ( $ns = $wgContLang->getNsIndex( $p ) ) {
2201 # Ordinary namespace
2203 $this->mNamespace
= $ns;
2204 # For Talk:X pages, check if X has a "namespace" prefix
2205 if( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2206 if( $wgContLang->getNsIndex( $x[1] ) )
2207 return false; # Disallow Talk:File:x type titles...
2208 else if( Interwiki
::isValidInterwiki( $x[1] ) )
2209 return false; # Disallow Talk:Interwiki:x type titles...
2211 } elseif( Interwiki
::isValidInterwiki( $p ) ) {
2213 # Can't make a local interwiki link to an interwiki link.
2214 # That's just crazy!
2220 $this->mInterwiki
= $wgContLang->lc( $p );
2222 # Redundant interwiki prefix to the local wiki
2223 if ( 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) ) {
2224 if( $dbkey == '' ) {
2225 # Can't have an empty self-link
2228 $this->mInterwiki
= '';
2230 # Do another namespace split...
2234 # If there's an initial colon after the interwiki, that also
2235 # resets the default namespace
2236 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2237 $this->mNamespace
= NS_MAIN
;
2238 $dbkey = substr( $dbkey, 1 );
2241 # If there's no recognized interwiki or namespace,
2242 # then let the colon expression be part of the title.
2247 # We already know that some pages won't be in the database!
2249 if ( '' != $this->mInterwiki || NS_SPECIAL
== $this->mNamespace
) {
2250 $this->mArticleID
= 0;
2252 $fragment = strstr( $dbkey, '#' );
2253 if ( false !== $fragment ) {
2254 $this->setFragment( $fragment );
2255 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2256 # remove whitespace again: prevents "Foo_bar_#"
2257 # becoming "Foo_bar_"
2258 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2261 # Reject illegal characters.
2263 if( preg_match( $rxTc, $dbkey ) ) {
2268 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2269 * reachable due to the way web browsers deal with 'relative' URLs.
2270 * Also, they conflict with subpage syntax. Forbid them explicitly.
2272 if ( strpos( $dbkey, '.' ) !== false &&
2273 ( $dbkey === '.' ||
$dbkey === '..' ||
2274 strpos( $dbkey, './' ) === 0 ||
2275 strpos( $dbkey, '../' ) === 0 ||
2276 strpos( $dbkey, '/./' ) !== false ||
2277 strpos( $dbkey, '/../' ) !== false ||
2278 substr( $dbkey, -2 ) == '/.' ||
2279 substr( $dbkey, -3 ) == '/..' ) )
2285 * Magic tilde sequences? Nu-uh!
2287 if( strpos( $dbkey, '~~~' ) !== false ) {
2292 * Limit the size of titles to 255 bytes.
2293 * This is typically the size of the underlying database field.
2294 * We make an exception for special pages, which don't need to be stored
2295 * in the database, and may edge over 255 bytes due to subpage syntax
2296 * for long titles, e.g. [[Special:Block/Long name]]
2298 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2299 strlen( $dbkey ) > 512 )
2305 * Normally, all wiki links are forced to have
2306 * an initial capital letter so [[foo]] and [[Foo]]
2307 * point to the same place.
2309 * Don't force it for interwikis, since the other
2310 * site might be case-sensitive.
2312 $this->mUserCaseDBKey
= $dbkey;
2313 if( $wgCapitalLinks && $this->mInterwiki
== '') {
2314 $dbkey = $wgContLang->ucfirst( $dbkey );
2318 * Can't make a link to a namespace alone...
2319 * "empty" local links can only be self-links
2320 * with a fragment identifier.
2323 $this->mInterwiki
== '' &&
2324 $this->mNamespace
!= NS_MAIN
) {
2327 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2328 // IP names are not allowed for accounts, and can only be referring to
2329 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2330 // there are numerous ways to present the same IP. Having sp:contribs scan
2331 // them all is silly and having some show the edits and others not is
2332 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2333 $dbkey = ($this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
) ?
2334 IP
::sanitizeIP( $dbkey ) : $dbkey;
2335 // Any remaining initial :s are illegal.
2336 if ( $dbkey !== '' && ':' == $dbkey{0} ) {
2341 $this->mDbkeyform
= $dbkey;
2342 $this->mUrlform
= wfUrlencode( $dbkey );
2344 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2350 * Set the fragment for this title. Removes the first character from the
2351 * specified fragment before setting, so it assumes you're passing it with
2354 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2355 * Still in active use privately.
2357 * @param $fragment \type{\string} text
2359 public function setFragment( $fragment ) {
2360 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2364 * Get a Title object associated with the talk page of this article
2365 * @return \type{Title} the object for the talk page
2367 public function getTalkPage() {
2368 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2372 * Get a title object associated with the subject page of this
2375 * @return \type{Title} the object for the subject page
2377 public function getSubjectPage() {
2378 // Is this the same title?
2379 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
2380 if( $this->getNamespace() == $subjectNS ) {
2383 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
2387 * Get an array of Title objects linking to this Title
2388 * Also stores the IDs in the link cache.
2390 * WARNING: do not use this function on arbitrary user-supplied titles!
2391 * On heavily-used templates it will max out the memory.
2393 * @param array $options may be FOR UPDATE
2394 * @return \type{\arrayof{Title}} the Title objects linking here
2396 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
2397 $linkCache = LinkCache
::singleton();
2399 if ( count( $options ) > 0 ) {
2400 $db = wfGetDB( DB_MASTER
);
2402 $db = wfGetDB( DB_SLAVE
);
2405 $res = $db->select( array( 'page', $table ),
2406 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect' ),
2408 "{$prefix}_from=page_id",
2409 "{$prefix}_namespace" => $this->getNamespace(),
2410 "{$prefix}_title" => $this->getDBkey() ),
2415 if ( $db->numRows( $res ) ) {
2416 foreach( $res as $row ) {
2417 if ( $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
) ) {
2418 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
);
2419 $retVal[] = $titleObj;
2423 $db->freeResult( $res );
2428 * Get an array of Title objects using this Title as a template
2429 * Also stores the IDs in the link cache.
2431 * WARNING: do not use this function on arbitrary user-supplied titles!
2432 * On heavily-used templates it will max out the memory.
2434 * @param array $options may be FOR UPDATE
2435 * @return \type{\arrayof{Title}} the Title objects linking here
2437 public function getTemplateLinksTo( $options = array() ) {
2438 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2442 * Get an array of Title objects referring to non-existent articles linked from this page
2444 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2445 * @return \type{\arrayof{Title}} the Title objects
2447 public function getBrokenLinksFrom() {
2448 if ( $this->getArticleId() == 0 ) {
2449 # All links from article ID 0 are false positives
2453 $dbr = wfGetDB( DB_SLAVE
);
2454 $res = $dbr->select(
2455 array( 'page', 'pagelinks' ),
2456 array( 'pl_namespace', 'pl_title' ),
2458 'pl_from' => $this->getArticleId(),
2459 'page_namespace IS NULL'
2461 __METHOD__
, array(),
2465 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
2471 foreach( $res as $row ) {
2472 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2479 * Get a list of URLs to purge from the Squid cache when this
2482 * @return \type{\arrayof{\string}} the URLs
2484 public function getSquidURLs() {
2488 $this->getInternalURL(),
2489 $this->getInternalURL( 'action=history' )
2492 // purge variant urls as well
2493 if($wgContLang->hasVariants()){
2494 $variants = $wgContLang->getVariants();
2495 foreach($variants as $vCode){
2496 if($vCode==$wgContLang->getCode()) continue; // we don't want default variant
2497 $urls[] = $this->getInternalURL('',$vCode);
2505 * Purge all applicable Squid URLs
2507 public function purgeSquid() {
2509 if ( $wgUseSquid ) {
2510 $urls = $this->getSquidURLs();
2511 $u = new SquidUpdate( $urls );
2517 * Move this page without authentication
2518 * @param &$nt \type{Title} the new page Title
2520 public function moveNoAuth( &$nt ) {
2521 return $this->moveTo( $nt, false );
2525 * Check whether a given move operation would be valid.
2526 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2527 * @param &$nt \type{Title} the new title
2528 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2530 * @param $reason \type{\string} is the log summary of the move, used for spam checking
2531 * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure
2533 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2538 // Normally we'd add this to $errors, but we'll get
2539 // lots of syntax errors if $nt is not an object
2540 return array(array('badtitletext'));
2542 if( $this->equals( $nt ) ) {
2543 $errors[] = array('selfmove');
2545 if( !$this->isMovable() ) {
2546 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2548 if ( $nt->getInterwiki() != '' ) {
2549 $errors[] = array( 'immobile-target-namespace-iw' );
2551 if ( !$nt->isMovable() ) {
2552 $errors[] = array('immobile-target-namespace', $nt->getNsText() );
2555 $oldid = $this->getArticleID();
2556 $newid = $nt->getArticleID();
2558 if ( strlen( $nt->getDBkey() ) < 1 ) {
2559 $errors[] = array('articleexists');
2561 if ( ( '' == $this->getDBkey() ) ||
2563 ( '' == $nt->getDBkey() ) ) {
2564 $errors[] = array('badarticleerror');
2567 // Image-specific checks
2568 if( $this->getNamespace() == NS_FILE
) {
2569 $file = wfLocalFile( $this );
2570 if( $file->exists() ) {
2571 if( $nt->getNamespace() != NS_FILE
) {
2572 $errors[] = array('imagenocrossnamespace');
2574 if( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
2575 $errors[] = array('imageinvalidfilename');
2577 if( !File
::checkExtensionCompatibility( $file, $nt->getDBKey() ) ) {
2578 $errors[] = array('imagetypemismatch');
2584 $errors = wfMergeErrorArrays( $errors,
2585 $this->getUserPermissionsErrors('move', $wgUser),
2586 $this->getUserPermissionsErrors('edit', $wgUser),
2587 $nt->getUserPermissionsErrors('move-target', $wgUser),
2588 $nt->getUserPermissionsErrors('edit', $wgUser) );
2591 $match = EditPage
::matchSpamRegex( $reason );
2592 if( $match !== false ) {
2593 // This is kind of lame, won't display nice
2594 $errors[] = array('spamprotectiontext');
2598 if( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
2599 $errors[] = array('hookaborted', $err);
2602 # The move is allowed only if (1) the target doesn't exist, or
2603 # (2) the target is a redirect to the source, and has no history
2604 # (so we can undo bad moves right after they're done).
2606 if ( 0 != $newid ) { # Target exists; check for validity
2607 if ( ! $this->isValidMoveTarget( $nt ) ) {
2608 $errors[] = array('articleexists');
2611 $tp = $nt->getTitleProtection();
2612 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
2613 if ( $tp and !$wgUser->isAllowed( $right ) ) {
2614 $errors[] = array('cantmove-titleprotected');
2623 * Move a title to a new location
2624 * @param &$nt \type{Title} the new title
2625 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2627 * @param $reason \type{\string} The reason for the move
2628 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title.
2629 * Ignored if the user doesn't have the suppressredirect right.
2630 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2632 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
2633 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
2634 if( is_array( $err ) ) {
2638 $pageid = $this->getArticleID();
2639 $protected = $this->isProtected();
2640 if( $nt->exists() ) {
2641 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
2642 $pageCountChange = ($createRedirect ?
0 : -1);
2643 } else { # Target didn't exist, do normal move.
2644 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
2645 $pageCountChange = ($createRedirect ?
1 : 0);
2648 if( is_array( $err ) ) {
2651 $redirid = $this->getArticleID();
2653 // Category memberships include a sort key which may be customized.
2654 // If it's left as the default (the page title), we need to update
2655 // the sort key to match the new title.
2657 // Be careful to avoid resetting cl_timestamp, which may disturb
2658 // time-based lists on some sites.
2660 // Warning -- if the sort key is *explicitly* set to the old title,
2661 // we can't actually distinguish it from a default here, and it'll
2662 // be set to the new title even though it really shouldn't.
2663 // It'll get corrected on the next edit, but resetting cl_timestamp.
2664 $dbw = wfGetDB( DB_MASTER
);
2665 $dbw->update( 'categorylinks',
2667 'cl_sortkey' => $nt->getPrefixedText(),
2668 'cl_timestamp=cl_timestamp' ),
2670 'cl_from' => $pageid,
2671 'cl_sortkey' => $this->getPrefixedText() ),
2675 # Protect the redirect title as the title used to be...
2676 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
2678 'pr_page' => $redirid,
2679 'pr_type' => 'pr_type',
2680 'pr_level' => 'pr_level',
2681 'pr_cascade' => 'pr_cascade',
2682 'pr_user' => 'pr_user',
2683 'pr_expiry' => 'pr_expiry'
2685 array( 'pr_page' => $pageid ),
2689 # Update the protection log
2690 $log = new LogPage( 'protect' );
2691 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2692 if( $reason ) $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
2693 $log->addEntry( 'move_prot', $nt, $comment, array($this->getPrefixedText()) ); // FIXME: $params?
2697 $oldnamespace = $this->getNamespace() & ~
1;
2698 $newnamespace = $nt->getNamespace() & ~
1;
2699 $oldtitle = $this->getDBkey();
2700 $newtitle = $nt->getDBkey();
2702 if( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
2703 WatchedItem
::duplicateEntries( $this, $nt );
2706 # Update search engine
2707 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
2709 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
2713 if( $this->isContentPage() && !$nt->isContentPage() ) {
2714 # No longer a content page
2715 # Not viewed, edited, removing
2716 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
2717 } elseif( !$this->isContentPage() && $nt->isContentPage() ) {
2718 # Now a content page
2719 # Not viewed, edited, adding
2720 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
2721 } elseif( $pageCountChange ) {
2723 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
2730 # Update message cache for interface messages
2731 if( $nt->getNamespace() == NS_MEDIAWIKI
) {
2732 global $wgMessageCache;
2733 $oldarticle = new Article( $this );
2734 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
2735 $newarticle = new Article( $nt );
2736 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
2740 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
2745 * Move page to a title which is at present a redirect to the
2748 * @param &$nt \type{Title} the page to move to, which should currently
2750 * @param $reason \type{\string} The reason for the move
2751 * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title.
2752 * Ignored if the user doesn't have the suppressredirect right
2754 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
2755 global $wgUseSquid, $wgUser;
2756 $fname = 'Title::moveOverExistingRedirect';
2757 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
2760 $comment .= ": $reason";
2763 $now = wfTimestampNow();
2764 $newid = $nt->getArticleID();
2765 $oldid = $this->getArticleID();
2766 $latest = $this->getLatestRevID();
2768 $dbw = wfGetDB( DB_MASTER
);
2770 # Delete the old redirect. We don't save it to history since
2771 # by definition if we've got here it's rather uninteresting.
2772 # We have to remove it so that the next step doesn't trigger
2773 # a conflict on the unique namespace+title index...
2774 $dbw->delete( 'page', array( 'page_id' => $newid ), $fname );
2775 if ( !$dbw->cascadingDeletes() ) {
2776 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
2777 global $wgUseTrackbacks;
2778 if ($wgUseTrackbacks)
2779 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
2780 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
2781 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
2782 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
2783 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
2784 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
2785 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
2786 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
2789 # Save a null revision in the page's history notifying of the move
2790 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2791 $nullRevId = $nullRevision->insertOn( $dbw );
2793 $article = new Article( $this );
2794 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $wgUser) );
2796 # Change the name of the target page:
2797 $dbw->update( 'page',
2799 'page_touched' => $dbw->timestamp($now),
2800 'page_namespace' => $nt->getNamespace(),
2801 'page_title' => $nt->getDBkey(),
2802 'page_latest' => $nullRevId,
2804 /* WHERE */ array( 'page_id' => $oldid ),
2807 $nt->resetArticleID( $oldid );
2809 # Recreate the redirect, this time in the other direction.
2810 if( $createRedirect ||
!$wgUser->isAllowed('suppressredirect') ) {
2811 $mwRedir = MagicWord
::get( 'redirect' );
2812 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2813 $redirectArticle = new Article( $this );
2814 $newid = $redirectArticle->insertOn( $dbw );
2815 $redirectRevision = new Revision( array(
2817 'comment' => $comment,
2818 'text' => $redirectText ) );
2819 $redirectRevision->insertOn( $dbw );
2820 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2822 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false, $wgUser) );
2824 # Now, we record the link from the redirect to the new title.
2825 # It should have no other outgoing links...
2826 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), $fname );
2827 $dbw->insert( 'pagelinks',
2829 'pl_from' => $newid,
2830 'pl_namespace' => $nt->getNamespace(),
2831 'pl_title' => $nt->getDBkey() ),
2833 $redirectSuppressed = false;
2835 $this->resetArticleID( 0 );
2836 $redirectSuppressed = true;
2839 # Move an image if this is a file
2840 if( $this->getNamespace() == NS_FILE
) {
2841 $file = wfLocalFile( $this );
2842 if( $file->exists() ) {
2843 $status = $file->move( $nt );
2844 if( !$status->isOk() ) {
2846 return $status->getErrorsArray();
2852 $log = new LogPage( 'move' );
2853 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2856 if ( $wgUseSquid ) {
2857 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
2858 $u = new SquidUpdate( $urls );
2865 * Move page to non-existing title.
2866 * @param &$nt \type{Title} the new Title
2867 * @param $reason \type{\string} The reason for the move
2868 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title
2869 * Ignored if the user doesn't have the suppressredirect right
2871 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
2872 global $wgUseSquid, $wgUser;
2873 $fname = 'MovePageForm::moveToNewTitle';
2874 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
2876 $comment .= wfMsgExt( 'colon-separator',
2877 array( 'escapenoentities', 'content' ) );
2878 $comment .= $reason;
2881 $newid = $nt->getArticleID();
2882 $oldid = $this->getArticleID();
2883 $latest = $this->getLatestRevId();
2885 $dbw = wfGetDB( DB_MASTER
);
2886 $now = $dbw->timestamp();
2888 # Save a null revision in the page's history notifying of the move
2889 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
2890 $nullRevId = $nullRevision->insertOn( $dbw );
2892 $article = new Article( $this );
2893 wfRunHooks( 'NewRevisionFromEditComplete', array($article, $nullRevision, $latest, $wgUser) );
2896 $dbw->update( 'page',
2898 'page_touched' => $now,
2899 'page_namespace' => $nt->getNamespace(),
2900 'page_title' => $nt->getDBkey(),
2901 'page_latest' => $nullRevId,
2903 /* WHERE */ array( 'page_id' => $oldid ),
2906 $nt->resetArticleID( $oldid );
2908 if( $createRedirect ||
!$wgUser->isAllowed('suppressredirect') ) {
2910 $mwRedir = MagicWord
::get( 'redirect' );
2911 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
2912 $redirectArticle = new Article( $this );
2913 $newid = $redirectArticle->insertOn( $dbw );
2914 $redirectRevision = new Revision( array(
2916 'comment' => $comment,
2917 'text' => $redirectText ) );
2918 $redirectRevision->insertOn( $dbw );
2919 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
2921 wfRunHooks( 'NewRevisionFromEditComplete', array($redirectArticle, $redirectRevision, false, $wgUser) );
2923 # Record the just-created redirect's linking to the page
2924 $dbw->insert( 'pagelinks',
2926 'pl_from' => $newid,
2927 'pl_namespace' => $nt->getNamespace(),
2928 'pl_title' => $nt->getDBkey() ),
2930 $redirectSuppressed = false;
2932 $this->resetArticleID( 0 );
2933 $redirectSuppressed = true;
2936 # Move an image if this is a file
2937 if( $this->getNamespace() == NS_FILE
) {
2938 $file = wfLocalFile( $this );
2939 if( $file->exists() ) {
2940 $status = $file->move( $nt );
2941 if( !$status->isOk() ) {
2943 return $status->getErrorsArray();
2949 $log = new LogPage( 'move' );
2950 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2952 # Purge caches as per article creation
2953 Article
::onArticleCreate( $nt );
2955 # Purge old title from squid
2956 # The new title, and links to the new title, are purged in Article::onArticleCreate()
2957 $this->purgeSquid();
2962 * Move this page's subpages to be subpages of $nt
2963 * @param $nt Title Move target
2964 * @param $auth bool Whether $wgUser's permissions should be checked
2965 * @param $reason string The reason for the move
2966 * @param $createRedirect bool Whether to create redirects from the old subpages to the new ones
2967 * Ignored if the user doesn't have the 'suppressredirect' right
2968 * @return mixed array with old page titles as keys, and strings (new page titles) or
2969 * arrays (errors) as values, or an error array with numeric indices if no pages were moved
2971 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
2972 global $wgUser, $wgMaximumMovedPages;
2973 // Check permissions
2974 if( !$this->userCan( 'move-subpages' ) )
2975 return array( 'cant-move-subpages' );
2976 // Do the source and target namespaces support subpages?
2977 if( !MWNamespace
::hasSubpages( $this->getNamespace() ) )
2978 return array( 'namespace-nosubpages',
2979 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
2980 if( !MWNamespace
::hasSubpages( $nt->getNamespace() ) )
2981 return array( 'namespace-nosubpages',
2982 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
2984 $subpages = $this->getSubpages($wgMaximumMovedPages +
1);
2987 foreach( $subpages as $oldSubpage ) {
2989 if( $count > $wgMaximumMovedPages ) {
2990 $retval[$oldSubpage->getPrefixedTitle()] =
2991 array( 'movepage-max-pages',
2992 $wgMaximumMovedPages );
2996 if( $oldSubpage->getArticleId() == $this->getArticleId() )
2997 // When moving a page to a subpage of itself,
2998 // don't move it twice
3000 $newPageName = preg_replace(
3001 '#^'.preg_quote( $this->getDBKey(), '#' ).'#',
3002 $nt->getDBKey(), $oldSubpage->getDBKey() );
3003 if( $oldSubpage->isTalkPage() ) {
3004 $newNs = $nt->getTalkPage()->getNamespace();
3006 $newNs = $nt->getSubjectPage()->getNamespace();
3008 # Bug 14385: we need makeTitleSafe because the new page names may
3009 # be longer than 255 characters.
3010 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3012 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3013 if( $success === true ) {
3014 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3016 $retval[$oldSubpage->getPrefixedText()] = $success;
3023 * Checks if this page is just a one-rev redirect.
3024 * Adds lock, so don't use just for light purposes.
3026 * @return \type{\bool} TRUE or FALSE
3028 public function isSingleRevRedirect() {
3029 $dbw = wfGetDB( DB_MASTER
);
3031 $row = $dbw->selectRow( 'page',
3032 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3035 array( 'FOR UPDATE' )
3037 # Cache some fields we may want
3038 $this->mArticleID
= $row ?
intval($row->page_id
) : 0;
3039 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3040 $this->mLatestID
= $row ?
intval($row->page_latest
) : false;
3041 if( !$this->mRedirect
) {
3044 # Does the article have a history?
3045 $row = $dbw->selectField( array( 'page', 'revision'),
3047 array( 'page_namespace' => $this->getNamespace(),
3048 'page_title' => $this->getDBkey(),
3050 'page_latest != rev_id'
3053 array( 'FOR UPDATE' )
3055 # Return true if there was no history
3056 return ($row === false);
3060 * Checks if $this can be moved to a given Title
3061 * - Selects for update, so don't call it unless you mean business
3063 * @param &$nt \type{Title} the new title to check
3064 * @return \type{\bool} TRUE or FALSE
3066 public function isValidMoveTarget( $nt ) {
3067 $dbw = wfGetDB( DB_MASTER
);
3068 # Is it an existsing file?
3069 if( $nt->getNamespace() == NS_FILE
) {
3070 $file = wfLocalFile( $nt );
3071 if( $file->exists() ) {
3072 wfDebug( __METHOD__
. ": file exists\n" );
3076 # Is it a redirect with no history?
3077 if( !$nt->isSingleRevRedirect() ) {
3078 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3081 # Get the article text
3082 $rev = Revision
::newFromTitle( $nt );
3083 $text = $rev->getText();
3084 # Does the redirect point to the source?
3085 # Or is it a broken self-redirect, usually caused by namespace collisions?
3087 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3088 $redirTitle = Title
::newFromText( $m[1] );
3089 if( !is_object( $redirTitle ) ||
3090 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3091 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3092 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3097 wfDebug( __METHOD__
. ": failsafe\n" );
3104 * Can this title be added to a user's watchlist?
3106 * @return \type{\bool} TRUE or FALSE
3108 public function isWatchable() {
3109 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
3113 * Get categories to which this Title belongs and return an array of
3114 * categories' names.
3116 * @return \type{\array} array an array of parents in the form:
3117 * $parent => $currentarticle
3119 public function getParentCategories() {
3122 $titlekey = $this->getArticleId();
3123 $dbr = wfGetDB( DB_SLAVE
);
3124 $categorylinks = $dbr->tableName( 'categorylinks' );
3127 $sql = "SELECT * FROM $categorylinks"
3128 ." WHERE cl_from='$titlekey'"
3129 ." AND cl_from <> '0'"
3130 ." ORDER BY cl_sortkey";
3132 $res = $dbr->query( $sql );
3134 if( $dbr->numRows( $res ) > 0 ) {
3135 foreach( $res as $row )
3136 //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3137 $data[$wgContLang->getNSText( NS_CATEGORY
).':'.$row->cl_to
] = $this->getFullText();
3138 $dbr->freeResult( $res );
3146 * Get a tree of parent categories
3147 * @param $children \type{\array} an array with the children in the keys, to check for circular refs
3148 * @return \type{\array} Tree of parent categories
3150 public function getParentCategoryTree( $children = array() ) {
3152 $parents = $this->getParentCategories();
3155 foreach( $parents as $parent => $current ) {
3156 if ( array_key_exists( $parent, $children ) ) {
3157 # Circular reference
3158 $stack[$parent] = array();
3160 $nt = Title
::newFromText($parent);
3162 $stack[$parent] = $nt->getParentCategoryTree( $children +
array($parent => 1) );
3174 * Get an associative array for selecting this title from
3177 * @return \type{\array} Selection array
3179 public function pageCond() {
3180 if( $this->mArticleID
> 0 ) {
3181 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3182 return array( 'page_id' => $this->mArticleID
);
3184 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3189 * Get the revision ID of the previous revision
3191 * @param $revId \type{\int} Revision ID. Get the revision that was before this one.
3192 * @param $flags \type{\int} GAID_FOR_UPDATE
3193 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3195 public function getPreviousRevisionID( $revId, $flags=0 ) {
3196 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3197 return $db->selectField( 'revision', 'rev_id',
3199 'rev_page' => $this->getArticleId($flags),
3200 'rev_id < ' . intval( $revId )
3203 array( 'ORDER BY' => 'rev_id DESC' )
3208 * Get the revision ID of the next revision
3210 * @param $revId \type{\int} Revision ID. Get the revision that was after this one.
3211 * @param $flags \type{\int} GAID_FOR_UPDATE
3212 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3214 public function getNextRevisionID( $revId, $flags=0 ) {
3215 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3216 return $db->selectField( 'revision', 'rev_id',
3218 'rev_page' => $this->getArticleId($flags),
3219 'rev_id > ' . intval( $revId )
3222 array( 'ORDER BY' => 'rev_id' )
3227 * Get the first revision of the page
3229 * @param $flags \type{\int} GAID_FOR_UPDATE
3230 * @return Revision (or NULL if page doesn't exist)
3232 public function getFirstRevision( $flags=0 ) {
3233 $db = ($flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3234 $pageId = $this->getArticleId($flags);
3235 if( !$pageId ) return NULL;
3236 $row = $db->selectRow( 'revision', '*',
3237 array( 'rev_page' => $pageId ),
3239 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3244 return new Revision( $row );
3249 * Check if this is a new page
3253 public function isNewPage() {
3254 $dbr = wfGetDB( DB_SLAVE
);
3255 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3259 * Get the oldest revision timestamp of this page
3261 * @return string, MW timestamp
3263 public function getEarliestRevTime() {
3264 $dbr = wfGetDB( DB_SLAVE
);
3265 if( $this->exists() ) {
3266 $min = $dbr->selectField( 'revision',
3267 'MIN(rev_timestamp)',
3268 array( 'rev_page' => $this->getArticleId() ),
3270 return wfTimestampOrNull( TS_MW
, $min );
3276 * Get the number of revisions between the given revision IDs.
3277 * Used for diffs and other things that really need it.
3279 * @param $old \type{\int} Revision ID.
3280 * @param $new \type{\int} Revision ID.
3281 * @return \type{\int} Number of revisions between these IDs.
3283 public function countRevisionsBetween( $old, $new ) {
3284 $dbr = wfGetDB( DB_SLAVE
);
3285 return $dbr->selectField( 'revision', 'count(*)',
3286 'rev_page = ' . intval( $this->getArticleId() ) .
3287 ' AND rev_id > ' . intval( $old ) .
3288 ' AND rev_id < ' . intval( $new ),
3290 array( 'USE INDEX' => 'PRIMARY' ) );
3294 * Compare with another title.
3296 * @param \type{Title} $title
3297 * @return \type{\bool} TRUE or FALSE
3299 public function equals( Title
$title ) {
3300 // Note: === is necessary for proper matching of number-like titles.
3301 return $this->getInterwiki() === $title->getInterwiki()
3302 && $this->getNamespace() == $title->getNamespace()
3303 && $this->getDBkey() === $title->getDBkey();
3307 * Callback for usort() to do title sorts by (namespace, title)
3309 static function compare( $a, $b ) {
3310 if( $a->getNamespace() == $b->getNamespace() ) {
3311 return strcmp( $a->getText(), $b->getText() );
3313 return $a->getNamespace() - $b->getNamespace();
3318 * Return a string representation of this title
3320 * @return \type{\string} String representation of this title
3322 public function __toString() {
3323 return $this->getPrefixedText();
3327 * Check if page exists. For historical reasons, this function simply
3328 * checks for the existence of the title in the page table, and will
3329 * thus return false for interwiki links, special pages and the like.
3330 * If you want to know if a title can be meaningfully viewed, you should
3331 * probably call the isKnown() method instead.
3333 * @return \type{\bool} TRUE or FALSE
3335 public function exists() {
3336 return $this->getArticleId() != 0;
3340 * Should links to this title be shown as potentially viewable (i.e. as
3341 * "bluelinks"), even if there's no record by this title in the page
3344 * This function is semi-deprecated for public use, as well as somewhat
3345 * misleadingly named. You probably just want to call isKnown(), which
3346 * calls this function internally.
3348 * (ISSUE: Most of these checks are cheap, but the file existence check
3349 * can potentially be quite expensive. Including it here fixes a lot of
3350 * existing code, but we might want to add an optional parameter to skip
3351 * it and any other expensive checks.)
3353 * @return \type{\bool} TRUE or FALSE
3355 public function isAlwaysKnown() {
3356 if( $this->mInterwiki
!= '' ) {
3357 return true; // any interwiki link might be viewable, for all we know
3359 switch( $this->mNamespace
) {
3362 return wfFindFile( $this ); // file exists, possibly in a foreign repo
3364 return SpecialPage
::exists( $this->getDBKey() ); // valid special page
3366 return $this->mDbkeyform
== ''; // selflink, possibly with fragment
3368 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3369 // the full l10n of that language to be loaded. That takes much memory and
3370 // isn't needed. So we strip the language part away.
3371 // Also, extension messages which are not loaded, are shown as red, because
3372 // we don't call MessageCache::loadAllMessages.
3373 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
3374 return wfMsgWeirdKey( $basename ); // known system message
3381 * Does this title refer to a page that can (or might) be meaningfully
3382 * viewed? In particular, this function may be used to determine if
3383 * links to the title should be rendered as "bluelinks" (as opposed to
3384 * "redlinks" to non-existent pages).
3386 * @return \type{\bool} TRUE or FALSE
3388 public function isKnown() {
3389 return $this->exists() ||
$this->isAlwaysKnown();
3393 * Is this in a namespace that allows actual pages?
3395 * @return \type{\bool} TRUE or FALSE
3397 public function canExist() {
3398 return $this->mNamespace
>= 0 && $this->mNamespace
!= NS_MEDIA
;
3402 * Update page_touched timestamps and send squid purge messages for
3403 * pages linking to this title. May be sent to the job queue depending
3404 * on the number of links. Typically called on create and delete.
3406 public function touchLinks() {
3407 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3410 if ( $this->getNamespace() == NS_CATEGORY
) {
3411 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3417 * Get the last touched timestamp
3418 * @param Database $db, optional db
3419 * @return \type{\string} Last touched timestamp
3421 public function getTouched( $db = NULL ) {
3422 $db = isset($db) ?
$db : wfGetDB( DB_SLAVE
);
3423 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
3428 * Get the timestamp when this page was updated since the user last saw it.
3430 * @return mixed string/NULL
3432 public function getNotificationTimestamp( $user = NULL ) {
3433 global $wgUser, $wgShowUpdatedMarker;
3434 // Assume current user if none given
3435 if( !$user ) $user = $wgUser;
3436 // Check cache first
3437 $uid = $user->getId();
3438 if( isset($this->mNotificationTimestamp
[$uid]) ) {
3439 return $this->mNotificationTimestamp
[$uid];
3441 if( !$uid ||
!$wgShowUpdatedMarker ) {
3442 return $this->mNotificationTimestamp
[$uid] = false;
3444 // Don't cache too much!
3445 if( count($this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
3446 $this->mNotificationTimestamp
= array();
3448 $dbr = wfGetDB( DB_SLAVE
);
3449 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
3450 'wl_notificationtimestamp',
3451 array( 'wl_namespace' => $this->getNamespace(),
3452 'wl_title' => $this->getDBkey(),
3453 'wl_user' => $user->getId()
3457 return $this->mNotificationTimestamp
[$uid];
3461 * Get the trackback URL for this page
3462 * @return \type{\string} Trackback URL
3464 public function trackbackURL() {
3465 global $wgScriptPath, $wgServer;
3467 return "$wgServer$wgScriptPath/trackback.php?article="
3468 . htmlspecialchars(urlencode($this->getPrefixedDBkey()));
3472 * Get the trackback RDF for this page
3473 * @return \type{\string} Trackback RDF
3475 public function trackbackRDF() {
3476 $url = htmlspecialchars($this->getFullURL());
3477 $title = htmlspecialchars($this->getText());
3478 $tburl = $this->trackbackURL();
3480 // Autodiscovery RDF is placed in comments so HTML validator
3481 // won't barf. This is a rather icky workaround, but seems
3482 // frequently used by this kind of RDF thingy.
3484 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3486 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3487 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3488 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3491 dc:identifier=\"$url\"
3493 trackback:ping=\"$tburl\" />
3499 * Generate strings used for xml 'id' names in monobook tabs
3500 * @return \type{\string} XML 'id' name
3502 public function getNamespaceKey() {
3504 switch ($this->getNamespace()) {
3507 return 'nstab-main';
3510 return 'nstab-user';
3512 return 'nstab-media';
3514 return 'nstab-special';
3516 case NS_PROJECT_TALK
:
3517 return 'nstab-project';
3520 return 'nstab-image';
3522 case NS_MEDIAWIKI_TALK
:
3523 return 'nstab-mediawiki';
3525 case NS_TEMPLATE_TALK
:
3526 return 'nstab-template';
3529 return 'nstab-help';
3531 case NS_CATEGORY_TALK
:
3532 return 'nstab-category';
3534 return 'nstab-' . $wgContLang->lc( $this->getSubjectNsText() );
3539 * Returns true if this title resolves to the named special page
3540 * @param $name \type{\string} The special page name
3542 public function isSpecial( $name ) {
3543 if ( $this->getNamespace() == NS_SPECIAL
) {
3544 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
3545 if ( $name == $thisName ) {
3553 * If the Title refers to a special page alias which is not the local default,
3554 * @return \type{Title} A new Title which points to the local default. Otherwise, returns $this.
3556 public function fixSpecialName() {
3557 if ( $this->getNamespace() == NS_SPECIAL
) {
3558 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
3559 if ( $canonicalName ) {
3560 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
3561 if ( $localName != $this->mDbkeyform
) {
3562 return Title
::makeTitle( NS_SPECIAL
, $localName );
3570 * Is this Title in a namespace which contains content?
3571 * In other words, is this a content page, for the purposes of calculating
3574 * @return \type{\bool} TRUE or FALSE
3576 public function isContentPage() {
3577 return MWNamespace
::isContent( $this->getNamespace() );
3581 * Get all extant redirects to this Title
3583 * @param $ns \twotypes{\int,\null} Single namespace to consider;
3584 * NULL to consider all namespaces
3585 * @return \type{\arrayof{Title}} Redirects to this title
3587 public function getRedirectsHere( $ns = null ) {
3590 $dbr = wfGetDB( DB_SLAVE
);
3592 'rd_namespace' => $this->getNamespace(),
3593 'rd_title' => $this->getDBkey(),
3596 if ( !is_null($ns) ) $where['page_namespace'] = $ns;
3598 $res = $dbr->select(
3599 array( 'redirect', 'page' ),
3600 array( 'page_namespace', 'page_title' ),
3606 foreach( $res as $row ) {
3607 $redirs[] = self
::newFromRow( $row );
3613 * Check if this Title is a valid redirect target
3615 * @return \type{\bool} TRUE or FALSE
3617 public function isValidRedirectTarget() {
3618 global $wgInvalidRedirectTargets;
3620 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
3621 if( $this->isSpecial( 'Userlogout' ) ) {
3625 foreach( $wgInvalidRedirectTargets as $target ) {
3626 if( $this->isSpecial( $target ) ) {
3635 * Get a backlink cache object
3637 function getBacklinkCache() {
3638 if ( is_null( $this->mBacklinkCache
) ) {
3639 $this->mBacklinkCache
= new BacklinkCache( $this );
3641 return $this->mBacklinkCache
;