3 * Representation a title within %MediaWiki.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
26 * Represents a title within MediaWiki.
27 * Optionally may contain an interwiki designation or namespace.
28 * @note This class can fetch various kinds of data from the database;
29 * however, it does so inefficiently.
31 * @internal documentation reviewed 15 Mar 2010
34 /** @name Static cache variables */
36 static private $titleCache = array();
40 * Title::newFromText maintains a cache to avoid expensive re-normalization of
41 * commonly used titles. On a batch operation this can become a memory leak
42 * if not bounded. After hitting this many titles reset the cache.
44 const CACHE_MAX
= 1000;
47 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
48 * to use the master DB
50 const GAID_FOR_UPDATE
= 1;
53 * @name Private member variables
54 * Please use the accessor functions instead.
59 var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
60 var $mUrlform = ''; // /< URL-encoded form of the main part
61 var $mDbkeyform = ''; // /< Main part with underscores
62 var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
63 var $mNamespace = NS_MAIN
; // /< Namespace index, i.e. one of the NS_xxxx constants
64 var $mInterwiki = ''; // /< Interwiki prefix (or null string)
65 var $mFragment; // /< Title fragment (i.e. the bit after the #)
66 var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
67 var $mLatestID = false; // /< ID of most recent revision
68 var $mContentModel = false; // /< ID of the page's content model, i.e. one of the CONTENT_MODEL_XXX constants
69 private $mEstimateRevisions; // /< Estimated number of revisions; null of not loaded
70 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
71 var $mOldRestrictions = false;
72 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
73 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
74 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
75 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
76 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
77 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
78 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
79 var $mTitleProtection; ///< Cached value for getTitleProtection (create protection)
80 # Don't change the following default, NS_MAIN is hardcoded in several
81 # places. See bug 696.
82 var $mDefaultNamespace = NS_MAIN
; // /< Namespace index when there is no namespace
83 # Zero except in {{transclusion}} tags
84 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
85 var $mLength = -1; // /< The page length, 0 for special pages
86 var $mRedirect = null; // /< Is the article at this title a redirect?
87 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
88 var $mHasSubpage; // /< Whether a page has any subpages
95 /*protected*/ function __construct() { }
98 * Create a new Title from a prefixed DB key
100 * @param $key String the database key, which has underscores
101 * instead of spaces, possibly including namespace and
103 * @return Title, or NULL on an error
105 public static function newFromDBkey( $key ) {
107 $t->mDbkeyform
= $key;
108 if ( $t->secureAndSplit() ) {
116 * Create a new Title from text, such as what one would find in a link. De-
117 * codes any HTML entities in the text.
119 * @param $text String the link text; spaces, prefixes, and an
120 * initial ':' indicating the main namespace are accepted.
121 * @param $defaultNamespace Int the namespace to use if none is speci-
122 * fied by a prefix. If you want to force a specific namespace even if
123 * $text might begin with a namespace prefix, use makeTitle() or
125 * @throws MWException
126 * @return Title|null - Title or null on an error.
128 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
129 if ( is_object( $text ) ) {
130 throw new MWException( 'Title::newFromText given an object' );
134 * Wiki pages often contain multiple links to the same page.
135 * Title normalization and parsing can become expensive on
136 * pages with many links, so we can save a little time by
139 * In theory these are value objects and won't get changed...
141 if ( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
142 return Title
::$titleCache[$text];
145 # Convert things like é ā or 〗 into normalized (bug 14952) text
146 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
149 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
150 $t->mDefaultNamespace
= $defaultNamespace;
152 static $cachedcount = 0 ;
153 if ( $t->secureAndSplit() ) {
154 if ( $defaultNamespace == NS_MAIN
) {
155 if ( $cachedcount >= self
::CACHE_MAX
) {
156 # Avoid memory leaks on mass operations...
157 Title
::$titleCache = array();
161 Title
::$titleCache[$text] =& $t;
171 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
173 * Example of wrong and broken code:
174 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
176 * Example of right code:
177 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
179 * Create a new Title from URL-encoded text. Ensures that
180 * the given title's length does not exceed the maximum.
182 * @param $url String the title, as might be taken from a URL
183 * @return Title the new object, or NULL on an error
185 public static function newFromURL( $url ) {
188 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
189 # but some URLs used it as a space replacement and they still come
190 # from some external search tools.
191 if ( strpos( self
::legalChars(), '+' ) === false ) {
192 $url = str_replace( '+', ' ', $url );
195 $t->mDbkeyform
= str_replace( ' ', '_', $url );
196 if ( $t->secureAndSplit() ) {
204 * Returns a list of fields that are to be selected for initializing Title objects or LinkCache entries.
205 * Uses $wgContentHandlerUseDB to determine whether to include page_content_model.
209 protected static function getSelectFields() {
210 global $wgContentHandlerUseDB;
213 'page_namespace', 'page_title', 'page_id',
214 'page_len', 'page_is_redirect', 'page_latest',
217 if ( $wgContentHandlerUseDB ) {
218 $fields[] = 'page_content_model';
225 * Create a new Title from an article ID
227 * @param $id Int the page_id corresponding to the Title to create
228 * @param $flags Int use Title::GAID_FOR_UPDATE to use master
229 * @return Title the new object, or NULL on an error
231 public static function newFromID( $id, $flags = 0 ) {
232 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
233 $row = $db->selectRow(
235 self
::getSelectFields(),
236 array( 'page_id' => $id ),
239 if ( $row !== false ) {
240 $title = Title
::newFromRow( $row );
248 * Make an array of titles from an array of IDs
250 * @param $ids Array of Int Array of IDs
251 * @return Array of Titles
253 public static function newFromIDs( $ids ) {
254 if ( !count( $ids ) ) {
257 $dbr = wfGetDB( DB_SLAVE
);
261 self
::getSelectFields(),
262 array( 'page_id' => $ids ),
267 foreach ( $res as $row ) {
268 $titles[] = Title
::newFromRow( $row );
274 * Make a Title object from a DB row
276 * @param $row Object database row (needs at least page_title,page_namespace)
277 * @return Title corresponding Title
279 public static function newFromRow( $row ) {
280 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
281 $t->loadFromRow( $row );
286 * Load Title object fields from a DB row.
287 * If false is given, the title will be treated as non-existing.
289 * @param $row Object|bool database row
291 public function loadFromRow( $row ) {
292 if ( $row ) { // page found
293 if ( isset( $row->page_id
) )
294 $this->mArticleID
= (int)$row->page_id
;
295 if ( isset( $row->page_len
) )
296 $this->mLength
= (int)$row->page_len
;
297 if ( isset( $row->page_is_redirect
) )
298 $this->mRedirect
= (bool)$row->page_is_redirect
;
299 if ( isset( $row->page_latest
) )
300 $this->mLatestID
= (int)$row->page_latest
;
301 if ( isset( $row->page_content_model
) )
302 $this->mContentModel
= strval( $row->page_content_model
);
304 $this->mContentModel
= false; # initialized lazily in getContentModel()
305 } else { // page not found
306 $this->mArticleID
= 0;
308 $this->mRedirect
= false;
309 $this->mLatestID
= 0;
310 $this->mContentModel
= false; # initialized lazily in getContentModel()
315 * Create a new Title from a namespace index and a DB key.
316 * It's assumed that $ns and $title are *valid*, for instance when
317 * they came directly from the database or a special page name.
318 * For convenience, spaces are converted to underscores so that
319 * eg user_text fields can be used directly.
321 * @param $ns Int the namespace of the article
322 * @param $title String the unprefixed database key form
323 * @param $fragment String the link fragment (after the "#")
324 * @param $interwiki String the interwiki prefix
325 * @return Title the new object
327 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
329 $t->mInterwiki
= $interwiki;
330 $t->mFragment
= $fragment;
331 $t->mNamespace
= $ns = intval( $ns );
332 $t->mDbkeyform
= str_replace( ' ', '_', $title );
333 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
334 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
335 $t->mTextform
= str_replace( '_', ' ', $title );
336 $t->mContentModel
= false; # initialized lazily in getContentModel()
341 * Create a new Title from a namespace index and a DB key.
342 * The parameters will be checked for validity, which is a bit slower
343 * than makeTitle() but safer for user-provided data.
345 * @param $ns Int the namespace of the article
346 * @param $title String database key form
347 * @param $fragment String the link fragment (after the "#")
348 * @param $interwiki String interwiki prefix
349 * @return Title the new object, or NULL on an error
351 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
352 if ( !MWNamespace
::exists( $ns ) ) {
357 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki );
358 if ( $t->secureAndSplit() ) {
366 * Create a new Title for the Main Page
368 * @return Title the new object
370 public static function newMainPage() {
371 $title = Title
::newFromText( wfMessage( 'mainpage' )->inContentLanguage()->text() );
372 // Don't give fatal errors if the message is broken
374 $title = Title
::newFromText( 'Main Page' );
380 * Extract a redirect destination from a string and return the
381 * Title, or null if the text doesn't contain a valid redirect
382 * This will only return the very next target, useful for
383 * the redirect table and other checks that don't need full recursion
385 * @param $text String: Text with possible redirect
386 * @return Title: The corresponding Title
387 * @deprecated since 1.21, use Content::getRedirectTarget instead.
389 public static function newFromRedirect( $text ) {
390 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
391 return $content->getRedirectTarget();
395 * Extract a redirect destination from a string and return the
396 * Title, or null if the text doesn't contain a valid redirect
397 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
398 * in order to provide (hopefully) the Title of the final destination instead of another redirect
400 * @param $text String Text with possible redirect
402 * @deprecated since 1.21, use Content::getUltimateRedirectTarget instead.
404 public static function newFromRedirectRecurse( $text ) {
405 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
406 return $content->getUltimateRedirectTarget();
410 * Extract a redirect destination from a string and return an
411 * array of Titles, or null if the text doesn't contain a valid redirect
412 * The last element in the array is the final destination after all redirects
413 * have been resolved (up to $wgMaxRedirects times)
415 * @param $text String Text with possible redirect
416 * @return Array of Titles, with the destination last
417 * @deprecated since 1.21, use Content::getRedirectChain instead.
419 public static function newFromRedirectArray( $text ) {
420 $content = ContentHandler
::makeContent( $text, null, CONTENT_MODEL_WIKITEXT
);
421 return $content->getRedirectChain();
425 * Get the prefixed DB key associated with an ID
427 * @param $id Int the page_id of the article
428 * @return Title an object representing the article, or NULL if no such article was found
430 public static function nameOf( $id ) {
431 $dbr = wfGetDB( DB_SLAVE
);
433 $s = $dbr->selectRow(
435 array( 'page_namespace', 'page_title' ),
436 array( 'page_id' => $id ),
439 if ( $s === false ) {
443 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
448 * Get a regex character class describing the legal characters in a link
450 * @return String the list of characters, not delimited
452 public static function legalChars() {
453 global $wgLegalTitleChars;
454 return $wgLegalTitleChars;
458 * Returns a simple regex that will match on characters and sequences invalid in titles.
459 * Note that this doesn't pick up many things that could be wrong with titles, but that
460 * replacing this regex with something valid will make many titles valid.
462 * @return String regex string
464 static function getTitleInvalidRegex() {
465 static $rxTc = false;
467 # Matching titles will be held as illegal.
469 # Any character not allowed is forbidden...
470 '[^' . self
::legalChars() . ']' .
471 # URL percent encoding sequences interfere with the ability
472 # to round-trip titles -- you can't link to them consistently.
474 # XML/HTML character references produce similar issues.
475 '|&[A-Za-z0-9\x80-\xff]+;' .
477 '|&#x[0-9A-Fa-f]+;' .
485 * Get a string representation of a title suitable for
486 * including in a search index
488 * @param $ns Int a namespace index
489 * @param $title String text-form main part
490 * @return String a stripped-down title string ready for the search index
492 public static function indexTitle( $ns, $title ) {
495 $lc = SearchEngine
::legalSearchChars() . '&#;';
496 $t = $wgContLang->normalizeForSearch( $title );
497 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
498 $t = $wgContLang->lc( $t );
501 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
502 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
504 $t = preg_replace( "/\\s+/", ' ', $t );
506 if ( $ns == NS_FILE
) {
507 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
513 * Make a prefixed DB key from a DB key and a namespace index
515 * @param $ns Int numerical representation of the namespace
516 * @param $title String the DB key form the title
517 * @param $fragment String The link fragment (after the "#")
518 * @param $interwiki String The interwiki prefix
519 * @return String the prefixed form of the title
521 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
524 $namespace = $wgContLang->getNsText( $ns );
525 $name = $namespace == '' ?
$title : "$namespace:$title";
526 if ( strval( $interwiki ) != '' ) {
527 $name = "$interwiki:$name";
529 if ( strval( $fragment ) != '' ) {
530 $name .= '#' . $fragment;
536 * Escape a text fragment, say from a link, for a URL
538 * @param $fragment string containing a URL or link fragment (after the "#")
539 * @return String: escaped string
541 static function escapeFragmentForURL( $fragment ) {
542 # Note that we don't urlencode the fragment. urlencoded Unicode
543 # fragments appear not to work in IE (at least up to 7) or in at least
544 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
545 # to care if they aren't encoded.
546 return Sanitizer
::escapeId( $fragment, 'noninitial' );
550 * Callback for usort() to do title sorts by (namespace, title)
555 * @return Integer: result of string comparison, or namespace comparison
557 public static function compare( $a, $b ) {
558 if ( $a->getNamespace() == $b->getNamespace() ) {
559 return strcmp( $a->getText(), $b->getText() );
561 return $a->getNamespace() - $b->getNamespace();
566 * Determine whether the object refers to a page within
569 * @return Bool TRUE if this is an in-project interwiki link or a wikilink, FALSE otherwise
571 public function isLocal() {
572 if ( $this->mInterwiki
!= '' ) {
573 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
580 * Is this Title interwiki?
584 public function isExternal() {
585 return ( $this->mInterwiki
!= '' );
589 * Get the interwiki prefix (or null string)
591 * @return String Interwiki prefix
593 public function getInterwiki() {
594 return $this->mInterwiki
;
598 * Determine whether the object refers to a page within
599 * this project and is transcludable.
601 * @return Bool TRUE if this is transcludable
603 public function isTrans() {
604 if ( $this->mInterwiki
== '' ) {
608 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
612 * Returns the DB name of the distant wiki which owns the object.
614 * @return String the DB name
616 public function getTransWikiID() {
617 if ( $this->mInterwiki
== '' ) {
621 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
625 * Get the text form (spaces not underscores) of the main part
627 * @return String Main part of the title
629 public function getText() {
630 return $this->mTextform
;
634 * Get the URL-encoded form of the main part
636 * @return String Main part of the title, URL-encoded
638 public function getPartialURL() {
639 return $this->mUrlform
;
643 * Get the main part with underscores
645 * @return String: Main part of the title, with underscores
647 public function getDBkey() {
648 return $this->mDbkeyform
;
652 * Get the DB key with the initial letter case as specified by the user
654 * @return String DB key
656 function getUserCaseDBKey() {
657 return $this->mUserCaseDBKey
;
661 * Get the namespace index, i.e. one of the NS_xxxx constants.
663 * @return Integer: Namespace index
665 public function getNamespace() {
666 return $this->mNamespace
;
670 * Get the page's content model id, see the CONTENT_MODEL_XXX constants.
672 * @return String: Content model id
674 public function getContentModel() {
675 if ( !$this->mContentModel
) {
676 $linkCache = LinkCache
::singleton();
677 $this->mContentModel
= $linkCache->getGoodLinkFieldObj( $this, 'model' );
680 if ( !$this->mContentModel
) {
681 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $this );
684 if( !$this->mContentModel
) {
685 throw new MWException( "failed to determin content model!" );
688 return $this->mContentModel
;
692 * Convenience method for checking a title's content model name
695 * @return Boolean true if $this->getContentModel() == $id
697 public function hasContentModel( $id ) {
698 return $this->getContentModel() == $id;
702 * Get the namespace text
704 * @return String: Namespace text
706 public function getNsText() {
709 if ( $this->mInterwiki
!= '' ) {
710 // This probably shouldn't even happen. ohh man, oh yuck.
711 // But for interwiki transclusion it sometimes does.
712 // Shit. Shit shit shit.
714 // Use the canonical namespaces if possible to try to
715 // resolve a foreign namespace.
716 if ( MWNamespace
::exists( $this->mNamespace
) ) {
717 return MWNamespace
::getCanonicalName( $this->mNamespace
);
721 if ( $wgContLang->needsGenderDistinction() &&
722 MWNamespace
::hasGenderDistinction( $this->mNamespace
) ) {
723 $gender = GenderCache
::singleton()->getGenderOf( $this->getText(), __METHOD__
);
724 return $wgContLang->getGenderNsText( $this->mNamespace
, $gender );
727 return $wgContLang->getNsText( $this->mNamespace
);
731 * Get the namespace text of the subject (rather than talk) page
733 * @return String Namespace text
735 public function getSubjectNsText() {
737 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
741 * Get the namespace text of the talk page
743 * @return String Namespace text
745 public function getTalkNsText() {
747 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
751 * Could this title have a corresponding talk page?
753 * @return Bool TRUE or FALSE
755 public function canTalk() {
756 return( MWNamespace
::canTalk( $this->mNamespace
) );
760 * Is this in a namespace that allows actual pages?
763 * @internal note -- uses hardcoded namespace index instead of constants
765 public function canExist() {
766 return $this->mNamespace
>= NS_MAIN
;
770 * Can this title be added to a user's watchlist?
772 * @return Bool TRUE or FALSE
774 public function isWatchable() {
775 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
779 * Returns true if this is a special page.
783 public function isSpecialPage() {
784 return $this->getNamespace() == NS_SPECIAL
;
788 * Returns true if this title resolves to the named special page
790 * @param $name String The special page name
793 public function isSpecial( $name ) {
794 if ( $this->isSpecialPage() ) {
795 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
796 if ( $name == $thisName ) {
804 * If the Title refers to a special page alias which is not the local default, resolve
805 * the alias, and localise the name as necessary. Otherwise, return $this
809 public function fixSpecialName() {
810 if ( $this->isSpecialPage() ) {
811 list( $canonicalName, $par ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
812 if ( $canonicalName ) {
813 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName, $par );
814 if ( $localName != $this->mDbkeyform
) {
815 return Title
::makeTitle( NS_SPECIAL
, $localName );
823 * Returns true if the title is inside the specified namespace.
825 * Please make use of this instead of comparing to getNamespace()
826 * This function is much more resistant to changes we may make
827 * to namespaces than code that makes direct comparisons.
828 * @param $ns int The namespace
832 public function inNamespace( $ns ) {
833 return MWNamespace
::equals( $this->getNamespace(), $ns );
837 * Returns true if the title is inside one of the specified namespaces.
839 * @param ...$namespaces The namespaces to check for
843 public function inNamespaces( /* ... */ ) {
844 $namespaces = func_get_args();
845 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
846 $namespaces = $namespaces[0];
849 foreach ( $namespaces as $ns ) {
850 if ( $this->inNamespace( $ns ) ) {
859 * Returns true if the title has the same subject namespace as the
860 * namespace specified.
861 * For example this method will take NS_USER and return true if namespace
862 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
863 * as their subject namespace.
865 * This is MUCH simpler than individually testing for equivilance
866 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
871 public function hasSubjectNamespace( $ns ) {
872 return MWNamespace
::subjectEquals( $this->getNamespace(), $ns );
876 * Is this Title in a namespace which contains content?
877 * In other words, is this a content page, for the purposes of calculating
882 public function isContentPage() {
883 return MWNamespace
::isContent( $this->getNamespace() );
887 * Would anybody with sufficient privileges be able to move this page?
888 * Some pages just aren't movable.
890 * @return Bool TRUE or FALSE
892 public function isMovable() {
893 if ( !MWNamespace
::isMovable( $this->getNamespace() ) ||
$this->getInterwiki() != '' ) {
894 // Interwiki title or immovable namespace. Hooks don't get to override here
899 wfRunHooks( 'TitleIsMovable', array( $this, &$result ) );
904 * Is this the mainpage?
905 * @note Title::newFromText seams to be sufficiently optimized by the title
906 * cache that we don't need to over-optimize by doing direct comparisons and
907 * acidentally creating new bugs where $title->equals( Title::newFromText() )
908 * ends up reporting something differently than $title->isMainPage();
913 public function isMainPage() {
914 return $this->equals( Title
::newMainPage() );
922 public function isSubpage() {
923 return MWNamespace
::hasSubpages( $this->mNamespace
)
924 ?
strpos( $this->getText(), '/' ) !== false
929 * Is this a conversion table for the LanguageConverter?
933 public function isConversionTable() {
934 //@todo: ConversionTable should become a separate content model.
936 return $this->getNamespace() == NS_MEDIAWIKI
&&
937 strpos( $this->getText(), 'Conversiontable/' ) === 0;
941 * Does that page contain wikitext, or it is JS, CSS or whatever?
945 public function isWikitextPage() {
946 return $this->hasContentModel( CONTENT_MODEL_WIKITEXT
);
950 * Could this page contain custom CSS or JavaScript for the global UI.
951 * This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS
952 * or CONTENT_MODEL_JAVASCRIPT.
954 * This method does *not* return true for per-user JS/CSS. Use isCssJsSubpage() for that!
956 * Note that this method should not return true for pages that contain and show "inactive" CSS or JS.
960 public function isCssOrJsPage() {
961 $isCssOrJsPage = NS_MEDIAWIKI
== $this->mNamespace
962 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
963 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
965 #NOTE: this hook is also called in ContentHandler::getDefaultModel. It's called here again to make sure
966 # hook funktions can force this method to return true even outside the mediawiki namespace.
968 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$isCssOrJsPage ) );
970 return $isCssOrJsPage;
974 * Is this a .css or .js subpage of a user page?
977 public function isCssJsSubpage() {
978 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
979 && ( $this->hasContentModel( CONTENT_MODEL_CSS
)
980 ||
$this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) ) );
984 * Trim down a .css or .js subpage title to get the corresponding skin name
986 * @return string containing skin name from .css or .js subpage title
988 public function getSkinFromCssJsSubpage() {
989 $subpage = explode( '/', $this->mTextform
);
990 $subpage = $subpage[ count( $subpage ) - 1 ];
991 $lastdot = strrpos( $subpage, '.' );
992 if ( $lastdot === false )
993 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
994 return substr( $subpage, 0, $lastdot );
998 * Is this a .css subpage of a user page?
1002 public function isCssSubpage() {
1003 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1004 && $this->hasContentModel( CONTENT_MODEL_CSS
) );
1008 * Is this a .js subpage of a user page?
1012 public function isJsSubpage() {
1013 return ( NS_USER
== $this->mNamespace
&& $this->isSubpage()
1014 && $this->hasContentModel( CONTENT_MODEL_JAVASCRIPT
) );
1018 * Is this a talk page of some sort?
1022 public function isTalkPage() {
1023 return MWNamespace
::isTalk( $this->getNamespace() );
1027 * Get a Title object associated with the talk page of this article
1029 * @return Title the object for the talk page
1031 public function getTalkPage() {
1032 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
1036 * Get a title object associated with the subject page of this
1039 * @return Title the object for the subject page
1041 public function getSubjectPage() {
1042 // Is this the same title?
1043 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
1044 if ( $this->getNamespace() == $subjectNS ) {
1047 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
1051 * Get the default namespace index, for when there is no namespace
1053 * @return Int Default namespace index
1055 public function getDefaultNamespace() {
1056 return $this->mDefaultNamespace
;
1060 * Get title for search index
1062 * @return String a stripped-down title string ready for the
1065 public function getIndexTitle() {
1066 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
1070 * Get the Title fragment (i.e.\ the bit after the #) in text form
1072 * @return String Title fragment
1074 public function getFragment() {
1075 return $this->mFragment
;
1079 * Get the fragment in URL form, including the "#" character if there is one
1080 * @return String Fragment in URL form
1082 public function getFragmentForURL() {
1083 if ( $this->mFragment
== '' ) {
1086 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
1091 * Set the fragment for this title. Removes the first character from the
1092 * specified fragment before setting, so it assumes you're passing it with
1095 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1096 * Still in active use privately.
1098 * @param $fragment String text
1100 public function setFragment( $fragment ) {
1101 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
1105 * Prefix some arbitrary text with the namespace or interwiki prefix
1108 * @param $name String the text
1109 * @return String the prefixed text
1112 private function prefix( $name ) {
1114 if ( $this->mInterwiki
!= '' ) {
1115 $p = $this->mInterwiki
. ':';
1118 if ( 0 != $this->mNamespace
) {
1119 $p .= $this->getNsText() . ':';
1125 * Get the prefixed database key form
1127 * @return String the prefixed title, with underscores and
1128 * any interwiki and namespace prefixes
1130 public function getPrefixedDBkey() {
1131 $s = $this->prefix( $this->mDbkeyform
);
1132 $s = str_replace( ' ', '_', $s );
1137 * Get the prefixed title with spaces.
1138 * This is the form usually used for display
1140 * @return String the prefixed title, with spaces
1142 public function getPrefixedText() {
1143 // @todo FIXME: Bad usage of empty() ?
1144 if ( empty( $this->mPrefixedText
) ) {
1145 $s = $this->prefix( $this->mTextform
);
1146 $s = str_replace( '_', ' ', $s );
1147 $this->mPrefixedText
= $s;
1149 return $this->mPrefixedText
;
1153 * Return a string representation of this title
1155 * @return String representation of this title
1157 public function __toString() {
1158 return $this->getPrefixedText();
1162 * Get the prefixed title with spaces, plus any fragment
1163 * (part beginning with '#')
1165 * @return String the prefixed title, with spaces and the fragment, including '#'
1167 public function getFullText() {
1168 $text = $this->getPrefixedText();
1169 if ( $this->mFragment
!= '' ) {
1170 $text .= '#' . $this->mFragment
;
1176 * Get the base page name, i.e. the leftmost part before any slashes
1178 * @return String Base name
1180 public function getBaseText() {
1181 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1182 return $this->getText();
1185 $parts = explode( '/', $this->getText() );
1186 # Don't discard the real title if there's no subpage involved
1187 if ( count( $parts ) > 1 ) {
1188 unset( $parts[count( $parts ) - 1] );
1190 return implode( '/', $parts );
1194 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1196 * @return String Subpage name
1198 public function getSubpageText() {
1199 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1200 return( $this->mTextform
);
1202 $parts = explode( '/', $this->mTextform
);
1203 return( $parts[count( $parts ) - 1] );
1207 * Get the HTML-escaped displayable text form.
1208 * Used for the title field in <a> tags.
1210 * @return String the text, including any prefixes
1212 public function getEscapedText() {
1213 wfDeprecated( __METHOD__
, '1.19' );
1214 return htmlspecialchars( $this->getPrefixedText() );
1218 * Get a URL-encoded form of the subpage text
1220 * @return String URL-encoded subpage name
1222 public function getSubpageUrlForm() {
1223 $text = $this->getSubpageText();
1224 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1229 * Get a URL-encoded title (not an actual URL) including interwiki
1231 * @return String the URL-encoded form
1233 public function getPrefixedURL() {
1234 $s = $this->prefix( $this->mDbkeyform
);
1235 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1240 * Helper to fix up the get{Local,Full,Link,Canonical}URL args
1241 * get{Canonical,Full,Link,Local}URL methods accepted an optional
1242 * second argument named variant. This was deprecated in favor
1243 * of passing an array of option with a "variant" key
1244 * Once $query2 is removed for good, this helper can be dropped
1245 * andthe wfArrayToCGI moved to getLocalURL();
1247 * @since 1.19 (r105919)
1249 * @param $query2 bool
1252 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1253 if( $query2 !== false ) {
1254 wfDeprecated( "Title::get{Canonical,Full,Link,Local} method called with a second parameter is deprecated. Add your parameter to an array passed as the first parameter.", "1.19" );
1256 if ( is_array( $query ) ) {
1257 $query = wfArrayToCGI( $query );
1260 if ( is_string( $query2 ) ) {
1261 // $query2 is a string, we will consider this to be
1262 // a deprecated $variant argument and add it to the query
1263 $query2 = wfArrayToCGI( array( 'variant' => $query2 ) );
1265 $query2 = wfArrayToCGI( $query2 );
1267 // If we have $query content add a & to it first
1271 // Now append the queries together
1278 * Get a real URL referring to this title, with interwiki link and
1281 * See getLocalURL for the arguments.
1283 * @see self::getLocalURL
1285 * @param $proto Protocol type to use in URL
1286 * @return String the URL
1288 public function getFullURL( $query = '', $query2 = false, $proto = PROTO_RELATIVE
) {
1289 $query = self
::fixUrlQueryArgs( $query, $query2 );
1291 # Hand off all the decisions on urls to getLocalURL
1292 $url = $this->getLocalURL( $query );
1294 # Expand the url to make it a full url. Note that getLocalURL has the
1295 # potential to output full urls for a variety of reasons, so we use
1296 # wfExpandUrl instead of simply prepending $wgServer
1297 $url = wfExpandUrl( $url, $proto );
1299 # Finally, add the fragment.
1300 $url .= $this->getFragmentForURL();
1302 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
1307 * Get a URL with no fragment or server name. If this page is generated
1308 * with action=render, $wgServer is prepended.
1311 * @param $query string|array an optional query string,
1312 * not used for interwiki links. Can be specified as an associative array as well,
1313 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1314 * Some query patterns will trigger various shorturl path replacements.
1315 * @param $query2 Mixed: An optional secondary query array. This one MUST
1316 * be an array. If a string is passed it will be interpreted as a deprecated
1317 * variant argument and urlencoded into a variant= argument.
1318 * This second query argument will be added to the $query
1319 * The second parameter is deprecated since 1.19. Pass it as a key,value
1320 * pair in the first parameter array instead.
1322 * @return String the URL
1324 public function getLocalURL( $query = '', $query2 = false ) {
1325 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1327 $query = self
::fixUrlQueryArgs( $query, $query2 );
1329 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
1331 $namespace = $this->getNsText();
1332 if ( $namespace != '' ) {
1333 # Can this actually happen? Interwikis shouldn't be parsed.
1334 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1337 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1338 $url = wfAppendQuery( $url, $query );
1340 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1341 if ( $query == '' ) {
1342 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1343 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1345 global $wgVariantArticlePath, $wgActionPaths;
1349 if ( !empty( $wgActionPaths ) &&
1350 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
1352 $action = urldecode( $matches[2] );
1353 if ( isset( $wgActionPaths[$action] ) ) {
1354 $query = $matches[1];
1355 if ( isset( $matches[4] ) ) {
1356 $query .= $matches[4];
1358 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1359 if ( $query != '' ) {
1360 $url = wfAppendQuery( $url, $query );
1365 if ( $url === false &&
1366 $wgVariantArticlePath &&
1367 $this->getPageLanguage()->hasVariants() &&
1368 preg_match( '/^variant=([^&]*)$/', $query, $matches ) )
1370 $variant = urldecode( $matches[1] );
1371 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1372 // Only do the variant replacement if the given variant is a valid
1373 // variant for the page's language.
1374 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1375 $url = str_replace( '$1', $dbkey, $url );
1379 if ( $url === false ) {
1380 if ( $query == '-' ) {
1383 $url = "{$wgScript}?title={$dbkey}&{$query}";
1387 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1389 // @todo FIXME: This causes breakage in various places when we
1390 // actually expected a local URL and end up with dupe prefixes.
1391 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1392 $url = $wgServer . $url;
1395 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1400 * Get a URL that's the simplest URL that will be valid to link, locally,
1401 * to the current Title. It includes the fragment, but does not include
1402 * the server unless action=render is used (or the link is external). If
1403 * there's a fragment but the prefixed text is empty, we just return a link
1406 * The result obviously should not be URL-escaped, but does need to be
1407 * HTML-escaped if it's being output in HTML.
1409 * See getLocalURL for the arguments.
1411 * @see self::getLocalURL
1412 * @return String the URL
1414 public function getLinkURL( $query = '', $query2 = false ) {
1415 wfProfileIn( __METHOD__
);
1416 if ( $this->isExternal() ) {
1417 $ret = $this->getFullURL( $query, $query2 );
1418 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
1419 $ret = $this->getFragmentForURL();
1421 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1423 wfProfileOut( __METHOD__
);
1428 * Get an HTML-escaped version of the URL form, suitable for
1429 * using in a link, without a server name or fragment
1431 * See getLocalURL for the arguments.
1433 * @see self::getLocalURL
1434 * @param $query string
1435 * @param $query2 bool|string
1436 * @return String the URL
1438 public function escapeLocalURL( $query = '', $query2 = false ) {
1439 wfDeprecated( __METHOD__
, '1.19' );
1440 return htmlspecialchars( $this->getLocalURL( $query, $query2 ) );
1444 * Get an HTML-escaped version of the URL form, suitable for
1445 * using in a link, including the server name and fragment
1447 * See getLocalURL for the arguments.
1449 * @see self::getLocalURL
1450 * @return String the URL
1452 public function escapeFullURL( $query = '', $query2 = false ) {
1453 wfDeprecated( __METHOD__
, '1.19' );
1454 return htmlspecialchars( $this->getFullURL( $query, $query2 ) );
1458 * Get the URL form for an internal link.
1459 * - Used in various Squid-related code, in case we have a different
1460 * internal hostname for the server from the exposed one.
1462 * This uses $wgInternalServer to qualify the path, or $wgServer
1463 * if $wgInternalServer is not set. If the server variable used is
1464 * protocol-relative, the URL will be expanded to http://
1466 * See getLocalURL for the arguments.
1468 * @see self::getLocalURL
1469 * @return String the URL
1471 public function getInternalURL( $query = '', $query2 = false ) {
1472 global $wgInternalServer, $wgServer;
1473 $query = self
::fixUrlQueryArgs( $query, $query2 );
1474 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1475 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
1476 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1481 * Get the URL for a canonical link, for use in things like IRC and
1482 * e-mail notifications. Uses $wgCanonicalServer and the
1483 * GetCanonicalURL hook.
1485 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1487 * See getLocalURL for the arguments.
1489 * @see self::getLocalURL
1490 * @return string The URL
1493 public function getCanonicalURL( $query = '', $query2 = false ) {
1494 $query = self
::fixUrlQueryArgs( $query, $query2 );
1495 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
1496 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1501 * HTML-escaped version of getCanonicalURL()
1503 * See getLocalURL for the arguments.
1505 * @see self::getLocalURL
1509 public function escapeCanonicalURL( $query = '', $query2 = false ) {
1510 wfDeprecated( __METHOD__
, '1.19' );
1511 return htmlspecialchars( $this->getCanonicalURL( $query, $query2 ) );
1515 * Get the edit URL for this Title
1517 * @return String the URL, or a null string if this is an
1520 public function getEditURL() {
1521 if ( $this->mInterwiki
!= '' ) {
1524 $s = $this->getLocalURL( 'action=edit' );
1530 * Is $wgUser watching this page?
1532 * @deprecated in 1.20; use User::isWatched() instead.
1535 public function userIsWatching() {
1538 if ( is_null( $this->mWatched
) ) {
1539 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1540 $this->mWatched
= false;
1542 $this->mWatched
= $wgUser->isWatched( $this );
1545 return $this->mWatched
;
1549 * Can $wgUser read this page?
1551 * @deprecated in 1.19; use userCan(), quickUserCan() or getUserPermissionsErrors() instead
1553 * @todo fold these checks into userCan()
1555 public function userCanRead() {
1556 wfDeprecated( __METHOD__
, '1.19' );
1557 return $this->userCan( 'read' );
1561 * Can $user perform $action on this page?
1562 * This skips potentially expensive cascading permission checks
1563 * as well as avoids expensive error formatting
1565 * Suitable for use for nonessential UI controls in common cases, but
1566 * _not_ for functional access control.
1568 * May provide false positives, but should never provide a false negative.
1570 * @param $action String action that permission needs to be checked for
1571 * @param $user User to check (since 1.19); $wgUser will be used if not
1575 public function quickUserCan( $action, $user = null ) {
1576 return $this->userCan( $action, $user, false );
1580 * Can $user perform $action on this page?
1582 * @param $action String action that permission needs to be checked for
1583 * @param $user User to check (since 1.19); $wgUser will be used if not
1585 * @param $doExpensiveQueries Bool Set this to false to avoid doing
1586 * unnecessary queries.
1589 public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1590 if ( !$user instanceof User
) {
1594 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries, true ) );
1598 * Can $user perform $action on this page?
1600 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1602 * @param $action String action that permission needs to be checked for
1603 * @param $user User to check
1604 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary
1605 * queries by skipping checks for cascading protections and user blocks.
1606 * @param $ignoreErrors Array of Strings Set this to a list of message keys
1607 * whose corresponding errors may be ignored.
1608 * @return Array of arguments to wfMessage to explain permissions problems.
1610 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1611 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1613 // Remove the errors being ignored.
1614 foreach ( $errors as $index => $error ) {
1615 $error_key = is_array( $error ) ?
$error[0] : $error;
1617 if ( in_array( $error_key, $ignoreErrors ) ) {
1618 unset( $errors[$index] );
1626 * Permissions checks that fail most often, and which are easiest to test.
1628 * @param $action String the action to check
1629 * @param $user User user to check
1630 * @param $errors Array list of current errors
1631 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1632 * @param $short Boolean short circuit on first error
1634 * @return Array list of errors
1636 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1637 if ( $action == 'create' ) {
1638 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1639 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1640 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1642 } elseif ( $action == 'move' ) {
1643 if ( !$user->isAllowed( 'move-rootuserpages' )
1644 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1645 // Show user page-specific message only if the user can move other pages
1646 $errors[] = array( 'cant-move-user-page' );
1649 // Check if user is allowed to move files if it's a file
1650 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1651 $errors[] = array( 'movenotallowedfile' );
1654 if ( !$user->isAllowed( 'move' ) ) {
1655 // User can't move anything
1656 global $wgGroupPermissions;
1657 $userCanMove = false;
1658 if ( isset( $wgGroupPermissions['user']['move'] ) ) {
1659 $userCanMove = $wgGroupPermissions['user']['move'];
1661 $autoconfirmedCanMove = false;
1662 if ( isset( $wgGroupPermissions['autoconfirmed']['move'] ) ) {
1663 $autoconfirmedCanMove = $wgGroupPermissions['autoconfirmed']['move'];
1665 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1666 // custom message if logged-in users without any special rights can move
1667 $errors[] = array( 'movenologintext' );
1669 $errors[] = array( 'movenotallowed' );
1672 } elseif ( $action == 'move-target' ) {
1673 if ( !$user->isAllowed( 'move' ) ) {
1674 // User can't move anything
1675 $errors[] = array( 'movenotallowed' );
1676 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1677 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1678 // Show user page-specific message only if the user can move other pages
1679 $errors[] = array( 'cant-move-to-user-page' );
1681 } elseif ( !$user->isAllowed( $action ) ) {
1682 $errors[] = $this->missingPermissionError( $action, $short );
1689 * Add the resulting error code to the errors array
1691 * @param $errors Array list of current errors
1692 * @param $result Mixed result of errors
1694 * @return Array list of errors
1696 private function resultToError( $errors, $result ) {
1697 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1698 // A single array representing an error
1699 $errors[] = $result;
1700 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
1701 // A nested array representing multiple errors
1702 $errors = array_merge( $errors, $result );
1703 } elseif ( $result !== '' && is_string( $result ) ) {
1704 // A string representing a message-id
1705 $errors[] = array( $result );
1706 } elseif ( $result === false ) {
1707 // a generic "We don't want them to do that"
1708 $errors[] = array( 'badaccess-group0' );
1714 * Check various permission hooks
1716 * @param $action String the action to check
1717 * @param $user User user to check
1718 * @param $errors Array list of current errors
1719 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1720 * @param $short Boolean short circuit on first error
1722 * @return Array list of errors
1724 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1725 // Use getUserPermissionsErrors instead
1727 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1728 return $result ?
array() : array( array( 'badaccess-group0' ) );
1730 // Check getUserPermissionsErrors hook
1731 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1732 $errors = $this->resultToError( $errors, $result );
1734 // Check getUserPermissionsErrorsExpensive hook
1735 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1736 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1737 $errors = $this->resultToError( $errors, $result );
1744 * Check permissions on special pages & namespaces
1746 * @param $action String the action to check
1747 * @param $user User user to check
1748 * @param $errors Array list of current errors
1749 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1750 * @param $short Boolean short circuit on first error
1752 * @return Array list of errors
1754 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1755 # Only 'createaccount' and 'execute' can be performed on
1756 # special pages, which don't actually exist in the DB.
1757 $specialOKActions = array( 'createaccount', 'execute', 'read' );
1758 if ( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions ) ) {
1759 $errors[] = array( 'ns-specialprotected' );
1762 # Check $wgNamespaceProtection for restricted namespaces
1763 if ( $this->isNamespaceProtected( $user ) ) {
1764 $ns = $this->mNamespace
== NS_MAIN ?
1765 wfMessage( 'nstab-main' )->text() : $this->getNsText();
1766 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
1767 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1774 * Check CSS/JS sub-page permissions
1776 * @param $action String the action to check
1777 * @param $user User user to check
1778 * @param $errors Array list of current errors
1779 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1780 * @param $short Boolean short circuit on first error
1782 * @return Array list of errors
1784 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1785 # Protect css/js subpages of user pages
1786 # XXX: this might be better using restrictions
1787 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1788 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1789 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
1790 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1791 $errors[] = array( 'customcssprotected' );
1792 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1793 $errors[] = array( 'customjsprotected' );
1801 * Check against page_restrictions table requirements on this
1802 * page. The user must possess all required rights for this
1805 * @param $action String the action to check
1806 * @param $user User user to check
1807 * @param $errors Array list of current errors
1808 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1809 * @param $short Boolean short circuit on first error
1811 * @return Array list of errors
1813 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1814 foreach ( $this->getRestrictions( $action ) as $right ) {
1815 // Backwards compatibility, rewrite sysop -> protect
1816 if ( $right == 'sysop' ) {
1819 if ( $right != '' && !$user->isAllowed( $right ) ) {
1820 // Users with 'editprotected' permission can edit protected pages
1821 // without cascading option turned on.
1822 if ( $action != 'edit' ||
!$user->isAllowed( 'editprotected' )
1823 ||
$this->mCascadeRestriction
)
1825 $errors[] = array( 'protectedpagetext', $right );
1834 * Check restrictions on cascading pages.
1836 * @param $action String the action to check
1837 * @param $user User to check
1838 * @param $errors Array list of current errors
1839 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1840 * @param $short Boolean short circuit on first error
1842 * @return Array list of errors
1844 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1845 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1846 # We /could/ use the protection level on the source page, but it's
1847 # fairly ugly as we have to establish a precedence hierarchy for pages
1848 # included by multiple cascade-protected pages. So just restrict
1849 # it to people with 'protect' permission, as they could remove the
1850 # protection anyway.
1851 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1852 # Cascading protection depends on more than this page...
1853 # Several cascading protected pages may include this page...
1854 # Check each cascading level
1855 # This is only for protection restrictions, not for all actions
1856 if ( isset( $restrictions[$action] ) ) {
1857 foreach ( $restrictions[$action] as $right ) {
1858 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1859 if ( $right != '' && !$user->isAllowed( $right ) ) {
1861 foreach ( $cascadingSources as $page )
1862 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1863 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1873 * Check action permissions not already checked in checkQuickPermissions
1875 * @param $action String the action to check
1876 * @param $user User to check
1877 * @param $errors Array list of current errors
1878 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1879 * @param $short Boolean short circuit on first error
1881 * @return Array list of errors
1883 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1884 global $wgDeleteRevisionsLimit, $wgLang;
1886 if ( $action == 'protect' ) {
1887 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $doExpensiveQueries, true ) ) ) {
1888 // If they can't edit, they shouldn't protect.
1889 $errors[] = array( 'protect-cantedit' );
1891 } elseif ( $action == 'create' ) {
1892 $title_protection = $this->getTitleProtection();
1893 if( $title_protection ) {
1894 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1895 $title_protection['pt_create_perm'] = 'protect'; // B/C
1897 if( $title_protection['pt_create_perm'] == '' ||
1898 !$user->isAllowed( $title_protection['pt_create_perm'] ) )
1900 $errors[] = array( 'titleprotected', User
::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1903 } elseif ( $action == 'move' ) {
1904 // Check for immobile pages
1905 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1906 // Specific message for this case
1907 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1908 } elseif ( !$this->isMovable() ) {
1909 // Less specific message for rarer cases
1910 $errors[] = array( 'immobile-source-page' );
1912 } elseif ( $action == 'move-target' ) {
1913 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1914 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1915 } elseif ( !$this->isMovable() ) {
1916 $errors[] = array( 'immobile-target-page' );
1918 } elseif ( $action == 'delete' ) {
1919 if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
1920 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion() )
1922 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
1929 * Check that the user isn't blocked from editting.
1931 * @param $action String the action to check
1932 * @param $user User to check
1933 * @param $errors Array list of current errors
1934 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1935 * @param $short Boolean short circuit on first error
1937 * @return Array list of errors
1939 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1940 // Account creation blocks handled at userlogin.
1941 // Unblocking handled in SpecialUnblock
1942 if( !$doExpensiveQueries ||
in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
1946 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
1948 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
1949 $errors[] = array( 'confirmedittext' );
1952 if ( ( $action == 'edit' ||
$action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
1953 // Don't block the user from editing their own talk page unless they've been
1954 // explicitly blocked from that too.
1955 } elseif( $user->isBlocked() && $user->mBlock
->prevents( $action ) !== false ) {
1956 $block = $user->getBlock();
1958 // This is from OutputPage::blockedPage
1959 // Copied at r23888 by werdna
1961 $id = $user->blockedBy();
1962 $reason = $user->blockedFor();
1963 if ( $reason == '' ) {
1964 $reason = wfMessage( 'blockednoreason' )->text();
1966 $ip = $user->getRequest()->getIP();
1968 if ( is_numeric( $id ) ) {
1969 $name = User
::whoIs( $id );
1974 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1975 $blockid = $block->getId();
1976 $blockExpiry = $block->getExpiry();
1977 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $block->mTimestamp
), true );
1978 if ( $blockExpiry == 'infinity' ) {
1979 $blockExpiry = wfMessage( 'infiniteblock' )->text();
1981 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1984 $intended = strval( $block->getTarget() );
1986 $errors[] = array( ( $block->mAuto ?
'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1987 $blockid, $blockExpiry, $intended, $blockTimestamp );
1994 * Check that the user is allowed to read this page.
1996 * @param $action String the action to check
1997 * @param $user User to check
1998 * @param $errors Array list of current errors
1999 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
2000 * @param $short Boolean short circuit on first error
2002 * @return Array list of errors
2004 private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
2005 global $wgWhitelistRead, $wgGroupPermissions, $wgRevokePermissions;
2006 static $useShortcut = null;
2008 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
2009 if ( is_null( $useShortcut ) ) {
2010 $useShortcut = true;
2011 if ( empty( $wgGroupPermissions['*']['read'] ) ) {
2012 # Not a public wiki, so no shortcut
2013 $useShortcut = false;
2014 } elseif ( !empty( $wgRevokePermissions ) ) {
2016 * Iterate through each group with permissions being revoked (key not included since we don't care
2017 * what the group name is), then check if the read permission is being revoked. If it is, then
2018 * we don't use the shortcut below since the user might not be able to read, even though anon
2019 * reading is allowed.
2021 foreach ( $wgRevokePermissions as $perms ) {
2022 if ( !empty( $perms['read'] ) ) {
2023 # We might be removing the read right from the user, so no shortcut
2024 $useShortcut = false;
2031 $whitelisted = false;
2032 if ( $useShortcut ) {
2033 # Shortcut for public wikis, allows skipping quite a bit of code
2034 $whitelisted = true;
2035 } elseif ( $user->isAllowed( 'read' ) ) {
2036 # If the user is allowed to read pages, he is allowed to read all pages
2037 $whitelisted = true;
2038 } elseif ( $this->isSpecial( 'Userlogin' )
2039 ||
$this->isSpecial( 'ChangePassword' )
2040 ||
$this->isSpecial( 'PasswordReset' )
2042 # Always grant access to the login page.
2043 # Even anons need to be able to log in.
2044 $whitelisted = true;
2045 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2046 # Time to check the whitelist
2047 # Only do these checks is there's something to check against
2048 $name = $this->getPrefixedText();
2049 $dbName = $this->getPrefixedDBKey();
2051 // Check for explicit whitelisting with and without underscores
2052 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2053 $whitelisted = true;
2054 } elseif ( $this->getNamespace() == NS_MAIN
) {
2055 # Old settings might have the title prefixed with
2056 # a colon for main-namespace pages
2057 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2058 $whitelisted = true;
2060 } elseif ( $this->isSpecialPage() ) {
2061 # If it's a special page, ditch the subpage bit and check again
2062 $name = $this->getDBkey();
2063 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
2064 if ( $name !== false ) {
2065 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2066 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2067 $whitelisted = true;
2073 if ( !$whitelisted ) {
2074 # If the title is not whitelisted, give extensions a chance to do so...
2075 wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2076 if ( !$whitelisted ) {
2077 $errors[] = $this->missingPermissionError( $action, $short );
2085 * Get a description array when the user doesn't have the right to perform
2086 * $action (i.e. when User::isAllowed() returns false)
2088 * @param $action String the action to check
2089 * @param $short Boolean short circuit on first error
2090 * @return Array list of errors
2092 private function missingPermissionError( $action, $short ) {
2093 // We avoid expensive display logic for quickUserCan's and such
2095 return array( 'badaccess-group0' );
2098 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2099 User
::getGroupsWithPermission( $action ) );
2101 if ( count( $groups ) ) {
2105 $wgLang->commaList( $groups ),
2109 return array( 'badaccess-group0' );
2114 * Can $user perform $action on this page? This is an internal function,
2115 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2116 * checks on wfReadOnly() and blocks)
2118 * @param $action String action that permission needs to be checked for
2119 * @param $user User to check
2120 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
2121 * @param $short Bool Set this to true to stop after the first permission error.
2122 * @return Array of arrays of the arguments to wfMessage to explain permissions problems.
2124 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
2125 wfProfileIn( __METHOD__
);
2127 # Read has special handling
2128 if ( $action == 'read' ) {
2130 'checkPermissionHooks',
2131 'checkReadPermissions',
2135 'checkQuickPermissions',
2136 'checkPermissionHooks',
2137 'checkSpecialsAndNSPermissions',
2138 'checkCSSandJSPermissions',
2139 'checkPageRestrictions',
2140 'checkCascadingSourcesRestrictions',
2141 'checkActionPermissions',
2147 while( count( $checks ) > 0 &&
2148 !( $short && count( $errors ) > 0 ) ) {
2149 $method = array_shift( $checks );
2150 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2153 wfProfileOut( __METHOD__
);
2158 * Protect css subpages of user pages: can $wgUser edit
2161 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2164 public function userCanEditCssSubpage() {
2166 wfDeprecated( __METHOD__
, '1.19' );
2167 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'editusercss' ) )
2168 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2172 * Protect js subpages of user pages: can $wgUser edit
2175 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2178 public function userCanEditJsSubpage() {
2180 wfDeprecated( __METHOD__
, '1.19' );
2181 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'edituserjs' ) )
2182 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2186 * Get a filtered list of all restriction types supported by this wiki.
2187 * @param bool $exists True to get all restriction types that apply to
2188 * titles that do exist, False for all restriction types that apply to
2189 * titles that do not exist
2192 public static function getFilteredRestrictionTypes( $exists = true ) {
2193 global $wgRestrictionTypes;
2194 $types = $wgRestrictionTypes;
2196 # Remove the create restriction for existing titles
2197 $types = array_diff( $types, array( 'create' ) );
2199 # Only the create and upload restrictions apply to non-existing titles
2200 $types = array_intersect( $types, array( 'create', 'upload' ) );
2206 * Returns restriction types for the current Title
2208 * @return array applicable restriction types
2210 public function getRestrictionTypes() {
2211 if ( $this->isSpecialPage() ) {
2215 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2217 if ( $this->getNamespace() != NS_FILE
) {
2218 # Remove the upload restriction for non-file titles
2219 $types = array_diff( $types, array( 'upload' ) );
2222 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2224 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2225 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2231 * Is this title subject to title protection?
2232 * Title protection is the one applied against creation of such title.
2234 * @return Mixed An associative array representing any existent title
2235 * protection, or false if there's none.
2237 private function getTitleProtection() {
2238 // Can't protect pages in special namespaces
2239 if ( $this->getNamespace() < 0 ) {
2243 // Can't protect pages that exist.
2244 if ( $this->exists() ) {
2248 if ( !isset( $this->mTitleProtection
) ) {
2249 $dbr = wfGetDB( DB_SLAVE
);
2250 $res = $dbr->select( 'protected_titles', '*',
2251 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2254 // fetchRow returns false if there are no rows.
2255 $this->mTitleProtection
= $dbr->fetchRow( $res );
2257 return $this->mTitleProtection
;
2261 * Update the title protection status
2263 * @deprecated in 1.19; will be removed in 1.20. Use WikiPage::doUpdateRestrictions() instead.
2264 * @param $create_perm String Permission required for creation
2265 * @param $reason String Reason for protection
2266 * @param $expiry String Expiry timestamp
2267 * @return boolean true
2269 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
2270 wfDeprecated( __METHOD__
, '1.19' );
2274 $limit = array( 'create' => $create_perm );
2275 $expiry = array( 'create' => $expiry );
2277 $page = WikiPage
::factory( $this );
2278 $status = $page->doUpdateRestrictions( $limit, $expiry, false, $reason, $wgUser );
2280 return $status->isOK();
2284 * Remove any title protection due to page existing
2286 public function deleteTitleProtection() {
2287 $dbw = wfGetDB( DB_MASTER
);
2291 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2294 $this->mTitleProtection
= false;
2298 * Is this page "semi-protected" - the *only* protection is autoconfirm?
2300 * @param $action String Action to check (default: edit)
2303 public function isSemiProtected( $action = 'edit' ) {
2304 if ( $this->exists() ) {
2305 $restrictions = $this->getRestrictions( $action );
2306 if ( count( $restrictions ) > 0 ) {
2307 foreach ( $restrictions as $restriction ) {
2308 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
2318 # If it doesn't exist, it can't be protected
2324 * Does the title correspond to a protected article?
2326 * @param $action String the action the page is protected from,
2327 * by default checks all actions.
2330 public function isProtected( $action = '' ) {
2331 global $wgRestrictionLevels;
2333 $restrictionTypes = $this->getRestrictionTypes();
2335 # Special pages have inherent protection
2336 if( $this->isSpecialPage() ) {
2340 # Check regular protection levels
2341 foreach ( $restrictionTypes as $type ) {
2342 if ( $action == $type ||
$action == '' ) {
2343 $r = $this->getRestrictions( $type );
2344 foreach ( $wgRestrictionLevels as $level ) {
2345 if ( in_array( $level, $r ) && $level != '' ) {
2356 * Determines if $user is unable to edit this page because it has been protected
2357 * by $wgNamespaceProtection.
2359 * @param $user User object to check permissions
2362 public function isNamespaceProtected( User
$user ) {
2363 global $wgNamespaceProtection;
2365 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2366 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2367 if ( $right != '' && !$user->isAllowed( $right ) ) {
2376 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2378 * @return Bool If the page is subject to cascading restrictions.
2380 public function isCascadeProtected() {
2381 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2382 return ( $sources > 0 );
2386 * Cascading protection: Get the source of any cascading restrictions on this page.
2388 * @param $getPages Bool Whether or not to retrieve the actual pages
2389 * that the restrictions have come from.
2390 * @return Mixed Array of Title objects of the pages from which cascading restrictions
2391 * have come, false for none, or true if such restrictions exist, but $getPages
2392 * was not set. The restriction array is an array of each type, each of which
2393 * contains a array of unique groups.
2395 public function getCascadeProtectionSources( $getPages = true ) {
2397 $pagerestrictions = array();
2399 if ( isset( $this->mCascadeSources
) && $getPages ) {
2400 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2401 } elseif ( isset( $this->mHasCascadingRestrictions
) && !$getPages ) {
2402 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2405 wfProfileIn( __METHOD__
);
2407 $dbr = wfGetDB( DB_SLAVE
);
2409 if ( $this->getNamespace() == NS_FILE
) {
2410 $tables = array( 'imagelinks', 'page_restrictions' );
2411 $where_clauses = array(
2412 'il_to' => $this->getDBkey(),
2417 $tables = array( 'templatelinks', 'page_restrictions' );
2418 $where_clauses = array(
2419 'tl_namespace' => $this->getNamespace(),
2420 'tl_title' => $this->getDBkey(),
2427 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2428 'pr_expiry', 'pr_type', 'pr_level' );
2429 $where_clauses[] = 'page_id=pr_page';
2432 $cols = array( 'pr_expiry' );
2435 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2437 $sources = $getPages ?
array() : false;
2438 $now = wfTimestampNow();
2439 $purgeExpired = false;
2441 foreach ( $res as $row ) {
2442 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2443 if ( $expiry > $now ) {
2445 $page_id = $row->pr_page
;
2446 $page_ns = $row->page_namespace
;
2447 $page_title = $row->page_title
;
2448 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2449 # Add groups needed for each restriction type if its not already there
2450 # Make sure this restriction type still exists
2452 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2453 $pagerestrictions[$row->pr_type
] = array();
2456 if ( isset( $pagerestrictions[$row->pr_type
] ) &&
2457 !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] ) ) {
2458 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2464 // Trigger lazy purge of expired restrictions from the db
2465 $purgeExpired = true;
2468 if ( $purgeExpired ) {
2469 Title
::purgeExpiredRestrictions();
2473 $this->mCascadeSources
= $sources;
2474 $this->mCascadingRestrictions
= $pagerestrictions;
2476 $this->mHasCascadingRestrictions
= $sources;
2479 wfProfileOut( __METHOD__
);
2480 return array( $sources, $pagerestrictions );
2484 * Accessor/initialisation for mRestrictions
2486 * @param $action String action that permission needs to be checked for
2487 * @return Array of Strings the array of groups allowed to edit this article
2489 public function getRestrictions( $action ) {
2490 if ( !$this->mRestrictionsLoaded
) {
2491 $this->loadRestrictions();
2493 return isset( $this->mRestrictions
[$action] )
2494 ?
$this->mRestrictions
[$action]
2499 * Get the expiry time for the restriction against a given action
2502 * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever
2503 * or not protected at all, or false if the action is not recognised.
2505 public function getRestrictionExpiry( $action ) {
2506 if ( !$this->mRestrictionsLoaded
) {
2507 $this->loadRestrictions();
2509 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2513 * Returns cascading restrictions for the current article
2517 function areRestrictionsCascading() {
2518 if ( !$this->mRestrictionsLoaded
) {
2519 $this->loadRestrictions();
2522 return $this->mCascadeRestriction
;
2526 * Loads a string into mRestrictions array
2528 * @param $res Resource restrictions as an SQL result.
2529 * @param $oldFashionedRestrictions String comma-separated list of page
2530 * restrictions from page table (pre 1.10)
2532 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2535 foreach ( $res as $row ) {
2539 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2543 * Compiles list of active page restrictions from both page table (pre 1.10)
2544 * and page_restrictions table for this existing page.
2545 * Public for usage by LiquidThreads.
2547 * @param $rows array of db result objects
2548 * @param $oldFashionedRestrictions string comma-separated list of page
2549 * restrictions from page table (pre 1.10)
2551 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2553 $dbr = wfGetDB( DB_SLAVE
);
2555 $restrictionTypes = $this->getRestrictionTypes();
2557 foreach ( $restrictionTypes as $type ) {
2558 $this->mRestrictions
[$type] = array();
2559 $this->mRestrictionsExpiry
[$type] = $wgContLang->formatExpiry( '', TS_MW
);
2562 $this->mCascadeRestriction
= false;
2564 # Backwards-compatibility: also load the restrictions from the page record (old format).
2566 if ( $oldFashionedRestrictions === null ) {
2567 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2568 array( 'page_id' => $this->getArticleID() ), __METHOD__
);
2571 if ( $oldFashionedRestrictions != '' ) {
2573 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2574 $temp = explode( '=', trim( $restrict ) );
2575 if ( count( $temp ) == 1 ) {
2576 // old old format should be treated as edit/move restriction
2577 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2578 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2580 $restriction = trim( $temp[1] );
2581 if( $restriction != '' ) { //some old entries are empty
2582 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
2587 $this->mOldRestrictions
= true;
2591 if ( count( $rows ) ) {
2592 # Current system - load second to make them override.
2593 $now = wfTimestampNow();
2594 $purgeExpired = false;
2596 # Cycle through all the restrictions.
2597 foreach ( $rows as $row ) {
2599 // Don't take care of restrictions types that aren't allowed
2600 if ( !in_array( $row->pr_type
, $restrictionTypes ) )
2603 // This code should be refactored, now that it's being used more generally,
2604 // But I don't really see any harm in leaving it in Block for now -werdna
2605 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2607 // Only apply the restrictions if they haven't expired!
2608 if ( !$expiry ||
$expiry > $now ) {
2609 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2610 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2612 $this->mCascadeRestriction |
= $row->pr_cascade
;
2614 // Trigger a lazy purge of expired restrictions
2615 $purgeExpired = true;
2619 if ( $purgeExpired ) {
2620 Title
::purgeExpiredRestrictions();
2624 $this->mRestrictionsLoaded
= true;
2628 * Load restrictions from the page_restrictions table
2630 * @param $oldFashionedRestrictions String comma-separated list of page
2631 * restrictions from page table (pre 1.10)
2633 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2635 if ( !$this->mRestrictionsLoaded
) {
2636 if ( $this->exists() ) {
2637 $dbr = wfGetDB( DB_SLAVE
);
2639 $res = $dbr->select(
2640 'page_restrictions',
2642 array( 'pr_page' => $this->getArticleID() ),
2646 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2648 $title_protection = $this->getTitleProtection();
2650 if ( $title_protection ) {
2651 $now = wfTimestampNow();
2652 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW
);
2654 if ( !$expiry ||
$expiry > $now ) {
2655 // Apply the restrictions
2656 $this->mRestrictionsExpiry
['create'] = $expiry;
2657 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2658 } else { // Get rid of the old restrictions
2659 Title
::purgeExpiredRestrictions();
2660 $this->mTitleProtection
= false;
2663 $this->mRestrictionsExpiry
['create'] = $wgContLang->formatExpiry( '', TS_MW
);
2665 $this->mRestrictionsLoaded
= true;
2671 * Flush the protection cache in this object and force reload from the database.
2672 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2674 public function flushRestrictions() {
2675 $this->mRestrictionsLoaded
= false;
2676 $this->mTitleProtection
= null;
2680 * Purge expired restrictions from the page_restrictions table
2682 static function purgeExpiredRestrictions() {
2683 $dbw = wfGetDB( DB_MASTER
);
2685 'page_restrictions',
2686 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2692 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2698 * Does this have subpages? (Warning, usually requires an extra DB query.)
2702 public function hasSubpages() {
2703 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
2708 # We dynamically add a member variable for the purpose of this method
2709 # alone to cache the result. There's no point in having it hanging
2710 # around uninitialized in every Title object; therefore we only add it
2711 # if needed and don't declare it statically.
2712 if ( isset( $this->mHasSubpages
) ) {
2713 return $this->mHasSubpages
;
2716 $subpages = $this->getSubpages( 1 );
2717 if ( $subpages instanceof TitleArray
) {
2718 return $this->mHasSubpages
= (bool)$subpages->count();
2720 return $this->mHasSubpages
= false;
2724 * Get all subpages of this page.
2726 * @param $limit Int maximum number of subpages to fetch; -1 for no limit
2727 * @return mixed TitleArray, or empty array if this page's namespace
2728 * doesn't allow subpages
2730 public function getSubpages( $limit = -1 ) {
2731 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
2735 $dbr = wfGetDB( DB_SLAVE
);
2736 $conds['page_namespace'] = $this->getNamespace();
2737 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
2739 if ( $limit > -1 ) {
2740 $options['LIMIT'] = $limit;
2742 return $this->mSubpages
= TitleArray
::newFromResult(
2743 $dbr->select( 'page',
2744 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
2753 * Is there a version of this page in the deletion archive?
2755 * @return Int the number of archived revisions
2757 public function isDeleted() {
2758 if ( $this->getNamespace() < 0 ) {
2761 $dbr = wfGetDB( DB_SLAVE
);
2763 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2764 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2767 if ( $this->getNamespace() == NS_FILE
) {
2768 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
2769 array( 'fa_name' => $this->getDBkey() ),
2778 * Is there a version of this page in the deletion archive?
2782 public function isDeletedQuick() {
2783 if ( $this->getNamespace() < 0 ) {
2786 $dbr = wfGetDB( DB_SLAVE
);
2787 $deleted = (bool)$dbr->selectField( 'archive', '1',
2788 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2791 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
2792 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2793 array( 'fa_name' => $this->getDBkey() ),
2801 * Get the article ID for this Title from the link cache,
2802 * adding it if necessary
2804 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select
2806 * @return Int the ID
2808 public function getArticleID( $flags = 0 ) {
2809 if ( $this->getNamespace() < 0 ) {
2810 return $this->mArticleID
= 0;
2812 $linkCache = LinkCache
::singleton();
2813 if ( $flags & self
::GAID_FOR_UPDATE
) {
2814 $oldUpdate = $linkCache->forUpdate( true );
2815 $linkCache->clearLink( $this );
2816 $this->mArticleID
= $linkCache->addLinkObj( $this );
2817 $linkCache->forUpdate( $oldUpdate );
2819 if ( -1 == $this->mArticleID
) {
2820 $this->mArticleID
= $linkCache->addLinkObj( $this );
2823 return $this->mArticleID
;
2827 * Is this an article that is a redirect page?
2828 * Uses link cache, adding it if necessary
2830 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2833 public function isRedirect( $flags = 0 ) {
2834 if ( !is_null( $this->mRedirect
) ) {
2835 return $this->mRedirect
;
2837 # Calling getArticleID() loads the field from cache as needed
2838 if ( !$this->getArticleID( $flags ) ) {
2839 return $this->mRedirect
= false;
2842 $linkCache = LinkCache
::singleton();
2843 $cached = $linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2844 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
2845 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2846 # as a stop gap, perhaps log this, but don't throw an exception?
2847 throw new MWException( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2850 $this->mRedirect
= (bool)$cached;
2852 return $this->mRedirect
;
2856 * What is the length of this page?
2857 * Uses link cache, adding it if necessary
2859 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2862 public function getLength( $flags = 0 ) {
2863 if ( $this->mLength
!= -1 ) {
2864 return $this->mLength
;
2866 # Calling getArticleID() loads the field from cache as needed
2867 if ( !$this->getArticleID( $flags ) ) {
2868 return $this->mLength
= 0;
2870 $linkCache = LinkCache
::singleton();
2871 $cached = $linkCache->getGoodLinkFieldObj( $this, 'length' );
2872 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
2873 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2874 # as a stop gap, perhaps log this, but don't throw an exception?
2875 throw new MWException( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2878 $this->mLength
= intval( $cached );
2880 return $this->mLength
;
2884 * What is the page_latest field for this page?
2886 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2887 * @return Int or 0 if the page doesn't exist
2889 public function getLatestRevID( $flags = 0 ) {
2890 if ( !( $flags & Title
::GAID_FOR_UPDATE
) && $this->mLatestID
!== false ) {
2891 return intval( $this->mLatestID
);
2893 # Calling getArticleID() loads the field from cache as needed
2894 if ( !$this->getArticleID( $flags ) ) {
2895 return $this->mLatestID
= 0;
2897 $linkCache = LinkCache
::singleton();
2898 $cached = $linkCache->getGoodLinkFieldObj( $this, 'revision' );
2899 if ( $cached === null ) { # check the assumption that the cache actually knows about this title
2900 # XXX: this does apparently happen, see https://bugzilla.wikimedia.org/show_bug.cgi?id=37209
2901 # as a stop gap, perhaps log this, but don't throw an exception?
2902 throw new MWException( "LinkCache doesn't currently know about this title: " . $this->getPrefixedDBkey() );
2905 $this->mLatestID
= intval( $cached );
2907 return $this->mLatestID
;
2911 * This clears some fields in this object, and clears any associated
2912 * keys in the "bad links" section of the link cache.
2914 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
2915 * loading of the new page_id. It's also called from
2916 * WikiPage::doDeleteArticleReal()
2918 * @param $newid Int the new Article ID
2920 public function resetArticleID( $newid ) {
2921 $linkCache = LinkCache
::singleton();
2922 $linkCache->clearLink( $this );
2924 if ( $newid === false ) {
2925 $this->mArticleID
= -1;
2927 $this->mArticleID
= intval( $newid );
2929 $this->mRestrictionsLoaded
= false;
2930 $this->mRestrictions
= array();
2931 $this->mRedirect
= null;
2932 $this->mLength
= -1;
2933 $this->mLatestID
= false;
2934 $this->mContentModel
= false;
2935 $this->mEstimateRevisions
= null;
2939 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2941 * @param $text String containing title to capitalize
2942 * @param $ns int namespace index, defaults to NS_MAIN
2943 * @return String containing capitalized title
2945 public static function capitalize( $text, $ns = NS_MAIN
) {
2948 if ( MWNamespace
::isCapitalized( $ns ) ) {
2949 return $wgContLang->ucfirst( $text );
2956 * Secure and split - main initialisation function for this object
2958 * Assumes that mDbkeyform has been set, and is urldecoded
2959 * and uses underscores, but not otherwise munged. This function
2960 * removes illegal characters, splits off the interwiki and
2961 * namespace prefixes, sets the other forms, and canonicalizes
2964 * @return Bool true on success
2966 private function secureAndSplit() {
2967 global $wgContLang, $wgLocalInterwiki;
2970 $this->mInterwiki
= $this->mFragment
= '';
2971 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2973 $dbkey = $this->mDbkeyform
;
2975 # Strip Unicode bidi override characters.
2976 # Sometimes they slip into cut-n-pasted page titles, where the
2977 # override chars get included in list displays.
2978 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2980 # Clean up whitespace
2981 # Note: use of the /u option on preg_replace here will cause
2982 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2983 # conveniently disabling them.
2984 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2985 $dbkey = trim( $dbkey, '_' );
2987 if ( $dbkey == '' ) {
2991 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2992 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2996 $this->mDbkeyform
= $dbkey;
2998 # Initial colon indicates main namespace rather than specified default
2999 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
3000 if ( ':' == $dbkey[0] ) {
3001 $this->mNamespace
= NS_MAIN
;
3002 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
3003 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
3006 # Namespace or interwiki prefix
3008 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
3011 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
3013 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
3014 # Ordinary namespace
3016 $this->mNamespace
= $ns;
3017 # For Talk:X pages, check if X has a "namespace" prefix
3018 if ( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
3019 if ( $wgContLang->getNsIndex( $x[1] ) ) {
3020 # Disallow Talk:File:x type titles...
3022 } elseif ( Interwiki
::isValidInterwiki( $x[1] ) ) {
3023 # Disallow Talk:Interwiki:x type titles...
3027 } elseif ( Interwiki
::isValidInterwiki( $p ) ) {
3028 if ( !$firstPass ) {
3029 # Can't make a local interwiki link to an interwiki link.
3030 # That's just crazy!
3036 $this->mInterwiki
= $wgContLang->lc( $p );
3038 # Redundant interwiki prefix to the local wiki
3039 if ( $wgLocalInterwiki !== false
3040 && 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) )
3042 if ( $dbkey == '' ) {
3043 # Can't have an empty self-link
3046 $this->mInterwiki
= '';
3048 # Do another namespace split...
3052 # If there's an initial colon after the interwiki, that also
3053 # resets the default namespace
3054 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
3055 $this->mNamespace
= NS_MAIN
;
3056 $dbkey = substr( $dbkey, 1 );
3059 # If there's no recognized interwiki or namespace,
3060 # then let the colon expression be part of the title.
3065 # We already know that some pages won't be in the database!
3066 if ( $this->mInterwiki
!= '' || NS_SPECIAL
== $this->mNamespace
) {
3067 $this->mArticleID
= 0;
3069 $fragment = strstr( $dbkey, '#' );
3070 if ( false !== $fragment ) {
3071 $this->setFragment( $fragment );
3072 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
3073 # remove whitespace again: prevents "Foo_bar_#"
3074 # becoming "Foo_bar_"
3075 $dbkey = preg_replace( '/_*$/', '', $dbkey );
3078 # Reject illegal characters.
3079 $rxTc = self
::getTitleInvalidRegex();
3080 if ( preg_match( $rxTc, $dbkey ) ) {
3084 # Pages with "/./" or "/../" appearing in the URLs will often be un-
3085 # reachable due to the way web browsers deal with 'relative' URLs.
3086 # Also, they conflict with subpage syntax. Forbid them explicitly.
3087 if ( strpos( $dbkey, '.' ) !== false &&
3088 ( $dbkey === '.' ||
$dbkey === '..' ||
3089 strpos( $dbkey, './' ) === 0 ||
3090 strpos( $dbkey, '../' ) === 0 ||
3091 strpos( $dbkey, '/./' ) !== false ||
3092 strpos( $dbkey, '/../' ) !== false ||
3093 substr( $dbkey, -2 ) == '/.' ||
3094 substr( $dbkey, -3 ) == '/..' ) )
3099 # Magic tilde sequences? Nu-uh!
3100 if ( strpos( $dbkey, '~~~' ) !== false ) {
3104 # Limit the size of titles to 255 bytes. This is typically the size of the
3105 # underlying database field. We make an exception for special pages, which
3106 # don't need to be stored in the database, and may edge over 255 bytes due
3107 # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
3108 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
3109 strlen( $dbkey ) > 512 )
3114 # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
3115 # and [[Foo]] point to the same place. Don't force it for interwikis, since the
3116 # other site might be case-sensitive.
3117 $this->mUserCaseDBKey
= $dbkey;
3118 if ( $this->mInterwiki
== '' ) {
3119 $dbkey = self
::capitalize( $dbkey, $this->mNamespace
);
3122 # Can't make a link to a namespace alone... "empty" local links can only be
3123 # self-links with a fragment identifier.
3124 if ( $dbkey == '' && $this->mInterwiki
== '' && $this->mNamespace
!= NS_MAIN
) {
3128 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
3129 // IP names are not allowed for accounts, and can only be referring to
3130 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
3131 // there are numerous ways to present the same IP. Having sp:contribs scan
3132 // them all is silly and having some show the edits and others not is
3133 // inconsistent. Same for talk/userpages. Keep them normalized instead.
3134 $dbkey = ( $this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
)
3135 ? IP
::sanitizeIP( $dbkey )
3138 // Any remaining initial :s are illegal.
3139 if ( $dbkey !== '' && ':' == $dbkey[0] ) {
3144 $this->mDbkeyform
= $dbkey;
3145 $this->mUrlform
= wfUrlencode( $dbkey );
3147 $this->mTextform
= str_replace( '_', ' ', $dbkey );
3153 * Get an array of Title objects linking to this Title
3154 * Also stores the IDs in the link cache.
3156 * WARNING: do not use this function on arbitrary user-supplied titles!
3157 * On heavily-used templates it will max out the memory.
3159 * @param $options Array: may be FOR UPDATE
3160 * @param $table String: table name
3161 * @param $prefix String: fields prefix
3162 * @return Array of Title objects linking here
3164 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3165 if ( count( $options ) > 0 ) {
3166 $db = wfGetDB( DB_MASTER
);
3168 $db = wfGetDB( DB_SLAVE
);
3172 array( 'page', $table ),
3173 self
::getSelectFields(),
3175 "{$prefix}_from=page_id",
3176 "{$prefix}_namespace" => $this->getNamespace(),
3177 "{$prefix}_title" => $this->getDBkey() ),
3183 if ( $res->numRows() ) {
3184 $linkCache = LinkCache
::singleton();
3185 foreach ( $res as $row ) {
3186 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
3188 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3189 $retVal[] = $titleObj;
3197 * Get an array of Title objects using this Title as a template
3198 * Also stores the IDs in the link cache.
3200 * WARNING: do not use this function on arbitrary user-supplied titles!
3201 * On heavily-used templates it will max out the memory.
3203 * @param $options Array: may be FOR UPDATE
3204 * @return Array of Title the Title objects linking here
3206 public function getTemplateLinksTo( $options = array() ) {
3207 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3211 * Get an array of Title objects linked from this Title
3212 * Also stores the IDs in the link cache.
3214 * WARNING: do not use this function on arbitrary user-supplied titles!
3215 * On heavily-used templates it will max out the memory.
3217 * @param $options Array: may be FOR UPDATE
3218 * @param $table String: table name
3219 * @param $prefix String: fields prefix
3220 * @return Array of Title objects linking here
3222 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3223 global $wgContentHandlerUseDB;
3225 $id = $this->getArticleID();
3227 # If the page doesn't exist; there can't be any link from this page
3232 if ( count( $options ) > 0 ) {
3233 $db = wfGetDB( DB_MASTER
);
3235 $db = wfGetDB( DB_SLAVE
);
3238 $namespaceFiled = "{$prefix}_namespace";
3239 $titleField = "{$prefix}_title";
3241 $fields = array( $namespaceFiled, $titleField, 'page_id', 'page_len', 'page_is_redirect', 'page_latest' );
3242 if ( $wgContentHandlerUseDB ) $fields[] = 'page_content_model';
3245 array( $table, 'page' ),
3247 array( "{$prefix}_from" => $id ),
3250 array( 'page' => array( 'LEFT JOIN', array( "page_namespace=$namespaceFiled", "page_title=$titleField" ) ) )
3254 if ( $res->numRows() ) {
3255 $linkCache = LinkCache
::singleton();
3256 foreach ( $res as $row ) {
3257 $titleObj = Title
::makeTitle( $row->$namespaceFiled, $row->$titleField );
3259 if ( $row->page_id
) {
3260 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3262 $linkCache->addBadLinkObj( $titleObj );
3264 $retVal[] = $titleObj;
3272 * Get an array of Title objects used on this Title as a template
3273 * Also stores the IDs in the link cache.
3275 * WARNING: do not use this function on arbitrary user-supplied titles!
3276 * On heavily-used templates it will max out the memory.
3278 * @param $options Array: may be FOR UPDATE
3279 * @return Array of Title the Title objects used here
3281 public function getTemplateLinksFrom( $options = array() ) {
3282 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3286 * Get an array of Title objects referring to non-existent articles linked from this page
3288 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
3289 * @return Array of Title the Title objects
3291 public function getBrokenLinksFrom() {
3292 if ( $this->getArticleID() == 0 ) {
3293 # All links from article ID 0 are false positives
3297 $dbr = wfGetDB( DB_SLAVE
);
3298 $res = $dbr->select(
3299 array( 'page', 'pagelinks' ),
3300 array( 'pl_namespace', 'pl_title' ),
3302 'pl_from' => $this->getArticleID(),
3303 'page_namespace IS NULL'
3305 __METHOD__
, array(),
3309 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3315 foreach ( $res as $row ) {
3316 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3323 * Get a list of URLs to purge from the Squid cache when this
3326 * @return Array of String the URLs
3328 public function getSquidURLs() {
3330 $this->getInternalURL(),
3331 $this->getInternalURL( 'action=history' )
3334 $pageLang = $this->getPageLanguage();
3335 if ( $pageLang->hasVariants() ) {
3336 $variants = $pageLang->getVariants();
3337 foreach ( $variants as $vCode ) {
3338 $urls[] = $this->getInternalURL( '', $vCode );
3346 * Purge all applicable Squid URLs
3348 public function purgeSquid() {
3350 if ( $wgUseSquid ) {
3351 $urls = $this->getSquidURLs();
3352 $u = new SquidUpdate( $urls );
3358 * Move this page without authentication
3360 * @param $nt Title the new page Title
3361 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3363 public function moveNoAuth( &$nt ) {
3364 return $this->moveTo( $nt, false );
3368 * Check whether a given move operation would be valid.
3369 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3371 * @param $nt Title the new title
3372 * @param $auth Bool indicates whether $wgUser's permissions
3374 * @param $reason String is the log summary of the move, used for spam checking
3375 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
3377 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3382 // Normally we'd add this to $errors, but we'll get
3383 // lots of syntax errors if $nt is not an object
3384 return array( array( 'badtitletext' ) );
3386 if ( $this->equals( $nt ) ) {
3387 $errors[] = array( 'selfmove' );
3389 if ( !$this->isMovable() ) {
3390 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3392 if ( $nt->getInterwiki() != '' ) {
3393 $errors[] = array( 'immobile-target-namespace-iw' );
3395 if ( !$nt->isMovable() ) {
3396 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3399 $oldid = $this->getArticleID();
3400 $newid = $nt->getArticleID();
3402 if ( strlen( $nt->getDBkey() ) < 1 ) {
3403 $errors[] = array( 'articleexists' );
3405 if ( ( $this->getDBkey() == '' ) ||
3407 ( $nt->getDBkey() == '' ) ) {
3408 $errors[] = array( 'badarticleerror' );
3411 // Image-specific checks
3412 if ( $this->getNamespace() == NS_FILE
) {
3413 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3416 if ( $nt->getNamespace() == NS_FILE
&& $this->getNamespace() != NS_FILE
) {
3417 $errors[] = array( 'nonfile-cannot-move-to-file' );
3421 $errors = wfMergeErrorArrays( $errors,
3422 $this->getUserPermissionsErrors( 'move', $wgUser ),
3423 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3424 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3425 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3428 $match = EditPage
::matchSummarySpamRegex( $reason );
3429 if ( $match !== false ) {
3430 // This is kind of lame, won't display nice
3431 $errors[] = array( 'spamprotectiontext' );
3435 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3436 $errors[] = array( 'hookaborted', $err );
3439 # The move is allowed only if (1) the target doesn't exist, or
3440 # (2) the target is a redirect to the source, and has no history
3441 # (so we can undo bad moves right after they're done).
3443 if ( 0 != $newid ) { # Target exists; check for validity
3444 if ( !$this->isValidMoveTarget( $nt ) ) {
3445 $errors[] = array( 'articleexists' );
3448 $tp = $nt->getTitleProtection();
3449 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
3450 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3451 $errors[] = array( 'cantmove-titleprotected' );
3454 if ( empty( $errors ) ) {
3461 * Check if the requested move target is a valid file move target
3462 * @param Title $nt Target title
3463 * @return array List of errors
3465 protected function validateFileMoveOperation( $nt ) {
3470 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3472 $file = wfLocalFile( $this );
3473 if ( $file->exists() ) {
3474 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3475 $errors[] = array( 'imageinvalidfilename' );
3477 if ( !File
::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3478 $errors[] = array( 'imagetypemismatch' );
3482 if ( $nt->getNamespace() != NS_FILE
) {
3483 $errors[] = array( 'imagenocrossnamespace' );
3484 // From here we want to do checks on a file object, so if we can't
3485 // create one, we must return.
3489 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3491 $destFile = wfLocalFile( $nt );
3492 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3493 $errors[] = array( 'file-exists-sharedrepo' );
3500 * Move a title to a new location
3502 * @param $nt Title the new title
3503 * @param $auth Bool indicates whether $wgUser's permissions
3505 * @param $reason String the reason for the move
3506 * @param $createRedirect Bool Whether to create a redirect from the old title to the new title.
3507 * Ignored if the user doesn't have the suppressredirect right.
3508 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3510 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3512 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3513 if ( is_array( $err ) ) {
3514 // Auto-block user's IP if the account was "hard" blocked
3515 $wgUser->spreadAnyEditBlock();
3518 // Check suppressredirect permission
3519 if ( $auth && !$wgUser->isAllowed( 'suppressredirect' ) ) {
3520 $createRedirect = true;
3523 // If it is a file, move it first.
3524 // It is done before all other moving stuff is done because it's hard to revert.
3525 $dbw = wfGetDB( DB_MASTER
);
3526 if ( $this->getNamespace() == NS_FILE
) {
3527 $file = wfLocalFile( $this );
3528 if ( $file->exists() ) {
3529 $status = $file->move( $nt );
3530 if ( !$status->isOk() ) {
3531 return $status->getErrorsArray();
3534 // Clear RepoGroup process cache
3535 RepoGroup
::singleton()->clearCache( $this );
3536 RepoGroup
::singleton()->clearCache( $nt ); # clear false negative cache
3539 $dbw->begin( __METHOD__
); # If $file was a LocalFile, its transaction would have closed our own.
3540 $pageid = $this->getArticleID( self
::GAID_FOR_UPDATE
);
3541 $protected = $this->isProtected();
3543 // Do the actual move
3544 $this->moveToInternal( $nt, $reason, $createRedirect );
3546 // Refresh the sortkey for this row. Be careful to avoid resetting
3547 // cl_timestamp, which may disturb time-based lists on some sites.
3548 $prefixes = $dbw->select(
3550 array( 'cl_sortkey_prefix', 'cl_to' ),
3551 array( 'cl_from' => $pageid ),
3554 foreach ( $prefixes as $prefixRow ) {
3555 $prefix = $prefixRow->cl_sortkey_prefix
;
3556 $catTo = $prefixRow->cl_to
;
3557 $dbw->update( 'categorylinks',
3559 'cl_sortkey' => Collation
::singleton()->getSortKey(
3560 $nt->getCategorySortkey( $prefix ) ),
3561 'cl_timestamp=cl_timestamp' ),
3563 'cl_from' => $pageid,
3564 'cl_to' => $catTo ),
3569 $redirid = $this->getArticleID();
3572 # Protect the redirect title as the title used to be...
3573 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3575 'pr_page' => $redirid,
3576 'pr_type' => 'pr_type',
3577 'pr_level' => 'pr_level',
3578 'pr_cascade' => 'pr_cascade',
3579 'pr_user' => 'pr_user',
3580 'pr_expiry' => 'pr_expiry'
3582 array( 'pr_page' => $pageid ),
3586 # Update the protection log
3587 $log = new LogPage( 'protect' );
3588 $comment = wfMessage(
3590 $this->getPrefixedText(),
3591 $nt->getPrefixedText()
3592 )->inContentLanguage()->text();
3594 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3596 // @todo FIXME: $params?
3597 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) );
3601 $oldnamespace = $this->getNamespace() & ~
1;
3602 $newnamespace = $nt->getNamespace() & ~
1;
3603 $oldtitle = $this->getDBkey();
3604 $newtitle = $nt->getDBkey();
3606 if ( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
3607 WatchedItem
::duplicateEntries( $this, $nt );
3610 $dbw->commit( __METHOD__
);
3612 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3617 * Move page to a title which is either a redirect to the
3618 * source page or nonexistent
3620 * @param $nt Title the page to move to, which should be a redirect or nonexistent
3621 * @param $reason String The reason for the move
3622 * @param $createRedirect Bool Whether to leave a redirect at the old title. Does not check
3623 * if the user has the suppressredirect right
3624 * @throws MWException
3626 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3627 global $wgUser, $wgContLang;
3629 if ( $nt->exists() ) {
3630 $moveOverRedirect = true;
3631 $logType = 'move_redir';
3633 $moveOverRedirect = false;
3637 if ( $createRedirect ) {
3638 $contentHandler = ContentHandler
::getForTitle( $this );
3639 $redirectContent = $contentHandler->makeRedirectContent( $nt );
3641 // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
3643 $redirectContent = null;
3646 $logEntry = new ManualLogEntry( 'move', $logType );
3647 $logEntry->setPerformer( $wgUser );
3648 $logEntry->setTarget( $this );
3649 $logEntry->setComment( $reason );
3650 $logEntry->setParameters( array(
3651 '4::target' => $nt->getPrefixedText(),
3652 '5::noredir' => $redirectContent ?
'0': '1',
3655 $formatter = LogFormatter
::newFromEntry( $logEntry );
3656 $formatter->setContext( RequestContext
::newExtraneousContext( $this ) );
3657 $comment = $formatter->getPlainActionText();
3659 $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
3661 # Truncate for whole multibyte characters.
3662 $comment = $wgContLang->truncate( $comment, 255 );
3664 $oldid = $this->getArticleID();
3666 $dbw = wfGetDB( DB_MASTER
);
3668 $newpage = WikiPage
::factory( $nt );
3670 if ( $moveOverRedirect ) {
3671 $newid = $nt->getArticleID();
3673 # Delete the old redirect. We don't save it to history since
3674 # by definition if we've got here it's rather uninteresting.
3675 # We have to remove it so that the next step doesn't trigger
3676 # a conflict on the unique namespace+title index...
3677 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__
);
3679 $newpage->doDeleteUpdates( $newid );
3682 # Save a null revision in the page's history notifying of the move
3683 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
3684 if ( !is_object( $nullRevision ) ) {
3685 throw new MWException( 'No valid null revision produced in ' . __METHOD__
);
3687 $nullRevId = $nullRevision->insertOn( $dbw );
3689 # Change the name of the target page:
3690 $dbw->update( 'page',
3692 'page_namespace' => $nt->getNamespace(),
3693 'page_title' => $nt->getDBkey(),
3695 /* WHERE */ array( 'page_id' => $oldid ),
3699 $this->resetArticleID( 0 );
3700 $nt->resetArticleID( $oldid );
3702 $newpage->updateRevisionOn( $dbw, $nullRevision );
3704 wfRunHooks( 'NewRevisionFromEditComplete',
3705 array( $newpage, $nullRevision, $nullRevision->getParentId(), $wgUser ) );
3707 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3709 if ( !$moveOverRedirect ) {
3710 WikiPage
::onArticleCreate( $nt );
3713 # Recreate the redirect, this time in the other direction.
3714 if ( !$redirectContent ) {
3715 WikiPage
::onArticleDelete( $this );
3717 $redirectArticle = WikiPage
::factory( $this );
3718 $newid = $redirectArticle->insertOn( $dbw );
3719 if ( $newid ) { // sanity
3720 $redirectRevision = new Revision( array(
3722 'comment' => $comment,
3723 'content' => $redirectContent ) );
3724 $redirectRevision->insertOn( $dbw );
3725 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3727 wfRunHooks( 'NewRevisionFromEditComplete',
3728 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3730 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3735 $logid = $logEntry->insert();
3736 $logEntry->publish( $logid );
3740 * Move this page's subpages to be subpages of $nt
3742 * @param $nt Title Move target
3743 * @param $auth bool Whether $wgUser's permissions should be checked
3744 * @param $reason string The reason for the move
3745 * @param $createRedirect bool Whether to create redirects from the old subpages to
3746 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3747 * @return mixed array with old page titles as keys, and strings (new page titles) or
3748 * arrays (errors) as values, or an error array with numeric indices if no pages
3751 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3752 global $wgMaximumMovedPages;
3753 // Check permissions
3754 if ( !$this->userCan( 'move-subpages' ) ) {
3755 return array( 'cant-move-subpages' );
3757 // Do the source and target namespaces support subpages?
3758 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3759 return array( 'namespace-nosubpages',
3760 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3762 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3763 return array( 'namespace-nosubpages',
3764 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3767 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3770 foreach ( $subpages as $oldSubpage ) {
3772 if ( $count > $wgMaximumMovedPages ) {
3773 $retval[$oldSubpage->getPrefixedTitle()] =
3774 array( 'movepage-max-pages',
3775 $wgMaximumMovedPages );
3779 // We don't know whether this function was called before
3780 // or after moving the root page, so check both
3782 if ( $oldSubpage->getArticleID() == $this->getArticleID() ||
3783 $oldSubpage->getArticleID() == $nt->getArticleID() )
3785 // When moving a page to a subpage of itself,
3786 // don't move it twice
3789 $newPageName = preg_replace(
3790 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3791 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3792 $oldSubpage->getDBkey() );
3793 if ( $oldSubpage->isTalkPage() ) {
3794 $newNs = $nt->getTalkPage()->getNamespace();
3796 $newNs = $nt->getSubjectPage()->getNamespace();
3798 # Bug 14385: we need makeTitleSafe because the new page names may
3799 # be longer than 255 characters.
3800 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3802 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3803 if ( $success === true ) {
3804 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3806 $retval[$oldSubpage->getPrefixedText()] = $success;
3813 * Checks if this page is just a one-rev redirect.
3814 * Adds lock, so don't use just for light purposes.
3818 public function isSingleRevRedirect() {
3819 global $wgContentHandlerUseDB;
3821 $dbw = wfGetDB( DB_MASTER
);
3824 $fields = array( 'page_is_redirect', 'page_latest', 'page_id' );
3825 if ( $wgContentHandlerUseDB ) $fields[] = 'page_content_model';
3827 $row = $dbw->selectRow( 'page',
3831 array( 'FOR UPDATE' )
3833 # Cache some fields we may want
3834 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3835 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3836 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3837 $this->mContentModel
= $row && isset( $row->page_content_model
) ?
strval( $row->page_content_model
) : false;
3838 if ( !$this->mRedirect
) {
3841 # Does the article have a history?
3842 $row = $dbw->selectField( array( 'page', 'revision' ),
3844 array( 'page_namespace' => $this->getNamespace(),
3845 'page_title' => $this->getDBkey(),
3847 'page_latest != rev_id'
3850 array( 'FOR UPDATE' )
3852 # Return true if there was no history
3853 return ( $row === false );
3857 * Checks if $this can be moved to a given Title
3858 * - Selects for update, so don't call it unless you mean business
3860 * @param $nt Title the new title to check
3863 public function isValidMoveTarget( $nt ) {
3864 # Is it an existing file?
3865 if ( $nt->getNamespace() == NS_FILE
) {
3866 $file = wfLocalFile( $nt );
3867 if ( $file->exists() ) {
3868 wfDebug( __METHOD__
. ": file exists\n" );
3872 # Is it a redirect with no history?
3873 if ( !$nt->isSingleRevRedirect() ) {
3874 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3877 # Get the article text
3878 $rev = Revision
::newFromTitle( $nt, false, Revision
::READ_LATEST
);
3879 if( !is_object( $rev ) ){
3882 $content = $rev->getContent();
3883 # Does the redirect point to the source?
3884 # Or is it a broken self-redirect, usually caused by namespace collisions?
3885 $redirTitle = $content->getRedirectTarget();
3887 if ( $redirTitle ) {
3888 if ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3889 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) {
3890 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3896 # Fail safe (not a redirect after all. strange.)
3897 wfDebug( __METHOD__
. ": failsafe: database sais " . $nt->getPrefixedDBkey() .
3898 " is a redirect, but it doesn't contain a valid redirect.\n" );
3904 * Get categories to which this Title belongs and return an array of
3905 * categories' names.
3907 * @return Array of parents in the form:
3908 * $parent => $currentarticle
3910 public function getParentCategories() {
3915 $titleKey = $this->getArticleID();
3917 if ( $titleKey === 0 ) {
3921 $dbr = wfGetDB( DB_SLAVE
);
3923 $res = $dbr->select( 'categorylinks', '*',
3925 'cl_from' => $titleKey,
3931 if ( $dbr->numRows( $res ) > 0 ) {
3932 foreach ( $res as $row ) {
3933 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3934 $data[$wgContLang->getNSText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3941 * Get a tree of parent categories
3943 * @param $children Array with the children in the keys, to check for circular refs
3944 * @return Array Tree of parent categories
3946 public function getParentCategoryTree( $children = array() ) {
3948 $parents = $this->getParentCategories();
3951 foreach ( $parents as $parent => $current ) {
3952 if ( array_key_exists( $parent, $children ) ) {
3953 # Circular reference
3954 $stack[$parent] = array();
3956 $nt = Title
::newFromText( $parent );
3958 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3968 * Get an associative array for selecting this title from
3971 * @return Array suitable for the $where parameter of DB::select()
3973 public function pageCond() {
3974 if ( $this->mArticleID
> 0 ) {
3975 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3976 return array( 'page_id' => $this->mArticleID
);
3978 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3983 * Get the revision ID of the previous revision
3985 * @param $revId Int Revision ID. Get the revision that was before this one.
3986 * @param $flags Int Title::GAID_FOR_UPDATE
3987 * @return Int|Bool Old revision ID, or FALSE if none exists
3989 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3990 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3991 $revId = $db->selectField( 'revision', 'rev_id',
3993 'rev_page' => $this->getArticleID( $flags ),
3994 'rev_id < ' . intval( $revId )
3997 array( 'ORDER BY' => 'rev_id DESC' )
4000 if ( $revId === false ) {
4003 return intval( $revId );
4008 * Get the revision ID of the next revision
4010 * @param $revId Int Revision ID. Get the revision that was after this one.
4011 * @param $flags Int Title::GAID_FOR_UPDATE
4012 * @return Int|Bool Next revision ID, or FALSE if none exists
4014 public function getNextRevisionID( $revId, $flags = 0 ) {
4015 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
4016 $revId = $db->selectField( 'revision', 'rev_id',
4018 'rev_page' => $this->getArticleID( $flags ),
4019 'rev_id > ' . intval( $revId )
4022 array( 'ORDER BY' => 'rev_id' )
4025 if ( $revId === false ) {
4028 return intval( $revId );
4033 * Get the first revision of the page
4035 * @param $flags Int Title::GAID_FOR_UPDATE
4036 * @return Revision|Null if page doesn't exist
4038 public function getFirstRevision( $flags = 0 ) {
4039 $pageId = $this->getArticleID( $flags );
4041 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
4042 $row = $db->selectRow( 'revision', Revision
::selectFields(),
4043 array( 'rev_page' => $pageId ),
4045 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
4048 return new Revision( $row );
4055 * Get the oldest revision timestamp of this page
4057 * @param $flags Int Title::GAID_FOR_UPDATE
4058 * @return String: MW timestamp
4060 public function getEarliestRevTime( $flags = 0 ) {
4061 $rev = $this->getFirstRevision( $flags );
4062 return $rev ?
$rev->getTimestamp() : null;
4066 * Check if this is a new page
4070 public function isNewPage() {
4071 $dbr = wfGetDB( DB_SLAVE
);
4072 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4076 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4080 public function isBigDeletion() {
4081 global $wgDeleteRevisionsLimit;
4083 if ( !$wgDeleteRevisionsLimit ) {
4087 $revCount = $this->estimateRevisionCount();
4088 return $revCount > $wgDeleteRevisionsLimit;
4092 * Get the approximate revision count of this page.
4096 public function estimateRevisionCount() {
4097 if ( !$this->exists() ) {
4101 if ( $this->mEstimateRevisions
=== null ) {
4102 $dbr = wfGetDB( DB_SLAVE
);
4103 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4104 array( 'rev_page' => $this->getArticleID() ), __METHOD__
);
4107 return $this->mEstimateRevisions
;
4111 * Get the number of revisions between the given revision.
4112 * Used for diffs and other things that really need it.
4114 * @param $old int|Revision Old revision or rev ID (first before range)
4115 * @param $new int|Revision New revision or rev ID (first after range)
4116 * @return Int Number of revisions between these revisions.
4118 public function countRevisionsBetween( $old, $new ) {
4119 if ( !( $old instanceof Revision
) ) {
4120 $old = Revision
::newFromTitle( $this, (int)$old );
4122 if ( !( $new instanceof Revision
) ) {
4123 $new = Revision
::newFromTitle( $this, (int)$new );
4125 if ( !$old ||
!$new ) {
4126 return 0; // nothing to compare
4128 $dbr = wfGetDB( DB_SLAVE
);
4129 return (int)$dbr->selectField( 'revision', 'count(*)',
4131 'rev_page' => $this->getArticleID(),
4132 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4133 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4140 * Get the number of authors between the given revisions or revision IDs.
4141 * Used for diffs and other things that really need it.
4143 * @param $old int|Revision Old revision or rev ID (first before range by default)
4144 * @param $new int|Revision New revision or rev ID (first after range by default)
4145 * @param $limit int Maximum number of authors
4146 * @param $options string|array (Optional): Single option, or an array of options:
4147 * 'include_old' Include $old in the range; $new is excluded.
4148 * 'include_new' Include $new in the range; $old is excluded.
4149 * 'include_both' Include both $old and $new in the range.
4150 * Unknown option values are ignored.
4151 * @return int Number of revision authors in the range; zero if not both revisions exist
4153 public function countAuthorsBetween( $old, $new, $limit, $options = array() ) {
4154 if ( !( $old instanceof Revision
) ) {
4155 $old = Revision
::newFromTitle( $this, (int)$old );
4157 if ( !( $new instanceof Revision
) ) {
4158 $new = Revision
::newFromTitle( $this, (int)$new );
4160 // XXX: what if Revision objects are passed in, but they don't refer to this title?
4161 // Add $old->getPage() != $new->getPage() || $old->getPage() != $this->getArticleID()
4162 // in the sanity check below?
4163 if ( !$old ||
!$new ) {
4164 return 0; // nothing to compare
4168 $options = (array) $options;
4169 if ( in_array( 'include_old', $options ) ) {
4172 if ( in_array( 'include_new', $options ) ) {
4175 if ( in_array( 'include_both', $options ) ) {
4179 // No DB query needed if $old and $new are the same or successive revisions:
4180 if ( $old->getId() === $new->getId() ) {
4181 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
0 : 1;
4182 } else if ( $old->getId() === $new->getParentId() ) {
4183 if ( $old_cmp === '>' ||
$new_cmp === '<' ) {
4184 return ( $old_cmp === '>' && $new_cmp === '<' ) ?
0 : 1;
4186 return ( $old->getRawUserText() === $new->getRawUserText() ) ?
1 : 2;
4188 $dbr = wfGetDB( DB_SLAVE
);
4189 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4191 'rev_page' => $this->getArticleID(),
4192 "rev_timestamp $old_cmp " . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4193 "rev_timestamp $new_cmp " . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4195 array( 'LIMIT' => $limit +
1 ) // add one so caller knows it was truncated
4197 return (int)$dbr->numRows( $res );
4201 * Compare with another title.
4203 * @param $title Title
4206 public function equals( Title
$title ) {
4207 // Note: === is necessary for proper matching of number-like titles.
4208 return $this->getInterwiki() === $title->getInterwiki()
4209 && $this->getNamespace() == $title->getNamespace()
4210 && $this->getDBkey() === $title->getDBkey();
4214 * Check if this title is a subpage of another title
4216 * @param $title Title
4219 public function isSubpageOf( Title
$title ) {
4220 return $this->getInterwiki() === $title->getInterwiki()
4221 && $this->getNamespace() == $title->getNamespace()
4222 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4226 * Check if page exists. For historical reasons, this function simply
4227 * checks for the existence of the title in the page table, and will
4228 * thus return false for interwiki links, special pages and the like.
4229 * If you want to know if a title can be meaningfully viewed, you should
4230 * probably call the isKnown() method instead.
4234 public function exists() {
4235 return $this->getArticleID() != 0;
4239 * Should links to this title be shown as potentially viewable (i.e. as
4240 * "bluelinks"), even if there's no record by this title in the page
4243 * This function is semi-deprecated for public use, as well as somewhat
4244 * misleadingly named. You probably just want to call isKnown(), which
4245 * calls this function internally.
4247 * (ISSUE: Most of these checks are cheap, but the file existence check
4248 * can potentially be quite expensive. Including it here fixes a lot of
4249 * existing code, but we might want to add an optional parameter to skip
4250 * it and any other expensive checks.)
4254 public function isAlwaysKnown() {
4258 * Allows overriding default behaviour for determining if a page exists.
4259 * If $isKnown is kept as null, regular checks happen. If it's
4260 * a boolean, this value is returned by the isKnown method.
4264 * @param Title $title
4265 * @param boolean|null $isKnown
4267 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4269 if ( !is_null( $isKnown ) ) {
4273 if ( $this->mInterwiki
!= '' ) {
4274 return true; // any interwiki link might be viewable, for all we know
4277 switch( $this->mNamespace
) {
4280 // file exists, possibly in a foreign repo
4281 return (bool)wfFindFile( $this );
4283 // valid special page
4284 return SpecialPageFactory
::exists( $this->getDBkey() );
4286 // selflink, possibly with fragment
4287 return $this->mDbkeyform
== '';
4289 // known system message
4290 return $this->hasSourceText() !== false;
4297 * Does this title refer to a page that can (or might) be meaningfully
4298 * viewed? In particular, this function may be used to determine if
4299 * links to the title should be rendered as "bluelinks" (as opposed to
4300 * "redlinks" to non-existent pages).
4301 * Adding something else to this function will cause inconsistency
4302 * since LinkHolderArray calls isAlwaysKnown() and does its own
4303 * page existence check.
4307 public function isKnown() {
4308 return $this->isAlwaysKnown() ||
$this->exists();
4312 * Does this page have source text?
4316 public function hasSourceText() {
4317 if ( $this->exists() ) {
4321 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4322 // If the page doesn't exist but is a known system message, default
4323 // message content will be displayed, same for language subpages-
4324 // Use always content language to avoid loading hundreds of languages
4325 // to get the link color.
4327 list( $name, $lang ) = MessageCache
::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4328 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4329 return $message->exists();
4336 * Get the default message text or false if the message doesn't exist
4338 * @return String or false
4340 public function getDefaultMessageText() {
4343 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
4347 list( $name, $lang ) = MessageCache
::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4348 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4350 if ( $message->exists() ) {
4351 return $message->plain();
4358 * Updates page_touched for this page; called from LinksUpdate.php
4360 * @return Bool true if the update succeded
4362 public function invalidateCache() {
4363 if ( wfReadOnly() ) {
4366 $dbw = wfGetDB( DB_MASTER
);
4367 $success = $dbw->update(
4369 array( 'page_touched' => $dbw->timestamp() ),
4373 HTMLFileCache
::clearFileCache( $this );
4378 * Update page_touched timestamps and send squid purge messages for
4379 * pages linking to this title. May be sent to the job queue depending
4380 * on the number of links. Typically called on create and delete.
4382 public function touchLinks() {
4383 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4386 if ( $this->getNamespace() == NS_CATEGORY
) {
4387 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4393 * Get the last touched timestamp
4395 * @param $db DatabaseBase: optional db
4396 * @return String last-touched timestamp
4398 public function getTouched( $db = null ) {
4399 $db = isset( $db ) ?
$db : wfGetDB( DB_SLAVE
);
4400 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4405 * Get the timestamp when this page was updated since the user last saw it.
4408 * @return String|Null
4410 public function getNotificationTimestamp( $user = null ) {
4411 global $wgUser, $wgShowUpdatedMarker;
4412 // Assume current user if none given
4416 // Check cache first
4417 $uid = $user->getId();
4418 // avoid isset here, as it'll return false for null entries
4419 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4420 return $this->mNotificationTimestamp
[$uid];
4422 if ( !$uid ||
!$wgShowUpdatedMarker ) {
4423 return $this->mNotificationTimestamp
[$uid] = false;
4425 // Don't cache too much!
4426 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4427 $this->mNotificationTimestamp
= array();
4429 $dbr = wfGetDB( DB_SLAVE
);
4430 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
4431 'wl_notificationtimestamp',
4433 'wl_user' => $user->getId(),
4434 'wl_namespace' => $this->getNamespace(),
4435 'wl_title' => $this->getDBkey(),
4439 return $this->mNotificationTimestamp
[$uid];
4443 * Generate strings used for xml 'id' names in monobook tabs
4445 * @param $prepend string defaults to 'nstab-'
4446 * @return String XML 'id' name
4448 public function getNamespaceKey( $prepend = 'nstab-' ) {
4450 // Gets the subject namespace if this title
4451 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4452 // Checks if cononical namespace name exists for namespace
4453 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4454 // Uses canonical namespace name
4455 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4457 // Uses text of namespace
4458 $namespaceKey = $this->getSubjectNsText();
4460 // Makes namespace key lowercase
4461 $namespaceKey = $wgContLang->lc( $namespaceKey );
4463 if ( $namespaceKey == '' ) {
4464 $namespaceKey = 'main';
4466 // Changes file to image for backwards compatibility
4467 if ( $namespaceKey == 'file' ) {
4468 $namespaceKey = 'image';
4470 return $prepend . $namespaceKey;
4474 * Get all extant redirects to this Title
4476 * @param $ns Int|Null Single namespace to consider; NULL to consider all namespaces
4477 * @return Array of Title redirects to this title
4479 public function getRedirectsHere( $ns = null ) {
4482 $dbr = wfGetDB( DB_SLAVE
);
4484 'rd_namespace' => $this->getNamespace(),
4485 'rd_title' => $this->getDBkey(),
4488 if ( $this->isExternal() ) {
4489 $where['rd_interwiki'] = $this->getInterwiki();
4491 $where[] = 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL';
4493 if ( !is_null( $ns ) ) {
4494 $where['page_namespace'] = $ns;
4497 $res = $dbr->select(
4498 array( 'redirect', 'page' ),
4499 array( 'page_namespace', 'page_title' ),
4504 foreach ( $res as $row ) {
4505 $redirs[] = self
::newFromRow( $row );
4511 * Check if this Title is a valid redirect target
4515 public function isValidRedirectTarget() {
4516 global $wgInvalidRedirectTargets;
4518 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4519 if ( $this->isSpecial( 'Userlogout' ) ) {
4523 foreach ( $wgInvalidRedirectTargets as $target ) {
4524 if ( $this->isSpecial( $target ) ) {
4533 * Get a backlink cache object
4535 * @return BacklinkCache
4537 public function getBacklinkCache() {
4538 return BacklinkCache
::get( $this );
4542 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4546 public function canUseNoindex() {
4547 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4549 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4550 ?
$wgContentNamespaces
4551 : $wgExemptFromUserRobotsControl;
4553 return !in_array( $this->mNamespace
, $bannedNamespaces );
4558 * Returns the raw sort key to be used for categories, with the specified
4559 * prefix. This will be fed to Collation::getSortKey() to get a
4560 * binary sortkey that can be used for actual sorting.
4562 * @param $prefix string The prefix to be used, specified using
4563 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4567 public function getCategorySortkey( $prefix = '' ) {
4568 $unprefixed = $this->getText();
4570 // Anything that uses this hook should only depend
4571 // on the Title object passed in, and should probably
4572 // tell the users to run updateCollations.php --force
4573 // in order to re-sort existing category relations.
4574 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4575 if ( $prefix !== '' ) {
4576 # Separate with a line feed, so the unprefixed part is only used as
4577 # a tiebreaker when two pages have the exact same prefix.
4578 # In UCA, tab is the only character that can sort above LF
4579 # so we strip both of them from the original prefix.
4580 $prefix = strtr( $prefix, "\n\t", ' ' );
4581 return "$prefix\n$unprefixed";
4587 * Get the language in which the content of this page is written in
4588 * wikitext. Defaults to $wgContLang, but in certain cases it can be
4589 * e.g. $wgLang (such as special pages, which are in the user language).
4594 public function getPageLanguage() {
4596 if ( $this->isSpecialPage() ) {
4597 // special pages are in the user language
4601 //TODO: use the LinkCache to cache this! Note that this may depend on user settings, so the cache should be only per-request.
4602 //NOTE: ContentHandler::getPageLanguage() may need to load the content to determine the page language!
4603 $contentHandler = ContentHandler
::getForTitle( $this );
4604 $pageLang = $contentHandler->getPageLanguage( $this );
4606 // Hook at the end because we don't want to override the above stuff
4607 wfRunHooks( 'PageContentLanguage', array( $this, &$pageLang, $wgLang ) );
4608 return wfGetLangObj( $pageLang );
4612 * Get the language in which the content of this page is written when
4613 * viewed by user. Defaults to $wgContLang, but in certain cases it can be
4614 * e.g. $wgLang (such as special pages, which are in the user language).
4619 public function getPageViewLanguage() {
4622 if ( $this->isSpecialPage() ) {
4623 // If the user chooses a variant, the content is actually
4624 // in a language whose code is the variant code.
4625 $variant = $wgLang->getPreferredVariant();
4626 if ( $wgLang->getCode() !== $variant ) {
4627 return Language
::factory( $variant );
4633 //NOTE: can't be cached persistently, depends on user settings
4634 //NOTE: ContentHandler::getPageViewLanguage() may need to load the content to determine the page language!
4635 $contentHandler = ContentHandler
::getForTitle( $this );
4636 $pageLang = $contentHandler->getPageViewLanguage( $this );