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' );
17 * @deprecated This used to be a define, but was moved to
18 * Title::GAID_FOR_UPDATE in 1.17. This will probably be removed in 1.18
20 define( 'GAID_FOR_UPDATE', Title
::GAID_FOR_UPDATE
);
23 * Represents a title within MediaWiki.
24 * Optionally may contain an interwiki designation or namespace.
25 * @note This class can fetch various kinds of data from the database;
26 * however, it does so inefficiently.
28 * @internal documentation reviewed 15 Mar 2010
31 /** @name Static cache variables */
33 static private $titleCache = array();
37 * Title::newFromText maintains a cache to avoid expensive re-normalization of
38 * commonly used titles. On a batch operation this can become a memory leak
39 * if not bounded. After hitting this many titles reset the cache.
41 const CACHE_MAX
= 1000;
44 * Used to be GAID_FOR_UPDATE define. Used with getArticleId() and friends
45 * to use the master DB
47 const GAID_FOR_UPDATE
= 1;
51 * @name Private member variables
52 * Please use the accessor functions instead.
57 var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
58 var $mUrlform = ''; // /< URL-encoded form of the main part
59 var $mDbkeyform = ''; // /< Main part with underscores
60 var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
61 var $mNamespace = NS_MAIN
; // /< Namespace index, i.e. one of the NS_xxxx constants
62 var $mInterwiki = ''; // /< Interwiki prefix (or null string)
63 var $mFragment; // /< Title fragment (i.e. the bit after the #)
64 var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
65 var $mLatestID = false; // /< ID of most recent revision
66 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
67 var $mOldRestrictions = false;
68 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
69 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
70 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
71 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
72 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
73 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
74 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
75 var $mTitleProtection; ///< Cached value for getTitleProtection (create protection)
76 # Don't change the following default, NS_MAIN is hardcoded in several
77 # places. See bug 696.
78 var $mDefaultNamespace = NS_MAIN
; // /< Namespace index when there is no namespace
79 # Zero except in {{transclusion}} tags
80 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
81 var $mLength = -1; // /< The page length, 0 for special pages
82 var $mRedirect = null; // /< Is the article at this title a redirect?
83 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
84 var $mBacklinkCache = null; // /< Cache of links to this title
92 /* private */ function __construct() { }
95 * Create a new Title from a prefixed DB key
97 * @param $key String The database key, which has underscores
98 * instead of spaces, possibly including namespace and
100 * @return Title the new object, or NULL on an error
102 public static function newFromDBkey( $key ) {
104 $t->mDbkeyform
= $key;
105 if ( $t->secureAndSplit() ) {
113 * Create a new Title from text, such as what one would find in a link. De-
114 * codes any HTML entities in the text.
116 * @param $text String The link text; spaces, prefixes, and an
117 * initial ':' indicating the main namespace are accepted.
118 * @param $defaultNamespace int The namespace to use if none is speci-
119 * fied by a prefix. If you want to force a specific namespace even if
120 * $text might begin with a namespace prefix, use makeTitle() or
122 * @return Title The new object, or null on an error.
124 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
125 if ( is_object( $text ) ) {
126 throw new MWException( 'Title::newFromText given an object' );
130 * Wiki pages often contain multiple links to the same page.
131 * Title normalization and parsing can become expensive on
132 * pages with many links, so we can save a little time by
135 * In theory these are value objects and won't get changed...
137 if ( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
138 return Title
::$titleCache[$text];
142 * Convert things like é ā or 〗 into normalized (bug 14952) text
144 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
147 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
148 $t->mDefaultNamespace
= $defaultNamespace;
150 static $cachedcount = 0 ;
151 if ( $t->secureAndSplit() ) {
152 if ( $defaultNamespace == NS_MAIN
) {
153 if ( $cachedcount >= self
::CACHE_MAX
) {
154 # Avoid memory leaks on mass operations...
155 Title
::$titleCache = array();
159 Title
::$titleCache[$text] =& $t;
169 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
171 * Example of wrong and broken code:
172 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
174 * Example of right code:
175 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
177 * Create a new Title from URL-encoded text. Ensures that
178 * the given title's length does not exceed the maximum.
180 * @param $url String the title, as might be taken from a URL
181 * @return Title the new object, or NULL on an error
183 public static function newFromURL( $url ) {
184 global $wgLegalTitleChars;
187 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
188 # but some URLs used it as a space replacement and they still come
189 # from some external search tools.
190 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
191 $url = str_replace( '+', ' ', $url );
194 $t->mDbkeyform
= str_replace( ' ', '_', $url );
195 if ( $t->secureAndSplit() ) {
203 * Create a new Title from an article ID
205 * @param $id Int the page_id corresponding to the Title to create
206 * @param $flags Int use Title::GAID_FOR_UPDATE to use master
207 * @return Title the new object, or NULL on an error
209 public static function newFromID( $id, $flags = 0 ) {
210 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
211 $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__
);
212 if ( $row !== false ) {
213 $title = Title
::newFromRow( $row );
221 * Make an array of titles from an array of IDs
223 * @param $ids Array of Int Array of IDs
224 * @return Array of Titles
226 public static function newFromIDs( $ids ) {
227 if ( !count( $ids ) ) {
230 $dbr = wfGetDB( DB_SLAVE
);
235 'page_namespace', 'page_title', 'page_id',
236 'page_len', 'page_is_redirect', 'page_latest',
238 array( 'page_id' => $ids ),
243 foreach ( $res as $row ) {
244 $titles[] = Title
::newFromRow( $row );
250 * Make a Title object from a DB row
252 * @param $row Object database row (needs at least page_title,page_namespace)
253 * @return Title corresponding Title
255 public static function newFromRow( $row ) {
256 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
258 $t->mArticleID
= isset( $row->page_id
) ?
intval( $row->page_id
) : -1;
259 $t->mLength
= isset( $row->page_len
) ?
intval( $row->page_len
) : -1;
260 $t->mRedirect
= isset( $row->page_is_redirect
) ?
(bool)$row->page_is_redirect
: null;
261 $t->mLatestID
= isset( $row->page_latest
) ?
intval( $row->page_latest
) : false;
267 * Create a new Title from a namespace index and a DB key.
268 * It's assumed that $ns and $title are *valid*, for instance when
269 * they came directly from the database or a special page name.
270 * For convenience, spaces are converted to underscores so that
271 * eg user_text fields can be used directly.
273 * @param $ns Int the namespace of the article
274 * @param $title String the unprefixed database key form
275 * @param $fragment String The link fragment (after the "#")
276 * @param $interwiki String The interwiki prefix
277 * @return Title the new object
279 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
281 $t->mInterwiki
= $interwiki;
282 $t->mFragment
= $fragment;
283 $t->mNamespace
= $ns = intval( $ns );
284 $t->mDbkeyform
= str_replace( ' ', '_', $title );
285 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
286 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
287 $t->mTextform
= str_replace( '_', ' ', $title );
292 * Create a new Title from a namespace index and a DB key.
293 * The parameters will be checked for validity, which is a bit slower
294 * than makeTitle() but safer for user-provided data.
296 * @param $ns Int the namespace of the article
297 * @param $title String the database key form
298 * @param $fragment String The link fragment (after the "#")
299 * @param $interwiki String The interwiki prefix
300 * @return Title the new object, or NULL on an error
302 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
304 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki );
305 if ( $t->secureAndSplit() ) {
313 * Create a new Title for the Main Page
315 * @return Title the new object
317 public static function newMainPage() {
318 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
319 // Don't give fatal errors if the message is broken
321 $title = Title
::newFromText( 'Main Page' );
327 * Extract a redirect destination from a string and return the
328 * Title, or null if the text doesn't contain a valid redirect
329 * This will only return the very next target, useful for
330 * the redirect table and other checks that don't need full recursion
332 * @param $text String: Text with possible redirect
333 * @return Title: The corresponding Title
335 public static function newFromRedirect( $text ) {
336 return self
::newFromRedirectInternal( $text );
340 * Extract a redirect destination from a string and return the
341 * Title, or null if the text doesn't contain a valid redirect
342 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
343 * in order to provide (hopefully) the Title of the final destination instead of another redirect
345 * @param $text String Text with possible redirect
346 * @return Title The corresponding Title
348 public static function newFromRedirectRecurse( $text ) {
349 $titles = self
::newFromRedirectArray( $text );
350 return $titles ?
array_pop( $titles ) : null;
354 * Extract a redirect destination from a string and return an
355 * array of Titles, or null if the text doesn't contain a valid redirect
356 * The last element in the array is the final destination after all redirects
357 * have been resolved (up to $wgMaxRedirects times)
359 * @param $text String Text with possible redirect
360 * @return Array of Titles, with the destination last
362 public static function newFromRedirectArray( $text ) {
363 global $wgMaxRedirects;
364 // are redirects disabled?
365 if ( $wgMaxRedirects < 1 ) {
368 $title = self
::newFromRedirectInternal( $text );
369 if ( is_null( $title ) ) {
372 // recursive check to follow double redirects
373 $recurse = $wgMaxRedirects;
374 $titles = array( $title );
375 while ( --$recurse > 0 ) {
376 if ( $title->isRedirect() ) {
377 $article = new Article( $title, 0 );
378 $newtitle = $article->getRedirectTarget();
382 // Redirects to some special pages are not permitted
383 if ( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
384 // the new title passes the checks, so make that our current title so that further recursion can be checked
386 $titles[] = $newtitle;
395 * Really extract the redirect destination
396 * Do not call this function directly, use one of the newFromRedirect* functions above
398 * @param $text String Text with possible redirect
399 * @return Title The corresponding Title
401 protected static function newFromRedirectInternal( $text ) {
402 $redir = MagicWord
::get( 'redirect' );
403 $text = trim( $text );
404 if ( $redir->matchStartAndRemove( $text ) ) {
405 // Extract the first link and see if it's usable
406 // Ensure that it really does come directly after #REDIRECT
407 // Some older redirects included a colon, so don't freak about that!
409 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
410 // Strip preceding colon used to "escape" categories, etc.
411 // and URL-decode links
412 if ( strpos( $m[1], '%' ) !== false ) {
413 // Match behavior of inline link parsing here;
414 $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
416 $title = Title
::newFromText( $m[1] );
417 // If the title is a redirect to bad special pages or is invalid, return null
418 if ( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
427 # ----------------------------------------------------------------------------
429 # ----------------------------------------------------------------------------
432 * Get the prefixed DB key associated with an ID
434 * @param $id Int the page_id of the article
435 * @return Title an object representing the article, or NULL
436 * if no such article was found
438 public static function nameOf( $id ) {
439 $dbr = wfGetDB( DB_SLAVE
);
441 $s = $dbr->selectRow(
443 array( 'page_namespace', 'page_title' ),
444 array( 'page_id' => $id ),
447 if ( $s === false ) {
451 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
456 * Get a regex character class describing the legal characters in a link
458 * @return String the list of characters, not delimited
460 public static function legalChars() {
461 global $wgLegalTitleChars;
462 return $wgLegalTitleChars;
466 * Get a string representation of a title suitable for
467 * including in a search index
469 * @param $ns Int a namespace index
470 * @param $title String text-form main part
471 * @return String a stripped-down title string ready for the
474 public static function indexTitle( $ns, $title ) {
477 $lc = SearchEngine
::legalSearchChars() . '&#;';
478 $t = $wgContLang->normalizeForSearch( $title );
479 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
480 $t = $wgContLang->lc( $t );
483 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
484 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
486 $t = preg_replace( "/\\s+/", ' ', $t );
488 if ( $ns == NS_FILE
) {
489 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
495 * Make a prefixed DB key from a DB key and a namespace index
497 * @param $ns Int numerical representation of the namespace
498 * @param $title String the DB key form the title
499 * @param $fragment String The link fragment (after the "#")
500 * @param $interwiki String The interwiki prefix
501 * @return String the prefixed form of the title
503 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
506 $namespace = $wgContLang->getNsText( $ns );
507 $name = $namespace == '' ?
$title : "$namespace:$title";
508 if ( strval( $interwiki ) != '' ) {
509 $name = "$interwiki:$name";
511 if ( strval( $fragment ) != '' ) {
512 $name .= '#' . $fragment;
518 * Determine whether the object refers to a page within
521 * @return Bool TRUE if this is an in-project interwiki link
522 * or a wikilink, FALSE otherwise
524 public function isLocal() {
525 if ( $this->mInterwiki
!= '' ) {
526 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
533 * Determine whether the object refers to a page within
534 * this project and is transcludable.
536 * @return Bool TRUE if this is transcludable
538 public function isTrans() {
539 if ( $this->mInterwiki
== '' ) {
543 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
547 * Returns the DB name of the distant wiki
548 * which owns the object.
550 * @return String the DB name
552 public function getTransWikiID() {
553 if ( $this->mInterwiki
== '' ) {
557 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
561 * Escape a text fragment, say from a link, for a URL
563 * @param $fragment string containing a URL or link fragment (after the "#")
564 * @return String: escaped string
566 static function escapeFragmentForURL( $fragment ) {
567 # Note that we don't urlencode the fragment. urlencoded Unicode
568 # fragments appear not to work in IE (at least up to 7) or in at least
569 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
570 # to care if they aren't encoded.
571 return Sanitizer
::escapeId( $fragment, 'noninitial' );
574 # ----------------------------------------------------------------------------
576 # ----------------------------------------------------------------------------
578 /** Simple accessors */
580 * Get the text form (spaces not underscores) of the main part
582 * @return String Main part of the title
584 public function getText() { return $this->mTextform
; }
587 * Get the URL-encoded form of the main part
589 * @return String Main part of the title, URL-encoded
591 public function getPartialURL() { return $this->mUrlform
; }
594 * Get the main part with underscores
596 * @return String: Main part of the title, with underscores
598 public function getDBkey() { return $this->mDbkeyform
; }
601 * Get the namespace index, i.e.\ one of the NS_xxxx constants.
603 * @return Integer: Namespace index
605 public function getNamespace() { return $this->mNamespace
; }
608 * Get the namespace text
610 * @return String: Namespace text
612 public function getNsText() {
615 if ( $this->mInterwiki
!= '' ) {
616 // This probably shouldn't even happen. ohh man, oh yuck.
617 // But for interwiki transclusion it sometimes does.
618 // Shit. Shit shit shit.
620 // Use the canonical namespaces if possible to try to
621 // resolve a foreign namespace.
622 if ( MWNamespace
::exists( $this->mNamespace
) ) {
623 return MWNamespace
::getCanonicalName( $this->mNamespace
);
626 return $wgContLang->getNsText( $this->mNamespace
);
630 * Get the DB key with the initial letter case as specified by the user
632 * @return String DB key
634 function getUserCaseDBKey() {
635 return $this->mUserCaseDBKey
;
639 * Get the namespace text of the subject (rather than talk) page
641 * @return String Namespace text
643 public function getSubjectNsText() {
645 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
649 * Get the namespace text of the talk page
651 * @return String Namespace text
653 public function getTalkNsText() {
655 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
659 * Could this title have a corresponding talk page?
661 * @return Bool TRUE or FALSE
663 public function canTalk() {
664 return( MWNamespace
::canTalk( $this->mNamespace
) );
668 * Get the interwiki prefix (or null string)
670 * @return String Interwiki prefix
672 public function getInterwiki() { return $this->mInterwiki
; }
675 * Get the Title fragment (i.e.\ the bit after the #) in text form
677 * @return String Title fragment
679 public function getFragment() { return $this->mFragment
; }
682 * Get the fragment in URL form, including the "#" character if there is one
683 * @return String Fragment in URL form
685 public function getFragmentForURL() {
686 if ( $this->mFragment
== '' ) {
689 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
694 * Get the default namespace index, for when there is no namespace
696 * @return Int Default namespace index
698 public function getDefaultNamespace() { return $this->mDefaultNamespace
; }
701 * Get title for search index
703 * @return String a stripped-down title string ready for the
706 public function getIndexTitle() {
707 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
711 * Get the prefixed database key form
713 * @return String the prefixed title, with underscores and
714 * any interwiki and namespace prefixes
716 public function getPrefixedDBkey() {
717 $s = $this->prefix( $this->mDbkeyform
);
718 $s = str_replace( ' ', '_', $s );
723 * Get the prefixed title with spaces.
724 * This is the form usually used for display
726 * @return String the prefixed title, with spaces
728 public function getPrefixedText() {
729 if ( empty( $this->mPrefixedText
) ) { // FIXME: bad usage of empty() ?
730 $s = $this->prefix( $this->mTextform
);
731 $s = str_replace( '_', ' ', $s );
732 $this->mPrefixedText
= $s;
734 return $this->mPrefixedText
;
738 * Get the prefixed title with spaces, plus any fragment
739 * (part beginning with '#')
741 * @return String the prefixed title, with spaces and
742 * the fragment, including '#'
744 public function getFullText() {
745 $text = $this->getPrefixedText();
746 if ( $this->mFragment
!= '' ) {
747 $text .= '#' . $this->mFragment
;
753 * Get the base name, i.e. the leftmost parts before the /
755 * @return String Base name
757 public function getBaseText() {
758 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
759 return $this->getText();
762 $parts = explode( '/', $this->getText() );
763 # Don't discard the real title if there's no subpage involved
764 if ( count( $parts ) > 1 ) {
765 unset( $parts[count( $parts ) - 1] );
767 return implode( '/', $parts );
771 * Get the lowest-level subpage name, i.e. the rightmost part after /
773 * @return String Subpage name
775 public function getSubpageText() {
776 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
777 return( $this->mTextform
);
779 $parts = explode( '/', $this->mTextform
);
780 return( $parts[count( $parts ) - 1] );
784 * Get a URL-encoded form of the subpage text
786 * @return String URL-encoded subpage name
788 public function getSubpageUrlForm() {
789 $text = $this->getSubpageText();
790 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
795 * Get a URL-encoded title (not an actual URL) including interwiki
797 * @return String the URL-encoded form
799 public function getPrefixedURL() {
800 $s = $this->prefix( $this->mDbkeyform
);
801 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
806 * Get a real URL referring to this title, with interwiki link and
809 * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki
810 * links. Can be specified as an associative array as well, e.g.,
811 * array( 'action' => 'edit' ) (keys and values will be URL-escaped).
812 * @param $variant String language variant of url (for sr, zh..)
813 * @return String the URL
815 public function getFullURL( $query = '', $variant = false ) {
816 global $wgServer, $wgRequest;
818 if ( is_array( $query ) ) {
819 $query = wfArrayToCGI( $query );
822 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
824 $url = $this->getLocalURL( $query, $variant );
826 // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
827 // Correct fix would be to move the prepending elsewhere.
828 if ( $wgRequest->getVal( 'action' ) != 'render' ) {
829 $url = $wgServer . $url;
832 $baseUrl = $interwiki->getURL();
834 $namespace = wfUrlencode( $this->getNsText() );
835 if ( $namespace != '' ) {
836 # Can this actually happen? Interwikis shouldn't be parsed.
837 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
840 $url = str_replace( '$1', $namespace . $this->mUrlform
, $baseUrl );
841 $url = wfAppendQuery( $url, $query );
844 # Finally, add the fragment.
845 $url .= $this->getFragmentForURL();
847 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
852 * Get a URL with no fragment or server name. If this page is generated
853 * with action=render, $wgServer is prepended.
855 * @param $query Mixed: an optional query string; if not specified,
856 * $wgArticlePath will be used. Can be specified as an associative array
857 * as well, e.g., array( 'action' => 'edit' ) (keys and values will be
859 * @param $variant String language variant of url (for sr, zh..)
860 * @return String the URL
862 public function getLocalURL( $query = '', $variant = false ) {
863 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
864 global $wgVariantArticlePath, $wgContLang;
866 if ( is_array( $query ) ) {
867 $query = wfArrayToCGI( $query );
870 if ( $this->isExternal() ) {
871 $url = $this->getFullURL();
873 // This is currently only used for edit section links in the
874 // context of interwiki transclusion. In theory we should
875 // append the query to the end of any existing query string,
876 // but interwiki transclusion is already broken in that case.
880 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
881 if ( $query == '' ) {
882 if ( $variant != false && $wgContLang->hasVariants() ) {
883 if ( !$wgVariantArticlePath ) {
884 $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
886 $variantArticlePath = $wgVariantArticlePath;
888 $url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
889 $url = str_replace( '$1', $dbkey, $url );
891 $url = str_replace( '$1', $dbkey, $wgArticlePath );
894 global $wgActionPaths;
897 if ( !empty( $wgActionPaths ) &&
898 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
900 $action = urldecode( $matches[2] );
901 if ( isset( $wgActionPaths[$action] ) ) {
902 $query = $matches[1];
903 if ( isset( $matches[4] ) ) {
904 $query .= $matches[4];
906 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
907 if ( $query != '' ) {
908 $url = wfAppendQuery( $url, $query );
912 if ( $url === false ) {
913 if ( $query == '-' ) {
916 $url = "{$wgScript}?title={$dbkey}&{$query}";
920 // FIXME: this causes breakage in various places when we
921 // actually expected a local URL and end up with dupe prefixes.
922 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
923 $url = $wgServer . $url;
926 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
931 * Get a URL that's the simplest URL that will be valid to link, locally,
932 * to the current Title. It includes the fragment, but does not include
933 * the server unless action=render is used (or the link is external). If
934 * there's a fragment but the prefixed text is empty, we just return a link
937 * The result obviously should not be URL-escaped, but does need to be
938 * HTML-escaped if it's being output in HTML.
940 * @param $query Array of Strings An associative array of key => value pairs for the
941 * query string. Keys and values will be escaped.
942 * @param $variant String Language variant of URL (for sr, zh..). Ignored
943 * for external links. Default is "false" (same variant as current page,
944 * for anonymous users).
945 * @return String the URL
947 public function getLinkUrl( $query = array(), $variant = false ) {
948 wfProfileIn( __METHOD__
);
949 if ( $this->isExternal() ) {
950 $ret = $this->getFullURL( $query );
951 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
952 $ret = $this->getFragmentForURL();
954 $ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
956 wfProfileOut( __METHOD__
);
961 * Get an HTML-escaped version of the URL form, suitable for
962 * using in a link, without a server name or fragment
964 * @param $query String an optional query string
965 * @return String the URL
967 public function escapeLocalURL( $query = '' ) {
968 return htmlspecialchars( $this->getLocalURL( $query ) );
972 * Get an HTML-escaped version of the URL form, suitable for
973 * using in a link, including the server name and fragment
975 * @param $query String an optional query string
976 * @return String the URL
978 public function escapeFullURL( $query = '' ) {
979 return htmlspecialchars( $this->getFullURL( $query ) );
983 * Get the URL form for an internal link.
984 * - Used in various Squid-related code, in case we have a different
985 * internal hostname for the server from the exposed one.
987 * @param $query String an optional query string
988 * @param $variant String language variant of url (for sr, zh..)
989 * @return String the URL
991 public function getInternalURL( $query = '', $variant = false ) {
992 global $wgInternalServer;
993 $url = $wgInternalServer . $this->getLocalURL( $query, $variant );
994 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
999 * Get the edit URL for this Title
1001 * @return String the URL, or a null string if this is an
1004 public function getEditURL() {
1005 if ( $this->mInterwiki
!= '' ) {
1008 $s = $this->getLocalURL( 'action=edit' );
1014 * Get the HTML-escaped displayable text form.
1015 * Used for the title field in <a> tags.
1017 * @return String the text, including any prefixes
1019 public function getEscapedText() {
1020 return htmlspecialchars( $this->getPrefixedText() );
1024 * Is this Title interwiki?
1028 public function isExternal() {
1029 return ( $this->mInterwiki
!= '' );
1033 * Is this page "semi-protected" - the *only* protection is autoconfirm?
1035 * @param $action String Action to check (default: edit)
1038 public function isSemiProtected( $action = 'edit' ) {
1039 if ( $this->exists() ) {
1040 $restrictions = $this->getRestrictions( $action );
1041 if ( count( $restrictions ) > 0 ) {
1042 foreach ( $restrictions as $restriction ) {
1043 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
1053 # If it doesn't exist, it can't be protected
1059 * Does the title correspond to a protected article?
1061 * @param $action String the action the page is protected from,
1062 * by default checks all actions.
1065 public function isProtected( $action = '' ) {
1066 global $wgRestrictionLevels;
1068 $restrictionTypes = $this->getRestrictionTypes();
1070 # Special pages have inherent protection
1071 if( $this->getNamespace() == NS_SPECIAL
) {
1075 # Check regular protection levels
1076 foreach ( $restrictionTypes as $type ) {
1077 if ( $action == $type ||
$action == '' ) {
1078 $r = $this->getRestrictions( $type );
1079 foreach ( $wgRestrictionLevels as $level ) {
1080 if ( in_array( $level, $r ) && $level != '' ) {
1091 * Is this a conversion table for the LanguageConverter?
1095 public function isConversionTable() {
1097 $this->getNamespace() == NS_MEDIAWIKI
&&
1098 strpos( $this->getText(), 'Conversiontable' ) !== false
1108 * Is $wgUser watching this page?
1112 public function userIsWatching() {
1115 if ( is_null( $this->mWatched
) ) {
1116 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1117 $this->mWatched
= false;
1119 $this->mWatched
= $wgUser->isWatched( $this );
1122 return $this->mWatched
;
1126 * Can $wgUser perform $action on this page?
1127 * This skips potentially expensive cascading permission checks
1128 * as well as avoids expensive error formatting
1130 * Suitable for use for nonessential UI controls in common cases, but
1131 * _not_ for functional access control.
1133 * May provide false positives, but should never provide a false negative.
1135 * @param $action String action that permission needs to be checked for
1138 public function quickUserCan( $action ) {
1139 return $this->userCan( $action, false );
1143 * Determines if $user is unable to edit this page because it has been protected
1144 * by $wgNamespaceProtection.
1146 * @param $user User object, $wgUser will be used if not passed
1149 public function isNamespaceProtected( User
$user = null ) {
1150 global $wgNamespaceProtection;
1152 if ( $user === null ) {
1157 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
1158 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
1159 if ( $right != '' && !$user->isAllowed( $right ) ) {
1168 * Can $wgUser perform $action on this page?
1170 * @param $action String action that permission needs to be checked for
1171 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
1174 public function userCan( $action, $doExpensiveQueries = true ) {
1176 return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries, true ) === array() );
1180 * Can $user perform $action on this page?
1182 * FIXME: This *does not* check throttles (User::pingLimiter()).
1184 * @param $action String action that permission needs to be checked for
1185 * @param $user User to check
1186 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
1187 * @param $ignoreErrors Array of Strings Set this to a list of message keys whose corresponding errors may be ignored.
1188 * @return Array of arrays of the arguments to wfMsg to explain permissions problems.
1190 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1191 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1193 // Remove the errors being ignored.
1194 foreach ( $errors as $index => $error ) {
1195 $error_key = is_array( $error ) ?
$error[0] : $error;
1197 if ( in_array( $error_key, $ignoreErrors ) ) {
1198 unset( $errors[$index] );
1206 * Permissions checks that fail most often, and which are easiest to test.
1208 * @param $action String the action to check
1209 * @param $user User user to check
1210 * @param $errors Array list of current errors
1211 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1212 * @param $short Boolean short circuit on first error
1214 * @return Array list of errors
1216 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1217 if ( $action == 'create' ) {
1218 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1219 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1220 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1222 } elseif ( $action == 'move' ) {
1223 if ( !$user->isAllowed( 'move-rootuserpages' )
1224 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1225 // Show user page-specific message only if the user can move other pages
1226 $errors[] = array( 'cant-move-user-page' );
1229 // Check if user is allowed to move files if it's a file
1230 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1231 $errors[] = array( 'movenotallowedfile' );
1234 if ( !$user->isAllowed( 'move' ) ) {
1235 // User can't move anything
1236 global $wgGroupPermissions;
1237 $userCanMove = false;
1238 if ( isset( $wgGroupPermissions['user']['move'] ) ) {
1239 $userCanMove = $wgGroupPermissions['user']['move'];
1241 $autoconfirmedCanMove = false;
1242 if ( isset( $wgGroupPermissions['autoconfirmed']['move'] ) ) {
1243 $autoconfirmedCanMove = $wgGroupPermissions['autoconfirmed']['move'];
1245 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1246 // custom message if logged-in users without any special rights can move
1247 $errors[] = array( 'movenologintext' );
1249 $errors[] = array( 'movenotallowed' );
1252 } elseif ( $action == 'move-target' ) {
1253 if ( !$user->isAllowed( 'move' ) ) {
1254 // User can't move anything
1255 $errors[] = array( 'movenotallowed' );
1256 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1257 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1258 // Show user page-specific message only if the user can move other pages
1259 $errors[] = array( 'cant-move-to-user-page' );
1261 } elseif ( !$user->isAllowed( $action ) ) {
1262 // We avoid expensive display logic for quickUserCan's and such
1265 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1266 User
::getGroupsWithPermission( $action ) );
1273 $wgLang->commaList( $groups ),
1277 $return = array( 'badaccess-group0' );
1279 $errors[] = $return;
1286 * Add the resulting error code to the errors array
1288 * @param $errors Array list of current errors
1289 * @param $result Mixed result of errors
1291 * @return Array list of errors
1293 private function resultToError( $errors, $result ) {
1294 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1295 // A single array representing an error
1296 $errors[] = $result;
1297 } else if ( is_array( $result ) && is_array( $result[0] ) ) {
1298 // A nested array representing multiple errors
1299 $errors = array_merge( $errors, $result );
1300 } else if ( $result !== '' && is_string( $result ) ) {
1301 // A string representing a message-id
1302 $errors[] = array( $result );
1303 } else if ( $result === false ) {
1304 // a generic "We don't want them to do that"
1305 $errors[] = array( 'badaccess-group0' );
1311 * Check various permission hooks
1313 * @param $action String the action to check
1314 * @param $user User user to check
1315 * @param $errors Array list of current errors
1316 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1317 * @param $short Boolean short circuit on first error
1319 * @return Array list of errors
1321 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1322 // Use getUserPermissionsErrors instead
1324 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1325 return $result ?
array() : array( array( 'badaccess-group0' ) );
1327 // Check getUserPermissionsErrors hook
1328 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1329 $errors = $this->resultToError( $errors, $result );
1331 // Check getUserPermissionsErrorsExpensive hook
1332 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1333 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1334 $errors = $this->resultToError( $errors, $result );
1341 * Check permissions on special pages & namespaces
1343 * @param $action String the action to check
1344 * @param $user User user to check
1345 * @param $errors Array list of current errors
1346 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1347 * @param $short Boolean short circuit on first error
1349 * @return Array list of errors
1351 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1352 # Only 'createaccount' and 'execute' can be performed on
1353 # special pages, which don't actually exist in the DB.
1354 $specialOKActions = array( 'createaccount', 'execute' );
1355 if ( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions ) ) {
1356 $errors[] = array( 'ns-specialprotected' );
1359 # Check $wgNamespaceProtection for restricted namespaces
1360 if ( $this->isNamespaceProtected( $user ) ) {
1361 $ns = $this->mNamespace
== NS_MAIN ?
1362 wfMsg( 'nstab-main' ) : $this->getNsText();
1363 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
1364 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1371 * Check CSS/JS sub-page permissions
1373 * @param $action String the action to check
1374 * @param $user User user to check
1375 * @param $errors Array list of current errors
1376 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1377 * @param $short Boolean short circuit on first error
1379 * @return Array list of errors
1381 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1382 # Protect css/js subpages of user pages
1383 # XXX: this might be better using restrictions
1384 # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssSubpage()
1385 # and $this->userCanEditJsSubpage() from working
1386 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1387 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1388 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
1389 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1390 $errors[] = array( 'customcssjsprotected' );
1391 } else if ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1392 $errors[] = array( 'customcssjsprotected' );
1400 * Check against page_restrictions table requirements on this
1401 * page. The user must possess all required rights for this
1404 * @param $action String the action to check
1405 * @param $user User user to check
1406 * @param $errors Array list of current errors
1407 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1408 * @param $short Boolean short circuit on first error
1410 * @return Array list of errors
1412 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1413 foreach ( $this->getRestrictions( $action ) as $right ) {
1414 // Backwards compatibility, rewrite sysop -> protect
1415 if ( $right == 'sysop' ) {
1418 if ( $right != '' && !$user->isAllowed( $right ) ) {
1419 // Users with 'editprotected' permission can edit protected pages
1420 if ( $action == 'edit' && $user->isAllowed( 'editprotected' ) ) {
1421 // Users with 'editprotected' permission cannot edit protected pages
1422 // with cascading option turned on.
1423 if ( $this->mCascadeRestriction
) {
1424 $errors[] = array( 'protectedpagetext', $right );
1427 $errors[] = array( 'protectedpagetext', $right );
1436 * Check restrictions on cascading pages.
1438 * @param $action String the action to check
1439 * @param $user User user to check
1440 * @param $errors Array list of current errors
1441 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1442 * @param $short Boolean short circuit on first error
1444 * @return Array list of errors
1446 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1447 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1448 # We /could/ use the protection level on the source page, but it's
1449 # fairly ugly as we have to establish a precedence hierarchy for pages
1450 # included by multiple cascade-protected pages. So just restrict
1451 # it to people with 'protect' permission, as they could remove the
1452 # protection anyway.
1453 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1454 # Cascading protection depends on more than this page...
1455 # Several cascading protected pages may include this page...
1456 # Check each cascading level
1457 # This is only for protection restrictions, not for all actions
1458 if ( isset( $restrictions[$action] ) ) {
1459 foreach ( $restrictions[$action] as $right ) {
1460 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1461 if ( $right != '' && !$user->isAllowed( $right ) ) {
1463 foreach ( $cascadingSources as $page )
1464 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1465 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1475 * Check action permissions not already checked in checkQuickPermissions
1477 * @param $action String the action to check
1478 * @param $user User user to check
1479 * @param $errors Array list of current errors
1480 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1481 * @param $short Boolean short circuit on first error
1483 * @return Array list of errors
1485 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1486 if ( $action == 'protect' ) {
1487 if ( $this->getUserPermissionsErrors( 'edit', $user ) != array() ) {
1488 // If they can't edit, they shouldn't protect.
1489 $errors[] = array( 'protect-cantedit' );
1491 } elseif ( $action == 'create' ) {
1492 $title_protection = $this->getTitleProtection();
1493 if( $title_protection ) {
1494 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1495 $title_protection['pt_create_perm'] = 'protect'; // B/C
1497 if( $title_protection['pt_create_perm'] == '' ||
!$user->isAllowed( $title_protection['pt_create_perm'] ) ) {
1498 $errors[] = array( 'titleprotected', User
::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1501 } elseif ( $action == 'move' ) {
1502 // Check for immobile pages
1503 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1504 // Specific message for this case
1505 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1506 } elseif ( !$this->isMovable() ) {
1507 // Less specific message for rarer cases
1508 $errors[] = array( 'immobile-page' );
1510 } elseif ( $action == 'move-target' ) {
1511 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1512 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1513 } elseif ( !$this->isMovable() ) {
1514 $errors[] = array( 'immobile-target-page' );
1521 * Check that the user isn't blocked from editting.
1523 * @param $action String the action to check
1524 * @param $user User user to check
1525 * @param $errors Array list of current errors
1526 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1527 * @param $short Boolean short circuit on first error
1529 * @return Array list of errors
1531 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1532 if( $short && count( $errors ) > 0 ) {
1536 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
1538 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
1539 $errors[] = array( 'confirmedittext' );
1542 // Edit blocks should not affect reading. Account creation blocks handled at userlogin.
1543 if ( $action != 'read' && $action != 'createaccount' && $user->isBlockedFrom( $this ) ) {
1544 $block = $user->mBlock
;
1546 // This is from OutputPage::blockedPage
1547 // Copied at r23888 by werdna
1549 $id = $user->blockedBy();
1550 $reason = $user->blockedFor();
1551 if ( $reason == '' ) {
1552 $reason = wfMsg( 'blockednoreason' );
1556 if ( is_numeric( $id ) ) {
1557 $name = User
::whoIs( $id );
1562 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1563 $blockid = $block->mId
;
1564 $blockExpiry = $user->mBlock
->mExpiry
;
1565 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1566 if ( $blockExpiry == 'infinity' ) {
1567 // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1568 $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1570 foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1571 if ( !strpos( $option, ':' ) )
1574 list( $show, $value ) = explode( ':', $option );
1576 if ( $value == 'infinite' ||
$value == 'indefinite' ) {
1577 $blockExpiry = $show;
1582 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1585 $intended = $user->mBlock
->mAddress
;
1587 $errors[] = array( ( $block->mAuto ?
'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1588 $blockid, $blockExpiry, $intended, $blockTimestamp );
1595 * Can $user perform $action on this page? This is an internal function,
1596 * which checks ONLY that previously checked by userCan (i.e. it leaves out
1597 * checks on wfReadOnly() and blocks)
1599 * @param $action String action that permission needs to be checked for
1600 * @param $user User to check
1601 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
1602 * @param $short Bool Set this to true to stop after the first permission error.
1603 * @return Array of arrays of the arguments to wfMsg to explain permissions problems.
1605 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
1606 wfProfileIn( __METHOD__
);
1610 'checkQuickPermissions',
1611 'checkPermissionHooks',
1612 'checkSpecialsAndNSPermissions',
1613 'checkCSSandJSPermissions',
1614 'checkPageRestrictions',
1615 'checkCascadingSourcesRestrictions',
1616 'checkActionPermissions',
1620 while( count( $checks ) > 0 &&
1621 !( $short && count( $errors ) > 0 ) ) {
1622 $method = array_shift( $checks );
1623 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
1626 wfProfileOut( __METHOD__
);
1631 * Is this title subject to title protection?
1632 * Title protection is the one applied against creation of such title.
1634 * @return Mixed An associative array representing any existent title
1635 * protection, or false if there's none.
1637 private function getTitleProtection() {
1638 // Can't protect pages in special namespaces
1639 if ( $this->getNamespace() < 0 ) {
1643 // Can't protect pages that exist.
1644 if ( $this->exists() ) {
1648 if ( !isset( $this->mTitleProtection
) ) {
1649 $dbr = wfGetDB( DB_SLAVE
);
1650 $res = $dbr->select( 'protected_titles', '*',
1651 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1654 // fetchRow returns false if there are no rows.
1655 $this->mTitleProtection
= $dbr->fetchRow( $res );
1657 return $this->mTitleProtection
;
1661 * Update the title protection status
1663 * @param $create_perm String Permission required for creation
1664 * @param $reason String Reason for protection
1665 * @param $expiry String Expiry timestamp
1666 * @return boolean true
1668 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
1669 global $wgUser, $wgContLang;
1671 if ( $create_perm == implode( ',', $this->getRestrictions( 'create' ) )
1672 && $expiry == $this->mRestrictionsExpiry
['create'] ) {
1677 list ( $namespace, $title ) = array( $this->getNamespace(), $this->getDBkey() );
1679 $dbw = wfGetDB( DB_MASTER
);
1681 $encodedExpiry = Block
::encodeExpiry( $expiry, $dbw );
1683 $expiry_description = '';
1684 if ( $encodedExpiry != 'infinity' ) {
1685 $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ),
1686 $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')';
1688 $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ) . ')';
1691 # Update protection table
1692 if ( $create_perm != '' ) {
1693 $this->mTitleProtection
= array(
1694 'pt_namespace' => $namespace,
1695 'pt_title' => $title,
1696 'pt_create_perm' => $create_perm,
1697 'pt_timestamp' => Block
::encodeExpiry( wfTimestampNow(), $dbw ),
1698 'pt_expiry' => $encodedExpiry,
1699 'pt_user' => $wgUser->getId(),
1700 'pt_reason' => $reason,
1702 $dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ),
1703 $this->mTitleProtection
, __METHOD__
);
1705 $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
1706 'pt_title' => $title ), __METHOD__
);
1707 $this->mTitleProtection
= false;
1710 # Update the protection log
1711 if ( $dbw->affectedRows() ) {
1712 $log = new LogPage( 'protect' );
1714 if ( $create_perm ) {
1715 $params = array( "[create=$create_perm] $expiry_description", '' );
1716 $log->addEntry( ( isset( $this->mRestrictions
['create'] ) && $this->mRestrictions
['create'] ) ?
'modify' : 'protect', $this, trim( $reason ), $params );
1718 $log->addEntry( 'unprotect', $this, $reason );
1726 * Remove any title protection due to page existing
1728 public function deleteTitleProtection() {
1729 $dbw = wfGetDB( DB_MASTER
);
1733 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
1736 $this->mTitleProtection
= false;
1740 * Would anybody with sufficient privileges be able to move this page?
1741 * Some pages just aren't movable.
1743 * @return Bool TRUE or FALSE
1745 public function isMovable() {
1746 return MWNamespace
::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
1750 * Can $wgUser read this page?
1753 * @todo fold these checks into userCan()
1755 public function userCanRead() {
1756 global $wgUser, $wgGroupPermissions;
1758 static $useShortcut = null;
1760 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
1761 if ( is_null( $useShortcut ) ) {
1762 global $wgRevokePermissions;
1763 $useShortcut = true;
1764 if ( empty( $wgGroupPermissions['*']['read'] ) ) {
1765 # Not a public wiki, so no shortcut
1766 $useShortcut = false;
1767 } elseif ( !empty( $wgRevokePermissions ) ) {
1769 * Iterate through each group with permissions being revoked (key not included since we don't care
1770 * what the group name is), then check if the read permission is being revoked. If it is, then
1771 * we don't use the shortcut below since the user might not be able to read, even though anon
1772 * reading is allowed.
1774 foreach ( $wgRevokePermissions as $perms ) {
1775 if ( !empty( $perms['read'] ) ) {
1776 # We might be removing the read right from the user, so no shortcut
1777 $useShortcut = false;
1785 wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
1786 if ( $result !== null ) {
1790 # Shortcut for public wikis, allows skipping quite a bit of code
1791 if ( $useShortcut ) {
1795 if ( $wgUser->isAllowed( 'read' ) ) {
1798 global $wgWhitelistRead;
1801 * Always grant access to the login page.
1802 * Even anons need to be able to log in.
1804 if ( $this->isSpecial( 'Userlogin' ) ||
$this->isSpecial( 'Resetpass' ) ) {
1809 * Bail out if there isn't whitelist
1811 if ( !is_array( $wgWhitelistRead ) ) {
1816 * Check for explicit whitelisting
1818 $name = $this->getPrefixedText();
1819 $dbName = $this->getPrefixedDBKey();
1820 // Check with and without underscores
1821 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) )
1825 * Old settings might have the title prefixed with
1826 * a colon for main-namespace pages
1828 if ( $this->getNamespace() == NS_MAIN
) {
1829 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
1835 * If it's a special page, ditch the subpage bit
1838 if ( $this->getNamespace() == NS_SPECIAL
) {
1839 $name = $this->getDBkey();
1840 list( $name, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $name );
1841 if ( $name === false ) {
1842 # Invalid special page, but we show standard login required message
1846 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
1847 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
1857 * Is this a talk page of some sort?
1861 public function isTalkPage() {
1862 return MWNamespace
::isTalk( $this->getNamespace() );
1866 * Is this a subpage?
1870 public function isSubpage() {
1871 return MWNamespace
::hasSubpages( $this->mNamespace
)
1872 ?
strpos( $this->getText(), '/' ) !== false
1877 * Does this have subpages? (Warning, usually requires an extra DB query.)
1881 public function hasSubpages() {
1882 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1887 # We dynamically add a member variable for the purpose of this method
1888 # alone to cache the result. There's no point in having it hanging
1889 # around uninitialized in every Title object; therefore we only add it
1890 # if needed and don't declare it statically.
1891 if ( isset( $this->mHasSubpages
) ) {
1892 return $this->mHasSubpages
;
1895 $subpages = $this->getSubpages( 1 );
1896 if ( $subpages instanceof TitleArray
) {
1897 return $this->mHasSubpages
= (bool)$subpages->count();
1899 return $this->mHasSubpages
= false;
1903 * Get all subpages of this page.
1905 * @param $limit Int maximum number of subpages to fetch; -1 for no limit
1906 * @return mixed TitleArray, or empty array if this page's namespace
1907 * doesn't allow subpages
1909 public function getSubpages( $limit = -1 ) {
1910 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
1914 $dbr = wfGetDB( DB_SLAVE
);
1915 $conds['page_namespace'] = $this->getNamespace();
1916 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
1918 if ( $limit > -1 ) {
1919 $options['LIMIT'] = $limit;
1921 return $this->mSubpages
= TitleArray
::newFromResult(
1922 $dbr->select( 'page',
1923 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
1932 * Could this page contain custom CSS or JavaScript, based
1937 public function isCssOrJsPage() {
1938 return $this->mNamespace
== NS_MEDIAWIKI
1939 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
1943 * Is this a .css or .js subpage of a user page?
1946 public function isCssJsSubpage() {
1947 return ( NS_USER
== $this->mNamespace
and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
1951 * Is this a *valid* .css or .js subpage of a user page?
1956 public function isValidCssJsSubpage() {
1957 return $this->isCssJsSubpage();
1961 * Trim down a .css or .js subpage title to get the corresponding skin name
1963 * @return string containing skin name from .css or .js subpage title
1965 public function getSkinFromCssJsSubpage() {
1966 $subpage = explode( '/', $this->mTextform
);
1967 $subpage = $subpage[ count( $subpage ) - 1 ];
1968 return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
1972 * Is this a .css subpage of a user page?
1976 public function isCssSubpage() {
1977 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.css$/", $this->mTextform
) );
1981 * Is this a .js subpage of a user page?
1985 public function isJsSubpage() {
1986 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.js$/", $this->mTextform
) );
1990 * Protect css subpages of user pages: can $wgUser edit
1994 * @todo XXX: this might be better using restrictions
1996 public function userCanEditCssSubpage() {
1998 return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'editusercss' ) )
1999 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2003 * Protect js subpages of user pages: can $wgUser edit
2007 * @todo XXX: this might be better using restrictions
2009 public function userCanEditJsSubpage() {
2011 return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'edituserjs' ) )
2012 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2016 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2018 * @return Bool If the page is subject to cascading restrictions.
2020 public function isCascadeProtected() {
2021 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2022 return ( $sources > 0 );
2026 * Cascading protection: Get the source of any cascading restrictions on this page.
2028 * @param $getPages Bool Whether or not to retrieve the actual pages
2029 * that the restrictions have come from.
2030 * @return Mixed Array of the Title
2031 * objects of the pages from which cascading restrictions have come,
2032 * false for none, or true if such restrictions exist, but $getPages was not set.
2033 * The restriction array is an array of each type, each of which contains a
2034 * array of unique groups.
2036 public function getCascadeProtectionSources( $getPages = true ) {
2037 $pagerestrictions = array();
2039 if ( isset( $this->mCascadeSources
) && $getPages ) {
2040 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2041 } else if ( isset( $this->mHasCascadingRestrictions
) && !$getPages ) {
2042 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2045 wfProfileIn( __METHOD__
);
2047 $dbr = wfGetDB( DB_SLAVE
);
2049 if ( $this->getNamespace() == NS_FILE
) {
2050 $tables = array( 'imagelinks', 'page_restrictions' );
2051 $where_clauses = array(
2052 'il_to' => $this->getDBkey(),
2057 $tables = array( 'templatelinks', 'page_restrictions' );
2058 $where_clauses = array(
2059 'tl_namespace' => $this->getNamespace(),
2060 'tl_title' => $this->getDBkey(),
2067 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2068 'pr_expiry', 'pr_type', 'pr_level' );
2069 $where_clauses[] = 'page_id=pr_page';
2072 $cols = array( 'pr_expiry' );
2075 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2077 $sources = $getPages ?
array() : false;
2078 $now = wfTimestampNow();
2079 $purgeExpired = false;
2081 foreach ( $res as $row ) {
2082 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
2083 if ( $expiry > $now ) {
2085 $page_id = $row->pr_page
;
2086 $page_ns = $row->page_namespace
;
2087 $page_title = $row->page_title
;
2088 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2089 # Add groups needed for each restriction type if its not already there
2090 # Make sure this restriction type still exists
2092 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2093 $pagerestrictions[$row->pr_type
] = array();
2096 if ( isset( $pagerestrictions[$row->pr_type
] ) &&
2097 !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] ) ) {
2098 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2104 // Trigger lazy purge of expired restrictions from the db
2105 $purgeExpired = true;
2108 if ( $purgeExpired ) {
2109 Title
::purgeExpiredRestrictions();
2112 wfProfileOut( __METHOD__
);
2115 $this->mCascadeSources
= $sources;
2116 $this->mCascadingRestrictions
= $pagerestrictions;
2118 $this->mHasCascadingRestrictions
= $sources;
2121 return array( $sources, $pagerestrictions );
2125 * Returns cascading restrictions for the current article
2129 function areRestrictionsCascading() {
2130 if ( !$this->mRestrictionsLoaded
) {
2131 $this->loadRestrictions();
2134 return $this->mCascadeRestriction
;
2138 * Loads a string into mRestrictions array
2140 * @param $res Resource restrictions as an SQL result.
2141 * @param $oldFashionedRestrictions string comma-separated list of page
2142 * restrictions from page table (pre 1.10)
2144 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2147 foreach ( $res as $row ) {
2151 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2155 * Compiles list of active page restrictions from both page table (pre 1.10)
2156 * and page_restrictions table for this existing page
2158 * @param $rows array of db result objects
2159 * @param $oldFashionedRestrictions string comma-separated list of page
2160 * restrictions from page table (pre 1.10)
2162 private function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2163 $dbr = wfGetDB( DB_SLAVE
);
2165 $restrictionTypes = $this->getRestrictionTypes();
2167 foreach ( $restrictionTypes as $type ) {
2168 $this->mRestrictions
[$type] = array();
2169 $this->mRestrictionsExpiry
[$type] = Block
::decodeExpiry( '' );
2172 $this->mCascadeRestriction
= false;
2174 # Backwards-compatibility: also load the restrictions from the page record (old format).
2176 if ( $oldFashionedRestrictions === null ) {
2177 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2178 array( 'page_id' => $this->getArticleId() ), __METHOD__
);
2181 if ( $oldFashionedRestrictions != '' ) {
2183 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2184 $temp = explode( '=', trim( $restrict ) );
2185 if ( count( $temp ) == 1 ) {
2186 // old old format should be treated as edit/move restriction
2187 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2188 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2190 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
2194 $this->mOldRestrictions
= true;
2198 if ( count( $rows ) ) {
2199 # Current system - load second to make them override.
2200 $now = wfTimestampNow();
2201 $purgeExpired = false;
2203 foreach ( $rows as $row ) {
2204 # Cycle through all the restrictions.
2206 // Don't take care of restrictions types that aren't allowed
2208 if ( !in_array( $row->pr_type
, $restrictionTypes ) )
2211 // This code should be refactored, now that it's being used more generally,
2212 // But I don't really see any harm in leaving it in Block for now -werdna
2213 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
2215 // Only apply the restrictions if they haven't expired!
2216 if ( !$expiry ||
$expiry > $now ) {
2217 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2218 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2220 $this->mCascadeRestriction |
= $row->pr_cascade
;
2222 // Trigger a lazy purge of expired restrictions
2223 $purgeExpired = true;
2227 if ( $purgeExpired ) {
2228 Title
::purgeExpiredRestrictions();
2232 $this->mRestrictionsLoaded
= true;
2236 * Load restrictions from the page_restrictions table
2238 * @param $oldFashionedRestrictions string comma-separated list of page
2239 * restrictions from page table (pre 1.10)
2241 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2242 if ( !$this->mRestrictionsLoaded
) {
2243 if ( $this->exists() ) {
2244 $dbr = wfGetDB( DB_SLAVE
);
2246 $res = $dbr->select( 'page_restrictions', '*',
2247 array( 'pr_page' => $this->getArticleId() ), __METHOD__
);
2249 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2251 $title_protection = $this->getTitleProtection();
2253 if ( $title_protection ) {
2254 $now = wfTimestampNow();
2255 $expiry = Block
::decodeExpiry( $title_protection['pt_expiry'] );
2257 if ( !$expiry ||
$expiry > $now ) {
2258 // Apply the restrictions
2259 $this->mRestrictionsExpiry
['create'] = $expiry;
2260 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2261 } else { // Get rid of the old restrictions
2262 Title
::purgeExpiredRestrictions();
2263 $this->mTitleProtection
= false;
2266 $this->mRestrictionsExpiry
['create'] = Block
::decodeExpiry( '' );
2268 $this->mRestrictionsLoaded
= true;
2274 * Purge expired restrictions from the page_restrictions table
2276 static function purgeExpiredRestrictions() {
2277 $dbw = wfGetDB( DB_MASTER
);
2279 'page_restrictions',
2280 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2286 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2292 * Accessor/initialisation for mRestrictions
2294 * @param $action String action that permission needs to be checked for
2295 * @return Array of Strings the array of groups allowed to edit this article
2297 public function getRestrictions( $action ) {
2298 if ( !$this->mRestrictionsLoaded
) {
2299 $this->loadRestrictions();
2301 return isset( $this->mRestrictions
[$action] )
2302 ?
$this->mRestrictions
[$action]
2307 * Get the expiry time for the restriction against a given action
2309 * @return 14-char timestamp, or 'infinity' if the page is protected forever
2310 * or not protected at all, or false if the action is not recognised.
2312 public function getRestrictionExpiry( $action ) {
2313 if ( !$this->mRestrictionsLoaded
) {
2314 $this->loadRestrictions();
2316 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2320 * Is there a version of this page in the deletion archive?
2322 * @return Int the number of archived revisions
2324 public function isDeleted() {
2325 if ( $this->getNamespace() < 0 ) {
2328 $dbr = wfGetDB( DB_SLAVE
);
2329 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2330 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2333 if ( $this->getNamespace() == NS_FILE
) {
2334 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
2335 array( 'fa_name' => $this->getDBkey() ),
2344 * Is there a version of this page in the deletion archive?
2348 public function isDeletedQuick() {
2349 if ( $this->getNamespace() < 0 ) {
2352 $dbr = wfGetDB( DB_SLAVE
);
2353 $deleted = (bool)$dbr->selectField( 'archive', '1',
2354 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2357 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
2358 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2359 array( 'fa_name' => $this->getDBkey() ),
2367 * Get the article ID for this Title from the link cache,
2368 * adding it if necessary
2370 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select
2372 * @return Int the ID
2374 public function getArticleID( $flags = 0 ) {
2375 if ( $this->getNamespace() < 0 ) {
2376 return $this->mArticleID
= 0;
2378 $linkCache = LinkCache
::singleton();
2379 if ( $flags & self
::GAID_FOR_UPDATE
) {
2380 $oldUpdate = $linkCache->forUpdate( true );
2381 $linkCache->clearLink( $this );
2382 $this->mArticleID
= $linkCache->addLinkObj( $this );
2383 $linkCache->forUpdate( $oldUpdate );
2385 if ( -1 == $this->mArticleID
) {
2386 $this->mArticleID
= $linkCache->addLinkObj( $this );
2389 return $this->mArticleID
;
2393 * Is this an article that is a redirect page?
2394 * Uses link cache, adding it if necessary
2396 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2399 public function isRedirect( $flags = 0 ) {
2400 if ( !is_null( $this->mRedirect
) ) {
2401 return $this->mRedirect
;
2403 # Calling getArticleID() loads the field from cache as needed
2404 if ( !$this->getArticleID( $flags ) ) {
2405 return $this->mRedirect
= false;
2407 $linkCache = LinkCache
::singleton();
2408 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2410 return $this->mRedirect
;
2414 * What is the length of this page?
2415 * Uses link cache, adding it if necessary
2417 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2420 public function getLength( $flags = 0 ) {
2421 if ( $this->mLength
!= -1 ) {
2422 return $this->mLength
;
2424 # Calling getArticleID() loads the field from cache as needed
2425 if ( !$this->getArticleID( $flags ) ) {
2426 return $this->mLength
= 0;
2428 $linkCache = LinkCache
::singleton();
2429 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2431 return $this->mLength
;
2435 * What is the page_latest field for this page?
2437 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2438 * @return Int or 0 if the page doesn't exist
2440 public function getLatestRevID( $flags = 0 ) {
2441 if ( $this->mLatestID
!== false ) {
2442 return intval( $this->mLatestID
);
2444 # Calling getArticleID() loads the field from cache as needed
2445 if ( !$this->getArticleID( $flags ) ) {
2446 return $this->mLatestID
= 0;
2448 $linkCache = LinkCache
::singleton();
2449 $this->mLatestID
= intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2451 return $this->mLatestID
;
2455 * This clears some fields in this object, and clears any associated
2456 * keys in the "bad links" section of the link cache.
2458 * - This is called from Article::doEdit() and Article::insertOn() to allow
2459 * loading of the new page_id. It's also called from
2460 * Article::doDeleteArticle()
2462 * @param $newid Int the new Article ID
2464 public function resetArticleID( $newid ) {
2465 $linkCache = LinkCache
::singleton();
2466 $linkCache->clearBadLink( $this->getPrefixedDBkey() );
2468 if ( $newid === false ) {
2469 $this->mArticleID
= -1;
2471 $this->mArticleID
= intval( $newid );
2473 $this->mRestrictionsLoaded
= false;
2474 $this->mRestrictions
= array();
2475 $this->mRedirect
= null;
2476 $this->mLength
= -1;
2477 $this->mLatestID
= false;
2481 * Updates page_touched for this page; called from LinksUpdate.php
2483 * @return Bool true if the update succeded
2485 public function invalidateCache() {
2486 if ( wfReadOnly() ) {
2489 $dbw = wfGetDB( DB_MASTER
);
2490 $success = $dbw->update(
2492 array( 'page_touched' => $dbw->timestamp() ),
2496 HTMLFileCache
::clearFileCache( $this );
2501 * Prefix some arbitrary text with the namespace or interwiki prefix
2504 * @param $name String the text
2505 * @return String the prefixed text
2508 /* private */ function prefix( $name ) {
2510 if ( $this->mInterwiki
!= '' ) {
2511 $p = $this->mInterwiki
. ':';
2513 if ( 0 != $this->mNamespace
) {
2514 $p .= $this->getNsText() . ':';
2520 * Returns a simple regex that will match on characters and sequences invalid in titles.
2521 * Note that this doesn't pick up many things that could be wrong with titles, but that
2522 * replacing this regex with something valid will make many titles valid.
2524 * @return string regex string
2526 static function getTitleInvalidRegex() {
2527 static $rxTc = false;
2529 # Matching titles will be held as illegal.
2531 # Any character not allowed is forbidden...
2532 '[^' . Title
::legalChars() . ']' .
2533 # URL percent encoding sequences interfere with the ability
2534 # to round-trip titles -- you can't link to them consistently.
2535 '|%[0-9A-Fa-f]{2}' .
2536 # XML/HTML character references produce similar issues.
2537 '|&[A-Za-z0-9\x80-\xff]+;' .
2539 '|&#x[0-9A-Fa-f]+;' .
2547 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2549 * @param $text string containing title to capitalize
2550 * @param $ns int namespace index, defaults to NS_MAIN
2551 * @return String containing capitalized title
2553 public static function capitalize( $text, $ns = NS_MAIN
) {
2556 if ( MWNamespace
::isCapitalized( $ns ) ) {
2557 return $wgContLang->ucfirst( $text );
2564 * Secure and split - main initialisation function for this object
2566 * Assumes that mDbkeyform has been set, and is urldecoded
2567 * and uses underscores, but not otherwise munged. This function
2568 * removes illegal characters, splits off the interwiki and
2569 * namespace prefixes, sets the other forms, and canonicalizes
2572 * @return Bool true on success
2574 private function secureAndSplit() {
2575 global $wgContLang, $wgLocalInterwiki;
2578 $rxTc = self
::getTitleInvalidRegex();
2580 $this->mInterwiki
= $this->mFragment
= '';
2581 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2583 $dbkey = $this->mDbkeyform
;
2585 # Strip Unicode bidi override characters.
2586 # Sometimes they slip into cut-n-pasted page titles, where the
2587 # override chars get included in list displays.
2588 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2590 # Clean up whitespace
2591 # Note: use of the /u option on preg_replace here will cause
2592 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2593 # conveniently disabling them.
2595 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2596 $dbkey = trim( $dbkey, '_' );
2598 if ( $dbkey == '' ) {
2602 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2603 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2607 $this->mDbkeyform
= $dbkey;
2609 # Initial colon indicates main namespace rather than specified default
2610 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2611 if ( ':' == $dbkey { 0 } ) {
2612 $this->mNamespace
= NS_MAIN
;
2613 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2614 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2617 # Namespace or interwiki prefix
2619 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2622 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2624 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
2625 # Ordinary namespace
2627 $this->mNamespace
= $ns;
2628 # For Talk:X pages, check if X has a "namespace" prefix
2629 if ( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2630 if ( $wgContLang->getNsIndex( $x[1] ) ) {
2631 return false; # Disallow Talk:File:x type titles...
2632 } else if ( Interwiki
::isValidInterwiki( $x[1] ) ) {
2633 return false; # Disallow Talk:Interwiki:x type titles...
2636 } elseif ( Interwiki
::isValidInterwiki( $p ) ) {
2637 if ( !$firstPass ) {
2638 # Can't make a local interwiki link to an interwiki link.
2639 # That's just crazy!
2645 $this->mInterwiki
= $wgContLang->lc( $p );
2647 # Redundant interwiki prefix to the local wiki
2648 if ( $wgLocalInterwiki !== false
2649 && 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) )
2651 if ( $dbkey == '' ) {
2652 # Can't have an empty self-link
2655 $this->mInterwiki
= '';
2657 # Do another namespace split...
2661 # If there's an initial colon after the interwiki, that also
2662 # resets the default namespace
2663 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
2664 $this->mNamespace
= NS_MAIN
;
2665 $dbkey = substr( $dbkey, 1 );
2668 # If there's no recognized interwiki or namespace,
2669 # then let the colon expression be part of the title.
2674 # We already know that some pages won't be in the database!
2676 if ( $this->mInterwiki
!= '' || NS_SPECIAL
== $this->mNamespace
) {
2677 $this->mArticleID
= 0;
2679 $fragment = strstr( $dbkey, '#' );
2680 if ( false !== $fragment ) {
2681 $this->setFragment( preg_replace( '/^#_*/', '#', $fragment ) );
2682 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2683 # remove whitespace again: prevents "Foo_bar_#"
2684 # becoming "Foo_bar_"
2685 $dbkey = preg_replace( '/_*$/', '', $dbkey );
2688 # Reject illegal characters.
2690 if ( preg_match( $rxTc, $dbkey ) ) {
2695 * Pages with "/./" or "/../" appearing in the URLs will often be un-
2696 * reachable due to the way web browsers deal with 'relative' URLs.
2697 * Also, they conflict with subpage syntax. Forbid them explicitly.
2699 if ( strpos( $dbkey, '.' ) !== false &&
2700 ( $dbkey === '.' ||
$dbkey === '..' ||
2701 strpos( $dbkey, './' ) === 0 ||
2702 strpos( $dbkey, '../' ) === 0 ||
2703 strpos( $dbkey, '/./' ) !== false ||
2704 strpos( $dbkey, '/../' ) !== false ||
2705 substr( $dbkey, -2 ) == '/.' ||
2706 substr( $dbkey, -3 ) == '/..' ) )
2712 * Magic tilde sequences? Nu-uh!
2714 if ( strpos( $dbkey, '~~~' ) !== false ) {
2719 * Limit the size of titles to 255 bytes.
2720 * This is typically the size of the underlying database field.
2721 * We make an exception for special pages, which don't need to be stored
2722 * in the database, and may edge over 255 bytes due to subpage syntax
2723 * for long titles, e.g. [[Special:Block/Long name]]
2725 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
2726 strlen( $dbkey ) > 512 )
2732 * Normally, all wiki links are forced to have
2733 * an initial capital letter so [[foo]] and [[Foo]]
2734 * point to the same place.
2736 * Don't force it for interwikis, since the other
2737 * site might be case-sensitive.
2739 $this->mUserCaseDBKey
= $dbkey;
2740 if ( $this->mInterwiki
== '' ) {
2741 $dbkey = self
::capitalize( $dbkey, $this->mNamespace
);
2745 * Can't make a link to a namespace alone...
2746 * "empty" local links can only be self-links
2747 * with a fragment identifier.
2749 if ( $dbkey == '' &&
2750 $this->mInterwiki
== '' &&
2751 $this->mNamespace
!= NS_MAIN
) {
2754 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
2755 // IP names are not allowed for accounts, and can only be referring to
2756 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
2757 // there are numerous ways to present the same IP. Having sp:contribs scan
2758 // them all is silly and having some show the edits and others not is
2759 // inconsistent. Same for talk/userpages. Keep them normalized instead.
2760 $dbkey = ( $this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
) ?
2761 IP
::sanitizeIP( $dbkey ) : $dbkey;
2762 // Any remaining initial :s are illegal.
2763 if ( $dbkey !== '' && ':' == $dbkey { 0 } ) {
2768 $this->mDbkeyform
= $dbkey;
2769 $this->mUrlform
= wfUrlencode( $dbkey );
2771 $this->mTextform
= str_replace( '_', ' ', $dbkey );
2777 * Set the fragment for this title. Removes the first character from the
2778 * specified fragment before setting, so it assumes you're passing it with
2781 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
2782 * Still in active use privately.
2784 * @param $fragment String text
2786 public function setFragment( $fragment ) {
2787 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
2791 * Get a Title object associated with the talk page of this article
2793 * @return Title the object for the talk page
2795 public function getTalkPage() {
2796 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
2800 * Get a title object associated with the subject page of this
2803 * @return Title the object for the subject page
2805 public function getSubjectPage() {
2806 // Is this the same title?
2807 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
2808 if ( $this->getNamespace() == $subjectNS ) {
2811 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
2815 * Get an array of Title objects linking to this Title
2816 * Also stores the IDs in the link cache.
2818 * WARNING: do not use this function on arbitrary user-supplied titles!
2819 * On heavily-used templates it will max out the memory.
2821 * @param $options Array: may be FOR UPDATE
2822 * @param $table String: table name
2823 * @param $prefix String: fields prefix
2824 * @return Array of Title objects linking here
2826 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
2827 $linkCache = LinkCache
::singleton();
2829 if ( count( $options ) > 0 ) {
2830 $db = wfGetDB( DB_MASTER
);
2832 $db = wfGetDB( DB_SLAVE
);
2836 array( 'page', $table ),
2837 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
2839 "{$prefix}_from=page_id",
2840 "{$prefix}_namespace" => $this->getNamespace(),
2841 "{$prefix}_title" => $this->getDBkey() ),
2847 if ( $db->numRows( $res ) ) {
2848 foreach ( $res as $row ) {
2849 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
2851 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
, $row->page_latest
);
2852 $retVal[] = $titleObj;
2860 * Get an array of Title objects using this Title as a template
2861 * Also stores the IDs in the link cache.
2863 * WARNING: do not use this function on arbitrary user-supplied titles!
2864 * On heavily-used templates it will max out the memory.
2866 * @param $options Array: may be FOR UPDATE
2867 * @return Array of Title the Title objects linking here
2869 public function getTemplateLinksTo( $options = array() ) {
2870 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
2874 * Get an array of Title objects referring to non-existent articles linked from this page
2876 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
2877 * @return Array of Title the Title objects
2879 public function getBrokenLinksFrom() {
2880 if ( $this->getArticleId() == 0 ) {
2881 # All links from article ID 0 are false positives
2885 $dbr = wfGetDB( DB_SLAVE
);
2886 $res = $dbr->select(
2887 array( 'page', 'pagelinks' ),
2888 array( 'pl_namespace', 'pl_title' ),
2890 'pl_from' => $this->getArticleId(),
2891 'page_namespace IS NULL'
2893 __METHOD__
, array(),
2897 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
2903 foreach ( $res as $row ) {
2904 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
2911 * Get a list of URLs to purge from the Squid cache when this
2914 * @return Array of String the URLs
2916 public function getSquidURLs() {
2920 $this->getInternalURL(),
2921 $this->getInternalURL( 'action=history' )
2924 // purge variant urls as well
2925 if ( $wgContLang->hasVariants() ) {
2926 $variants = $wgContLang->getVariants();
2927 foreach ( $variants as $vCode ) {
2928 $urls[] = $this->getInternalURL( '', $vCode );
2936 * Purge all applicable Squid URLs
2938 public function purgeSquid() {
2940 if ( $wgUseSquid ) {
2941 $urls = $this->getSquidURLs();
2942 $u = new SquidUpdate( $urls );
2948 * Move this page without authentication
2950 * @param $nt Title the new page Title
2951 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
2953 public function moveNoAuth( &$nt ) {
2954 return $this->moveTo( $nt, false );
2958 * Check whether a given move operation would be valid.
2959 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
2961 * @param $nt Title the new title
2962 * @param $auth Bool indicates whether $wgUser's permissions
2964 * @param $reason String is the log summary of the move, used for spam checking
2965 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
2967 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
2972 // Normally we'd add this to $errors, but we'll get
2973 // lots of syntax errors if $nt is not an object
2974 return array( array( 'badtitletext' ) );
2976 if ( $this->equals( $nt ) ) {
2977 $errors[] = array( 'selfmove' );
2979 if ( !$this->isMovable() ) {
2980 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
2982 if ( $nt->getInterwiki() != '' ) {
2983 $errors[] = array( 'immobile-target-namespace-iw' );
2985 if ( !$nt->isMovable() ) {
2986 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
2989 $oldid = $this->getArticleID();
2990 $newid = $nt->getArticleID();
2992 if ( strlen( $nt->getDBkey() ) < 1 ) {
2993 $errors[] = array( 'articleexists' );
2995 if ( ( $this->getDBkey() == '' ) ||
2997 ( $nt->getDBkey() == '' ) ) {
2998 $errors[] = array( 'badarticleerror' );
3001 // Image-specific checks
3002 if ( $this->getNamespace() == NS_FILE
) {
3003 if ( $nt->getNamespace() != NS_FILE
) {
3004 $errors[] = array( 'imagenocrossnamespace' );
3006 $file = wfLocalFile( $this );
3007 if ( $file->exists() ) {
3008 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3009 $errors[] = array( 'imageinvalidfilename' );
3011 if ( !File
::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3012 $errors[] = array( 'imagetypemismatch' );
3015 $destfile = wfLocalFile( $nt );
3016 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destfile->exists() && wfFindFile( $nt ) ) {
3017 $errors[] = array( 'file-exists-sharedrepo' );
3021 if ( $nt->getNamespace() == NS_FILE
&& $this->getNamespace() != NS_FILE
) {
3022 $errors[] = array( 'nonfile-cannot-move-to-file' );
3026 $errors = wfMergeErrorArrays( $errors,
3027 $this->getUserPermissionsErrors( 'move', $wgUser ),
3028 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3029 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3030 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3033 $match = EditPage
::matchSummarySpamRegex( $reason );
3034 if ( $match !== false ) {
3035 // This is kind of lame, won't display nice
3036 $errors[] = array( 'spamprotectiontext' );
3040 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3041 $errors[] = array( 'hookaborted', $err );
3044 # The move is allowed only if (1) the target doesn't exist, or
3045 # (2) the target is a redirect to the source, and has no history
3046 # (so we can undo bad moves right after they're done).
3048 if ( 0 != $newid ) { # Target exists; check for validity
3049 if ( !$this->isValidMoveTarget( $nt ) ) {
3050 $errors[] = array( 'articleexists' );
3053 $tp = $nt->getTitleProtection();
3054 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
3055 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3056 $errors[] = array( 'cantmove-titleprotected' );
3059 if ( empty( $errors ) ) {
3066 * Move a title to a new location
3068 * @param $nt Title the new title
3069 * @param $auth Bool indicates whether $wgUser's permissions
3071 * @param $reason String The reason for the move
3072 * @param $createRedirect Bool Whether to create a redirect from the old title to the new title.
3073 * Ignored if the user doesn't have the suppressredirect right.
3074 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3076 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3079 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3080 if ( is_array( $err ) ) {
3084 // If it is a file, move it first. It is done before all other moving stuff is done because it's hard to revert
3085 $dbw = wfGetDB( DB_MASTER
);
3086 if ( $this->getNamespace() == NS_FILE
) {
3087 $file = wfLocalFile( $this );
3088 if ( $file->exists() ) {
3089 $status = $file->move( $nt );
3090 if ( !$status->isOk() ) {
3091 return $status->getErrorsArray();
3096 $pageid = $this->getArticleID();
3097 $protected = $this->isProtected();
3098 $pageCountChange = ( $createRedirect ?
1 : 0 ) - ( $nt->exists() ?
1 : 0 );
3100 // Do the actual move
3101 $err = $this->moveToInternal( $nt, $reason, $createRedirect );
3102 if ( is_array( $err ) ) {
3106 $redirid = $this->getArticleID();
3108 // Refresh the sortkey for this row. Be careful to avoid resetting
3109 // cl_timestamp, which may disturb time-based lists on some sites.
3110 $prefix = $dbw->selectField(
3112 'cl_sortkey_prefix',
3113 array( 'cl_from' => $pageid ),
3116 $dbw->update( 'categorylinks',
3118 'cl_sortkey' => $wgContLang->convertToSortkey( $nt->getCategorySortkey( $prefix ) ),
3119 'cl_timestamp=cl_timestamp' ),
3120 array( 'cl_from' => $pageid ),
3124 # Protect the redirect title as the title used to be...
3125 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3127 'pr_page' => $redirid,
3128 'pr_type' => 'pr_type',
3129 'pr_level' => 'pr_level',
3130 'pr_cascade' => 'pr_cascade',
3131 'pr_user' => 'pr_user',
3132 'pr_expiry' => 'pr_expiry'
3134 array( 'pr_page' => $pageid ),
3138 # Update the protection log
3139 $log = new LogPage( 'protect' );
3140 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3142 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3144 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) ); // FIXME: $params?
3148 $oldnamespace = $this->getNamespace() & ~
1;
3149 $newnamespace = $nt->getNamespace() & ~
1;
3150 $oldtitle = $this->getDBkey();
3151 $newtitle = $nt->getDBkey();
3153 if ( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
3154 WatchedItem
::duplicateEntries( $this, $nt );
3157 # Update search engine
3158 $u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
3160 $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
3164 if ( $this->isContentPage() && !$nt->isContentPage() ) {
3165 # No longer a content page
3166 # Not viewed, edited, removing
3167 $u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
3168 } elseif ( !$this->isContentPage() && $nt->isContentPage() ) {
3169 # Now a content page
3170 # Not viewed, edited, adding
3171 $u = new SiteStatsUpdate( 0, 1, +
1, $pageCountChange );
3172 } elseif ( $pageCountChange ) {
3174 $u = new SiteStatsUpdate( 0, 0, 0, 1 );
3182 # Update message cache for interface messages
3183 global $wgMessageCache;
3184 if ( $this->getNamespace() == NS_MEDIAWIKI
) {
3185 # @bug 17860: old article can be deleted, if this the case,
3186 # delete it from message cache
3187 if ( $this->getArticleID() === 0 ) {
3188 $wgMessageCache->replace( $this->getDBkey(), false );
3190 $oldarticle = new Article( $this );
3191 $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
3194 if ( $nt->getNamespace() == NS_MEDIAWIKI
) {
3195 $newarticle = new Article( $nt );
3196 $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
3200 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3205 * Move page to a title which is either a redirect to the
3206 * source page or nonexistent
3208 * @param $nt Title the page to move to, which should
3209 * be a redirect or nonexistent
3210 * @param $reason String The reason for the move
3211 * @param $createRedirect Bool Whether to leave a
3212 * redirect at the old title. Ignored if the user doesn't
3213 * have the suppressredirect right
3215 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3216 global $wgUser, $wgContLang;
3218 $moveOverRedirect = $nt->exists();
3220 $commentMsg = ( $moveOverRedirect ?
'1movedto2_redir' : '1movedto2' );
3221 $comment = wfMsgForContent( $commentMsg, $this->getPrefixedText(), $nt->getPrefixedText() );
3224 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3226 # Truncate for whole multibyte characters. +5 bytes for ellipsis
3227 $comment = $wgContLang->truncate( $comment, 250 );
3229 $oldid = $this->getArticleID();
3230 $latest = $this->getLatestRevID();
3232 $dbw = wfGetDB( DB_MASTER
);
3234 if ( $moveOverRedirect ) {
3235 $rcts = $dbw->timestamp( $nt->getEarliestRevTime() );
3237 $newid = $nt->getArticleID();
3238 $newns = $nt->getNamespace();
3239 $newdbk = $nt->getDBkey();
3241 # Delete the old redirect. We don't save it to history since
3242 # by definition if we've got here it's rather uninteresting.
3243 # We have to remove it so that the next step doesn't trigger
3244 # a conflict on the unique namespace+title index...
3245 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__
);
3246 if ( !$dbw->cascadingDeletes() ) {
3247 $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__
);
3248 global $wgUseTrackbacks;
3249 if ( $wgUseTrackbacks ) {
3250 $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__
);
3252 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
3253 $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__
);
3254 $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__
);
3255 $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__
);
3256 $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__
);
3257 $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__
);
3258 $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__
);
3260 // If the target page was recently created, it may have an entry in recentchanges still
3261 $dbw->delete( 'recentchanges',
3262 array( 'rc_timestamp' => $rcts, 'rc_namespace' => $newns, 'rc_title' => $newdbk, 'rc_new' => 1 ),
3267 # Save a null revision in the page's history notifying of the move
3268 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
3269 if ( !is_object( $nullRevision ) ) {
3270 throw new MWException( 'No valid null revision produced in ' . __METHOD__
);
3272 $nullRevId = $nullRevision->insertOn( $dbw );
3274 $article = new Article( $this );
3275 wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) );
3277 # Change the name of the target page:
3278 $dbw->update( 'page',
3280 'page_touched' => $dbw->timestamp(),
3281 'page_namespace' => $nt->getNamespace(),
3282 'page_title' => $nt->getDBkey(),
3283 'page_latest' => $nullRevId,
3285 /* WHERE */ array( 'page_id' => $oldid ),
3288 $nt->resetArticleID( $oldid );
3290 # Recreate the redirect, this time in the other direction.
3291 if ( $createRedirect ||
!$wgUser->isAllowed( 'suppressredirect' ) ) {
3292 $mwRedir = MagicWord
::get( 'redirect' );
3293 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3294 $redirectArticle = new Article( $this );
3295 $newid = $redirectArticle->insertOn( $dbw );
3296 $redirectRevision = new Revision( array(
3298 'comment' => $comment,
3299 'text' => $redirectText ) );
3300 $redirectRevision->insertOn( $dbw );
3301 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3303 wfRunHooks( 'NewRevisionFromEditComplete', array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3305 # Now, we record the link from the redirect to the new title.
3306 # It should have no other outgoing links...
3307 $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__
);
3308 $dbw->insert( 'pagelinks',
3310 'pl_from' => $newid,
3311 'pl_namespace' => $nt->getNamespace(),
3312 'pl_title' => $nt->getDBkey() ),
3314 $redirectSuppressed = false;
3316 $this->resetArticleID( 0 );
3317 $redirectSuppressed = true;
3321 $log = new LogPage( 'move' );
3322 $logType = ( $moveOverRedirect ?
'move_redir' : 'move' );
3323 $log->addEntry( $logType, $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
3325 # Purge caches for old and new titles
3326 if ( $moveOverRedirect ) {
3327 # A simple purge is enough when moving over a redirect
3330 # Purge caches as per article creation, including any pages that link to this title
3331 Article
::onArticleCreate( $nt );
3333 $this->purgeSquid();
3337 * Move this page's subpages to be subpages of $nt
3339 * @param $nt Title Move target
3340 * @param $auth bool Whether $wgUser's permissions should be checked
3341 * @param $reason string The reason for the move
3342 * @param $createRedirect bool Whether to create redirects from the old subpages to the new ones
3343 * Ignored if the user doesn't have the 'suppressredirect' right
3344 * @return mixed array with old page titles as keys, and strings (new page titles) or
3345 * arrays (errors) as values, or an error array with numeric indices if no pages were moved
3347 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3348 global $wgMaximumMovedPages;
3349 // Check permissions
3350 if ( !$this->userCan( 'move-subpages' ) ) {
3351 return array( 'cant-move-subpages' );
3353 // Do the source and target namespaces support subpages?
3354 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3355 return array( 'namespace-nosubpages',
3356 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3358 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3359 return array( 'namespace-nosubpages',
3360 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3363 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3366 foreach ( $subpages as $oldSubpage ) {
3368 if ( $count > $wgMaximumMovedPages ) {
3369 $retval[$oldSubpage->getPrefixedTitle()] =
3370 array( 'movepage-max-pages',
3371 $wgMaximumMovedPages );
3375 // We don't know whether this function was called before
3376 // or after moving the root page, so check both
3378 if ( $oldSubpage->getArticleId() == $this->getArticleId() ||
3379 $oldSubpage->getArticleID() == $nt->getArticleId() )
3381 // When moving a page to a subpage of itself,
3382 // don't move it twice
3385 $newPageName = preg_replace(
3386 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3387 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3388 $oldSubpage->getDBkey() );
3389 if ( $oldSubpage->isTalkPage() ) {
3390 $newNs = $nt->getTalkPage()->getNamespace();
3392 $newNs = $nt->getSubjectPage()->getNamespace();
3394 # Bug 14385: we need makeTitleSafe because the new page names may
3395 # be longer than 255 characters.
3396 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3398 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3399 if ( $success === true ) {
3400 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3402 $retval[$oldSubpage->getPrefixedText()] = $success;
3409 * Checks if this page is just a one-rev redirect.
3410 * Adds lock, so don't use just for light purposes.
3414 public function isSingleRevRedirect() {
3415 $dbw = wfGetDB( DB_MASTER
);
3417 $row = $dbw->selectRow( 'page',
3418 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3421 array( 'FOR UPDATE' )
3423 # Cache some fields we may want
3424 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3425 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3426 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3427 if ( !$this->mRedirect
) {
3430 # Does the article have a history?
3431 $row = $dbw->selectField( array( 'page', 'revision' ),
3433 array( 'page_namespace' => $this->getNamespace(),
3434 'page_title' => $this->getDBkey(),
3436 'page_latest != rev_id'
3439 array( 'FOR UPDATE' )
3441 # Return true if there was no history
3442 return ( $row === false );
3446 * Checks if $this can be moved to a given Title
3447 * - Selects for update, so don't call it unless you mean business
3449 * @param $nt Title the new title to check
3450 * @return Bool TRUE or FALSE
3452 public function isValidMoveTarget( $nt ) {
3453 # Is it an existing file?
3454 if ( $nt->getNamespace() == NS_FILE
) {
3455 $file = wfLocalFile( $nt );
3456 if ( $file->exists() ) {
3457 wfDebug( __METHOD__
. ": file exists\n" );
3461 # Is it a redirect with no history?
3462 if ( !$nt->isSingleRevRedirect() ) {
3463 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3466 # Get the article text
3467 $rev = Revision
::newFromTitle( $nt );
3468 $text = $rev->getText();
3469 # Does the redirect point to the source?
3470 # Or is it a broken self-redirect, usually caused by namespace collisions?
3472 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3473 $redirTitle = Title
::newFromText( $m[1] );
3474 if ( !is_object( $redirTitle ) ||
3475 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3476 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3477 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3482 wfDebug( __METHOD__
. ": failsafe\n" );
3489 * Can this title be added to a user's watchlist?
3491 * @return Bool TRUE or FALSE
3493 public function isWatchable() {
3494 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
3498 * Get categories to which this Title belongs and return an array of
3499 * categories' names.
3501 * @return Array of parents in the form:
3502 * $parent => $currentarticle
3504 public function getParentCategories() {
3507 $titlekey = $this->getArticleId();
3508 $dbr = wfGetDB( DB_SLAVE
);
3509 $categorylinks = $dbr->tableName( 'categorylinks' );
3512 $sql = "SELECT * FROM $categorylinks"
3513 . " WHERE cl_from='$titlekey'"
3514 . " AND cl_from <> '0'"
3515 . " ORDER BY cl_sortkey";
3517 $res = $dbr->query( $sql );
3520 if ( $dbr->numRows( $res ) > 0 ) {
3521 foreach ( $res as $row ) {
3522 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3523 $data[$wgContLang->getNSText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3530 * Get a tree of parent categories
3532 * @param $children Array with the children in the keys, to check for circular refs
3533 * @return Array Tree of parent categories
3535 public function getParentCategoryTree( $children = array() ) {
3537 $parents = $this->getParentCategories();
3540 foreach ( $parents as $parent => $current ) {
3541 if ( array_key_exists( $parent, $children ) ) {
3542 # Circular reference
3543 $stack[$parent] = array();
3545 $nt = Title
::newFromText( $parent );
3547 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3558 * Get an associative array for selecting this title from
3561 * @return Array Selection array
3563 public function pageCond() {
3564 if ( $this->mArticleID
> 0 ) {
3565 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3566 return array( 'page_id' => $this->mArticleID
);
3568 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3573 * Get the revision ID of the previous revision
3575 * @param $revId Int Revision ID. Get the revision that was before this one.
3576 * @param $flags Int Title::GAID_FOR_UPDATE
3577 * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists
3579 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3580 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3581 return $db->selectField( 'revision', 'rev_id',
3583 'rev_page' => $this->getArticleId( $flags ),
3584 'rev_id < ' . intval( $revId )
3587 array( 'ORDER BY' => 'rev_id DESC' )
3592 * Get the revision ID of the next revision
3594 * @param $revId Int Revision ID. Get the revision that was after this one.
3595 * @param $flags Int Title::GAID_FOR_UPDATE
3596 * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists
3598 public function getNextRevisionID( $revId, $flags = 0 ) {
3599 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3600 return $db->selectField( 'revision', 'rev_id',
3602 'rev_page' => $this->getArticleId( $flags ),
3603 'rev_id > ' . intval( $revId )
3606 array( 'ORDER BY' => 'rev_id' )
3611 * Get the first revision of the page
3613 * @param $flags Int Title::GAID_FOR_UPDATE
3614 * @return Revision (or NULL if page doesn't exist)
3616 public function getFirstRevision( $flags = 0 ) {
3617 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3618 $pageId = $this->getArticleId( $flags );
3622 $row = $db->selectRow( 'revision', '*',
3623 array( 'rev_page' => $pageId ),
3625 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3630 return new Revision( $row );
3635 * Check if this is a new page
3639 public function isNewPage() {
3640 $dbr = wfGetDB( DB_SLAVE
);
3641 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
3645 * Get the oldest revision timestamp of this page
3647 * @return String: MW timestamp
3649 public function getEarliestRevTime() {
3650 $dbr = wfGetDB( DB_SLAVE
);
3651 if ( $this->exists() ) {
3652 $min = $dbr->selectField( 'revision',
3653 'MIN(rev_timestamp)',
3654 array( 'rev_page' => $this->getArticleId() ),
3656 return wfTimestampOrNull( TS_MW
, $min );
3662 * Get the number of revisions between the given revision IDs.
3663 * Used for diffs and other things that really need it.
3665 * @param $old Int Revision ID.
3666 * @param $new Int Revision ID.
3667 * @return Int Number of revisions between these IDs.
3669 public function countRevisionsBetween( $old, $new ) {
3670 $dbr = wfGetDB( DB_SLAVE
);
3671 return (int)$dbr->selectField( 'revision', 'count(*)', array(
3672 'rev_page' => intval( $this->getArticleId() ),
3673 'rev_id > ' . intval( $old ),
3674 'rev_id < ' . intval( $new )
3680 * Get the number of authors between the given revision IDs.
3681 * Used for diffs and other things that really need it.
3683 * @param $fromRevId Int Revision ID (first before range)
3684 * @param $toRevId Int Revision ID (first after range)
3685 * @param $limit Int Maximum number of authors
3686 * @param $flags Int Title::GAID_FOR_UPDATE
3689 public function countAuthorsBetween( $fromRevId, $toRevId, $limit, $flags = 0 ) {
3690 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3691 $res = $db->select( 'revision', 'DISTINCT rev_user_text',
3693 'rev_page' => $this->getArticleID(),
3694 'rev_id > ' . (int)$fromRevId,
3695 'rev_id < ' . (int)$toRevId
3697 array( 'LIMIT' => $limit )
3699 return (int)$db->numRows( $res );
3703 * Compare with another title.
3705 * @param $title Title
3706 * @return Bool TRUE or FALSE
3708 public function equals( Title
$title ) {
3709 // Note: === is necessary for proper matching of number-like titles.
3710 return $this->getInterwiki() === $title->getInterwiki()
3711 && $this->getNamespace() == $title->getNamespace()
3712 && $this->getDBkey() === $title->getDBkey();
3716 * Callback for usort() to do title sorts by (namespace, title)
3718 * @return Integer: result of string comparison, or namespace comparison
3720 public static function compare( $a, $b ) {
3721 if ( $a->getNamespace() == $b->getNamespace() ) {
3722 return strcmp( $a->getText(), $b->getText() );
3724 return $a->getNamespace() - $b->getNamespace();
3729 * Return a string representation of this title
3731 * @return String String representation of this title
3733 public function __toString() {
3734 return $this->getPrefixedText();
3738 * Check if page exists. For historical reasons, this function simply
3739 * checks for the existence of the title in the page table, and will
3740 * thus return false for interwiki links, special pages and the like.
3741 * If you want to know if a title can be meaningfully viewed, you should
3742 * probably call the isKnown() method instead.
3746 public function exists() {
3747 return $this->getArticleId() != 0;
3751 * Should links to this title be shown as potentially viewable (i.e. as
3752 * "bluelinks"), even if there's no record by this title in the page
3755 * This function is semi-deprecated for public use, as well as somewhat
3756 * misleadingly named. You probably just want to call isKnown(), which
3757 * calls this function internally.
3759 * (ISSUE: Most of these checks are cheap, but the file existence check
3760 * can potentially be quite expensive. Including it here fixes a lot of
3761 * existing code, but we might want to add an optional parameter to skip
3762 * it and any other expensive checks.)
3766 public function isAlwaysKnown() {
3767 if ( $this->mInterwiki
!= '' ) {
3768 return true; // any interwiki link might be viewable, for all we know
3770 switch( $this->mNamespace
) {
3773 return (bool)wfFindFile( $this ); // file exists, possibly in a foreign repo
3775 return SpecialPage
::exists( $this->getDBkey() ); // valid special page
3777 return $this->mDbkeyform
== ''; // selflink, possibly with fragment
3779 // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes
3780 // the full l10n of that language to be loaded. That takes much memory and
3781 // isn't needed. So we strip the language part away.
3782 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
3783 return (bool)wfMsgWeirdKey( $basename ); // known system message
3790 * Does this title refer to a page that can (or might) be meaningfully
3791 * viewed? In particular, this function may be used to determine if
3792 * links to the title should be rendered as "bluelinks" (as opposed to
3793 * "redlinks" to non-existent pages).
3797 public function isKnown() {
3798 return $this->isAlwaysKnown() ||
$this->exists();
3802 * Does this page have source text?
3806 public function hasSourceText() {
3807 if ( $this->exists() ) {
3811 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
3812 // If the page doesn't exist but is a known system message, default
3813 // message content will be displayed, same for language subpages
3814 // Also, if the page is form Mediawiki:message/lang, calling wfMsgWeirdKey
3815 // causes the full l10n of that language to be loaded. That takes much
3816 // memory and isn't needed. So we strip the language part away.
3817 list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform
, 2 );
3818 return (bool)wfMsgWeirdKey( $basename );
3825 * Is this in a namespace that allows actual pages?
3828 * @internal note -- uses hardcoded namespace index instead of constants
3830 public function canExist() {
3831 return $this->mNamespace
>= 0 && $this->mNamespace
!= NS_MEDIA
;
3835 * Update page_touched timestamps and send squid purge messages for
3836 * pages linking to this title. May be sent to the job queue depending
3837 * on the number of links. Typically called on create and delete.
3839 public function touchLinks() {
3840 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
3843 if ( $this->getNamespace() == NS_CATEGORY
) {
3844 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
3850 * Get the last touched timestamp
3852 * @param $db DatabaseBase: optional db
3853 * @return String Last touched timestamp
3855 public function getTouched( $db = null ) {
3856 $db = isset( $db ) ?
$db : wfGetDB( DB_SLAVE
);
3857 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
3862 * Get the timestamp when this page was updated since the user last saw it.
3865 * @return Mixed: string/null
3867 public function getNotificationTimestamp( $user = null ) {
3868 global $wgUser, $wgShowUpdatedMarker;
3869 // Assume current user if none given
3873 // Check cache first
3874 $uid = $user->getId();
3875 if ( isset( $this->mNotificationTimestamp
[$uid] ) ) {
3876 return $this->mNotificationTimestamp
[$uid];
3878 if ( !$uid ||
!$wgShowUpdatedMarker ) {
3879 return $this->mNotificationTimestamp
[$uid] = false;
3881 // Don't cache too much!
3882 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
3883 $this->mNotificationTimestamp
= array();
3885 $dbr = wfGetDB( DB_SLAVE
);
3886 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
3887 'wl_notificationtimestamp',
3888 array( 'wl_namespace' => $this->getNamespace(),
3889 'wl_title' => $this->getDBkey(),
3890 'wl_user' => $user->getId()
3894 return $this->mNotificationTimestamp
[$uid];
3898 * Get the trackback URL for this page
3900 * @return String Trackback URL
3902 public function trackbackURL() {
3903 global $wgScriptPath, $wgServer, $wgScriptExtension;
3905 return "$wgServer$wgScriptPath/trackback$wgScriptExtension?article="
3906 . htmlspecialchars( urlencode( $this->getPrefixedDBkey() ) );
3910 * Get the trackback RDF for this page
3912 * @return String Trackback RDF
3914 public function trackbackRDF() {
3915 $url = htmlspecialchars( $this->getFullURL() );
3916 $title = htmlspecialchars( $this->getText() );
3917 $tburl = $this->trackbackURL();
3919 // Autodiscovery RDF is placed in comments so HTML validator
3920 // won't barf. This is a rather icky workaround, but seems
3921 // frequently used by this kind of RDF thingy.
3923 // Spec: http://www.sixapart.com/pronet/docs/trackback_spec
3925 <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
3926 xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
3927 xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
3930 dc:identifier=\"$url\"
3932 trackback:ping=\"$tburl\" />
3938 * Generate strings used for xml 'id' names in monobook tabs
3940 * @param $prepend string defaults to 'nstab-'
3941 * @return String XML 'id' name
3943 public function getNamespaceKey( $prepend = 'nstab-' ) {
3945 // Gets the subject namespace if this title
3946 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
3947 // Checks if cononical namespace name exists for namespace
3948 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
3949 // Uses canonical namespace name
3950 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
3952 // Uses text of namespace
3953 $namespaceKey = $this->getSubjectNsText();
3955 // Makes namespace key lowercase
3956 $namespaceKey = $wgContLang->lc( $namespaceKey );
3958 if ( $namespaceKey == '' ) {
3959 $namespaceKey = 'main';
3961 // Changes file to image for backwards compatibility
3962 if ( $namespaceKey == 'file' ) {
3963 $namespaceKey = 'image';
3965 return $prepend . $namespaceKey;
3969 * Returns true if this is a special page.
3973 public function isSpecialPage() {
3974 return $this->getNamespace() == NS_SPECIAL
;
3978 * Returns true if this title resolves to the named special page
3980 * @param $name String The special page name
3983 public function isSpecial( $name ) {
3984 if ( $this->getNamespace() == NS_SPECIAL
) {
3985 list( $thisName, /* $subpage */ ) = SpecialPage
::resolveAliasWithSubpage( $this->getDBkey() );
3986 if ( $name == $thisName ) {
3994 * If the Title refers to a special page alias which is not the local default,
3996 * @return Title A new Title which points to the local default.
3997 * Otherwise, returns $this.
3999 public function fixSpecialName() {
4000 if ( $this->getNamespace() == NS_SPECIAL
) {
4001 $canonicalName = SpecialPage
::resolveAlias( $this->mDbkeyform
);
4002 if ( $canonicalName ) {
4003 $localName = SpecialPage
::getLocalNameFor( $canonicalName );
4004 if ( $localName != $this->mDbkeyform
) {
4005 return Title
::makeTitle( NS_SPECIAL
, $localName );
4013 * Is this Title in a namespace which contains content?
4014 * In other words, is this a content page, for the purposes of calculating
4019 public function isContentPage() {
4020 return MWNamespace
::isContent( $this->getNamespace() );
4024 * Get all extant redirects to this Title
4026 * @param $ns Int|Null Single namespace to consider;
4027 * NULL to consider all namespaces
4028 * @return Array of Title redirects to this title
4030 public function getRedirectsHere( $ns = null ) {
4033 $dbr = wfGetDB( DB_SLAVE
);
4035 'rd_namespace' => $this->getNamespace(),
4036 'rd_title' => $this->getDBkey(),
4039 if ( !is_null( $ns ) ) {
4040 $where['page_namespace'] = $ns;
4043 $res = $dbr->select(
4044 array( 'redirect', 'page' ),
4045 array( 'page_namespace', 'page_title' ),
4050 foreach ( $res as $row ) {
4051 $redirs[] = self
::newFromRow( $row );
4057 * Check if this Title is a valid redirect target
4061 public function isValidRedirectTarget() {
4062 global $wgInvalidRedirectTargets;
4064 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4065 if ( $this->isSpecial( 'Userlogout' ) ) {
4069 foreach ( $wgInvalidRedirectTargets as $target ) {
4070 if ( $this->isSpecial( $target ) ) {
4079 * Get a backlink cache object
4081 * @return object BacklinkCache
4083 function getBacklinkCache() {
4084 if ( is_null( $this->mBacklinkCache
) ) {
4085 $this->mBacklinkCache
= new BacklinkCache( $this );
4087 return $this->mBacklinkCache
;
4091 * Whether the magic words __INDEX__ and __NOINDEX__ function for
4096 public function canUseNoindex() {
4097 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4099 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4100 ?
$wgContentNamespaces
4101 : $wgExemptFromUserRobotsControl;
4103 return !in_array( $this->mNamespace
, $bannedNamespaces );
4108 * Returns restriction types for the current Title
4110 * @return array applicable restriction types
4112 public function getRestrictionTypes() {
4113 global $wgRestrictionTypes;
4115 $types = $this->exists() ?
$wgRestrictionTypes : array( 'create' );
4117 if ( $this->getNamespace() != NS_FILE
) {
4118 $types = array_diff( $types, array( 'upload' ) );
4121 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
4127 * Returns the raw sort key to be used for categories, with the specified
4128 * prefix. This will be fed to Language::convertToSortkey() to get a
4129 * binary sortkey that can be used for actual sorting.
4131 * @param $prefix string The prefix to be used, specified using
4132 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4136 public function getCategorySortkey( $prefix = '' ) {
4137 $unprefixed = $this->getText();
4138 if ( $prefix !== '' ) {
4139 # Separate with a null byte, so the unprefixed part is only used as
4140 # a tiebreaker when two pages have the exact same prefix -- null
4141 # sorts before everything else (hopefully).
4142 return "$prefix\0$unprefixed";