8 * @todo: determine if it is really necessary to load this. Appears to be left over from pre-autoloader versions, and
9 * is only really needed to provide access to constant UTF8_REPLACEMENT, which actually resides in UtfNormalDefines.php
10 * and is loaded by UtfNormalUtil.php, which is loaded by UtfNormal.php.
12 if ( !class_exists( 'UtfNormal' ) ) {
13 require_once( dirname( __FILE__
) . '/normal/UtfNormal.php' );
16 define ( 'GAID_FOR_UPDATE', 1 );
19 * Represents a title within MediaWiki.
20 * Optionally may contain an interwiki designation or namespace.
21 * @note This class can fetch various kinds of data from the database;
22 * however, it does so inefficiently.
24 * @internal documentation reviewed 15 Mar 2010
27 /** @name Static cache variables */
29 static private $titleCache = array();
30 static private $interwikiCache = array();
34 * Title::newFromText maintains a cache to avoid expensive re-normalization of
35 * commonly used titles. On a batch operation this can become a memory leak
36 * if not bounded. After hitting this many titles reset the cache.
38 const CACHE_MAX
= 1000;
42 * @name Private member variables
43 * Please use the accessor functions instead.
48 var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
49 var $mUrlform = ''; // /< URL-encoded form of the main part
50 var $mDbkeyform = ''; // /< Main part with underscores
51 var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
52 var $mNamespace = NS_MAIN
; // /< Namespace index, i.e. one of the NS_xxxx constants
53 var $mInterwiki = ''; // /< Interwiki prefix (or null string)
54 var $mFragment; // /< Title fragment (i.e. the bit after the #)
55 var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
56 var $mLatestID = false; // /< ID of most recent revision
57 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
58 var $mOldRestrictions = false;
59 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
60 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
61 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
62 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
63 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
64 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
65 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
66 var $mTitleProtection; ///< Cached value of getTitleProtection
67 # Don't change the following default, NS_MAIN is hardcoded in several
68 # places. See bug 696.
69 var $mDefaultNamespace = NS_MAIN
; // /< Namespace index when there is no namespace
70 # Zero except in {{transclusion}} tags
71 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
72 var $mLength = -1; // /< The page length, 0 for special pages
73 var $mRedirect = null; // /< Is the article at this title a redirect?
74 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
75 var $mBacklinkCache = null; // /< Cache of links to this title
83 /* private */ function __construct() { }
86 * Create a new Title from a prefixed DB key
88 * @param $key \type{\string} The database key, which has underscores
89 * instead of spaces, possibly including namespace and
91 * @return \type{Title} the new object, or NULL on an error
93 public static function newFromDBkey( $key ) {
95 $t->mDbkeyform
= $key;
96 if ( $t->secureAndSplit() )
103 * Create a new Title from text, such as what one would find in a link. De-
104 * codes any HTML entities in the text.
106 * @param $text string The link text; spaces, prefixes, and an
107 * initial ':' indicating the main namespace are accepted.
108 * @param $defaultNamespace int The namespace to use if none is speci-
109 * fied by a prefix. If you want to force a specific namespace even if
110 * $text might begin with a namespace prefix, use makeTitle() or
112 * @return Title The new object, or null on an error.
114 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
115 if ( is_object( $text ) ) {
116 throw new MWException( 'Title::newFromText given an object' );
120 * Wiki pages often contain multiple links to the same page.
121 * Title normalization and parsing can become expensive on
122 * pages with many links, so we can save a little time by
125 * In theory these are value objects and won't get changed...
127 if ( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
128 return Title
::$titleCache[$text];
132 * Convert things like é ā or 〗 into normalized(bug 14952) text
134 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
137 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
138 $t->mDefaultNamespace
= $defaultNamespace;
140 static $cachedcount = 0 ;
141 if ( $t->secureAndSplit() ) {
142 if ( $defaultNamespace == NS_MAIN
) {
143 if ( $cachedcount >= self
::CACHE_MAX
) {
144 # Avoid memory leaks on mass operations...
145 Title
::$titleCache = array();
149 Title
::$titleCache[$text] =& $t;
159 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
161 * Example of wrong and broken code:
162 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
164 * Example of right code:
165 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
167 * Create a new Title from URL-encoded text. Ensures that
168 * the given title's length does not exceed the maximum.
170 * @param $url \type{\string} the title, as might be taken from a URL
171 * @return \type{Title} the new object, or NULL on an error
173 public static function newFromURL( $url ) {
174 global $wgLegalTitleChars;
177 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
178 # but some URLs used it as a space replacement and they still come
179 # from some external search tools.
180 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
181 $url = str_replace( '+', ' ', $url );
184 $t->mDbkeyform
= str_replace( ' ', '_', $url );
185 if ( $t->secureAndSplit() ) {
193 * Create a new Title from an article ID
195 * @param $id \type{\int} the page_id corresponding to the Title to create
196 * @param $flags \type{\int} use GAID_FOR_UPDATE to use master
197 * @return \type{Title} the new object, or NULL on an error
199 public static function newFromID( $id, $flags = 0 ) {
200 $db = ( $flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
201 $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__
);
202 if ( $row !== false ) {
203 $title = Title
::newFromRow( $row );
211 * Make an array of titles from an array of IDs
213 * @param $ids \type{\arrayof{\int}} Array of IDs
214 * @return \type{\arrayof{Title}} Array of Titles
216 public static function newFromIDs( $ids ) {
217 if ( !count( $ids ) ) {
220 $dbr = wfGetDB( DB_SLAVE
);
222 $res = $dbr->select( 'page', array( '*' ),
223 array( 'page_id' => $ids ), __METHOD__
);
226 foreach ( $res as $row ) {
227 $titles[] = Title
::newFromRow( $row );
233 * Make a Title object from a DB row
235 * @param $row \type{Row} (needs at least page_title,page_namespace)
236 * @return \type{Title} corresponding Title
238 public static function newFromRow( $row ) {
239 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
241 $t->mArticleID
= isset( $row->page_id
) ?
intval( $row->page_id
) : -1;
242 $t->mLength
= isset( $row->page_len
) ?
intval( $row->page_len
) : -1;
243 $t->mRedirect
= isset( $row->page_is_redirect
) ?
(bool)$row->page_is_redirect
: null;
244 $t->mLatestID
= isset( $row->page_latest
) ?
intval( $row->page_latest
) : false;
250 * Create a new Title from a namespace index and a DB key.
251 * It's assumed that $ns and $title are *valid*, for instance when
252 * they came directly from the database or a special page name.
253 * For convenience, spaces are converted to underscores so that
254 * eg user_text fields can be used directly.
256 * @param $ns \type{\int} the namespace of the article
257 * @param $title \type{\string} the unprefixed database key form
258 * @param $fragment \type{\string} The link fragment (after the "#")
259 * @param $interwiki \type{\string} The interwiki prefix
260 * @return \type{Title} the new object
262 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
264 $t->mInterwiki
= $interwiki;
265 $t->mFragment
= $fragment;
266 $t->mNamespace
= $ns = intval( $ns );
267 $t->mDbkeyform
= str_replace( ' ', '_', $title );
268 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
269 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
270 $t->mTextform
= str_replace( '_', ' ', $title );
275 * Create a new Title from a namespace index and a DB key.
276 * The parameters will be checked for validity, which is a bit slower
277 * than makeTitle() but safer for user-provided data.
279 * @param $ns \type{\int} the namespace of the article
280 * @param $title \type{\string} the database key form
281 * @param $fragment \type{\string} The link fragment (after the "#")
282 * @param $interwiki \type{\string} The interwiki prefix
283 * @return \type{Title} the new object, or NULL on an error
285 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
287 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki );
288 if ( $t->secureAndSplit() ) {
296 * Create a new Title for the Main Page
298 * @return \type{Title} the new object
300 public static function newMainPage() {
301 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
302 // Don't give fatal errors if the message is broken
304 $title = Title
::newFromText( 'Main Page' );
310 * Extract a redirect destination from a string and return the
311 * Title, or null if the text doesn't contain a valid redirect
312 * This will only return the very next target, useful for
313 * the redirect table and other checks that don't need full recursion
315 * @param $text \type{\string} Text with possible redirect
316 * @return \type{Title} The corresponding Title
318 public static function newFromRedirect( $text ) {
319 return self
::newFromRedirectInternal( $text );
323 * Extract a redirect destination from a string and return the
324 * Title, or null if the text doesn't contain a valid redirect
325 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
326 * in order to provide (hopefully) the Title of the final destination instead of another redirect
328 * @param $text \type{\string} Text with possible redirect
329 * @return \type{Title} The corresponding Title
331 public static function newFromRedirectRecurse( $text ) {
332 $titles = self
::newFromRedirectArray( $text );
333 return $titles ?
array_pop( $titles ) : null;
337 * Extract a redirect destination from a string and return an
338 * array of Titles, or null if the text doesn't contain a valid redirect
339 * The last element in the array is the final destination after all redirects
340 * have been resolved (up to $wgMaxRedirects times)
342 * @param $text \type{\string} Text with possible redirect
343 * @return \type{\array} Array of Titles, with the destination last
345 public static function newFromRedirectArray( $text ) {
346 global $wgMaxRedirects;
347 // are redirects disabled?
348 if ( $wgMaxRedirects < 1 )
350 $title = self
::newFromRedirectInternal( $text );
351 if ( is_null( $title ) )
353 // recursive check to follow double redirects
354 $recurse = $wgMaxRedirects;
355 $titles = array( $title );
356 while ( --$recurse > 0 ) {
357 if ( $title->isRedirect() ) {
358 $article = new Article( $title, 0 );
359 $newtitle = $article->getRedirectTarget();
363 // Redirects to some special pages are not permitted
364 if ( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
365 // the new title passes the checks, so make that our current title so that further recursion can be checked
367 $titles[] = $newtitle;
376 * Really extract the redirect destination
377 * Do not call this function directly, use one of the newFromRedirect* functions above
379 * @param $text \type{\string} Text with possible redirect
380 * @return \type{Title} The corresponding Title
382 protected static function newFromRedirectInternal( $text ) {
383 $redir = MagicWord
::get( 'redirect' );
384 $text = trim( $text );
385 if ( $redir->matchStartAndRemove( $text ) ) {
386 // Extract the first link and see if it's usable
387 // Ensure that it really does come directly after #REDIRECT
388 // Some older redirects included a colon, so don't freak about that!
390 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
391 // Strip preceding colon used to "escape" categories, etc.
392 // and URL-decode links
393 if ( strpos( $m[1], '%' ) !== false ) {
394 // Match behavior of inline link parsing here;
395 // don't interpret + as " " most of the time!
396 // It might be safe to just use rawurldecode instead, though.
397 $m[1] = urldecode( ltrim( $m[1], ':' ) );
399 $title = Title
::newFromText( $m[1] );
400 // If the title is a redirect to bad special pages or is invalid, return null
401 if ( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
410 # ----------------------------------------------------------------------------
412 # ----------------------------------------------------------------------------
415 * Get the prefixed DB key associated with an ID
417 * @param $id \type{\int} the page_id of the article
418 * @return \type{Title} an object representing the article, or NULL
419 * if no such article was found
421 public static function nameOf( $id ) {
422 $dbr = wfGetDB( DB_SLAVE
);
424 $s = $dbr->selectRow( 'page',
425 array( 'page_namespace', 'page_title' ),
426 array( 'page_id' => $id ),
428 if ( $s === false ) { return null; }
430 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
435 * Get a regex character class describing the legal characters in a link
437 * @return \type{\string} the list of characters, not delimited
439 public static function legalChars() {
440 global $wgLegalTitleChars;
441 return $wgLegalTitleChars;
445 * Get a string representation of a title suitable for
446 * including in a search index
448 * @param $ns \type{\int} a namespace index
449 * @param $title \type{\string} text-form main part
450 * @return \type{\string} a stripped-down title string ready for the
453 public static function indexTitle( $ns, $title ) {
456 $lc = SearchEngine
::legalSearchChars() . '&#;';
457 $t = $wgContLang->normalizeForSearch( $title );
458 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
459 $t = $wgContLang->lc( $t );
462 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
463 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
465 $t = preg_replace( "/\\s+/", ' ', $t );
467 if ( $ns == NS_FILE
) {
468 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
474 * Make a prefixed DB key from a DB key and a namespace index
476 * @param $ns \type{\int} numerical representation of the namespace
477 * @param $title \type{\string} the DB key form the title
478 * @param $fragment \type{\string} The link fragment (after the "#")
479 * @param $interwiki \type{\string} The interwiki prefix
480 * @return \type{\string} the prefixed form of the title
482 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
485 $namespace = $wgContLang->getNsText( $ns );
486 $name = $namespace == '' ?
$title : "$namespace:$title";
487 if ( strval( $interwiki ) != '' ) {
488 $name = "$interwiki:$name";
490 if ( strval( $fragment ) != '' ) {
491 $name .= '#' . $fragment;
497 * Determine whether the object refers to a page within
500 * @return \type{\bool} TRUE if this is an in-project interwiki link
501 * or a wikilink, FALSE otherwise
503 public function isLocal() {
504 if ( $this->mInterwiki
!= '' ) {
505 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
512 * Determine whether the object refers to a page within
513 * this project and is transcludable.
515 * @return \type{\bool} TRUE if this is transcludable
517 public function isTrans() {
518 if ( $this->mInterwiki
== '' )
521 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
525 * Returns the DB name of the distant wiki
526 * which owns the object.
528 * @return \type{\string} the DB name
530 public function getTransWikiID() {
531 if ( $this->mInterwiki
== '' )
534 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
538 * Escape a text fragment, say from a link, for a URL
540 * @param $fragment string containing a URL or link fragment (after the "#")
541 * @return String: escaped string
543 static function escapeFragmentForURL( $fragment ) {
544 # Note that we don't urlencode the fragment. urlencoded Unicode
545 # fragments appear not to work in IE (at least up to 7) or in at least
546 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
547 # to care if they aren't encoded.
548 return Sanitizer
::escapeId( $fragment, 'noninitial' );
551 # ----------------------------------------------------------------------------
553 # ----------------------------------------------------------------------------
555 /** Simple accessors */
557 * Get the text form (spaces not underscores) of the main part
559 * @return \type{\string} Main part of the title
561 public function getText() { return $this->mTextform
; }
564 * Get the URL-encoded form of the main part
566 * @return \type{\string} Main part of the title, URL-encoded
568 public function getPartialURL() { return $this->mUrlform
; }
571 * Get the main part with underscores
573 * @return \type{\string} Main part of the title, with underscores
575 public function getDBkey() { return $this->mDbkeyform
; }
578 * Get the namespace index, i.e.\ one of the NS_xxxx constants.
580 * @return \type{\int} Namespace index
582 public function getNamespace() { return $this->mNamespace
; }
585 * Get the namespace text
587 * @return \type{\string} Namespace text
589 public function getNsText() {
592 if ( $this->mInterwiki
!= '' ) {
593 // This probably shouldn't even happen. ohh man, oh yuck.
594 // But for interwiki transclusion it sometimes does.
595 // Shit. Shit shit shit.
597 // Use the canonical namespaces if possible to try to
598 // resolve a foreign namespace.
599 if ( MWNamespace
::exists( $this->mNamespace
) ) {
600 return MWNamespace
::getCanonicalName( $this->mNamespace
);
603 return $wgContLang->getNsText( $this->mNamespace
);
607 * Get the DB key with the initial letter case as specified by the user
609 * @return \type{\string} DB key
611 function getUserCaseDBKey() {
612 return $this->mUserCaseDBKey
;
616 * Get the namespace text of the subject (rather than talk) page
618 * @return \type{\string} Namespace text
620 public function getSubjectNsText() {
622 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
626 * Get the namespace text of the talk page
628 * @return \type{\string} Namespace text
630 public function getTalkNsText() {
632 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
636 * Could this title have a corresponding talk page?
638 * @return \type{\bool} TRUE or FALSE
640 public function canTalk() {
641 return( MWNamespace
::canTalk( $this->mNamespace
) );
645 * Get the interwiki prefix (or null string)
647 * @return \type{\string} Interwiki prefix
649 public function getInterwiki() { return $this->mInterwiki
; }
652 * Get the Title fragment (i.e.\ the bit after the #) in text form
654 * @return \type{\string} Title fragment
656 public function getFragment() { return $this->mFragment
; }
659 * Get the fragment in URL form, including the "#" character if there is one
660 * @return \type{\string} Fragment in URL form
662 public function getFragmentForURL() {
663 if ( $this->mFragment
== '' ) {
666 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
671 * Get the default namespace index, for when there is no namespace
673 * @return \type{\int} Default namespace index
675 public function getDefaultNamespace() { return $this->mDefaultNamespace
; }
678 * Get title for search index
680 * @return \type{\string} a stripped-down title string ready for the
683 public function getIndexTitle() {
684 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
688 * Get the prefixed database key form
690 * @return \type{\string} the prefixed title, with underscores and
691 * any interwiki and namespace prefixes
693 public function getPrefixedDBkey() {
694 $s = $this->prefix( $this->mDbkeyform
);
695 $s = str_replace( ' ', '_', $s );
700 * Get the prefixed title with spaces.
701 * This is the form usually used for display
703 * @return \type{\string} the prefixed title, with spaces
705 public function getPrefixedText() {
706 if ( empty( $this->mPrefixedText
) ) { // FIXME: bad usage of empty() ?
707 $s = $this->prefix( $this->mTextform
);
708 $s = str_replace( '_', ' ', $s );
709 $this->mPrefixedText
= $s;
711 return $this->mPrefixedText
;
715 * Get the prefixed title with spaces, plus any fragment
716 * (part beginning with '#')
718 * @return \type{\string} the prefixed title, with spaces and
719 * the fragment, including '#'
721 public function getFullText() {
722 $text = $this->getPrefixedText();
723 if ( $this->mFragment
!= '' ) {
724 $text .= '#' . $this->mFragment
;
730 * Get the base name, i.e. the leftmost parts before the /
732 * @return \type{\string} Base name
734 public function getBaseText() {
735 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
736 return $this->getText();
739 $parts = explode( '/', $this->getText() );
740 # Don't discard the real title if there's no subpage involved
741 if ( count( $parts ) > 1 )
742 unset( $parts[ count( $parts ) - 1 ] );
743 return implode( '/', $parts );
747 * Get the lowest-level subpage name, i.e. the rightmost part after /
749 * @return \type{\string} Subpage name
751 public function getSubpageText() {
752 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
753 return( $this->mTextform
);
755 $parts = explode( '/', $this->mTextform
);
756 return( $parts[ count( $parts ) - 1 ] );
760 * Get a URL-encoded form of the subpage text
762 * @return \type{\string} URL-encoded subpage name
764 public function getSubpageUrlForm() {
765 $text = $this->getSubpageText();
766 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
771 * Get a URL-encoded title (not an actual URL) including interwiki
773 * @return \type{\string} the URL-encoded form
775 public function getPrefixedURL() {
776 $s = $this->prefix( $this->mDbkeyform
);
777 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
782 * Get a real URL referring to this title, with interwiki link and
785 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
786 * links. Can be specified as an associative array as well, e.g.,
787 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
788 * @param $variant \type{\string} language variant of url (for sr, zh..)
789 * @return \type{\string} the URL
791 public function getFullURL( $query = '', $variant = false ) {
792 global $wgServer, $wgRequest;
794 if ( is_array( $query ) ) {
795 $query = wfArrayToCGI( $query );
798 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
800 $url = $this->getLocalURL( $query, $variant );
802 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
803 // Correct fix would be to move the prepending elsewhere.
804 if ( $wgRequest->getVal( 'action' ) != 'render' ) {
805 $url = $wgServer . $url;
808 $baseUrl = $interwiki->getURL( );
810 $namespace = wfUrlencode( $this->getNsText() );
811 if ( $namespace != '' ) {
812 # Can this actually happen? Interwikis shouldn't be parsed.
813 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
816 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
817 $url = wfAppendQuery( $url, $query );
820 # Finally, add the fragment.
821 $url .= $this->getFragmentForURL();
823 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
828 * Get a URL with no fragment or server name. If this page is generated
829 * with action=render, $wgServer is prepended.
831 * @param $query Mixed: an optional query string; if not specified,
832 * $wgArticlePath will be used. Can be specified as an associative array
833 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
835 * @param $variant \type{\string} language variant of url (for sr, zh..)
836 * @return \type{\string} the URL
838 public function getLocalURL( $query = '', $variant = false ) {
839 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
840 global $wgVariantArticlePath, $wgContLang, $wgUser;
842 if ( is_array( $query ) ) {
843 $query = wfArrayToCGI( $query );
846 // internal links should point to same variant as current page (only anonymous users)
847 if ( !$variant && $wgContLang->hasVariants() && !$wgUser->isLoggedIn() ) {
848 $pref = $wgContLang->getPreferredVariant( false );
849 if ( $pref != $wgContLang->getCode() )
853 if ( $this->isExternal() ) {
854 $url = $this->getFullURL();
856 // This is currently only used for edit section links in the
857 // context of interwiki transclusion. In theory we should
858 // append the query to the end of any existing query string,
859 // but interwiki transclusion is already broken in that case.
863 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
864 if ( $query == '' ) {
865 if ( $variant != false && $wgContLang->hasVariants() ) {
866 if ( !$wgVariantArticlePath ) {
867 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
869 $variantArticlePath = $wgVariantArticlePath;
871 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
872 $url = str_replace( '$1', $dbkey, $url );
874 $url = str_replace( '$1', $dbkey, $wgArticlePath );
877 global $wgActionPaths;
880 if ( !empty( $wgActionPaths ) &&
881 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
883 $action = urldecode( $matches[2] );
884 if ( isset( $wgActionPaths[$action] ) ) {
885 $query = $matches[1];
886 if ( isset( $matches[4] ) ) $query .= $matches[4];
887 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
888 if ( $query != '' ) {
889 $url = wfAppendQuery( $url, $query );
893 if ( $url === false ) {
894 if ( $query == '-' ) {
897 $url = "{$wgScript}?title={$dbkey}&{$query}";
901 // FIXME: this causes breakage in various places when we
902 // actually expected a local URL and end up with dupe prefixes.
903 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
904 $url = $wgServer . $url;
907 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
912 * Get a URL that's the simplest URL that will be valid to link, locally,
913 * to the current Title. It includes the fragment, but does not include
914 * the server unless action=render is used (or the link is external). If
915 * there's a fragment but the prefixed text is empty, we just return a link
918 * The result obviously should not be URL-escaped, but does need to be
919 * HTML-escaped if it's being output in HTML.
921 * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the
922 * query string. Keys and values will be escaped.
923 * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
924 * for external links. Default is "false" (same variant as current page,
925 * for anonymous users).
926 * @return \type{\string} the URL
928 public function getLinkUrl( $query = array(), $variant = false ) {
929 wfProfileIn( __METHOD__
);
930 if ( $this->isExternal() ) {
931 $ret = $this->getFullURL( $query );
932 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
933 $ret = $this->getFragmentForURL();
935 $ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
937 wfProfileOut( __METHOD__
);
942 * Get an HTML-escaped version of the URL form, suitable for
943 * using in a link, without a server name or fragment
945 * @param $query \type{\string} an optional query string
946 * @return \type{\string} the URL
948 public function escapeLocalURL( $query = '' ) {
949 return htmlspecialchars( $this->getLocalURL( $query ) );
953 * Get an HTML-escaped version of the URL form, suitable for
954 * using in a link, including the server name and fragment
956 * @param $query \type{\string} an optional query string
957 * @return \type{\string} the URL
959 public function escapeFullURL( $query = '' ) {
960 return htmlspecialchars( $this->getFullURL( $query ) );
964 * Get the URL form for an internal link.
965 * - Used in various Squid-related code, in case we have a different
966 * internal hostname for the server from the exposed one.
968 * @param $query \type{\string} an optional query string
969 * @param $variant \type{\string} language variant of url (for sr, zh..)
970 * @return \type{\string} the URL
972 public function getInternalURL( $query = '', $variant = false ) {
973 global $wgInternalServer;
974 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
975 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
980 * Get the edit URL for this Title
982 * @return \type{\string} the URL, or a null string if this is an
985 public function getEditURL() {
986 if ( $this->mInterwiki
!= '' ) { return ''; }
987 $s = $this->getLocalURL( 'action=edit' );
993 * Get the HTML-escaped displayable text form.
994 * Used for the title field in <a> tags.
996 * @return \type{\string} the text, including any prefixes
998 public function getEscapedText() {
999 return htmlspecialchars( $this->getPrefixedText() );
1003 * Is this Title interwiki?
1005 * @return \type{\bool}
1007 public function isExternal() { return ( $this->mInterwiki
!= '' ); }
1010 * Is this page "semi-protected" - the *only* protection is autoconfirm?
1012 * @param $action \type{\string} Action to check (default: edit)
1013 * @return \type{\bool}
1015 public function isSemiProtected( $action = 'edit' ) {
1016 if ( $this->exists() ) {
1017 $restrictions = $this->getRestrictions( $action );
1018 if ( count( $restrictions ) > 0 ) {
1019 foreach ( $restrictions as $restriction ) {
1020 if ( strtolower( $restriction ) != 'autoconfirmed' )
1029 # If it doesn't exist, it can't be protected
1035 * Does the title correspond to a protected article?
1037 * @param $action \type{\string} the action the page is protected from,
1038 * by default checks all actions.
1039 * @return \type{\bool}
1041 public function isProtected( $action = '' ) {
1042 global $wgRestrictionLevels;
1044 $restrictionTypes = $this->getRestrictionTypes();
1046 # Special pages have inherent protection
1047 if( $this->getNamespace() == NS_SPECIAL
)
1050 # Check regular protection levels
1051 foreach ( $restrictionTypes as $type ) {
1052 if ( $action == $type ||
$action == '' ) {
1053 $r = $this->getRestrictions( $type );
1054 foreach ( $wgRestrictionLevels as $level ) {
1055 if ( in_array( $level, $r ) && $level != '' ) {
1066 * Is this a conversion table for the LanguageConverter?
1068 * @return \type{\bool}
1070 public function isConversionTable() {
1071 if($this->getNamespace() == NS_MEDIAWIKI
1072 && strpos( $this->getText(), 'Conversiontable' ) !== false ) {
1080 * Is $wgUser watching this page?
1082 * @return \type{\bool}
1084 public function userIsWatching() {
1087 if ( is_null( $this->mWatched
) ) {
1088 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1089 $this->mWatched
= false;
1091 $this->mWatched
= $wgUser->isWatched( $this );
1094 return $this->mWatched
;
1098 * Can $wgUser perform $action on this page?
1099 * This skips potentially expensive cascading permission checks
1100 * as well as avoids expensive error formatting
1102 * Suitable for use for nonessential UI controls in common cases, but
1103 * _not_ for functional access control.
1105 * May provide false positives, but should never provide a false negative.
1107 * @param $action \type{\string} action that permission needs to be checked for
1108 * @return \type{\bool}
1110 public function quickUserCan( $action ) {
1111 return $this->userCan( $action, false );
1115 * Determines if $wgUser is unable to edit this page because it has been protected
1116 * by $wgNamespaceProtection.
1118 * @return \type{\bool}
1120 public function isNamespaceProtected() {
1121 global $wgNamespaceProtection, $wgUser;
1122 if ( isset( $wgNamespaceProtection[ $this->mNamespace
] ) ) {
1123 foreach ( (array)$wgNamespaceProtection[ $this->mNamespace
] as $right ) {
1124 if ( $right != '' && !$wgUser->isAllowed( $right ) )
1132 * Can $wgUser perform $action on this page?
1134 * @param $action \type{\string} action that permission needs to be checked for
1135 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1136 * @return \type{\bool}
1138 public function userCan( $action, $doExpensiveQueries = true ) {
1140 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries, true ) === array() );
1144 * Can $user perform $action on this page?
1146 * FIXME: This *does not* check throttles (User::pingLimiter()).
1148 * @param $action \type{\string}action that permission needs to be checked for
1149 * @param $user \type{User} user to check
1150 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1151 * @param $ignoreErrors \type{\arrayof{\string}} Set this to a list of message keys whose corresponding errors may be ignored.
1152 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1154 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1155 if ( !StubObject
::isRealObject( $user ) ) {
1156 // Since StubObject is always used on globals, we can
1157 // unstub $wgUser here and set $user = $wgUser
1159 $wgUser->_unstub( '', 5 );
1163 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1165 // Remove the errors being ignored.
1166 foreach ( $errors as $index => $error ) {
1167 $error_key = is_array( $error ) ?
$error[0] : $error;
1169 if ( in_array( $error_key, $ignoreErrors ) ) {
1170 unset( $errors[$index] );
1178 * Permissions checks that fail most often, and which are easiest to test.
1180 * @param $action String the action to check
1181 * @param $user User user to check
1182 * @param $errors Array list of current errors
1183 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1184 * @param $short Boolean short circuit on first error
1186 * @return Array list of errors
1188 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1189 if ( $action == 'create' ) {
1190 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1191 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1192 $errors[] = $user->isAnon() ?
array ( 'nocreatetext' ) : array ( 'nocreate-loggedin' );
1194 } elseif ( $action == 'move' ) {
1195 if ( !$user->isAllowed( 'move-rootuserpages' )
1196 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1197 // Show user page-specific message only if the user can move other pages
1198 $errors[] = array( 'cant-move-user-page' );
1201 // Check if user is allowed to move files if it's a file
1202 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1203 $errors[] = array( 'movenotallowedfile' );
1206 if ( !$user->isAllowed( 'move' ) ) {
1207 // User can't move anything
1208 global $wgGroupPermissions;
1209 $userCanMove = false;
1210 if ( isset( $wgGroupPermissions['user']['move'] ) ) {
1211 $userCanMove = $wgGroupPermissions['user']['move'];
1213 $autoconfirmedCanMove = false;
1214 if ( isset( $wgGroupPermissions['autoconfirmed']['move'] ) ) {
1215 $autoconfirmedCanMove = $wgGroupPermissions['autoconfirmed']['move'];
1217 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1218 // custom message if logged-in users without any special rights can move
1219 $errors[] = array ( 'movenologintext' );
1221 $errors[] = array ( 'movenotallowed' );
1224 } elseif ( $action == 'move-target' ) {
1225 if ( !$user->isAllowed( 'move' ) ) {
1226 // User can't move anything
1227 $errors[] = array ( 'movenotallowed' );
1228 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1229 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1230 // Show user page-specific message only if the user can move other pages
1231 $errors[] = array( 'cant-move-to-user-page' );
1233 } elseif ( !$user->isAllowed( $action ) ) {
1236 // We avoid expensive display logic for quickUserCan's and such
1239 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1240 User
::getGroupsWithPermission( $action ) );
1247 $wgLang->commaList( $groups ),
1251 $return = array( "badaccess-group0" );
1253 $errors[] = $return;
1260 * Add the resulting error code to the errors array
1262 * @param $errors Array list of current errors
1263 * @param $result Mixed result of errors
1265 * @return Array list of errors
1267 private function resultToError( $errors, $result ) {
1268 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1269 // A single array representing an error
1270 $errors[] = $result;
1271 } else if ( is_array( $result ) && is_array( $result[0] ) ) {
1272 // A nested array representing multiple errors
1273 $errors = array_merge( $errors, $result );
1274 } else if ( $result !== '' && is_string( $result ) ) {
1275 // A string representing a message-id
1276 $errors[] = array( $result );
1277 } else if ( $result === false ) {
1278 // a generic "We don't want them to do that"
1279 $errors[] = array( 'badaccess-group0' );
1285 * Check various permission hooks
1286 * @see checkQuickPermissions for parameter information
1288 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1289 // Use getUserPermissionsErrors instead
1290 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1291 return $result ?
array() : array( array( 'badaccess-group0' ) );
1293 // Check getUserPermissionsErrors hook
1294 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1295 $errors = $this->resultToError( $errors, $result );
1297 // Check getUserPermissionsErrorsExpensive hook
1298 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1299 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1300 $errors = $this->resultToError( $errors, $result );
1307 * Check permissions on special pages & namespaces
1308 * @see checkQuickPermissions for parameter information
1310 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1311 # Only 'createaccount' and 'execute' can be performed on
1312 # special pages, which don't actually exist in the DB.
1313 $specialOKActions = array( 'createaccount', 'execute' );
1314 if ( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions ) ) {
1315 $errors[] = array( 'ns-specialprotected' );
1318 # Check $wgNamespaceProtection for restricted namespaces
1319 if ( $this->isNamespaceProtected() ) {
1320 $ns = $this->mNamespace
== NS_MAIN ?
1321 wfMsg( 'nstab-main' ) : $this->getNsText();
1322 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
1323 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1330 * Check CSS/JS sub-page permissions
1331 * @see checkQuickPermissions for parameter information
1333 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1334 # Protect css/js subpages of user pages
1335 # XXX: this might be better using restrictions
1336 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssSubpage()
1337 # and $this->userCanEditJsSubpage() from working
1338 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1339 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1340 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
1341 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1342 $errors[] = array( 'customcssjsprotected' );
1343 } else if ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1344 $errors[] = array( 'customcssjsprotected' );
1352 * Check against page_restrictions table requirements on this
1353 * page. The user must possess all required rights for this
1355 * @see checkQuickPermissions for parameter information
1357 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1358 foreach ( $this->getRestrictions( $action ) as $right ) {
1359 // Backwards compatibility, rewrite sysop -> protect
1360 if ( $right == 'sysop' ) {
1363 if ( $right != '' && !$user->isAllowed( $right ) ) {
1364 // Users with 'editprotected' permission can edit protected pages
1365 if ( $action == 'edit' && $user->isAllowed( 'editprotected' ) ) {
1366 // Users with 'editprotected' permission cannot edit protected pages
1367 // with cascading option turned on.
1368 if ( $this->mCascadeRestriction
) {
1369 $errors[] = array( 'protectedpagetext', $right );
1372 $errors[] = array( 'protectedpagetext', $right );
1381 * Check restrictions on cascading pages.
1382 * @see checkQuickPermissions for parameter information
1384 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1385 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1386 # We /could/ use the protection level on the source page, but it's
1387 # fairly ugly as we have to establish a precedence hierarchy for pages
1388 # included by multiple cascade-protected pages. So just restrict
1389 # it to people with 'protect' permission, as they could remove the
1390 # protection anyway.
1391 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1392 # Cascading protection depends on more than this page...
1393 # Several cascading protected pages may include this page...
1394 # Check each cascading level
1395 # This is only for protection restrictions, not for all actions
1396 if ( isset( $restrictions[$action] ) ) {
1397 foreach ( $restrictions[$action] as $right ) {
1398 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1399 if ( $right != '' && !$user->isAllowed( $right ) ) {
1401 foreach ( $cascadingSources as $page )
1402 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1403 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1413 * Check action permissions not already checked in checkQuickPermissions
1414 * @see checkQuickPermissions for parameter information
1416 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1417 if ( $action == 'protect' ) {
1418 if ( $this->getUserPermissionsErrors( 'edit', $user ) != array() ) {
1419 // If they can't edit, they shouldn't protect.
1420 $errors[] = array( 'protect-cantedit' );
1422 } elseif ( $action == 'create' ) {
1423 $title_protection = $this->getTitleProtection();
1424 if( $title_protection ) {
1425 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1426 $title_protection['pt_create_perm'] = 'protect'; // B/C
1428 if( $title_protection['pt_create_perm'] == '' ||
!$user->isAllowed( $title_protection['pt_create_perm'] ) ) {
1429 $errors[] = array( 'titleprotected', User
::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1432 } elseif ( $action == 'move' ) {
1433 // Check for immobile pages
1434 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1435 // Specific message for this case
1436 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1437 } elseif ( !$this->isMovable() ) {
1438 // Less specific message for rarer cases
1439 $errors[] = array( 'immobile-page' );
1441 } elseif ( $action == 'move-target' ) {
1442 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1443 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1444 } elseif ( !$this->isMovable() ) {
1445 $errors[] = array( 'immobile-target-page' );
1452 * Check that the user isn't blocked from editting.
1453 * @see checkQuickPermissions for parameter information
1455 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1462 global $wgEmailConfirmToEdit;
1464 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1465 $errors[] = array( 'confirmedittext' );
1468 // Edit blocks should not affect reading. Account creation blocks handled at userlogin.
1469 if ( $action != 'read' && $action != 'createaccount' && $user->isBlockedFrom( $this ) ) {
1470 $block = $user->mBlock
;
1472 // This is from OutputPage::blockedPage
1473 // Copied at r23888 by werdna
1475 $id = $user->blockedBy();
1476 $reason = $user->blockedFor();
1477 if ( $reason == '' ) {
1478 $reason = wfMsg( 'blockednoreason' );
1482 if ( is_numeric( $id ) ) {
1483 $name = User
::whoIs( $id );
1488 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1489 $blockid = $block->mId
;
1490 $blockExpiry = $user->mBlock
->mExpiry
;
1491 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1492 if ( $blockExpiry == 'infinity' ) {
1493 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1494 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1496 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1497 if ( !strpos( $option, ':' ) )
1500 list ( $show, $value ) = explode( ":", $option );
1502 if ( $value == 'infinite' ||
$value == 'indefinite' ) {
1503 $blockExpiry = $show;
1508 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1511 $intended = $user->mBlock
->mAddress
;
1513 $errors[] = array( ( $block->mAuto ?
'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1514 $blockid, $blockExpiry, $intended, $blockTimestamp );
1521 * Can $user perform $action on this page? This is an internal function,
1522 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1523 * checks on wfReadOnly() and blocks)
1525 * @param $action \type{\string} action that permission needs to be checked for
1526 * @param $user \type{User} user to check
1527 * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
1528 * @param $short \type{\bool} Set this to true to stop after the first permission error.
1529 * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems.
1531 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
1532 wfProfileIn( __METHOD__
);
1535 $checks = array( 'checkQuickPermissions',
1536 'checkPermissionHooks',
1537 'checkSpecialsAndNSPermissions',
1538 'checkCSSandJSPermissions',
1539 'checkPageRestrictions',
1540 'checkCascadingSourcesRestrictions',
1541 'checkActionPermissions',
1544 while( count( $checks ) > 0 &&
1545 !( $short && count( $errors ) > 0 ) ) {
1546 $method = array_shift( $checks );
1547 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
1550 wfProfileOut( __METHOD__
);
1555 * Is this title subject to title protection?
1557 * @return \type{\mixed} An associative array representing any existent title
1558 * protection, or false if there's none.
1560 private function getTitleProtection() {
1561 // Can't protect pages in special namespaces
1562 if ( $this->getNamespace() < 0 ) {
1566 // Can't protect pages that exist.
1567 if ( $this->exists() ) {
1571 if ( !isset( $this->mTitleProtection
) ) {
1572 $dbr = wfGetDB( DB_SLAVE
);
1573 $res = $dbr->select( 'protected_titles', '*',
1574 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1577 // fetchRow returns false if there are no rows.
1578 $this->mTitleProtection
= $dbr->fetchRow( $res );
1580 return $this->mTitleProtection
;
1584 * Update the title protection status
1586 * @param $create_perm \type{\string} Permission required for creation
1587 * @param $reason \type{\string} Reason for protection
1588 * @param $expiry \type{\string} Expiry timestamp
1589 * @return boolean true
1591 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1592 global $wgUser, $wgContLang;
1594 if ( $create_perm == implode( ',', $this->getRestrictions( 'create' ) )
1595 && $expiry == $this->mRestrictionsExpiry
['create'] ) {
1600 list ( $namespace, $title ) = array( $this->getNamespace(), $this->getDBkey() );
1602 $dbw = wfGetDB( DB_MASTER
);
1604 $encodedExpiry = Block
::encodeExpiry( $expiry, $dbw );
1606 $expiry_description = '';
1607 if ( $encodedExpiry != 'infinity' ) {
1608 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ),
1609 $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')';
1612 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ) . ')';
1615 # Update protection table
1616 if ( $create_perm != '' ) {
1617 $dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ),
1619 'pt_namespace' => $namespace,
1620 'pt_title' => $title,
1621 'pt_create_perm' => $create_perm,
1622 'pt_timestamp' => Block
::encodeExpiry( wfTimestampNow(), $dbw ),
1623 'pt_expiry' => $encodedExpiry,
1624 'pt_user' => $wgUser->getId(),
1625 'pt_reason' => $reason,
1629 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1630 'pt_title' => $title ), __METHOD__
);
1632 # Update the protection log
1633 if ( $dbw->affectedRows() ) {
1634 $log = new LogPage( 'protect' );
1636 if ( $create_perm ) {
1637 $params = array( "[create=$create_perm] $expiry_description", '' );
1638 $log->addEntry( ( isset( $this->mRestrictions
['create'] ) && $this->mRestrictions
['create'] ) ?
'modify' : 'protect', $this, trim( $reason ), $params );
1640 $log->addEntry( 'unprotect', $this, $reason );
1648 * Remove any title protection due to page existing
1650 public function deleteTitleProtection() {
1651 $dbw = wfGetDB( DB_MASTER
);
1653 $dbw->delete( 'protected_titles',
1654 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1659 * Would anybody with sufficient privileges be able to move this page?
1660 * Some pages just aren't movable.
1662 * @return \type{\bool} TRUE or FALSE
1664 public function isMovable() {
1665 return MWNamespace
::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
1669 * Can $wgUser read this page?
1671 * @return \type{\bool}
1672 * @todo fold these checks into userCan()
1674 public function userCanRead() {
1675 global $wgUser, $wgGroupPermissions;
1677 static $useShortcut = null;
1679 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
1680 if ( is_null( $useShortcut ) ) {
1681 global $wgRevokePermissions;
1682 $useShortcut = true;
1683 if ( empty( $wgGroupPermissions['*']['read'] ) ) {
1684 # Not a public wiki, so no shortcut
1685 $useShortcut = false;
1686 } elseif ( !empty( $wgRevokePermissions ) ) {
1688 * Iterate through each group with permissions being revoked (key not included since we don't care
1689 * what the group name is), then check if the read permission is being revoked. If it is, then
1690 * we don't use the shortcut below since the user might not be able to read, even though anon
1691 * reading is allowed.
1693 foreach ( $wgRevokePermissions as $perms ) {
1694 if ( !empty( $perms['read'] ) ) {
1695 # We might be removing the read right from the user, so no shortcut
1696 $useShortcut = false;
1704 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1705 if ( $result !== null ) {
1709 # Shortcut for public wikis, allows skipping quite a bit of code
1713 if ( $wgUser->isAllowed( 'read' ) ) {
1716 global $wgWhitelistRead;
1719 * Always grant access to the login page.
1720 * Even anons need to be able to log in.
1722 if ( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'Resetpass' ) ) {
1727 * Bail out if there isn't whitelist
1729 if ( !is_array( $wgWhitelistRead ) ) {
1734 * Check for explicit whitelisting
1736 $name = $this->getPrefixedText();
1737 $dbName = $this->getPrefixedDBKey();
1738 // Check with and without underscores
1739 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) )
1743 * Old settings might have the title prefixed with
1744 * a colon for main-namespace pages
1746 if ( $this->getNamespace() == NS_MAIN
) {
1747 if ( in_array( ':' . $name, $wgWhitelistRead ) )
1752 * If it's a special page, ditch the subpage bit
1755 if ( $this->getNamespace() == NS_SPECIAL
) {
1756 $name = $this->getDBkey();
1757 list( $name, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $name );
1758 if ( $name === false ) {
1759 # Invalid special page, but we show standard login required message
1763 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1764 if ( in_array( $pure, $wgWhitelistRead, true ) )
1773 * Is this a talk page of some sort?
1775 * @return \type{\bool}
1777 public function isTalkPage() {
1778 return MWNamespace
::isTalk( $this->getNamespace() );
1782 * Is this a subpage?
1784 * @return \type{\bool}
1786 public function isSubpage() {
1787 return MWNamespace
::hasSubpages( $this->mNamespace
)
1788 ?
strpos( $this->getText(), '/' ) !== false
1793 * Does this have subpages? (Warning, usually requires an extra DB query.)
1795 * @return \type{\bool}
1797 public function hasSubpages() {
1798 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1803 # We dynamically add a member variable for the purpose of this method
1804 # alone to cache the result. There's no point in having it hanging
1805 # around uninitialized in every Title object; therefore we only add it
1806 # if needed and don't declare it statically.
1807 if ( isset( $this->mHasSubpages
) ) {
1808 return $this->mHasSubpages
;
1811 $subpages = $this->getSubpages( 1 );
1812 if ( $subpages instanceof TitleArray
)
1813 return $this->mHasSubpages
= (bool)$subpages->count();
1814 return $this->mHasSubpages
= false;
1818 * Get all subpages of this page.
1820 * @param $limit Maximum number of subpages to fetch; -1 for no limit
1821 * @return mixed TitleArray, or empty array if this page's namespace
1822 * doesn't allow subpages
1824 public function getSubpages( $limit = -1 ) {
1825 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) )
1828 $dbr = wfGetDB( DB_SLAVE
);
1829 $conds['page_namespace'] = $this->getNamespace();
1830 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
1833 $options['LIMIT'] = $limit;
1834 return $this->mSubpages
= TitleArray
::newFromResult(
1835 $dbr->select( 'page',
1836 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
1845 * Could this page contain custom CSS or JavaScript, based
1848 * @return \type{\bool}
1850 public function isCssOrJsPage() {
1851 return $this->mNamespace
== NS_MEDIAWIKI
1852 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1856 * Is this a .css or .js subpage of a user page?
1857 * @return \type{\bool}
1859 public function isCssJsSubpage() {
1860 return ( NS_USER
== $this->mNamespace
and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
1864 * Is this a *valid* .css or .js subpage of a user page?
1865 * Check that the corresponding skin exists
1867 * @return \type{\bool}
1869 public function isValidCssJsSubpage() {
1870 if ( $this->isCssJsSubpage() ) {
1871 $name = $this->getSkinFromCssJsSubpage();
1872 if ( $name == 'common' ) return true;
1873 $skinNames = Skin
::getSkinNames();
1874 return array_key_exists( $name, $skinNames );
1881 * Trim down a .css or .js subpage title to get the corresponding skin name
1883 * @return string containing skin name from .css or .js subpage title
1885 public function getSkinFromCssJsSubpage() {
1886 $subpage = explode( '/', $this->mTextform
);
1887 $subpage = $subpage[ count( $subpage ) - 1 ];
1888 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1892 * Is this a .css subpage of a user page?
1894 * @return \type{\bool}
1896 public function isCssSubpage() {
1897 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.css$/", $this->mTextform
) );
1901 * Is this a .js subpage of a user page?
1903 * @return \type{\bool}
1905 public function isJsSubpage() {
1906 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.js$/", $this->mTextform
) );
1910 * Protect css subpages of user pages: can $wgUser edit
1913 * @return \type{\bool}
1914 * @todo XXX: this might be better using restrictions
1916 public function userCanEditCssSubpage() {
1918 return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'editusercss' ) )
1919 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
1922 * Protect js subpages of user pages: can $wgUser edit
1925 * @return \type{\bool}
1926 * @todo XXX: this might be better using restrictions
1928 public function userCanEditJsSubpage() {
1930 return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'edituserjs' ) )
1931 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
1935 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
1937 * @return \type{\bool} If the page is subject to cascading restrictions.
1939 public function isCascadeProtected() {
1940 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
1941 return ( $sources > 0 );
1945 * Cascading protection: Get the source of any cascading restrictions on this page.
1947 * @param $getPages \type{\bool} Whether or not to retrieve the actual pages
1948 * that the restrictions have come from.
1949 * @return \type{\arrayof{mixed title array, restriction array}} Array of the Title
1950 * objects of the pages from which cascading restrictions have come,
1951 * false for none, or true if such restrictions exist, but $getPages was not set.
1952 * The restriction array is an array of each type, each of which contains a
1953 * array of unique groups.
1955 public function getCascadeProtectionSources( $getPages = true ) {
1956 $pagerestrictions = array();
1958 if ( isset( $this->mCascadeSources
) && $getPages ) {
1959 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
1960 } else if ( isset( $this->mHasCascadingRestrictions
) && !$getPages ) {
1961 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
1964 wfProfileIn( __METHOD__
);
1966 $dbr = wfGetDB( DB_SLAVE
);
1968 if ( $this->getNamespace() == NS_FILE
) {
1969 $tables = array ( 'imagelinks', 'page_restrictions' );
1970 $where_clauses = array(
1971 'il_to' => $this->getDBkey(),
1973 'pr_cascade' => 1 );
1975 $tables = array ( 'templatelinks', 'page_restrictions' );
1976 $where_clauses = array(
1977 'tl_namespace' => $this->getNamespace(),
1978 'tl_title' => $this->getDBkey(),
1980 'pr_cascade' => 1 );
1984 $cols = array( 'pr_page', 'page_namespace', 'page_title',
1985 'pr_expiry', 'pr_type', 'pr_level' );
1986 $where_clauses[] = 'page_id=pr_page';
1989 $cols = array( 'pr_expiry' );
1992 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
1994 $sources = $getPages ?
array() : false;
1995 $now = wfTimestampNow();
1996 $purgeExpired = false;
1998 foreach ( $res as $row ) {
1999 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
2000 if ( $expiry > $now ) {
2002 $page_id = $row->pr_page
;
2003 $page_ns = $row->page_namespace
;
2004 $page_title = $row->page_title
;
2005 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2006 # Add groups needed for each restriction type if its not already there
2007 # Make sure this restriction type still exists
2009 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2010 $pagerestrictions[$row->pr_type
] = array();
2013 if ( isset( $pagerestrictions[$row->pr_type
] ) &&
2014 !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] ) ) {
2015 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2021 // Trigger lazy purge of expired restrictions from the db
2022 $purgeExpired = true;
2025 if ( $purgeExpired ) {
2026 Title
::purgeExpiredRestrictions();
2029 wfProfileOut( __METHOD__
);
2032 $this->mCascadeSources
= $sources;
2033 $this->mCascadingRestrictions
= $pagerestrictions;
2035 $this->mHasCascadingRestrictions
= $sources;
2038 return array( $sources, $pagerestrictions );
2042 * Returns cascading restrictions for the current article
2046 function areRestrictionsCascading() {
2047 if ( !$this->mRestrictionsLoaded
) {
2048 $this->loadRestrictions();
2051 return $this->mCascadeRestriction
;
2055 * Loads a string into mRestrictions array
2057 * @param $res \type{Resource} restrictions as an SQL result.
2058 * @param $oldFashionedRestrictions string comma-separated list of page
2059 * restrictions from page table (pre 1.10)
2061 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2063 $dbr = wfGetDB( DB_SLAVE
);
2065 while ( $row = $dbr->fetchObject( $res ) ) {
2069 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2073 * Compiles list of active page restrictions from both page table (pre 1.10)
2074 * and page_restrictions table
2076 * @param $rows array of db result objects
2077 * @param $oldFashionedRestrictions string comma-separated list of page
2078 * restrictions from page table (pre 1.10)
2080 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2081 $dbr = wfGetDB( DB_SLAVE
);
2083 $restrictionTypes = $this->getRestrictionTypes();
2085 foreach ( $restrictionTypes as $type ) {
2086 $this->mRestrictions
[$type] = array();
2087 $this->mRestrictionsExpiry
[$type] = Block
::decodeExpiry( '' );
2090 $this->mCascadeRestriction
= false;
2092 # Backwards-compatibility: also load the restrictions from the page record (old format).
2094 if ( $oldFashionedRestrictions === null ) {
2095 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2096 array( 'page_id' => $this->getArticleId() ), __METHOD__
);
2099 if ( $oldFashionedRestrictions != '' ) {
2101 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2102 $temp = explode( '=', trim( $restrict ) );
2103 if ( count( $temp ) == 1 ) {
2104 // old old format should be treated as edit/move restriction
2105 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2106 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2108 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
2112 $this->mOldRestrictions
= true;
2116 if ( count( $rows ) ) {
2117 # Current system - load second to make them override.
2118 $now = wfTimestampNow();
2119 $purgeExpired = false;
2121 foreach ( $rows as $row ) {
2122 # Cycle through all the restrictions.
2124 // Don't take care of restrictions types that aren't allowed
2126 if ( !in_array( $row->pr_type
, $restrictionTypes ) )
2129 // This code should be refactored, now that it's being used more generally,
2130 // But I don't really see any harm in leaving it in Block for now -werdna
2131 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
2133 // Only apply the restrictions if they haven't expired!
2134 if ( !$expiry ||
$expiry > $now ) {
2135 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2136 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2138 $this->mCascadeRestriction |
= $row->pr_cascade
;
2140 // Trigger a lazy purge of expired restrictions
2141 $purgeExpired = true;
2145 if ( $purgeExpired ) {
2146 Title
::purgeExpiredRestrictions();
2150 $this->mRestrictionsLoaded
= true;
2154 * Load restrictions from the page_restrictions table
2156 * @param $oldFashionedRestrictions string comma-separated list of page
2157 * restrictions from page table (pre 1.10)
2159 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2160 if ( !$this->mRestrictionsLoaded
) {
2161 if ( $this->exists() ) {
2162 $dbr = wfGetDB( DB_SLAVE
);
2164 $res = $dbr->select( 'page_restrictions', '*',
2165 array ( 'pr_page' => $this->getArticleId() ), __METHOD__
);
2167 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2169 $title_protection = $this->getTitleProtection();
2171 if ( $title_protection ) {
2172 $now = wfTimestampNow();
2173 $expiry = Block
::decodeExpiry( $title_protection['pt_expiry'] );
2175 if ( !$expiry ||
$expiry > $now ) {
2176 // Apply the restrictions
2177 $this->mRestrictionsExpiry
['create'] = $expiry;
2178 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2179 } else { // Get rid of the old restrictions
2180 Title
::purgeExpiredRestrictions();
2183 $this->mRestrictionsExpiry
['create'] = Block
::decodeExpiry( '' );
2185 $this->mRestrictionsLoaded
= true;
2191 * Purge expired restrictions from the page_restrictions table
2193 static function purgeExpiredRestrictions() {
2194 $dbw = wfGetDB( DB_MASTER
);
2195 $dbw->delete( 'page_restrictions',
2196 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2199 $dbw->delete( 'protected_titles',
2200 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2205 * Accessor/initialisation for mRestrictions
2207 * @param $action \type{\string} action that permission needs to be checked for
2208 * @return \type{\arrayof{\string}} the array of groups allowed to edit this article
2210 public function getRestrictions( $action ) {
2211 if ( !$this->mRestrictionsLoaded
) {
2212 $this->loadRestrictions();
2214 return isset( $this->mRestrictions
[$action] )
2215 ?
$this->mRestrictions
[$action]
2220 * Get the expiry time for the restriction against a given action
2222 * @return 14-char timestamp, or 'infinity' if the page is protected forever
2223 * or not protected at all, or false if the action is not recognised.
2225 public function getRestrictionExpiry( $action ) {
2226 if ( !$this->mRestrictionsLoaded
) {
2227 $this->loadRestrictions();
2229 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2233 * Is there a version of this page in the deletion archive?
2235 * @return \type{\int} the number of archived revisions
2237 public function isDeleted() {
2238 if ( $this->getNamespace() < 0 ) {
2241 $dbr = wfGetDB( DB_SLAVE
);
2242 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2243 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2246 if ( $this->getNamespace() == NS_FILE
) {
2247 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
2248 array( 'fa_name' => $this->getDBkey() ),
2257 * Is there a version of this page in the deletion archive?
2261 public function isDeletedQuick() {
2262 if ( $this->getNamespace() < 0 ) {
2265 $dbr = wfGetDB( DB_SLAVE
);
2266 $deleted = (bool)$dbr->selectField( 'archive', '1',
2267 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2270 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
2271 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2272 array( 'fa_name' => $this->getDBkey() ),
2280 * Get the article ID for this Title from the link cache,
2281 * adding it if necessary
2283 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select
2285 * @return \type{\int} the ID
2287 public function getArticleID( $flags = 0 ) {
2288 if ( $this->getNamespace() < 0 ) {
2289 return $this->mArticleID
= 0;
2291 $linkCache = LinkCache
::singleton();
2292 if ( $flags & GAID_FOR_UPDATE
) {
2293 $oldUpdate = $linkCache->forUpdate( true );
2294 $linkCache->clearLink( $this );
2295 $this->mArticleID
= $linkCache->addLinkObj( $this );
2296 $linkCache->forUpdate( $oldUpdate );
2298 if ( -1 == $this->mArticleID
) {
2299 $this->mArticleID
= $linkCache->addLinkObj( $this );
2302 return $this->mArticleID
;
2306 * Is this an article that is a redirect page?
2307 * Uses link cache, adding it if necessary
2309 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2310 * @return \type{\bool}
2312 public function isRedirect( $flags = 0 ) {
2313 if ( !is_null( $this->mRedirect
) )
2314 return $this->mRedirect
;
2315 # Calling getArticleID() loads the field from cache as needed
2316 if ( !$this->getArticleID( $flags ) ) {
2317 return $this->mRedirect
= false;
2319 $linkCache = LinkCache
::singleton();
2320 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2322 return $this->mRedirect
;
2326 * What is the length of this page?
2327 * Uses link cache, adding it if necessary
2329 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2330 * @return \type{\bool}
2332 public function getLength( $flags = 0 ) {
2333 if ( $this->mLength
!= -1 )
2334 return $this->mLength
;
2335 # Calling getArticleID() loads the field from cache as needed
2336 if ( !$this->getArticleID( $flags ) ) {
2337 return $this->mLength
= 0;
2339 $linkCache = LinkCache
::singleton();
2340 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2342 return $this->mLength
;
2346 * What is the page_latest field for this page?
2348 * @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2349 * @return \type{\int} or 0 if the page doesn't exist
2351 public function getLatestRevID( $flags = 0 ) {
2352 if ( $this->mLatestID
!== false )
2353 return intval( $this->mLatestID
);
2354 # Calling getArticleID() loads the field from cache as needed
2355 if ( !$this->getArticleID( $flags ) ) {
2356 return $this->mLatestID
= 0;
2358 $linkCache = LinkCache
::singleton();
2359 $this->mLatestID
= intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2361 return $this->mLatestID
;
2365 * This clears some fields in this object, and clears any associated
2366 * keys in the "bad links" section of the link cache.
2368 * @param $newid \type{\int} the new Article ID
2370 public function resetArticleID( $newid ) {
2371 $linkCache = LinkCache
::singleton();
2372 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2374 if ( $newid === false ) {
2375 $this->mArticleID
= -1;
2377 $this->mArticleID
= intval( $newid );
2379 $this->mRestrictionsLoaded
= false;
2380 $this->mRestrictions
= array();
2381 $this->mRedirect
= null;
2382 $this->mLength
= -1;
2383 $this->mLatestID
= false;
2387 * Updates page_touched for this page; called from LinksUpdate.php
2389 * @return \type{\bool} true if the update succeded
2391 public function invalidateCache() {
2392 if ( wfReadOnly() ) {
2395 $dbw = wfGetDB( DB_MASTER
);
2396 $success = $dbw->update( 'page',
2397 array( 'page_touched' => $dbw->timestamp() ),
2401 HTMLFileCache
::clearFileCache( $this );
2406 * Prefix some arbitrary text with the namespace or interwiki prefix
2409 * @param $name \type{\string} the text
2410 * @return \type{\string} the prefixed text
2413 /* private */ function prefix( $name ) {
2415 if ( $this->mInterwiki
!= '' ) {
2416 $p = $this->mInterwiki
. ':';
2418 if ( 0 != $this->mNamespace
) {
2419 $p .= $this->getNsText() . ':';
2425 * Returns a simple regex that will match on characters and sequences invalid in titles.
2426 * Note that this doesn't pick up many things that could be wrong with titles, but that
2427 * replacing this regex with something valid will make many titles valid.
2429 * @return string regex string
2431 static function getTitleInvalidRegex() {
2432 static $rxTc = false;
2434 # Matching titles will be held as illegal.
2436 # Any character not allowed is forbidden...
2437 '[^' . Title
::legalChars() . ']' .
2438 # URL percent encoding sequences interfere with the ability
2439 # to round-trip titles -- you can't link to them consistently.
2440 '|%[0-9A-Fa-f]{2}' .
2441 # XML/HTML character references produce similar issues.
2442 '|&[A-Za-z0-9\x80-\xff]+;' .
2444 '|&#x[0-9A-Fa-f]+;' .
2452 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2454 * @param $text string containing title to capitalize
2455 * @param $ns int namespace index, defaults to NS_MAIN
2456 * @return String containing capitalized title
2458 public static function capitalize( $text, $ns = NS_MAIN
) {
2461 if ( MWNamespace
::isCapitalized( $ns ) )
2462 return $wgContLang->ucfirst( $text );
2468 * Secure and split - main initialisation function for this object
2470 * Assumes that mDbkeyform has been set, and is urldecoded
2471 * and uses underscores, but not otherwise munged. This function
2472 * removes illegal characters, splits off the interwiki and
2473 * namespace prefixes, sets the other forms, and canonicalizes
2476 * @return \type{\bool} true on success
2478 private function secureAndSplit() {
2479 global $wgContLang, $wgLocalInterwiki;
2482 $rxTc = self
::getTitleInvalidRegex();
2484 $this->mInterwiki
= $this->mFragment
= '';
2485 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2487 $dbkey = $this->mDbkeyform
;
2489 # Strip Unicode bidi override characters.
2490 # Sometimes they slip into cut-n-pasted page titles, where the
2491 # override chars get included in list displays.
2492 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2494 # Clean up whitespace
2495 # Note: use of the /u option on preg_replace here will cause
2496 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2497 # conveniently disabling them.
2499 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2500 $dbkey = trim( $dbkey, '_' );
2502 if ( $dbkey == '' ) {
2506 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2507 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2511 $this->mDbkeyform
= $dbkey;
2513 # Initial colon indicates main namespace rather than specified default
2514 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2515 if ( ':' == $dbkey { 0 } ) {
2516 $this->mNamespace
= NS_MAIN
;
2517 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2518 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2521 # Namespace or interwiki prefix
2523 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2526 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2528 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
2529 # Ordinary namespace
2531 $this->mNamespace
= $ns;
2532 # For Talk:X pages, check if X has a "namespace" prefix
2533 if ( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2534 if ( $wgContLang->getNsIndex( $x[1] ) )
2535 return false; # Disallow Talk:File:x type titles...
2536 else if ( Interwiki
::isValidInterwiki( $x[1] ) )
2537 return false; # Disallow Talk:Interwiki:x type titles...
2539 } elseif ( Interwiki
::isValidInterwiki( $p ) ) {
2540 if ( !$firstPass ) {
2541 # Can't make a local interwiki link to an interwiki link.
2542 # That's just crazy!
2548 $this->mInterwiki
= $wgContLang->lc( $p );
2550 # Redundant interwiki prefix to the local wiki
2551 if ( 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) ) {
2552 if ( $dbkey == '' ) {
2553 # Can't have an empty self-link
2556 $this->mInterwiki
= '';
2558 # Do another namespace split...
2562 # If there's an initial colon after the interwiki, that also
2563 # resets the default namespace
2564 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2565 $this->mNamespace
= NS_MAIN
;
2566 $dbkey = substr( $dbkey, 1 );
2569 # If there's no recognized interwiki or namespace,
2570 # then let the colon expression be part of the title.
2575 # We already know that some pages won't be in the database!
2577 if ( $this->mInterwiki
!= '' || NS_SPECIAL
== $this->mNamespace
) {
2578 $this->mArticleID
= 0;
2580 $fragment = strstr( $dbkey, '#' );
2581 if ( false !== $fragment ) {
2582 $this->setFragment( preg_replace( '/^#_*/', '#', $fragment ) );
2583 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2584 # remove whitespace again: prevents "Foo_bar_#"
2585 # becoming "Foo_bar_"
2586 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2589 # Reject illegal characters.
2591 if ( preg_match( $rxTc, $dbkey ) ) {
2596 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2597 * reachable due to the way web browsers deal with 'relative' URLs.
2598 * Also, they conflict with subpage syntax. Forbid them explicitly.
2600 if ( strpos( $dbkey, '.' ) !== false &&
2601 ( $dbkey === '.' ||
$dbkey === '..' ||
2602 strpos( $dbkey, './' ) === 0 ||
2603 strpos( $dbkey, '../' ) === 0 ||
2604 strpos( $dbkey, '/./' ) !== false ||
2605 strpos( $dbkey, '/../' ) !== false ||
2606 substr( $dbkey, -2 ) == '/.' ||
2607 substr( $dbkey, -3 ) == '/..' ) )
2613 * Magic tilde sequences? Nu-uh!
2615 if ( strpos( $dbkey, '~~~' ) !== false ) {
2620 * Limit the size of titles to 255 bytes.
2621 * This is typically the size of the underlying database field.
2622 * We make an exception for special pages, which don't need to be stored
2623 * in the database, and may edge over 255 bytes due to subpage syntax
2624 * for long titles, e.g. [[Special:Block/Long name]]
2626 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2627 strlen( $dbkey ) > 512 )
2633 * Normally, all wiki links are forced to have
2634 * an initial capital letter so [[foo]] and [[Foo]]
2635 * point to the same place.
2637 * Don't force it for interwikis, since the other
2638 * site might be case-sensitive.
2640 $this->mUserCaseDBKey
= $dbkey;
2641 if ( $this->mInterwiki
== '' ) {
2642 $dbkey = self
::capitalize( $dbkey, $this->mNamespace
);
2646 * Can't make a link to a namespace alone...
2647 * "empty" local links can only be self-links
2648 * with a fragment identifier.
2650 if ( $dbkey == '' &&
2651 $this->mInterwiki
== '' &&
2652 $this->mNamespace
!= NS_MAIN
) {
2655 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2656 // IP names are not allowed for accounts, and can only be referring to
2657 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2658 // there are numerous ways to present the same IP. Having sp:contribs scan
2659 // them all is silly and having some show the edits and others not is
2660 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2661 $dbkey = ( $this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
) ?
2662 IP
::sanitizeIP( $dbkey ) : $dbkey;
2663 // Any remaining initial :s are illegal.
2664 if ( $dbkey !== '' && ':' == $dbkey { 0 } ) {
2669 $this->mDbkeyform
= $dbkey;
2670 $this->mUrlform
= wfUrlencode( $dbkey );
2672 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2678 * Set the fragment for this title. Removes the first character from the
2679 * specified fragment before setting, so it assumes you're passing it with
2682 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2683 * Still in active use privately.
2685 * @param $fragment \type{\string} text
2687 public function setFragment( $fragment ) {
2688 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2692 * Get a Title object associated with the talk page of this article
2694 * @return \type{Title} the object for the talk page
2696 public function getTalkPage() {
2697 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2701 * Get a title object associated with the subject page of this
2704 * @return \type{Title} the object for the subject page
2706 public function getSubjectPage() {
2707 // Is this the same title?
2708 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
2709 if ( $this->getNamespace() == $subjectNS ) {
2712 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
2716 * Get an array of Title objects linking to this Title
2717 * Also stores the IDs in the link cache.
2719 * WARNING: do not use this function on arbitrary user-supplied titles!
2720 * On heavily-used templates it will max out the memory.
2722 * @param $options Array: may be FOR UPDATE
2723 * @param $table String: table name
2724 * @param $prefix String: fields prefix
2725 * @return \type{\arrayof{Title}} the Title objects linking here
2727 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
2728 $linkCache = LinkCache
::singleton();
2730 if ( count( $options ) > 0 ) {
2731 $db = wfGetDB( DB_MASTER
);
2733 $db = wfGetDB( DB_SLAVE
);
2736 $res = $db->select( array( 'page', $table ),
2737 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
2739 "{$prefix}_from=page_id",
2740 "{$prefix}_namespace" => $this->getNamespace(),
2741 "{$prefix}_title" => $this->getDBkey() ),
2746 if ( $db->numRows( $res ) ) {
2747 foreach ( $res as $row ) {
2748 if ( $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
) ) {
2749 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
, $row->page_latest
);
2750 $retVal[] = $titleObj;
2754 $db->freeResult( $res );
2759 * Get an array of Title objects using this Title as a template
2760 * Also stores the IDs in the link cache.
2762 * WARNING: do not use this function on arbitrary user-supplied titles!
2763 * On heavily-used templates it will max out the memory.
2765 * @param $options Array: may be FOR UPDATE
2766 * @return \type{\arrayof{Title}} the Title objects linking here
2768 public function getTemplateLinksTo( $options = array() ) {
2769 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2773 * Get an array of Title objects referring to non-existent articles linked from this page
2775 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2776 * @return \type{\arrayof{Title}} the Title objects
2778 public function getBrokenLinksFrom() {
2779 if ( $this->getArticleId() == 0 ) {
2780 # All links from article ID 0 are false positives
2784 $dbr = wfGetDB( DB_SLAVE
);
2785 $res = $dbr->select(
2786 array( 'page', 'pagelinks' ),
2787 array( 'pl_namespace', 'pl_title' ),
2789 'pl_from' => $this->getArticleId(),
2790 'page_namespace IS NULL'
2792 __METHOD__
, array(),
2796 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
2802 foreach ( $res as $row ) {
2803 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2810 * Get a list of URLs to purge from the Squid cache when this
2813 * @return \type{\arrayof{\string}} the URLs
2815 public function getSquidURLs() {
2819 $this->getInternalURL(),
2820 $this->getInternalURL( 'action=history' )
2823 // purge variant urls as well
2824 if ( $wgContLang->hasVariants() ) {
2825 $variants = $wgContLang->getVariants();
2826 foreach ( $variants as $vCode ) {
2827 $urls[] = $this->getInternalURL( '', $vCode );
2835 * Purge all applicable Squid URLs
2837 public function purgeSquid() {
2839 if ( $wgUseSquid ) {
2840 $urls = $this->getSquidURLs();
2841 $u = new SquidUpdate( $urls );
2847 * Move this page without authentication
2849 * @param $nt \type{Title} the new page Title
2850 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2852 public function moveNoAuth( &$nt ) {
2853 return $this->moveTo( $nt, false );
2857 * Check whether a given move operation would be valid.
2858 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2860 * @param $nt \type{Title} the new title
2861 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2863 * @param $reason \type{\string} is the log summary of the move, used for spam checking
2864 * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure
2866 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2871 // Normally we'd add this to $errors, but we'll get
2872 // lots of syntax errors if $nt is not an object
2873 return array( array( 'badtitletext' ) );
2875 if ( $this->equals( $nt ) ) {
2876 $errors[] = array( 'selfmove' );
2878 if ( !$this->isMovable() ) {
2879 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2881 if ( $nt->getInterwiki() != '' ) {
2882 $errors[] = array( 'immobile-target-namespace-iw' );
2884 if ( !$nt->isMovable() ) {
2885 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
2888 $oldid = $this->getArticleID();
2889 $newid = $nt->getArticleID();
2891 if ( strlen( $nt->getDBkey() ) < 1 ) {
2892 $errors[] = array( 'articleexists' );
2894 if ( ( $this->getDBkey() == '' ) ||
2896 ( $nt->getDBkey() == '' ) ) {
2897 $errors[] = array( 'badarticleerror' );
2900 // Image-specific checks
2901 if ( $this->getNamespace() == NS_FILE
) {
2902 if ( $nt->getNamespace() != NS_FILE
) {
2903 $errors[] = array( 'imagenocrossnamespace' );
2905 $file = wfLocalFile( $this );
2906 if ( $file->exists() ) {
2907 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
2908 $errors[] = array( 'imageinvalidfilename' );
2910 if ( !File
::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
2911 $errors[] = array( 'imagetypemismatch' );
2914 $destfile = wfLocalFile( $nt );
2915 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destfile->exists() && wfFindFile( $nt ) ) {
2916 $errors[] = array( 'file-exists-sharedrepo' );
2920 if ( $nt->getNamespace() == NS_FILE
&& $this->getNamespace() != NS_FILE
) {
2921 $errors[] = array( 'nonfile-cannot-move-to-file' );
2925 $errors = wfMergeErrorArrays( $errors,
2926 $this->getUserPermissionsErrors( 'move', $wgUser ),
2927 $this->getUserPermissionsErrors( 'edit', $wgUser ),
2928 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
2929 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
2932 $match = EditPage
::matchSummarySpamRegex( $reason );
2933 if ( $match !== false ) {
2934 // This is kind of lame, won't display nice
2935 $errors[] = array( 'spamprotectiontext' );
2939 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
2940 $errors[] = array( 'hookaborted', $err );
2943 # The move is allowed only if (1) the target doesn't exist, or
2944 # (2) the target is a redirect to the source, and has no history
2945 # (so we can undo bad moves right after they're done).
2947 if ( 0 != $newid ) { # Target exists; check for validity
2948 if ( !$this->isValidMoveTarget( $nt ) ) {
2949 $errors[] = array( 'articleexists' );
2952 $tp = $nt->getTitleProtection();
2953 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
2954 if ( $tp and !$wgUser->isAllowed( $right ) ) {
2955 $errors[] = array( 'cantmove-titleprotected' );
2958 if ( empty( $errors ) )
2964 * Move a title to a new location
2966 * @param $nt \type{Title} the new title
2967 * @param $auth \type{\bool} indicates whether $wgUser's permissions
2969 * @param $reason \type{\string} The reason for the move
2970 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title.
2971 * Ignored if the user doesn't have the suppressredirect right.
2972 * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
2974 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
2975 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
2976 if ( is_array( $err ) ) {
2980 // If it is a file, move it first. It is done before all other moving stuff is done because it's hard to revert
2981 $dbw = wfGetDB( DB_MASTER
);
2982 if ( $this->getNamespace() == NS_FILE
) {
2983 $file = wfLocalFile( $this );
2984 if ( $file->exists() ) {
2985 $status = $file->move( $nt );
2986 if ( !$status->isOk() ) {
2987 return $status->getErrorsArray();
2992 $pageid = $this->getArticleID();
2993 $protected = $this->isProtected();
2994 if ( $nt->exists() ) {
2995 $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect );
2996 $pageCountChange = ( $createRedirect ?
0 : -1 );
2997 } else { # Target didn't exist, do normal move.
2998 $err = $this->moveToNewTitle( $nt, $reason, $createRedirect );
2999 $pageCountChange = ( $createRedirect ?
1 : 0 );
3002 if ( is_array( $err ) ) {
3005 $redirid = $this->getArticleID();
3007 // Category memberships include a sort key which may be customized.
3008 // If it's left as the default (the page title), we need to update
3009 // the sort key to match the new title.
3011 // Be careful to avoid resetting cl_timestamp, which may disturb
3012 // time-based lists on some sites.
3014 // Warning -- if the sort key is *explicitly* set to the old title,
3015 // we can't actually distinguish it from a default here, and it'll
3016 // be set to the new title even though it really shouldn't.
3017 // It'll get corrected on the next edit, but resetting cl_timestamp.
3018 $dbw->update( 'categorylinks',
3020 'cl_sortkey' => $nt->getPrefixedText(),
3021 'cl_timestamp=cl_timestamp' ),
3023 'cl_from' => $pageid,
3024 'cl_sortkey' => $this->getPrefixedText() ),
3028 # Protect the redirect title as the title used to be...
3029 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3031 'pr_page' => $redirid,
3032 'pr_type' => 'pr_type',
3033 'pr_level' => 'pr_level',
3034 'pr_cascade' => 'pr_cascade',
3035 'pr_user' => 'pr_user',
3036 'pr_expiry' => 'pr_expiry'
3038 array( 'pr_page' => $pageid ),
3042 # Update the protection log
3043 $log = new LogPage( 'protect' );
3044 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3045 if ( $reason ) $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3046 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) ); // FIXME: $params?
3050 $oldnamespace = $this->getNamespace() & ~
1;
3051 $newnamespace = $nt->getNamespace() & ~
1;
3052 $oldtitle = $this->getDBkey();
3053 $newtitle = $nt->getDBkey();
3055 if ( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
3056 WatchedItem
::duplicateEntries( $this, $nt );
3059 # Update search engine
3060 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
3062 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
3066 if ( $this->isContentPage() && !$nt->isContentPage() ) {
3067 # No longer a content page
3068 # Not viewed, edited, removing
3069 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
3070 } elseif ( !$this->isContentPage() && $nt->isContentPage() ) {
3071 # Now a content page
3072 # Not viewed, edited, adding
3073 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
3074 } elseif ( $pageCountChange ) {
3076 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
3083 # Update message cache for interface messages
3084 if ( $nt->getNamespace() == NS_MEDIAWIKI
) {
3085 global $wgMessageCache;
3087 # @bug 17860: old article can be deleted, if this the case,
3088 # delete it from message cache
3089 if ( $this->getArticleID() === 0 ) {
3090 $wgMessageCache->replace( $this->getDBkey(), false );
3092 $oldarticle = new Article( $this );
3093 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
3096 $newarticle = new Article( $nt );
3097 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
3101 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3106 * Move page to a title which is at present a redirect to the
3109 * @param $nt \type{Title} the page to move to, which should currently
3111 * @param $reason \type{\string} The reason for the move
3112 * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title.
3113 * Ignored if the user doesn't have the suppressredirect right
3115 private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
3116 global $wgUseSquid, $wgUser, $wgContLang;
3118 $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
3121 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3123 # Truncate for whole multibyte characters. +5 bytes for ellipsis
3124 $comment = $wgContLang->truncate( $comment, 250 );
3126 $now = wfTimestampNow();
3127 $newid = $nt->getArticleID();
3128 $oldid = $this->getArticleID();
3129 $latest = $this->getLatestRevID();
3131 $dbw = wfGetDB( DB_MASTER
);
3133 $rcts = $dbw->timestamp( $nt->getEarliestRevTime() );
3134 $newns = $nt->getNamespace();
3135 $newdbk = $nt->getDBkey();
3137 # Delete the old redirect. We don't save it to history since
3138 # by definition if we've got here it's rather uninteresting.
3139 # We have to remove it so that the next step doesn't trigger
3140 # a conflict on the unique namespace+title index...
3141 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__
);
3142 if ( !$dbw->cascadingDeletes() ) {
3143 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
3144 global $wgUseTrackbacks;
3145 if ( $wgUseTrackbacks )
3146 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
3147 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
3148 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
3149 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
3150 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
3151 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
3152 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
3153 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
3155 // If the redirect was recently created, it may have an entry in recentchanges still
3156 $dbw->delete( 'recentchanges',
3157 array( 'rc_timestamp' => $rcts, 'rc_namespace' => $newns, 'rc_title' => $newdbk, 'rc_new' => 1 ),
3161 # Save a null revision in the page's history notifying of the move
3162 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
3163 $nullRevId = $nullRevision->insertOn( $dbw );
3165 $article = new Article( $this );
3166 wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) );
3168 # Change the name of the target page:
3169 $dbw->update( 'page',
3171 'page_touched' => $dbw->timestamp( $now ),
3172 'page_namespace' => $nt->getNamespace(),
3173 'page_title' => $nt->getDBkey(),
3174 'page_latest' => $nullRevId,
3176 /* WHERE */ array( 'page_id' => $oldid ),
3179 $nt->resetArticleID( $oldid );
3181 # Recreate the redirect, this time in the other direction.
3182 if ( $createRedirect ||
!$wgUser->isAllowed( 'suppressredirect' ) ) {
3183 $mwRedir = MagicWord
::get( 'redirect' );
3184 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3185 $redirectArticle = new Article( $this );
3186 $newid = $redirectArticle->insertOn( $dbw );
3187 $redirectRevision = new Revision( array(
3189 'comment' => $comment,
3190 'text' => $redirectText ) );
3191 $redirectRevision->insertOn( $dbw );
3192 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3194 wfRunHooks( 'NewRevisionFromEditComplete', array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3196 # Now, we record the link from the redirect to the new title.
3197 # It should have no other outgoing links...
3198 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
3199 $dbw->insert( 'pagelinks',
3201 'pl_from' => $newid,
3202 'pl_namespace' => $nt->getNamespace(),
3203 'pl_title' => $nt->getDBkey() ),
3205 $redirectSuppressed = false;
3207 $this->resetArticleID( 0 );
3208 $redirectSuppressed = true;
3212 $log = new LogPage( 'move' );
3213 $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3216 if ( $wgUseSquid ) {
3217 $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() );
3218 $u = new SquidUpdate( $urls );
3225 * Move page to non-existing title.
3227 * @param $nt \type{Title} the new Title
3228 * @param $reason \type{\string} The reason for the move
3229 * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title
3230 * Ignored if the user doesn't have the suppressredirect right
3232 private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) {
3233 global $wgUser, $wgContLang;
3235 $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3237 $comment .= wfMsgExt( 'colon-separator',
3238 array( 'escapenoentities', 'content' ) );
3239 $comment .= $reason;
3241 # Truncate for whole multibyte characters. +5 bytes for ellipsis
3242 $comment = $wgContLang->truncate( $comment, 250 );
3244 $newid = $nt->getArticleID();
3245 $oldid = $this->getArticleID();
3246 $latest = $this->getLatestRevId();
3248 $dbw = wfGetDB( DB_MASTER
);
3249 $now = $dbw->timestamp();
3251 # Save a null revision in the page's history notifying of the move
3252 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
3253 if ( !is_object( $nullRevision ) ) {
3254 throw new MWException( 'No valid null revision produced in ' . __METHOD__
);
3256 $nullRevId = $nullRevision->insertOn( $dbw );
3258 $article = new Article( $this );
3259 wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) );
3262 $dbw->update( 'page',
3264 'page_touched' => $now,
3265 'page_namespace' => $nt->getNamespace(),
3266 'page_title' => $nt->getDBkey(),
3267 'page_latest' => $nullRevId,
3269 /* WHERE */ array( 'page_id' => $oldid ),
3272 $nt->resetArticleID( $oldid );
3274 if ( $createRedirect ||
!$wgUser->isAllowed( 'suppressredirect' ) ) {
3276 $mwRedir = MagicWord
::get( 'redirect' );
3277 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3278 $redirectArticle = new Article( $this );
3279 $newid = $redirectArticle->insertOn( $dbw );
3280 $redirectRevision = new Revision( array(
3282 'comment' => $comment,
3283 'text' => $redirectText ) );
3284 $redirectRevision->insertOn( $dbw );
3285 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3287 wfRunHooks( 'NewRevisionFromEditComplete', array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3289 # Record the just-created redirect's linking to the page
3290 $dbw->insert( 'pagelinks',
3292 'pl_from' => $newid,
3293 'pl_namespace' => $nt->getNamespace(),
3294 'pl_title' => $nt->getDBkey() ),
3296 $redirectSuppressed = false;
3298 $this->resetArticleID( 0 );
3299 $redirectSuppressed = true;
3303 $log = new LogPage( 'move' );
3304 $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3306 # Purge caches as per article creation
3307 Article
::onArticleCreate( $nt );
3309 # Purge old title from squid
3310 # The new title, and links to the new title, are purged in Article::onArticleCreate()
3311 $this->purgeSquid();
3316 * Move this page's subpages to be subpages of $nt
3318 * @param $nt Title Move target
3319 * @param $auth bool Whether $wgUser's permissions should be checked
3320 * @param $reason string The reason for the move
3321 * @param $createRedirect bool Whether to create redirects from the old subpages to the new ones
3322 * Ignored if the user doesn't have the 'suppressredirect' right
3323 * @return mixed array with old page titles as keys, and strings (new page titles) or
3324 * arrays (errors) as values, or an error array with numeric indices if no pages were moved
3326 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3327 global $wgMaximumMovedPages;
3328 // Check permissions
3329 if ( !$this->userCan( 'move-subpages' ) )
3330 return array( 'cant-move-subpages' );
3331 // Do the source and target namespaces support subpages?
3332 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) )
3333 return array( 'namespace-nosubpages',
3334 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3335 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) )
3336 return array( 'namespace-nosubpages',
3337 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3339 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3342 foreach ( $subpages as $oldSubpage ) {
3344 if ( $count > $wgMaximumMovedPages ) {
3345 $retval[$oldSubpage->getPrefixedTitle()] =
3346 array( 'movepage-max-pages',
3347 $wgMaximumMovedPages );
3351 // We don't know whether this function was called before
3352 // or after moving the root page, so check both
3354 if ( $oldSubpage->getArticleId() == $this->getArticleId() ||
3355 $oldSubpage->getArticleID() == $nt->getArticleId() )
3356 // When moving a page to a subpage of itself,
3357 // don't move it twice
3359 $newPageName = preg_replace(
3360 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3361 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3362 $oldSubpage->getDBkey() );
3363 if ( $oldSubpage->isTalkPage() ) {
3364 $newNs = $nt->getTalkPage()->getNamespace();
3366 $newNs = $nt->getSubjectPage()->getNamespace();
3368 # Bug 14385: we need makeTitleSafe because the new page names may
3369 # be longer than 255 characters.
3370 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3372 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3373 if ( $success === true ) {
3374 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3376 $retval[$oldSubpage->getPrefixedText()] = $success;
3383 * Checks if this page is just a one-rev redirect.
3384 * Adds lock, so don't use just for light purposes.
3386 * @return \type{\bool}
3388 public function isSingleRevRedirect() {
3389 $dbw = wfGetDB( DB_MASTER
);
3391 $row = $dbw->selectRow( 'page',
3392 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3395 array( 'FOR UPDATE' )
3397 # Cache some fields we may want
3398 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3399 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3400 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3401 if ( !$this->mRedirect
) {
3404 # Does the article have a history?
3405 $row = $dbw->selectField( array( 'page', 'revision' ),
3407 array( 'page_namespace' => $this->getNamespace(),
3408 'page_title' => $this->getDBkey(),
3410 'page_latest != rev_id'
3413 array( 'FOR UPDATE' )
3415 # Return true if there was no history
3416 return ( $row === false );
3420 * Checks if $this can be moved to a given Title
3421 * - Selects for update, so don't call it unless you mean business
3423 * @param $nt \type{Title} the new title to check
3424 * @return \type{\bool} TRUE or FALSE
3426 public function isValidMoveTarget( $nt ) {
3427 $dbw = wfGetDB( DB_MASTER
);
3428 # Is it an existing file?
3429 if ( $nt->getNamespace() == NS_FILE
) {
3430 $file = wfLocalFile( $nt );
3431 if ( $file->exists() ) {
3432 wfDebug( __METHOD__
. ": file exists\n" );
3436 # Is it a redirect with no history?
3437 if ( !$nt->isSingleRevRedirect() ) {
3438 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3441 # Get the article text
3442 $rev = Revision
::newFromTitle( $nt );
3443 $text = $rev->getText();
3444 # Does the redirect point to the source?
3445 # Or is it a broken self-redirect, usually caused by namespace collisions?
3447 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3448 $redirTitle = Title
::newFromText( $m[1] );
3449 if ( !is_object( $redirTitle ) ||
3450 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3451 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3452 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3457 wfDebug( __METHOD__
. ": failsafe\n" );
3464 * Can this title be added to a user's watchlist?
3466 * @return \type{\bool} TRUE or FALSE
3468 public function isWatchable() {
3469 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
3473 * Get categories to which this Title belongs and return an array of
3474 * categories' names.
3476 * @return \type{\array} array an array of parents in the form:
3477 * $parent => $currentarticle
3479 public function getParentCategories() {
3482 $titlekey = $this->getArticleId();
3483 $dbr = wfGetDB( DB_SLAVE
);
3484 $categorylinks = $dbr->tableName( 'categorylinks' );
3487 $sql = "SELECT * FROM $categorylinks"
3488 . " WHERE cl_from='$titlekey'"
3489 . " AND cl_from <> '0'"
3490 . " ORDER BY cl_sortkey";
3492 $res = $dbr->query( $sql );
3494 if ( $dbr->numRows( $res ) > 0 ) {
3495 foreach ( $res as $row )
3496 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3497 $data[$wgContLang->getNSText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3498 $dbr->freeResult( $res );
3506 * Get a tree of parent categories
3508 * @param $children \type{\array} an array with the children in the keys, to check for circular refs
3509 * @return \type{\array} Tree of parent categories
3511 public function getParentCategoryTree( $children = array() ) {
3513 $parents = $this->getParentCategories();
3516 foreach ( $parents as $parent => $current ) {
3517 if ( array_key_exists( $parent, $children ) ) {
3518 # Circular reference
3519 $stack[$parent] = array();
3521 $nt = Title
::newFromText( $parent );
3523 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3535 * Get an associative array for selecting this title from
3538 * @return \type{\array} Selection array
3540 public function pageCond() {
3541 if ( $this->mArticleID
> 0 ) {
3542 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3543 return array( 'page_id' => $this->mArticleID
);
3545 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3550 * Get the revision ID of the previous revision
3552 * @param $revId \type{\int} Revision ID. Get the revision that was before this one.
3553 * @param $flags \type{\int} GAID_FOR_UPDATE
3554 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3556 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3557 $db = ( $flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3558 return $db->selectField( 'revision', 'rev_id',
3560 'rev_page' => $this->getArticleId( $flags ),
3561 'rev_id < ' . intval( $revId )
3564 array( 'ORDER BY' => 'rev_id DESC' )
3569 * Get the revision ID of the next revision
3571 * @param $revId \type{\int} Revision ID. Get the revision that was after this one.
3572 * @param $flags \type{\int} GAID_FOR_UPDATE
3573 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3575 public function getNextRevisionID( $revId, $flags = 0 ) {
3576 $db = ( $flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3577 return $db->selectField( 'revision', 'rev_id',
3579 'rev_page' => $this->getArticleId( $flags ),
3580 'rev_id > ' . intval( $revId )
3583 array( 'ORDER BY' => 'rev_id' )
3588 * Get the first revision of the page
3590 * @param $flags \type{\int} GAID_FOR_UPDATE
3591 * @return Revision (or NULL if page doesn't exist)
3593 public function getFirstRevision( $flags = 0 ) {
3594 $db = ( $flags & GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3595 $pageId = $this->getArticleId( $flags );
3596 if ( !$pageId ) return null;
3597 $row = $db->selectRow( 'revision', '*',
3598 array( 'rev_page' => $pageId ),
3600 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3605 return new Revision( $row );
3610 * Check if this is a new page
3614 public function isNewPage() {
3615 $dbr = wfGetDB( DB_SLAVE
);
3616 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3620 * Get the oldest revision timestamp of this page
3622 * @return String: MW timestamp
3624 public function getEarliestRevTime() {
3625 $dbr = wfGetDB( DB_SLAVE
);
3626 if ( $this->exists() ) {
3627 $min = $dbr->selectField( 'revision',
3628 'MIN(rev_timestamp)',
3629 array( 'rev_page' => $this->getArticleId() ),
3631 return wfTimestampOrNull( TS_MW
, $min );
3637 * Get the number of revisions between the given revision IDs.
3638 * Used for diffs and other things that really need it.
3640 * @param $old \type{\int} Revision ID.
3641 * @param $new \type{\int} Revision ID.
3642 * @return \type{\int} Number of revisions between these IDs.
3644 public function countRevisionsBetween( $old, $new ) {
3645 $dbr = wfGetDB( DB_SLAVE
);
3646 return (int)$dbr->selectField( 'revision', 'count(*)',
3647 'rev_page = ' . intval( $this->getArticleId() ) .
3648 ' AND rev_id > ' . intval( $old ) .
3649 ' AND rev_id < ' . intval( $new ),
3655 * Compare with another title.
3657 * @param $title \type{Title}
3658 * @return \type{\bool} TRUE or FALSE
3660 public function equals( Title
$title ) {
3661 // Note: === is necessary for proper matching of number-like titles.
3662 return $this->getInterwiki() === $title->getInterwiki()
3663 && $this->getNamespace() == $title->getNamespace()
3664 && $this->getDBkey() === $title->getDBkey();
3668 * Callback for usort() to do title sorts by (namespace, title)
3670 * @return Integer: result of string comparison, or namespace comparison
3672 public static function compare( $a, $b ) {
3673 if ( $a->getNamespace() == $b->getNamespace() ) {
3674 return strcmp( $a->getText(), $b->getText() );
3676 return $a->getNamespace() - $b->getNamespace();
3681 * Return a string representation of this title
3683 * @return \type{\string} String representation of this title
3685 public function __toString() {
3686 return $this->getPrefixedText();
3690 * Check if page exists. For historical reasons, this function simply
3691 * checks for the existence of the title in the page table, and will
3692 * thus return false for interwiki links, special pages and the like.
3693 * If you want to know if a title can be meaningfully viewed, you should
3694 * probably call the isKnown() method instead.
3696 * @return \type{\bool}
3698 public function exists() {
3699 return $this->getArticleId() != 0;
3703 * Should links to this title be shown as potentially viewable (i.e. as
3704 * "bluelinks"), even if there's no record by this title in the page
3707 * This function is semi-deprecated for public use, as well as somewhat
3708 * misleadingly named. You probably just want to call isKnown(), which
3709 * calls this function internally.
3711 * (ISSUE: Most of these checks are cheap, but the file existence check
3712 * can potentially be quite expensive. Including it here fixes a lot of
3713 * existing code, but we might want to add an optional parameter to skip
3714 * it and any other expensive checks.)
3716 * @return \type{\bool}
3718 public function isAlwaysKnown() {
3719 if ( $this->mInterwiki
!= '' ) {
3720 return true; // any interwiki link might be viewable, for all we know
3722 switch( $this->mNamespace
) {
3725 return (bool)wfFindFile( $this ); // file exists, possibly in a foreign repo
3727 return SpecialPage
::exists( $this->getDBkey() ); // valid special page
3729 return $this->mDbkeyform
== ''; // selflink, possibly with fragment
3731 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3732 // the full l10n of that language to be loaded. That takes much memory and
3733 // isn't needed. So we strip the language part away.
3734 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
3735 return (bool)wfMsgWeirdKey( $basename ); // known system message
3742 * Does this title refer to a page that can (or might) be meaningfully
3743 * viewed? In particular, this function may be used to determine if
3744 * links to the title should be rendered as "bluelinks" (as opposed to
3745 * "redlinks" to non-existent pages).
3747 * @return \type{\bool}
3749 public function isKnown() {
3750 return $this->exists() ||
$this->isAlwaysKnown();
3754 * Does this page have source text?
3758 public function hasSourceText() {
3759 if ( $this->exists() )
3762 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
3763 // If the page doesn't exist but is a known system message, default
3764 // message content will be displayed, same for language subpages
3765 // Also, if the page is form Mediawiki:message/lang, calling wfMsgWeirdKey
3766 // causes the full l10n of that language to be loaded. That takes much
3767 // memory and isn't needed. So we strip the language part away.
3768 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
3769 return (bool)wfMsgWeirdKey( $basename );
3776 * Is this in a namespace that allows actual pages?
3778 * @return \type{\bool}
3779 * @internal note -- uses hardcoded namespace index instead of constants
3781 public function canExist() {
3782 return $this->mNamespace
>= 0 && $this->mNamespace
!= NS_MEDIA
;
3786 * Update page_touched timestamps and send squid purge messages for
3787 * pages linking to this title. May be sent to the job queue depending
3788 * on the number of links. Typically called on create and delete.
3790 public function touchLinks() {
3791 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3794 if ( $this->getNamespace() == NS_CATEGORY
) {
3795 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3801 * Get the last touched timestamp
3803 * @param $db DatabaseBase: optional db
3804 * @return \type{\string} Last touched timestamp
3806 public function getTouched( $db = null ) {
3807 $db = isset( $db ) ?
$db : wfGetDB( DB_SLAVE
);
3808 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
3813 * Get the timestamp when this page was updated since the user last saw it.
3816 * @return Mixed: string/null
3818 public function getNotificationTimestamp( $user = null ) {
3819 global $wgUser, $wgShowUpdatedMarker;
3820 // Assume current user if none given
3821 if ( !$user ) $user = $wgUser;
3822 // Check cache first
3823 $uid = $user->getId();
3824 if ( isset( $this->mNotificationTimestamp
[$uid] ) ) {
3825 return $this->mNotificationTimestamp
[$uid];
3827 if ( !$uid ||
!$wgShowUpdatedMarker ) {
3828 return $this->mNotificationTimestamp
[$uid] = false;
3830 // Don't cache too much!
3831 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
3832 $this->mNotificationTimestamp
= array();
3834 $dbr = wfGetDB( DB_SLAVE
);
3835 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
3836 'wl_notificationtimestamp',
3837 array( 'wl_namespace' => $this->getNamespace(),
3838 'wl_title' => $this->getDBkey(),
3839 'wl_user' => $user->getId()
3843 return $this->mNotificationTimestamp
[$uid];
3847 * Get the trackback URL for this page
3849 * @return \type{\string} Trackback URL
3851 public function trackbackURL() {
3852 global $wgScriptPath, $wgServer, $wgScriptExtension;
3854 return "$wgServer$wgScriptPath/trackback$wgScriptExtension?article="
3855 . htmlspecialchars( urlencode( $this->getPrefixedDBkey() ) );
3859 * Get the trackback RDF for this page
3861 * @return \type{\string} Trackback RDF
3863 public function trackbackRDF() {
3864 $url = htmlspecialchars( $this->getFullURL() );
3865 $title = htmlspecialchars( $this->getText() );
3866 $tburl = $this->trackbackURL();
3868 // Autodiscovery RDF is placed in comments so HTML validator
3869 // won't barf. This is a rather icky workaround, but seems
3870 // frequently used by this kind of RDF thingy.
3872 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3874 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3875 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3876 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3879 dc:identifier=\"$url\"
3881 trackback:ping=\"$tburl\" />
3887 * Generate strings used for xml 'id' names in monobook tabs
3889 * @param $prepend string defaults to 'nstab-'
3890 * @return \type{\string} XML 'id' name
3892 public function getNamespaceKey( $prepend = 'nstab-' ) {
3894 // Gets the subject namespace if this title
3895 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
3896 // Checks if cononical namespace name exists for namespace
3897 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
3898 // Uses canonical namespace name
3899 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
3901 // Uses text of namespace
3902 $namespaceKey = $this->getSubjectNsText();
3904 // Makes namespace key lowercase
3905 $namespaceKey = $wgContLang->lc( $namespaceKey );
3907 if ( $namespaceKey == '' ) {
3908 $namespaceKey = 'main';
3910 // Changes file to image for backwards compatibility
3911 if ( $namespaceKey == 'file' ) {
3912 $namespaceKey = 'image';
3914 return $prepend . $namespaceKey;
3918 * Returns true if this is a special page.
3922 public function isSpecialPage( ) {
3923 return $this->getNamespace() == NS_SPECIAL
;
3927 * Returns true if this title resolves to the named special page
3929 * @param $name \type{\string} The special page name
3932 public function isSpecial( $name ) {
3933 if ( $this->getNamespace() == NS_SPECIAL
) {
3934 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
3935 if ( $name == $thisName ) {
3943 * If the Title refers to a special page alias which is not the local default,
3945 * @return \type{Title} A new Title which points to the local default.
3946 * Otherwise, returns $this.
3948 public function fixSpecialName() {
3949 if ( $this->getNamespace() == NS_SPECIAL
) {
3950 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
3951 if ( $canonicalName ) {
3952 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
3953 if ( $localName != $this->mDbkeyform
) {
3954 return Title
::makeTitle( NS_SPECIAL
, $localName );
3962 * Is this Title in a namespace which contains content?
3963 * In other words, is this a content page, for the purposes of calculating
3966 * @return \type{\bool}
3968 public function isContentPage() {
3969 return MWNamespace
::isContent( $this->getNamespace() );
3973 * Get all extant redirects to this Title
3975 * @param $ns \twotypes{\int,\null} Single namespace to consider;
3976 * NULL to consider all namespaces
3977 * @return \type{\arrayof{Title}} Redirects to this title
3979 public function getRedirectsHere( $ns = null ) {
3982 $dbr = wfGetDB( DB_SLAVE
);
3984 'rd_namespace' => $this->getNamespace(),
3985 'rd_title' => $this->getDBkey(),
3988 if ( !is_null( $ns ) ) $where['page_namespace'] = $ns;
3990 $res = $dbr->select(
3991 array( 'redirect', 'page' ),
3992 array( 'page_namespace', 'page_title' ),
3998 foreach ( $res as $row ) {
3999 $redirs[] = self
::newFromRow( $row );
4005 * Check if this Title is a valid redirect target
4007 * @return \type{\bool}
4009 public function isValidRedirectTarget() {
4010 global $wgInvalidRedirectTargets;
4012 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4013 if ( $this->isSpecial( 'Userlogout' ) ) {
4017 foreach ( $wgInvalidRedirectTargets as $target ) {
4018 if ( $this->isSpecial( $target ) ) {
4027 * Get a backlink cache object
4029 * @return object BacklinkCache
4031 function getBacklinkCache() {
4032 if ( is_null( $this->mBacklinkCache
) ) {
4033 $this->mBacklinkCache
= new BacklinkCache( $this );
4035 return $this->mBacklinkCache
;
4039 * Whether the magic words __INDEX__ and __NOINDEX__ function for
4044 public function canUseNoindex() {
4045 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4047 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4048 ?
$wgContentNamespaces
4049 : $wgExemptFromUserRobotsControl;
4051 return !in_array( $this->mNamespace
, $bannedNamespaces );
4056 * Returns restriction types for the current Title
4058 * @return array applicable restriction types
4060 public function getRestrictionTypes() {
4061 global $wgRestrictionTypes;
4062 $types = $this->exists() ?
$wgRestrictionTypes : array( 'create' );
4064 if ( $this->getNamespace() == NS_FILE
) {
4065 $types[] = 'upload';
4068 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );