5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Represents a title within MediaWiki.
25 * Optionally may contain an interwiki designation or namespace.
26 * @note This class can fetch various kinds of data from the database;
27 * however, it does so inefficiently.
29 * @internal documentation reviewed 15 Mar 2010
32 /** @name Static cache variables */
34 static private $titleCache = array();
38 * Title::newFromText maintains a cache to avoid expensive re-normalization of
39 * commonly used titles. On a batch operation this can become a memory leak
40 * if not bounded. After hitting this many titles reset the cache.
42 const CACHE_MAX
= 1000;
45 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
46 * to use the master DB
48 const GAID_FOR_UPDATE
= 1;
51 * @name Private member variables
52 * Please use the accessor functions instead.
57 var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
58 var $mUrlform = ''; // /< URL-encoded form of the main part
59 var $mDbkeyform = ''; // /< Main part with underscores
60 var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
61 var $mNamespace = NS_MAIN
; // /< Namespace index, i.e. one of the NS_xxxx constants
62 var $mInterwiki = ''; // /< Interwiki prefix (or null string)
63 var $mFragment; // /< Title fragment (i.e. the bit after the #)
64 var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
65 var $mLatestID = false; // /< ID of most recent revision
66 var $mCounter = -1; // /< Number of times this page has been viewed (-1 means "not loaded")
67 private $mEstimateRevisions; // /< Estimated number of revisions; null of not loaded
68 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
69 var $mOldRestrictions = false;
70 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
71 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
72 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
73 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
74 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
75 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
76 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
77 var $mTitleProtection; ///< Cached value for getTitleProtection (create protection)
78 # Don't change the following default, NS_MAIN is hardcoded in several
79 # places. See bug 696.
80 var $mDefaultNamespace = NS_MAIN
; // /< Namespace index when there is no namespace
81 # Zero except in {{transclusion}} tags
82 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
83 var $mLength = -1; // /< The page length, 0 for special pages
84 var $mRedirect = null; // /< Is the article at this title a redirect?
85 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
86 var $mBacklinkCache = null; // /< Cache of links to this title
93 /*protected*/ function __construct() { }
96 * Create a new Title from a prefixed DB key
98 * @param $key String the database key, which has underscores
99 * instead of spaces, possibly including namespace and
101 * @return Title, or NULL on an error
103 public static function newFromDBkey( $key ) {
105 $t->mDbkeyform
= $key;
106 if ( $t->secureAndSplit() ) {
114 * Create a new Title from text, such as what one would find in a link. De-
115 * codes any HTML entities in the text.
117 * @param $text String the link text; spaces, prefixes, and an
118 * initial ':' indicating the main namespace are accepted.
119 * @param $defaultNamespace Int the namespace to use if none is speci-
120 * fied by a prefix. If you want to force a specific namespace even if
121 * $text might begin with a namespace prefix, use makeTitle() or
123 * @return Title, or null on an error.
125 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
126 if ( is_object( $text ) ) {
127 throw new MWException( 'Title::newFromText given an object' );
131 * Wiki pages often contain multiple links to the same page.
132 * Title normalization and parsing can become expensive on
133 * pages with many links, so we can save a little time by
136 * In theory these are value objects and won't get changed...
138 if ( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
139 return Title
::$titleCache[$text];
142 # Convert things like é ā or 〗 into normalized (bug 14952) text
143 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
146 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
147 $t->mDefaultNamespace
= $defaultNamespace;
149 static $cachedcount = 0 ;
150 if ( $t->secureAndSplit() ) {
151 if ( $defaultNamespace == NS_MAIN
) {
152 if ( $cachedcount >= self
::CACHE_MAX
) {
153 # Avoid memory leaks on mass operations...
154 Title
::$titleCache = array();
158 Title
::$titleCache[$text] =& $t;
168 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
170 * Example of wrong and broken code:
171 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
173 * Example of right code:
174 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
176 * Create a new Title from URL-encoded text. Ensures that
177 * the given title's length does not exceed the maximum.
179 * @param $url String the title, as might be taken from a URL
180 * @return Title the new object, or NULL on an error
182 public static function newFromURL( $url ) {
183 global $wgLegalTitleChars;
186 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
187 # but some URLs used it as a space replacement and they still come
188 # from some external search tools.
189 if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
190 $url = str_replace( '+', ' ', $url );
193 $t->mDbkeyform
= str_replace( ' ', '_', $url );
194 if ( $t->secureAndSplit() ) {
202 * Create a new Title from an article ID
204 * @param $id Int the page_id corresponding to the Title to create
205 * @param $flags Int use Title::GAID_FOR_UPDATE to use master
206 * @return Title the new object, or NULL on an error
208 public static function newFromID( $id, $flags = 0 ) {
209 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
210 $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__
);
211 if ( $row !== false ) {
212 $title = Title
::newFromRow( $row );
220 * Make an array of titles from an array of IDs
222 * @param $ids Array of Int Array of IDs
223 * @return Array of Titles
225 public static function newFromIDs( $ids ) {
226 if ( !count( $ids ) ) {
229 $dbr = wfGetDB( DB_SLAVE
);
234 'page_namespace', 'page_title', 'page_id',
235 'page_len', 'page_is_redirect', 'page_latest',
237 array( 'page_id' => $ids ),
242 foreach ( $res as $row ) {
243 $titles[] = Title
::newFromRow( $row );
249 * Make a Title object from a DB row
251 * @param $row Object database row (needs at least page_title,page_namespace)
252 * @return Title corresponding Title
254 public static function newFromRow( $row ) {
255 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
256 $t->loadFromRow( $row );
261 * Load Title object fields from a DB row.
262 * If false is given, the title will be treated as non-existing.
264 * @param $row Object|false database row
267 public function loadFromRow( $row ) {
268 if ( $row ) { // page found
269 if ( isset( $row->page_id
) )
270 $this->mArticleID
= (int)$row->page_id
;
271 if ( isset( $row->page_len
) )
272 $this->mLength
= (int)$row->page_len
;
273 if ( isset( $row->page_is_redirect
) )
274 $this->mRedirect
= (bool)$row->page_is_redirect
;
275 if ( isset( $row->page_latest
) )
276 $this->mLatestID
= (int)$row->page_latest
;
277 if ( isset( $row->page_counter
) )
278 $this->mCounter
= (int)$row->page_counter
;
279 } else { // page not found
280 $this->mArticleID
= 0;
282 $this->mRedirect
= false;
283 $this->mLatestID
= 0;
289 * Create a new Title from a namespace index and a DB key.
290 * It's assumed that $ns and $title are *valid*, for instance when
291 * they came directly from the database or a special page name.
292 * For convenience, spaces are converted to underscores so that
293 * eg user_text fields can be used directly.
295 * @param $ns Int the namespace of the article
296 * @param $title String the unprefixed database key form
297 * @param $fragment String the link fragment (after the "#")
298 * @param $interwiki String the interwiki prefix
299 * @return Title the new object
301 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
303 $t->mInterwiki
= $interwiki;
304 $t->mFragment
= $fragment;
305 $t->mNamespace
= $ns = intval( $ns );
306 $t->mDbkeyform
= str_replace( ' ', '_', $title );
307 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
308 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
309 $t->mTextform
= str_replace( '_', ' ', $title );
314 * Create a new Title from a namespace index and a DB key.
315 * The parameters will be checked for validity, which is a bit slower
316 * than makeTitle() but safer for user-provided data.
318 * @param $ns Int the namespace of the article
319 * @param $title String database key form
320 * @param $fragment String the link fragment (after the "#")
321 * @param $interwiki String interwiki prefix
322 * @return Title the new object, or NULL on an error
324 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
326 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki );
327 if ( $t->secureAndSplit() ) {
335 * Create a new Title for the Main Page
337 * @return Title the new object
339 public static function newMainPage() {
340 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
341 // Don't give fatal errors if the message is broken
343 $title = Title
::newFromText( 'Main Page' );
349 * Extract a redirect destination from a string and return the
350 * Title, or null if the text doesn't contain a valid redirect
351 * This will only return the very next target, useful for
352 * the redirect table and other checks that don't need full recursion
354 * @param $text String: Text with possible redirect
355 * @return Title: The corresponding Title
357 public static function newFromRedirect( $text ) {
358 return self
::newFromRedirectInternal( $text );
362 * Extract a redirect destination from a string and return the
363 * Title, or null if the text doesn't contain a valid redirect
364 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
365 * in order to provide (hopefully) the Title of the final destination instead of another redirect
367 * @param $text String Text with possible redirect
370 public static function newFromRedirectRecurse( $text ) {
371 $titles = self
::newFromRedirectArray( $text );
372 return $titles ?
array_pop( $titles ) : null;
376 * Extract a redirect destination from a string and return an
377 * array of Titles, or null if the text doesn't contain a valid redirect
378 * The last element in the array is the final destination after all redirects
379 * have been resolved (up to $wgMaxRedirects times)
381 * @param $text String Text with possible redirect
382 * @return Array of Titles, with the destination last
384 public static function newFromRedirectArray( $text ) {
385 global $wgMaxRedirects;
386 $title = self
::newFromRedirectInternal( $text );
387 if ( is_null( $title ) ) {
390 // recursive check to follow double redirects
391 $recurse = $wgMaxRedirects;
392 $titles = array( $title );
393 while ( --$recurse > 0 ) {
394 if ( $title->isRedirect() ) {
395 $page = WikiPage
::factory( $title );
396 $newtitle = $page->getRedirectTarget();
400 // Redirects to some special pages are not permitted
401 if ( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
402 // the new title passes the checks, so make that our current title so that further recursion can be checked
404 $titles[] = $newtitle;
413 * Really extract the redirect destination
414 * Do not call this function directly, use one of the newFromRedirect* functions above
416 * @param $text String Text with possible redirect
419 protected static function newFromRedirectInternal( $text ) {
420 global $wgMaxRedirects;
421 if ( $wgMaxRedirects < 1 ) {
422 //redirects are disabled, so quit early
425 $redir = MagicWord
::get( 'redirect' );
426 $text = trim( $text );
427 if ( $redir->matchStartAndRemove( $text ) ) {
428 // Extract the first link and see if it's usable
429 // Ensure that it really does come directly after #REDIRECT
430 // Some older redirects included a colon, so don't freak about that!
432 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
433 // Strip preceding colon used to "escape" categories, etc.
434 // and URL-decode links
435 if ( strpos( $m[1], '%' ) !== false ) {
436 // Match behavior of inline link parsing here;
437 $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
439 $title = Title
::newFromText( $m[1] );
440 // If the title is a redirect to bad special pages or is invalid, return null
441 if ( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
451 * Get the prefixed DB key associated with an ID
453 * @param $id Int the page_id of the article
454 * @return Title an object representing the article, or NULL if no such article was found
456 public static function nameOf( $id ) {
457 $dbr = wfGetDB( DB_SLAVE
);
459 $s = $dbr->selectRow(
461 array( 'page_namespace', 'page_title' ),
462 array( 'page_id' => $id ),
465 if ( $s === false ) {
469 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
474 * Get a regex character class describing the legal characters in a link
476 * @return String the list of characters, not delimited
478 public static function legalChars() {
479 global $wgLegalTitleChars;
480 return $wgLegalTitleChars;
484 * Returns a simple regex that will match on characters and sequences invalid in titles.
485 * Note that this doesn't pick up many things that could be wrong with titles, but that
486 * replacing this regex with something valid will make many titles valid.
488 * @return String regex string
490 static function getTitleInvalidRegex() {
491 static $rxTc = false;
493 # Matching titles will be held as illegal.
495 # Any character not allowed is forbidden...
496 '[^' . self
::legalChars() . ']' .
497 # URL percent encoding sequences interfere with the ability
498 # to round-trip titles -- you can't link to them consistently.
500 # XML/HTML character references produce similar issues.
501 '|&[A-Za-z0-9\x80-\xff]+;' .
503 '|&#x[0-9A-Fa-f]+;' .
511 * Get a string representation of a title suitable for
512 * including in a search index
514 * @param $ns Int a namespace index
515 * @param $title String text-form main part
516 * @return String a stripped-down title string ready for the search index
518 public static function indexTitle( $ns, $title ) {
521 $lc = SearchEngine
::legalSearchChars() . '&#;';
522 $t = $wgContLang->normalizeForSearch( $title );
523 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
524 $t = $wgContLang->lc( $t );
527 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
528 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
530 $t = preg_replace( "/\\s+/", ' ', $t );
532 if ( $ns == NS_FILE
) {
533 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
539 * Make a prefixed DB key from a DB key and a namespace index
541 * @param $ns Int numerical representation of the namespace
542 * @param $title String the DB key form the title
543 * @param $fragment String The link fragment (after the "#")
544 * @param $interwiki String The interwiki prefix
545 * @return String the prefixed form of the title
547 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
550 $namespace = $wgContLang->getNsText( $ns );
551 $name = $namespace == '' ?
$title : "$namespace:$title";
552 if ( strval( $interwiki ) != '' ) {
553 $name = "$interwiki:$name";
555 if ( strval( $fragment ) != '' ) {
556 $name .= '#' . $fragment;
562 * Escape a text fragment, say from a link, for a URL
564 * @param $fragment string containing a URL or link fragment (after the "#")
565 * @return String: escaped string
567 static function escapeFragmentForURL( $fragment ) {
568 # Note that we don't urlencode the fragment. urlencoded Unicode
569 # fragments appear not to work in IE (at least up to 7) or in at least
570 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
571 # to care if they aren't encoded.
572 return Sanitizer
::escapeId( $fragment, 'noninitial' );
576 * Callback for usort() to do title sorts by (namespace, title)
581 * @return Integer: result of string comparison, or namespace comparison
583 public static function compare( $a, $b ) {
584 if ( $a->getNamespace() == $b->getNamespace() ) {
585 return strcmp( $a->getText(), $b->getText() );
587 return $a->getNamespace() - $b->getNamespace();
592 * Determine whether the object refers to a page within
595 * @return Bool TRUE if this is an in-project interwiki link or a wikilink, FALSE otherwise
597 public function isLocal() {
598 if ( $this->mInterwiki
!= '' ) {
599 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
606 * Is this Title interwiki?
610 public function isExternal() {
611 return ( $this->mInterwiki
!= '' );
615 * Get the interwiki prefix (or null string)
617 * @return String Interwiki prefix
619 public function getInterwiki() {
620 return $this->mInterwiki
;
624 * Determine whether the object refers to a page within
625 * this project and is transcludable.
627 * @return Bool TRUE if this is transcludable
629 public function isTrans() {
630 if ( $this->mInterwiki
== '' ) {
634 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
638 * Returns the DB name of the distant wiki which owns the object.
640 * @return String the DB name
642 public function getTransWikiID() {
643 if ( $this->mInterwiki
== '' ) {
647 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
651 * Get the text form (spaces not underscores) of the main part
653 * @return String Main part of the title
655 public function getText() {
656 return $this->mTextform
;
660 * Get the URL-encoded form of the main part
662 * @return String Main part of the title, URL-encoded
664 public function getPartialURL() {
665 return $this->mUrlform
;
669 * Get the main part with underscores
671 * @return String: Main part of the title, with underscores
673 public function getDBkey() {
674 return $this->mDbkeyform
;
678 * Get the DB key with the initial letter case as specified by the user
680 * @return String DB key
682 function getUserCaseDBKey() {
683 return $this->mUserCaseDBKey
;
687 * Get the namespace index, i.e. one of the NS_xxxx constants.
689 * @return Integer: Namespace index
691 public function getNamespace() {
692 return $this->mNamespace
;
696 * Get the namespace text
698 * @return String: Namespace text
700 public function getNsText() {
703 if ( $this->mInterwiki
!= '' ) {
704 // This probably shouldn't even happen. ohh man, oh yuck.
705 // But for interwiki transclusion it sometimes does.
706 // Shit. Shit shit shit.
708 // Use the canonical namespaces if possible to try to
709 // resolve a foreign namespace.
710 if ( MWNamespace
::exists( $this->mNamespace
) ) {
711 return MWNamespace
::getCanonicalName( $this->mNamespace
);
715 // Strip off subpages
716 $pagename = $this->getText();
717 if ( strpos( $pagename, '/' ) !== false ) {
718 list( $username , ) = explode( '/', $pagename, 2 );
720 $username = $pagename;
723 if ( $wgContLang->needsGenderDistinction() &&
724 MWNamespace
::hasGenderDistinction( $this->mNamespace
) ) {
725 $gender = GenderCache
::singleton()->getGenderOf( $username, __METHOD__
);
726 return $wgContLang->getGenderNsText( $this->mNamespace
, $gender );
729 return $wgContLang->getNsText( $this->mNamespace
);
733 * Get the namespace text of the subject (rather than talk) page
735 * @return String Namespace text
737 public function getSubjectNsText() {
739 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
743 * Get the namespace text of the talk page
745 * @return String Namespace text
747 public function getTalkNsText() {
749 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
753 * Could this title have a corresponding talk page?
755 * @return Bool TRUE or FALSE
757 public function canTalk() {
758 return( MWNamespace
::canTalk( $this->mNamespace
) );
762 * Is this in a namespace that allows actual pages?
765 * @internal note -- uses hardcoded namespace index instead of constants
767 public function canExist() {
768 return $this->mNamespace
>= NS_MAIN
;
772 * Can this title be added to a user's watchlist?
774 * @return Bool TRUE or FALSE
776 public function isWatchable() {
777 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
781 * Returns true if this is a special page.
785 public function isSpecialPage() {
786 return $this->getNamespace() == NS_SPECIAL
;
790 * Returns true if this title resolves to the named special page
792 * @param $name String The special page name
795 public function isSpecial( $name ) {
796 if ( $this->isSpecialPage() ) {
797 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
798 if ( $name == $thisName ) {
806 * If the Title refers to a special page alias which is not the local default, resolve
807 * the alias, and localise the name as necessary. Otherwise, return $this
811 public function fixSpecialName() {
812 if ( $this->isSpecialPage() ) {
813 list( $canonicalName, $par ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
814 if ( $canonicalName ) {
815 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName, $par );
816 if ( $localName != $this->mDbkeyform
) {
817 return Title
::makeTitle( NS_SPECIAL
, $localName );
825 * Returns true if the title is inside the specified namespace.
827 * Please make use of this instead of comparing to getNamespace()
828 * This function is much more resistant to changes we may make
829 * to namespaces than code that makes direct comparisons.
830 * @param $ns int The namespace
834 public function inNamespace( $ns ) {
835 return MWNamespace
::equals( $this->getNamespace(), $ns );
839 * Returns true if the title is inside one of the specified namespaces.
841 * @param ...$namespaces The namespaces to check for
845 public function inNamespaces( /* ... */ ) {
846 $namespaces = func_get_args();
847 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
848 $namespaces = $namespaces[0];
851 foreach ( $namespaces as $ns ) {
852 if ( $this->inNamespace( $ns ) ) {
861 * Returns true if the title has the same subject namespace as the
862 * namespace specified.
863 * For example this method will take NS_USER and return true if namespace
864 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
865 * as their subject namespace.
867 * This is MUCH simpler than individually testing for equivilance
868 * 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 return $this->getNamespace() == NS_MEDIAWIKI
&&
935 strpos( $this->getText(), 'Conversiontable' ) !== false;
939 * Does that page contain wikitext, or it is JS, CSS or whatever?
943 public function isWikitextPage() {
944 $retval = !$this->isCssOrJsPage() && !$this->isCssJsSubpage();
945 wfRunHooks( 'TitleIsWikitextPage', array( $this, &$retval ) );
950 * Could this page contain custom CSS or JavaScript, based
955 public function isCssOrJsPage() {
956 $retval = $this->mNamespace
== NS_MEDIAWIKI
957 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
958 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$retval ) );
963 * Is this a .css or .js subpage of a user page?
966 public function isCssJsSubpage() {
967 return ( NS_USER
== $this->mNamespace
and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
971 * Trim down a .css or .js subpage title to get the corresponding skin name
973 * @return string containing skin name from .css or .js subpage title
975 public function getSkinFromCssJsSubpage() {
976 $subpage = explode( '/', $this->mTextform
);
977 $subpage = $subpage[ count( $subpage ) - 1 ];
978 $lastdot = strrpos( $subpage, '.' );
979 if ( $lastdot === false )
980 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
981 return substr( $subpage, 0, $lastdot );
985 * Is this a .css subpage of a user page?
989 public function isCssSubpage() {
990 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.css$/", $this->mTextform
) );
994 * Is this a .js subpage of a user page?
998 public function isJsSubpage() {
999 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.js$/", $this->mTextform
) );
1003 * Is this a talk page of some sort?
1007 public function isTalkPage() {
1008 return MWNamespace
::isTalk( $this->getNamespace() );
1012 * Get a Title object associated with the talk page of this article
1014 * @return Title the object for the talk page
1016 public function getTalkPage() {
1017 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
1021 * Get a title object associated with the subject page of this
1024 * @return Title the object for the subject page
1026 public function getSubjectPage() {
1027 // Is this the same title?
1028 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
1029 if ( $this->getNamespace() == $subjectNS ) {
1032 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
1036 * Get the default namespace index, for when there is no namespace
1038 * @return Int Default namespace index
1040 public function getDefaultNamespace() {
1041 return $this->mDefaultNamespace
;
1045 * Get title for search index
1047 * @return String a stripped-down title string ready for the
1050 public function getIndexTitle() {
1051 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
1055 * Get the Title fragment (i.e.\ the bit after the #) in text form
1057 * @return String Title fragment
1059 public function getFragment() {
1060 return $this->mFragment
;
1064 * Get the fragment in URL form, including the "#" character if there is one
1065 * @return String Fragment in URL form
1067 public function getFragmentForURL() {
1068 if ( $this->mFragment
== '' ) {
1071 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
1076 * Set the fragment for this title. Removes the first character from the
1077 * specified fragment before setting, so it assumes you're passing it with
1080 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1081 * Still in active use privately.
1083 * @param $fragment String text
1085 public function setFragment( $fragment ) {
1086 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
1090 * Prefix some arbitrary text with the namespace or interwiki prefix
1093 * @param $name String the text
1094 * @return String the prefixed text
1097 private function prefix( $name ) {
1099 if ( $this->mInterwiki
!= '' ) {
1100 $p = $this->mInterwiki
. ':';
1103 if ( 0 != $this->mNamespace
) {
1104 $p .= $this->getNsText() . ':';
1110 * Get the prefixed database key form
1112 * @return String the prefixed title, with underscores and
1113 * any interwiki and namespace prefixes
1115 public function getPrefixedDBkey() {
1116 $s = $this->prefix( $this->mDbkeyform
);
1117 $s = str_replace( ' ', '_', $s );
1122 * Get the prefixed title with spaces.
1123 * This is the form usually used for display
1125 * @return String the prefixed title, with spaces
1127 public function getPrefixedText() {
1128 // @todo FIXME: Bad usage of empty() ?
1129 if ( empty( $this->mPrefixedText
) ) {
1130 $s = $this->prefix( $this->mTextform
);
1131 $s = str_replace( '_', ' ', $s );
1132 $this->mPrefixedText
= $s;
1134 return $this->mPrefixedText
;
1138 * Return a string representation of this title
1140 * @return String representation of this title
1142 public function __toString() {
1143 return $this->getPrefixedText();
1147 * Get the prefixed title with spaces, plus any fragment
1148 * (part beginning with '#')
1150 * @return String the prefixed title, with spaces and the fragment, including '#'
1152 public function getFullText() {
1153 $text = $this->getPrefixedText();
1154 if ( $this->mFragment
!= '' ) {
1155 $text .= '#' . $this->mFragment
;
1161 * Get the base page name, i.e. the leftmost part before any slashes
1163 * @return String Base name
1165 public function getBaseText() {
1166 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1167 return $this->getText();
1170 $parts = explode( '/', $this->getText() );
1171 # Don't discard the real title if there's no subpage involved
1172 if ( count( $parts ) > 1 ) {
1173 unset( $parts[count( $parts ) - 1] );
1175 return implode( '/', $parts );
1179 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1181 * @return String Subpage name
1183 public function getSubpageText() {
1184 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1185 return( $this->mTextform
);
1187 $parts = explode( '/', $this->mTextform
);
1188 return( $parts[count( $parts ) - 1] );
1192 * Get the HTML-escaped displayable text form.
1193 * Used for the title field in <a> tags.
1195 * @return String the text, including any prefixes
1197 public function getEscapedText() {
1198 wfDeprecated( __METHOD__
, '1.19' );
1199 return htmlspecialchars( $this->getPrefixedText() );
1203 * Get a URL-encoded form of the subpage text
1205 * @return String URL-encoded subpage name
1207 public function getSubpageUrlForm() {
1208 $text = $this->getSubpageText();
1209 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1214 * Get a URL-encoded title (not an actual URL) including interwiki
1216 * @return String the URL-encoded form
1218 public function getPrefixedURL() {
1219 $s = $this->prefix( $this->mDbkeyform
);
1220 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1225 * Helper to fix up the get{Local,Full,Link,Canonical}URL args
1227 private static function fixUrlQueryArgs( $query, $query2 ) {
1228 if ( is_array( $query ) ) {
1229 $query = wfArrayToCGI( $query );
1232 if ( is_string( $query2 ) ) {
1233 // $query2 is a string, we will consider this to be
1234 // a deprecated $variant argument and add it to the query
1235 $query2 = wfArrayToCGI( array( 'variant' => $query2 ) );
1237 $query2 = wfArrayToCGI( $query2 );
1239 // If we have $query content add a & to it first
1243 // Now append the queries together
1250 * Get a real URL referring to this title, with interwiki link and
1253 * See getLocalURL for the arguments.
1255 * @see self::getLocalURL
1256 * @return String the URL
1258 public function getFullURL( $query = '', $query2 = false ) {
1259 $query = self
::fixUrlQueryArgs( $query, $query2 );
1261 # Hand off all the decisions on urls to getLocalURL
1262 $url = $this->getLocalURL( $query );
1264 # Expand the url to make it a full url. Note that getLocalURL has the
1265 # potential to output full urls for a variety of reasons, so we use
1266 # wfExpandUrl instead of simply prepending $wgServer
1267 $url = wfExpandUrl( $url, PROTO_RELATIVE
);
1269 # Finally, add the fragment.
1270 $url .= $this->getFragmentForURL();
1272 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
1277 * Get a URL with no fragment or server name. If this page is generated
1278 * with action=render, $wgServer is prepended.
1281 * @param $query \twotypes{\string,\array} an optional query string,
1282 * not used for interwiki links. Can be specified as an associative array as well,
1283 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1284 * Some query patterns will trigger various shorturl path replacements.
1285 * @param $query2 Mixed: An optional secondary query array. This one MUST
1286 * be an array. If a string is passed it will be interpreted as a deprecated
1287 * variant argument and urlencoded into a variant= argument.
1288 * This second query argument will be added to the $query
1289 * @return String the URL
1291 public function getLocalURL( $query = '', $query2 = false ) {
1292 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1294 $query = self
::fixUrlQueryArgs( $query, $query2 );
1296 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
1298 $namespace = $this->getNsText();
1299 if ( $namespace != '' ) {
1300 # Can this actually happen? Interwikis shouldn't be parsed.
1301 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1304 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1305 $url = wfAppendQuery( $url, $query );
1307 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1308 if ( $query == '' ) {
1309 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1310 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1312 global $wgVariantArticlePath, $wgActionPaths;
1316 if ( !empty( $wgActionPaths ) &&
1317 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
1319 $action = urldecode( $matches[2] );
1320 if ( isset( $wgActionPaths[$action] ) ) {
1321 $query = $matches[1];
1322 if ( isset( $matches[4] ) ) {
1323 $query .= $matches[4];
1325 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1326 if ( $query != '' ) {
1327 $url = wfAppendQuery( $url, $query );
1332 if ( $url === false &&
1333 $wgVariantArticlePath &&
1334 $this->getPageLanguage()->hasVariants() &&
1335 preg_match( '/^variant=([^&]*)$/', $query, $matches ) )
1337 $variant = urldecode( $matches[1] );
1338 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1339 // Only do the variant replacement if the given variant is a valid
1340 // variant for the page's language.
1341 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1342 $url = str_replace( '$1', $dbkey, $url );
1346 if ( $url === false ) {
1347 if ( $query == '-' ) {
1350 $url = "{$wgScript}?title={$dbkey}&{$query}";
1354 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1356 // @todo FIXME: This causes breakage in various places when we
1357 // actually expected a local URL and end up with dupe prefixes.
1358 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1359 $url = $wgServer . $url;
1362 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1367 * Get a URL that's the simplest URL that will be valid to link, locally,
1368 * to the current Title. It includes the fragment, but does not include
1369 * the server unless action=render is used (or the link is external). If
1370 * there's a fragment but the prefixed text is empty, we just return a link
1373 * The result obviously should not be URL-escaped, but does need to be
1374 * HTML-escaped if it's being output in HTML.
1376 * See getLocalURL for the arguments.
1378 * @see self::getLocalURL
1379 * @return String the URL
1381 public function getLinkURL( $query = '', $query2 = false ) {
1382 wfProfileIn( __METHOD__
);
1383 if ( $this->isExternal() ) {
1384 $ret = $this->getFullURL( $query, $query2 );
1385 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
1386 $ret = $this->getFragmentForURL();
1388 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1390 wfProfileOut( __METHOD__
);
1395 * Get an HTML-escaped version of the URL form, suitable for
1396 * using in a link, without a server name or fragment
1398 * See getLocalURL for the arguments.
1400 * @see self::getLocalURL
1401 * @return String the URL
1403 public function escapeLocalURL( $query = '', $query2 = false ) {
1404 wfDeprecated( __METHOD__
, '1.19' );
1405 return htmlspecialchars( $this->getLocalURL( $query, $query2 ) );
1409 * Get an HTML-escaped version of the URL form, suitable for
1410 * using in a link, including the server name and fragment
1412 * See getLocalURL for the arguments.
1414 * @see self::getLocalURL
1415 * @return String the URL
1417 public function escapeFullURL( $query = '', $query2 = false ) {
1418 wfDeprecated( __METHOD__
, '1.19' );
1419 return htmlspecialchars( $this->getFullURL( $query, $query2 ) );
1423 * Get the URL form for an internal link.
1424 * - Used in various Squid-related code, in case we have a different
1425 * internal hostname for the server from the exposed one.
1427 * This uses $wgInternalServer to qualify the path, or $wgServer
1428 * if $wgInternalServer is not set. If the server variable used is
1429 * protocol-relative, the URL will be expanded to http://
1431 * See getLocalURL for the arguments.
1433 * @see self::getLocalURL
1434 * @return String the URL
1436 public function getInternalURL( $query = '', $query2 = false ) {
1437 global $wgInternalServer, $wgServer;
1438 $query = self
::fixUrlQueryArgs( $query, $query2 );
1439 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1440 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
1441 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1446 * Get the URL for a canonical link, for use in things like IRC and
1447 * e-mail notifications. Uses $wgCanonicalServer and the
1448 * GetCanonicalURL hook.
1450 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1452 * See getLocalURL for the arguments.
1454 * @see self::getLocalURL
1455 * @return string The URL
1458 public function getCanonicalURL( $query = '', $query2 = false ) {
1459 $query = self
::fixUrlQueryArgs( $query, $query2 );
1460 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
1461 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1466 * HTML-escaped version of getCanonicalURL()
1468 * See getLocalURL for the arguments.
1470 * @see self::getLocalURL
1473 public function escapeCanonicalURL( $query = '', $query2 = false ) {
1474 wfDeprecated( __METHOD__
, '1.19' );
1475 return htmlspecialchars( $this->getCanonicalURL( $query, $query2 ) );
1479 * Get the edit URL for this Title
1481 * @return String the URL, or a null string if this is an
1484 public function getEditURL() {
1485 if ( $this->mInterwiki
!= '' ) {
1488 $s = $this->getLocalURL( 'action=edit' );
1494 * Is $wgUser watching this page?
1498 public function userIsWatching() {
1501 if ( is_null( $this->mWatched
) ) {
1502 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1503 $this->mWatched
= false;
1505 $this->mWatched
= $wgUser->isWatched( $this );
1508 return $this->mWatched
;
1512 * Can $wgUser read this page?
1514 * @deprecated in 1.19; use userCan(), quickUserCan() or getUserPermissionsErrors() instead
1516 * @todo fold these checks into userCan()
1518 public function userCanRead() {
1519 wfDeprecated( __METHOD__
, '1.19' );
1520 return $this->userCan( 'read' );
1524 * Can $user perform $action on this page?
1525 * This skips potentially expensive cascading permission checks
1526 * as well as avoids expensive error formatting
1528 * Suitable for use for nonessential UI controls in common cases, but
1529 * _not_ for functional access control.
1531 * May provide false positives, but should never provide a false negative.
1533 * @param $action String action that permission needs to be checked for
1534 * @param $user User to check (since 1.19); $wgUser will be used if not
1538 public function quickUserCan( $action, $user = null ) {
1539 return $this->userCan( $action, $user, false );
1543 * Can $user perform $action on this page?
1545 * @param $action String action that permission needs to be checked for
1546 * @param $user User to check (since 1.19); $wgUser will be used if not
1548 * @param $doExpensiveQueries Bool Set this to false to avoid doing
1549 * unnecessary queries.
1552 public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1553 if ( !$user instanceof User
) {
1557 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries, true ) );
1561 * Can $user perform $action on this page?
1563 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1565 * @param $action String action that permission needs to be checked for
1566 * @param $user User to check
1567 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary
1568 * queries by skipping checks for cascading protections and user blocks.
1569 * @param $ignoreErrors Array of Strings Set this to a list of message keys
1570 * whose corresponding errors may be ignored.
1571 * @return Array of arguments to wfMsg to explain permissions problems.
1573 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1574 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1576 // Remove the errors being ignored.
1577 foreach ( $errors as $index => $error ) {
1578 $error_key = is_array( $error ) ?
$error[0] : $error;
1580 if ( in_array( $error_key, $ignoreErrors ) ) {
1581 unset( $errors[$index] );
1589 * Permissions checks that fail most often, and which are easiest to test.
1591 * @param $action String the action to check
1592 * @param $user User user to check
1593 * @param $errors Array list of current errors
1594 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1595 * @param $short Boolean short circuit on first error
1597 * @return Array list of errors
1599 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1600 if ( $action == 'create' ) {
1601 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1602 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1603 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1605 } elseif ( $action == 'move' ) {
1606 if ( !$user->isAllowed( 'move-rootuserpages' )
1607 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1608 // Show user page-specific message only if the user can move other pages
1609 $errors[] = array( 'cant-move-user-page' );
1612 // Check if user is allowed to move files if it's a file
1613 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1614 $errors[] = array( 'movenotallowedfile' );
1617 if ( !$user->isAllowed( 'move' ) ) {
1618 // User can't move anything
1619 global $wgGroupPermissions;
1620 $userCanMove = false;
1621 if ( isset( $wgGroupPermissions['user']['move'] ) ) {
1622 $userCanMove = $wgGroupPermissions['user']['move'];
1624 $autoconfirmedCanMove = false;
1625 if ( isset( $wgGroupPermissions['autoconfirmed']['move'] ) ) {
1626 $autoconfirmedCanMove = $wgGroupPermissions['autoconfirmed']['move'];
1628 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1629 // custom message if logged-in users without any special rights can move
1630 $errors[] = array( 'movenologintext' );
1632 $errors[] = array( 'movenotallowed' );
1635 } elseif ( $action == 'move-target' ) {
1636 if ( !$user->isAllowed( 'move' ) ) {
1637 // User can't move anything
1638 $errors[] = array( 'movenotallowed' );
1639 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1640 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1641 // Show user page-specific message only if the user can move other pages
1642 $errors[] = array( 'cant-move-to-user-page' );
1644 } elseif ( !$user->isAllowed( $action ) ) {
1645 $errors[] = $this->missingPermissionError( $action, $short );
1652 * Add the resulting error code to the errors array
1654 * @param $errors Array list of current errors
1655 * @param $result Mixed result of errors
1657 * @return Array list of errors
1659 private function resultToError( $errors, $result ) {
1660 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1661 // A single array representing an error
1662 $errors[] = $result;
1663 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
1664 // A nested array representing multiple errors
1665 $errors = array_merge( $errors, $result );
1666 } elseif ( $result !== '' && is_string( $result ) ) {
1667 // A string representing a message-id
1668 $errors[] = array( $result );
1669 } elseif ( $result === false ) {
1670 // a generic "We don't want them to do that"
1671 $errors[] = array( 'badaccess-group0' );
1677 * Check various permission hooks
1679 * @param $action String the action to check
1680 * @param $user User user to check
1681 * @param $errors Array list of current errors
1682 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1683 * @param $short Boolean short circuit on first error
1685 * @return Array list of errors
1687 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1688 // Use getUserPermissionsErrors instead
1690 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1691 return $result ?
array() : array( array( 'badaccess-group0' ) );
1693 // Check getUserPermissionsErrors hook
1694 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1695 $errors = $this->resultToError( $errors, $result );
1697 // Check getUserPermissionsErrorsExpensive hook
1698 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1699 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1700 $errors = $this->resultToError( $errors, $result );
1707 * Check permissions on special pages & namespaces
1709 * @param $action String the action to check
1710 * @param $user User user to check
1711 * @param $errors Array list of current errors
1712 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1713 * @param $short Boolean short circuit on first error
1715 * @return Array list of errors
1717 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1718 # Only 'createaccount' and 'execute' can be performed on
1719 # special pages, which don't actually exist in the DB.
1720 $specialOKActions = array( 'createaccount', 'execute', 'read' );
1721 if ( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions ) ) {
1722 $errors[] = array( 'ns-specialprotected' );
1725 # Check $wgNamespaceProtection for restricted namespaces
1726 if ( $this->isNamespaceProtected( $user ) ) {
1727 $ns = $this->mNamespace
== NS_MAIN ?
1728 wfMsg( 'nstab-main' ) : $this->getNsText();
1729 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
1730 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1737 * Check CSS/JS sub-page permissions
1739 * @param $action String the action to check
1740 * @param $user User user to check
1741 * @param $errors Array list of current errors
1742 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1743 * @param $short Boolean short circuit on first error
1745 * @return Array list of errors
1747 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1748 # Protect css/js subpages of user pages
1749 # XXX: this might be better using restrictions
1750 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1751 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1752 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
1753 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1754 $errors[] = array( 'customcssprotected' );
1755 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1756 $errors[] = array( 'customjsprotected' );
1764 * Check against page_restrictions table requirements on this
1765 * page. The user must possess all required rights for this
1768 * @param $action String the action to check
1769 * @param $user User user to check
1770 * @param $errors Array list of current errors
1771 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1772 * @param $short Boolean short circuit on first error
1774 * @return Array list of errors
1776 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1777 foreach ( $this->getRestrictions( $action ) as $right ) {
1778 // Backwards compatibility, rewrite sysop -> protect
1779 if ( $right == 'sysop' ) {
1782 if ( $right != '' && !$user->isAllowed( $right ) ) {
1783 // Users with 'editprotected' permission can edit protected pages
1784 // without cascading option turned on.
1785 if ( $action != 'edit' ||
!$user->isAllowed( 'editprotected' )
1786 ||
$this->mCascadeRestriction
)
1788 $errors[] = array( 'protectedpagetext', $right );
1797 * Check restrictions on cascading pages.
1799 * @param $action String the action to check
1800 * @param $user User to check
1801 * @param $errors Array list of current errors
1802 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1803 * @param $short Boolean short circuit on first error
1805 * @return Array list of errors
1807 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1808 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1809 # We /could/ use the protection level on the source page, but it's
1810 # fairly ugly as we have to establish a precedence hierarchy for pages
1811 # included by multiple cascade-protected pages. So just restrict
1812 # it to people with 'protect' permission, as they could remove the
1813 # protection anyway.
1814 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1815 # Cascading protection depends on more than this page...
1816 # Several cascading protected pages may include this page...
1817 # Check each cascading level
1818 # This is only for protection restrictions, not for all actions
1819 if ( isset( $restrictions[$action] ) ) {
1820 foreach ( $restrictions[$action] as $right ) {
1821 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1822 if ( $right != '' && !$user->isAllowed( $right ) ) {
1824 foreach ( $cascadingSources as $page )
1825 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1826 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1836 * Check action permissions not already checked in checkQuickPermissions
1838 * @param $action String the action to check
1839 * @param $user User to check
1840 * @param $errors Array list of current errors
1841 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1842 * @param $short Boolean short circuit on first error
1844 * @return Array list of errors
1846 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1847 global $wgDeleteRevisionsLimit, $wgLang;
1849 if ( $action == 'protect' ) {
1850 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $doExpensiveQueries, true ) ) ) {
1851 // If they can't edit, they shouldn't protect.
1852 $errors[] = array( 'protect-cantedit' );
1854 } elseif ( $action == 'create' ) {
1855 $title_protection = $this->getTitleProtection();
1856 if( $title_protection ) {
1857 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1858 $title_protection['pt_create_perm'] = 'protect'; // B/C
1860 if( $title_protection['pt_create_perm'] == '' ||
1861 !$user->isAllowed( $title_protection['pt_create_perm'] ) )
1863 $errors[] = array( 'titleprotected', User
::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1866 } elseif ( $action == 'move' ) {
1867 // Check for immobile pages
1868 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1869 // Specific message for this case
1870 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1871 } elseif ( !$this->isMovable() ) {
1872 // Less specific message for rarer cases
1873 $errors[] = array( 'immobile-source-page' );
1875 } elseif ( $action == 'move-target' ) {
1876 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1877 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1878 } elseif ( !$this->isMovable() ) {
1879 $errors[] = array( 'immobile-target-page' );
1881 } elseif ( $action == 'delete' ) {
1882 if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
1883 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion() )
1885 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
1892 * Check that the user isn't blocked from editting.
1894 * @param $action String the action to check
1895 * @param $user User to check
1896 * @param $errors Array list of current errors
1897 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1898 * @param $short Boolean short circuit on first error
1900 * @return Array list of errors
1902 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1903 // Account creation blocks handled at userlogin.
1904 // Unblocking handled in SpecialUnblock
1905 if( !$doExpensiveQueries ||
in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
1909 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
1911 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
1912 $errors[] = array( 'confirmedittext' );
1915 if ( ( $action == 'edit' ||
$action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
1916 // Don't block the user from editing their own talk page unless they've been
1917 // explicitly blocked from that too.
1918 } elseif( $user->isBlocked() && $user->mBlock
->prevents( $action ) !== false ) {
1919 $block = $user->mBlock
;
1921 // This is from OutputPage::blockedPage
1922 // Copied at r23888 by werdna
1924 $id = $user->blockedBy();
1925 $reason = $user->blockedFor();
1926 if ( $reason == '' ) {
1927 $reason = wfMsg( 'blockednoreason' );
1929 $ip = $user->getRequest()->getIP();
1931 if ( is_numeric( $id ) ) {
1932 $name = User
::whoIs( $id );
1937 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1938 $blockid = $block->getId();
1939 $blockExpiry = $user->mBlock
->mExpiry
;
1940 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $user->mBlock
->mTimestamp
), true );
1941 if ( $blockExpiry == 'infinity' ) {
1942 $blockExpiry = wfMessage( 'infiniteblock' )->text();
1944 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1947 $intended = strval( $user->mBlock
->getTarget() );
1949 $errors[] = array( ( $block->mAuto ?
'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1950 $blockid, $blockExpiry, $intended, $blockTimestamp );
1957 * Check that the user is allowed to read this page.
1959 * @param $action String the action to check
1960 * @param $user User to check
1961 * @param $errors Array list of current errors
1962 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1963 * @param $short Boolean short circuit on first error
1965 * @return Array list of errors
1967 private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1968 global $wgWhitelistRead, $wgGroupPermissions, $wgRevokePermissions;;
1969 static $useShortcut = null;
1971 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
1972 if ( is_null( $useShortcut ) ) {
1973 $useShortcut = true;
1974 if ( empty( $wgGroupPermissions['*']['read'] ) ) {
1975 # Not a public wiki, so no shortcut
1976 $useShortcut = false;
1977 } elseif ( !empty( $wgRevokePermissions ) ) {
1979 * Iterate through each group with permissions being revoked (key not included since we don't care
1980 * what the group name is), then check if the read permission is being revoked. If it is, then
1981 * we don't use the shortcut below since the user might not be able to read, even though anon
1982 * reading is allowed.
1984 foreach ( $wgRevokePermissions as $perms ) {
1985 if ( !empty( $perms['read'] ) ) {
1986 # We might be removing the read right from the user, so no shortcut
1987 $useShortcut = false;
1994 $whitelisted = false;
1995 if ( $useShortcut ) {
1996 # Shortcut for public wikis, allows skipping quite a bit of code
1997 $whitelisted = true;
1998 } elseif ( $user->isAllowed( 'read' ) ) {
1999 # If the user is allowed to read pages, he is allowed to read all pages
2000 $whitelisted = true;
2001 } elseif ( $this->isSpecial( 'Userlogin' )
2002 ||
$this->isSpecial( 'ChangePassword' )
2003 ||
$this->isSpecial( 'PasswordReset' )
2005 # Always grant access to the login page.
2006 # Even anons need to be able to log in.
2007 $whitelisted = true;
2008 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2009 # Time to check the whitelist
2010 # Only do these checks is there's something to check against
2011 $name = $this->getPrefixedText();
2012 $dbName = $this->getPrefixedDBKey();
2014 // Check with and without underscores
2015 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2016 # Check for explicit whitelisting
2017 $whitelisted = true;
2018 } elseif ( $this->getNamespace() == NS_MAIN
) {
2019 # Old settings might have the title prefixed with
2020 # a colon for main-namespace pages
2021 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2022 $whitelisted = true;
2024 } elseif ( $this->isSpecialPage() ) {
2025 # If it's a special page, ditch the subpage bit and check again
2026 $name = $this->getDBkey();
2027 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
2028 if ( $name !== false ) {
2029 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2030 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2031 $whitelisted = true;
2037 if ( !$whitelisted ) {
2038 # If the title is not whitelisted, give extensions a chance to do so...
2039 wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2040 if ( !$whitelisted ) {
2041 $errors[] = $this->missingPermissionError( $action, $short );
2049 * Get a description array when the user doesn't have the right to perform
2050 * $action (i.e. when User::isAllowed() returns false)
2052 * @param $action String the action to check
2053 * @param $short Boolean short circuit on first error
2054 * @return Array list of errors
2056 private function missingPermissionError( $action, $short ) {
2057 // We avoid expensive display logic for quickUserCan's and such
2059 return array( 'badaccess-group0' );
2062 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2063 User
::getGroupsWithPermission( $action ) );
2065 if ( count( $groups ) ) {
2069 $wgLang->commaList( $groups ),
2073 return array( 'badaccess-group0' );
2078 * Can $user perform $action on this page? This is an internal function,
2079 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2080 * checks on wfReadOnly() and blocks)
2082 * @param $action String action that permission needs to be checked for
2083 * @param $user User to check
2084 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
2085 * @param $short Bool Set this to true to stop after the first permission error.
2086 * @return Array of arrays of the arguments to wfMsg to explain permissions problems.
2088 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
2089 wfProfileIn( __METHOD__
);
2091 # Read has special handling
2092 if ( $action == 'read' ) {
2094 'checkPermissionHooks',
2095 'checkReadPermissions',
2099 'checkQuickPermissions',
2100 'checkPermissionHooks',
2101 'checkSpecialsAndNSPermissions',
2102 'checkCSSandJSPermissions',
2103 'checkPageRestrictions',
2104 'checkCascadingSourcesRestrictions',
2105 'checkActionPermissions',
2111 while( count( $checks ) > 0 &&
2112 !( $short && count( $errors ) > 0 ) ) {
2113 $method = array_shift( $checks );
2114 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2117 wfProfileOut( __METHOD__
);
2122 * Protect css subpages of user pages: can $wgUser edit
2125 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2128 public function userCanEditCssSubpage() {
2130 wfDeprecated( __METHOD__
, '1.19' );
2131 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'editusercss' ) )
2132 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2136 * Protect js subpages of user pages: can $wgUser edit
2139 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2142 public function userCanEditJsSubpage() {
2144 wfDeprecated( __METHOD__
, '1.19' );
2145 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'edituserjs' ) )
2146 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2150 * Get a filtered list of all restriction types supported by this wiki.
2151 * @param bool $exists True to get all restriction types that apply to
2152 * titles that do exist, False for all restriction types that apply to
2153 * titles that do not exist
2156 public static function getFilteredRestrictionTypes( $exists = true ) {
2157 global $wgRestrictionTypes;
2158 $types = $wgRestrictionTypes;
2160 # Remove the create restriction for existing titles
2161 $types = array_diff( $types, array( 'create' ) );
2163 # Only the create and upload restrictions apply to non-existing titles
2164 $types = array_intersect( $types, array( 'create', 'upload' ) );
2170 * Returns restriction types for the current Title
2172 * @return array applicable restriction types
2174 public function getRestrictionTypes() {
2175 if ( $this->isSpecialPage() ) {
2179 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2181 if ( $this->getNamespace() != NS_FILE
) {
2182 # Remove the upload restriction for non-file titles
2183 $types = array_diff( $types, array( 'upload' ) );
2186 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2188 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2189 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2195 * Is this title subject to title protection?
2196 * Title protection is the one applied against creation of such title.
2198 * @return Mixed An associative array representing any existent title
2199 * protection, or false if there's none.
2201 private function getTitleProtection() {
2202 // Can't protect pages in special namespaces
2203 if ( $this->getNamespace() < 0 ) {
2207 // Can't protect pages that exist.
2208 if ( $this->exists() ) {
2212 if ( !isset( $this->mTitleProtection
) ) {
2213 $dbr = wfGetDB( DB_SLAVE
);
2214 $res = $dbr->select( 'protected_titles', '*',
2215 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2218 // fetchRow returns false if there are no rows.
2219 $this->mTitleProtection
= $dbr->fetchRow( $res );
2221 return $this->mTitleProtection
;
2225 * Update the title protection status
2227 * @deprecated in 1.19; will be removed in 1.20. Use WikiPage::doUpdateRestrictions() instead.
2228 * @param $create_perm String Permission required for creation
2229 * @param $reason String Reason for protection
2230 * @param $expiry String Expiry timestamp
2231 * @return boolean true
2233 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
2234 wfDeprecated( __METHOD__
, '1.19' );
2238 $limit = array( 'create' => $create_perm );
2239 $expiry = array( 'create' => $expiry );
2241 $page = WikiPage
::factory( $this );
2242 $status = $page->doUpdateRestrictions( $limit, $expiry, false, $reason, $wgUser );
2244 return $status->isOK();
2248 * Remove any title protection due to page existing
2250 public function deleteTitleProtection() {
2251 $dbw = wfGetDB( DB_MASTER
);
2255 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2258 $this->mTitleProtection
= false;
2262 * Is this page "semi-protected" - the *only* protection is autoconfirm?
2264 * @param $action String Action to check (default: edit)
2267 public function isSemiProtected( $action = 'edit' ) {
2268 if ( $this->exists() ) {
2269 $restrictions = $this->getRestrictions( $action );
2270 if ( count( $restrictions ) > 0 ) {
2271 foreach ( $restrictions as $restriction ) {
2272 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
2282 # If it doesn't exist, it can't be protected
2288 * Does the title correspond to a protected article?
2290 * @param $action String the action the page is protected from,
2291 * by default checks all actions.
2294 public function isProtected( $action = '' ) {
2295 global $wgRestrictionLevels;
2297 $restrictionTypes = $this->getRestrictionTypes();
2299 # Special pages have inherent protection
2300 if( $this->isSpecialPage() ) {
2304 # Check regular protection levels
2305 foreach ( $restrictionTypes as $type ) {
2306 if ( $action == $type ||
$action == '' ) {
2307 $r = $this->getRestrictions( $type );
2308 foreach ( $wgRestrictionLevels as $level ) {
2309 if ( in_array( $level, $r ) && $level != '' ) {
2320 * Determines if $user is unable to edit this page because it has been protected
2321 * by $wgNamespaceProtection.
2323 * @param $user User object to check permissions
2326 public function isNamespaceProtected( User
$user ) {
2327 global $wgNamespaceProtection;
2329 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2330 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2331 if ( $right != '' && !$user->isAllowed( $right ) ) {
2340 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2342 * @return Bool If the page is subject to cascading restrictions.
2344 public function isCascadeProtected() {
2345 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2346 return ( $sources > 0 );
2350 * Cascading protection: Get the source of any cascading restrictions on this page.
2352 * @param $getPages Bool Whether or not to retrieve the actual pages
2353 * that the restrictions have come from.
2354 * @return Mixed Array of Title objects of the pages from which cascading restrictions
2355 * have come, false for none, or true if such restrictions exist, but $getPages
2356 * was not set. The restriction array is an array of each type, each of which
2357 * contains a array of unique groups.
2359 public function getCascadeProtectionSources( $getPages = true ) {
2361 $pagerestrictions = array();
2363 if ( isset( $this->mCascadeSources
) && $getPages ) {
2364 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2365 } elseif ( isset( $this->mHasCascadingRestrictions
) && !$getPages ) {
2366 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2369 wfProfileIn( __METHOD__
);
2371 $dbr = wfGetDB( DB_SLAVE
);
2373 if ( $this->getNamespace() == NS_FILE
) {
2374 $tables = array( 'imagelinks', 'page_restrictions' );
2375 $where_clauses = array(
2376 'il_to' => $this->getDBkey(),
2381 $tables = array( 'templatelinks', 'page_restrictions' );
2382 $where_clauses = array(
2383 'tl_namespace' => $this->getNamespace(),
2384 'tl_title' => $this->getDBkey(),
2391 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2392 'pr_expiry', 'pr_type', 'pr_level' );
2393 $where_clauses[] = 'page_id=pr_page';
2396 $cols = array( 'pr_expiry' );
2399 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2401 $sources = $getPages ?
array() : false;
2402 $now = wfTimestampNow();
2403 $purgeExpired = false;
2405 foreach ( $res as $row ) {
2406 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2407 if ( $expiry > $now ) {
2409 $page_id = $row->pr_page
;
2410 $page_ns = $row->page_namespace
;
2411 $page_title = $row->page_title
;
2412 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2413 # Add groups needed for each restriction type if its not already there
2414 # Make sure this restriction type still exists
2416 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2417 $pagerestrictions[$row->pr_type
] = array();
2420 if ( isset( $pagerestrictions[$row->pr_type
] ) &&
2421 !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] ) ) {
2422 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2428 // Trigger lazy purge of expired restrictions from the db
2429 $purgeExpired = true;
2432 if ( $purgeExpired ) {
2433 Title
::purgeExpiredRestrictions();
2437 $this->mCascadeSources
= $sources;
2438 $this->mCascadingRestrictions
= $pagerestrictions;
2440 $this->mHasCascadingRestrictions
= $sources;
2443 wfProfileOut( __METHOD__
);
2444 return array( $sources, $pagerestrictions );
2448 * Accessor/initialisation for mRestrictions
2450 * @param $action String action that permission needs to be checked for
2451 * @return Array of Strings the array of groups allowed to edit this article
2453 public function getRestrictions( $action ) {
2454 if ( !$this->mRestrictionsLoaded
) {
2455 $this->loadRestrictions();
2457 return isset( $this->mRestrictions
[$action] )
2458 ?
$this->mRestrictions
[$action]
2463 * Get the expiry time for the restriction against a given action
2465 * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever
2466 * or not protected at all, or false if the action is not recognised.
2468 public function getRestrictionExpiry( $action ) {
2469 if ( !$this->mRestrictionsLoaded
) {
2470 $this->loadRestrictions();
2472 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2476 * Returns cascading restrictions for the current article
2480 function areRestrictionsCascading() {
2481 if ( !$this->mRestrictionsLoaded
) {
2482 $this->loadRestrictions();
2485 return $this->mCascadeRestriction
;
2489 * Loads a string into mRestrictions array
2491 * @param $res Resource restrictions as an SQL result.
2492 * @param $oldFashionedRestrictions String comma-separated list of page
2493 * restrictions from page table (pre 1.10)
2495 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2498 foreach ( $res as $row ) {
2502 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2506 * Compiles list of active page restrictions from both page table (pre 1.10)
2507 * and page_restrictions table for this existing page.
2508 * Public for usage by LiquidThreads.
2510 * @param $rows array of db result objects
2511 * @param $oldFashionedRestrictions string comma-separated list of page
2512 * restrictions from page table (pre 1.10)
2514 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2516 $dbr = wfGetDB( DB_SLAVE
);
2518 $restrictionTypes = $this->getRestrictionTypes();
2520 foreach ( $restrictionTypes as $type ) {
2521 $this->mRestrictions
[$type] = array();
2522 $this->mRestrictionsExpiry
[$type] = $wgContLang->formatExpiry( '', TS_MW
);
2525 $this->mCascadeRestriction
= false;
2527 # Backwards-compatibility: also load the restrictions from the page record (old format).
2529 if ( $oldFashionedRestrictions === null ) {
2530 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2531 array( 'page_id' => $this->getArticleId() ), __METHOD__
);
2534 if ( $oldFashionedRestrictions != '' ) {
2536 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2537 $temp = explode( '=', trim( $restrict ) );
2538 if ( count( $temp ) == 1 ) {
2539 // old old format should be treated as edit/move restriction
2540 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2541 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2543 $this->mRestrictions
[$temp[0]] = explode( ',', trim( $temp[1] ) );
2547 $this->mOldRestrictions
= true;
2551 if ( count( $rows ) ) {
2552 # Current system - load second to make them override.
2553 $now = wfTimestampNow();
2554 $purgeExpired = false;
2556 # Cycle through all the restrictions.
2557 foreach ( $rows as $row ) {
2559 // Don't take care of restrictions types that aren't allowed
2560 if ( !in_array( $row->pr_type
, $restrictionTypes ) )
2563 // This code should be refactored, now that it's being used more generally,
2564 // But I don't really see any harm in leaving it in Block for now -werdna
2565 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2567 // Only apply the restrictions if they haven't expired!
2568 if ( !$expiry ||
$expiry > $now ) {
2569 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2570 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2572 $this->mCascadeRestriction |
= $row->pr_cascade
;
2574 // Trigger a lazy purge of expired restrictions
2575 $purgeExpired = true;
2579 if ( $purgeExpired ) {
2580 Title
::purgeExpiredRestrictions();
2584 $this->mRestrictionsLoaded
= true;
2588 * Load restrictions from the page_restrictions table
2590 * @param $oldFashionedRestrictions String comma-separated list of page
2591 * restrictions from page table (pre 1.10)
2593 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2595 if ( !$this->mRestrictionsLoaded
) {
2596 if ( $this->exists() ) {
2597 $dbr = wfGetDB( DB_SLAVE
);
2599 $res = $dbr->select(
2600 'page_restrictions',
2602 array( 'pr_page' => $this->getArticleId() ),
2606 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2608 $title_protection = $this->getTitleProtection();
2610 if ( $title_protection ) {
2611 $now = wfTimestampNow();
2612 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW
);
2614 if ( !$expiry ||
$expiry > $now ) {
2615 // Apply the restrictions
2616 $this->mRestrictionsExpiry
['create'] = $expiry;
2617 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2618 } else { // Get rid of the old restrictions
2619 Title
::purgeExpiredRestrictions();
2620 $this->mTitleProtection
= false;
2623 $this->mRestrictionsExpiry
['create'] = $wgContLang->formatExpiry( '', TS_MW
);
2625 $this->mRestrictionsLoaded
= true;
2631 * Flush the protection cache in this object and force reload from the database.
2632 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2634 public function flushRestrictions() {
2635 $this->mRestrictionsLoaded
= false;
2636 $this->mTitleProtection
= null;
2640 * Purge expired restrictions from the page_restrictions table
2642 static function purgeExpiredRestrictions() {
2643 $dbw = wfGetDB( DB_MASTER
);
2645 'page_restrictions',
2646 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2652 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2658 * Does this have subpages? (Warning, usually requires an extra DB query.)
2662 public function hasSubpages() {
2663 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
2668 # We dynamically add a member variable for the purpose of this method
2669 # alone to cache the result. There's no point in having it hanging
2670 # around uninitialized in every Title object; therefore we only add it
2671 # if needed and don't declare it statically.
2672 if ( isset( $this->mHasSubpages
) ) {
2673 return $this->mHasSubpages
;
2676 $subpages = $this->getSubpages( 1 );
2677 if ( $subpages instanceof TitleArray
) {
2678 return $this->mHasSubpages
= (bool)$subpages->count();
2680 return $this->mHasSubpages
= false;
2684 * Get all subpages of this page.
2686 * @param $limit Int maximum number of subpages to fetch; -1 for no limit
2687 * @return mixed TitleArray, or empty array if this page's namespace
2688 * doesn't allow subpages
2690 public function getSubpages( $limit = -1 ) {
2691 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
2695 $dbr = wfGetDB( DB_SLAVE
);
2696 $conds['page_namespace'] = $this->getNamespace();
2697 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
2699 if ( $limit > -1 ) {
2700 $options['LIMIT'] = $limit;
2702 return $this->mSubpages
= TitleArray
::newFromResult(
2703 $dbr->select( 'page',
2704 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
2713 * Is there a version of this page in the deletion archive?
2715 * @return Int the number of archived revisions
2717 public function isDeleted() {
2718 if ( $this->getNamespace() < 0 ) {
2721 $dbr = wfGetDB( DB_SLAVE
);
2723 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2724 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2727 if ( $this->getNamespace() == NS_FILE
) {
2728 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
2729 array( 'fa_name' => $this->getDBkey() ),
2738 * Is there a version of this page in the deletion archive?
2742 public function isDeletedQuick() {
2743 if ( $this->getNamespace() < 0 ) {
2746 $dbr = wfGetDB( DB_SLAVE
);
2747 $deleted = (bool)$dbr->selectField( 'archive', '1',
2748 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2751 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
2752 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2753 array( 'fa_name' => $this->getDBkey() ),
2761 * Get the number of views of this page
2763 * @return int The view count for the page
2765 public function getCount() {
2766 if ( $this->mCounter
== -1 ) {
2767 if ( $this->exists() ) {
2768 $dbr = wfGetDB( DB_SLAVE
);
2769 $this->mCounter
= $dbr->selectField( 'page',
2771 array( 'page_id' => $this->getArticleID() ),
2775 $this->mCounter
= 0;
2779 return $this->mCounter
;
2783 * Get the article ID for this Title from the link cache,
2784 * adding it if necessary
2786 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select
2788 * @return Int the ID
2790 public function getArticleID( $flags = 0 ) {
2791 if ( $this->getNamespace() < 0 ) {
2792 return $this->mArticleID
= 0;
2794 $linkCache = LinkCache
::singleton();
2795 if ( $flags & self
::GAID_FOR_UPDATE
) {
2796 $oldUpdate = $linkCache->forUpdate( true );
2797 $linkCache->clearLink( $this );
2798 $this->mArticleID
= $linkCache->addLinkObj( $this );
2799 $linkCache->forUpdate( $oldUpdate );
2801 if ( -1 == $this->mArticleID
) {
2802 $this->mArticleID
= $linkCache->addLinkObj( $this );
2805 return $this->mArticleID
;
2809 * Is this an article that is a redirect page?
2810 * Uses link cache, adding it if necessary
2812 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2815 public function isRedirect( $flags = 0 ) {
2816 if ( !is_null( $this->mRedirect
) ) {
2817 return $this->mRedirect
;
2819 # Calling getArticleID() loads the field from cache as needed
2820 if ( !$this->getArticleID( $flags ) ) {
2821 return $this->mRedirect
= false;
2823 $linkCache = LinkCache
::singleton();
2824 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2826 return $this->mRedirect
;
2830 * What is the length of this page?
2831 * Uses link cache, adding it if necessary
2833 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2836 public function getLength( $flags = 0 ) {
2837 if ( $this->mLength
!= -1 ) {
2838 return $this->mLength
;
2840 # Calling getArticleID() loads the field from cache as needed
2841 if ( !$this->getArticleID( $flags ) ) {
2842 return $this->mLength
= 0;
2844 $linkCache = LinkCache
::singleton();
2845 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2847 return $this->mLength
;
2851 * What is the page_latest field for this page?
2853 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2854 * @return Int or 0 if the page doesn't exist
2856 public function getLatestRevID( $flags = 0 ) {
2857 if ( $this->mLatestID
!== false ) {
2858 return intval( $this->mLatestID
);
2860 # Calling getArticleID() loads the field from cache as needed
2861 if ( !$this->getArticleID( $flags ) ) {
2862 return $this->mLatestID
= 0;
2864 $linkCache = LinkCache
::singleton();
2865 $this->mLatestID
= intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2867 return $this->mLatestID
;
2871 * This clears some fields in this object, and clears any associated
2872 * keys in the "bad links" section of the link cache.
2874 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
2875 * loading of the new page_id. It's also called from
2876 * WikiPage::doDeleteArticle()
2878 * @param $newid Int the new Article ID
2880 public function resetArticleID( $newid ) {
2881 $linkCache = LinkCache
::singleton();
2882 $linkCache->clearLink( $this );
2884 if ( $newid === false ) {
2885 $this->mArticleID
= -1;
2887 $this->mArticleID
= intval( $newid );
2889 $this->mRestrictionsLoaded
= false;
2890 $this->mRestrictions
= array();
2891 $this->mRedirect
= null;
2892 $this->mLength
= -1;
2893 $this->mLatestID
= false;
2894 $this->mCounter
= -1;
2895 $this->mEstimateRevisions
= null;
2899 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2901 * @param $text String containing title to capitalize
2902 * @param $ns int namespace index, defaults to NS_MAIN
2903 * @return String containing capitalized title
2905 public static function capitalize( $text, $ns = NS_MAIN
) {
2908 if ( MWNamespace
::isCapitalized( $ns ) ) {
2909 return $wgContLang->ucfirst( $text );
2916 * Secure and split - main initialisation function for this object
2918 * Assumes that mDbkeyform has been set, and is urldecoded
2919 * and uses underscores, but not otherwise munged. This function
2920 * removes illegal characters, splits off the interwiki and
2921 * namespace prefixes, sets the other forms, and canonicalizes
2924 * @return Bool true on success
2926 private function secureAndSplit() {
2927 global $wgContLang, $wgLocalInterwiki;
2930 $this->mInterwiki
= $this->mFragment
= '';
2931 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2933 $dbkey = $this->mDbkeyform
;
2935 # Strip Unicode bidi override characters.
2936 # Sometimes they slip into cut-n-pasted page titles, where the
2937 # override chars get included in list displays.
2938 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2940 # Clean up whitespace
2941 # Note: use of the /u option on preg_replace here will cause
2942 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2943 # conveniently disabling them.
2944 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2945 $dbkey = trim( $dbkey, '_' );
2947 if ( $dbkey == '' ) {
2951 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2952 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2956 $this->mDbkeyform
= $dbkey;
2958 # Initial colon indicates main namespace rather than specified default
2959 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2960 if ( ':' == $dbkey[0] ) {
2961 $this->mNamespace
= NS_MAIN
;
2962 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2963 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2966 # Namespace or interwiki prefix
2968 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2971 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2973 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
2974 # Ordinary namespace
2976 $this->mNamespace
= $ns;
2977 # For Talk:X pages, check if X has a "namespace" prefix
2978 if ( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2979 if ( $wgContLang->getNsIndex( $x[1] ) ) {
2980 # Disallow Talk:File:x type titles...
2982 } elseif ( Interwiki
::isValidInterwiki( $x[1] ) ) {
2983 # Disallow Talk:Interwiki:x type titles...
2987 } elseif ( Interwiki
::isValidInterwiki( $p ) ) {
2988 if ( !$firstPass ) {
2989 # Can't make a local interwiki link to an interwiki link.
2990 # That's just crazy!
2996 $this->mInterwiki
= $wgContLang->lc( $p );
2998 # Redundant interwiki prefix to the local wiki
2999 if ( $wgLocalInterwiki !== false
3000 && 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) )
3002 if ( $dbkey == '' ) {
3003 # Can't have an empty self-link
3006 $this->mInterwiki
= '';
3008 # Do another namespace split...
3012 # If there's an initial colon after the interwiki, that also
3013 # resets the default namespace
3014 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
3015 $this->mNamespace
= NS_MAIN
;
3016 $dbkey = substr( $dbkey, 1 );
3019 # If there's no recognized interwiki or namespace,
3020 # then let the colon expression be part of the title.
3025 # We already know that some pages won't be in the database!
3026 if ( $this->mInterwiki
!= '' || NS_SPECIAL
== $this->mNamespace
) {
3027 $this->mArticleID
= 0;
3029 $fragment = strstr( $dbkey, '#' );
3030 if ( false !== $fragment ) {
3031 $this->setFragment( $fragment );
3032 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
3033 # remove whitespace again: prevents "Foo_bar_#"
3034 # becoming "Foo_bar_"
3035 $dbkey = preg_replace( '/_*$/', '', $dbkey );
3038 # Reject illegal characters.
3039 $rxTc = self
::getTitleInvalidRegex();
3040 if ( preg_match( $rxTc, $dbkey ) ) {
3044 # Pages with "/./" or "/../" appearing in the URLs will often be un-
3045 # reachable due to the way web browsers deal with 'relative' URLs.
3046 # Also, they conflict with subpage syntax. Forbid them explicitly.
3047 if ( strpos( $dbkey, '.' ) !== false &&
3048 ( $dbkey === '.' ||
$dbkey === '..' ||
3049 strpos( $dbkey, './' ) === 0 ||
3050 strpos( $dbkey, '../' ) === 0 ||
3051 strpos( $dbkey, '/./' ) !== false ||
3052 strpos( $dbkey, '/../' ) !== false ||
3053 substr( $dbkey, -2 ) == '/.' ||
3054 substr( $dbkey, -3 ) == '/..' ) )
3059 # Magic tilde sequences? Nu-uh!
3060 if ( strpos( $dbkey, '~~~' ) !== false ) {
3064 # Limit the size of titles to 255 bytes. This is typically the size of the
3065 # underlying database field. We make an exception for special pages, which
3066 # don't need to be stored in the database, and may edge over 255 bytes due
3067 # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
3068 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
3069 strlen( $dbkey ) > 512 )
3074 # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
3075 # and [[Foo]] point to the same place. Don't force it for interwikis, since the
3076 # other site might be case-sensitive.
3077 $this->mUserCaseDBKey
= $dbkey;
3078 if ( $this->mInterwiki
== '' ) {
3079 $dbkey = self
::capitalize( $dbkey, $this->mNamespace
);
3082 # Can't make a link to a namespace alone... "empty" local links can only be
3083 # self-links with a fragment identifier.
3084 if ( $dbkey == '' && $this->mInterwiki
== '' && $this->mNamespace
!= NS_MAIN
) {
3088 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
3089 // IP names are not allowed for accounts, and can only be referring to
3090 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
3091 // there are numerous ways to present the same IP. Having sp:contribs scan
3092 // them all is silly and having some show the edits and others not is
3093 // inconsistent. Same for talk/userpages. Keep them normalized instead.
3094 $dbkey = ( $this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
)
3095 ? IP
::sanitizeIP( $dbkey )
3098 // Any remaining initial :s are illegal.
3099 if ( $dbkey !== '' && ':' == $dbkey[0] ) {
3104 $this->mDbkeyform
= $dbkey;
3105 $this->mUrlform
= wfUrlencode( $dbkey );
3107 $this->mTextform
= str_replace( '_', ' ', $dbkey );
3113 * Get an array of Title objects linking to this Title
3114 * Also stores the IDs in the link cache.
3116 * WARNING: do not use this function on arbitrary user-supplied titles!
3117 * On heavily-used templates it will max out the memory.
3119 * @param $options Array: may be FOR UPDATE
3120 * @param $table String: table name
3121 * @param $prefix String: fields prefix
3122 * @return Array of Title objects linking here
3124 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3125 if ( count( $options ) > 0 ) {
3126 $db = wfGetDB( DB_MASTER
);
3128 $db = wfGetDB( DB_SLAVE
);
3132 array( 'page', $table ),
3133 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
3135 "{$prefix}_from=page_id",
3136 "{$prefix}_namespace" => $this->getNamespace(),
3137 "{$prefix}_title" => $this->getDBkey() ),
3143 if ( $res->numRows() ) {
3144 $linkCache = LinkCache
::singleton();
3145 foreach ( $res as $row ) {
3146 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
3148 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3149 $retVal[] = $titleObj;
3157 * Get an array of Title objects using this Title as a template
3158 * Also stores the IDs in the link cache.
3160 * WARNING: do not use this function on arbitrary user-supplied titles!
3161 * On heavily-used templates it will max out the memory.
3163 * @param $options Array: may be FOR UPDATE
3164 * @return Array of Title the Title objects linking here
3166 public function getTemplateLinksTo( $options = array() ) {
3167 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3171 * Get an array of Title objects linked from this Title
3172 * Also stores the IDs in the link cache.
3174 * WARNING: do not use this function on arbitrary user-supplied titles!
3175 * On heavily-used templates it will max out the memory.
3177 * @param $options Array: may be FOR UPDATE
3178 * @param $table String: table name
3179 * @param $prefix String: fields prefix
3180 * @return Array of Title objects linking here
3182 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3183 $id = $this->getArticleId();
3185 # If the page doesn't exist; there can't be any link from this page
3190 if ( count( $options ) > 0 ) {
3191 $db = wfGetDB( DB_MASTER
);
3193 $db = wfGetDB( DB_SLAVE
);
3196 $namespaceFiled = "{$prefix}_namespace";
3197 $titleField = "{$prefix}_title";
3200 array( $table, 'page' ),
3201 array( $namespaceFiled, $titleField, 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
3202 array( "{$prefix}_from" => $id ),
3205 array( 'page' => array( 'LEFT JOIN', array( "page_namespace=$namespaceFiled", "page_title=$titleField" ) ) )
3209 if ( $res->numRows() ) {
3210 $linkCache = LinkCache
::singleton();
3211 foreach ( $res as $row ) {
3212 $titleObj = Title
::makeTitle( $row->$namespaceFiled, $row->$titleField );
3214 if ( $row->page_id
) {
3215 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3217 $linkCache->addBadLinkObj( $titleObj );
3219 $retVal[] = $titleObj;
3227 * Get an array of Title objects used on this Title as a template
3228 * Also stores the IDs in the link cache.
3230 * WARNING: do not use this function on arbitrary user-supplied titles!
3231 * On heavily-used templates it will max out the memory.
3233 * @param $options Array: may be FOR UPDATE
3234 * @return Array of Title the Title objects used here
3236 public function getTemplateLinksFrom( $options = array() ) {
3237 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3241 * Get an array of Title objects referring to non-existent articles linked from this page
3243 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
3244 * @return Array of Title the Title objects
3246 public function getBrokenLinksFrom() {
3247 if ( $this->getArticleId() == 0 ) {
3248 # All links from article ID 0 are false positives
3252 $dbr = wfGetDB( DB_SLAVE
);
3253 $res = $dbr->select(
3254 array( 'page', 'pagelinks' ),
3255 array( 'pl_namespace', 'pl_title' ),
3257 'pl_from' => $this->getArticleId(),
3258 'page_namespace IS NULL'
3260 __METHOD__
, array(),
3264 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3270 foreach ( $res as $row ) {
3271 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3278 * Get a list of URLs to purge from the Squid cache when this
3281 * @return Array of String the URLs
3283 public function getSquidURLs() {
3287 $this->getInternalURL(),
3288 $this->getInternalURL( 'action=history' )
3291 // purge variant urls as well
3292 if ( $wgContLang->hasVariants() ) {
3293 $variants = $wgContLang->getVariants();
3294 foreach ( $variants as $vCode ) {
3295 $urls[] = $this->getInternalURL( '', $vCode );
3303 * Purge all applicable Squid URLs
3305 public function purgeSquid() {
3307 if ( $wgUseSquid ) {
3308 $urls = $this->getSquidURLs();
3309 $u = new SquidUpdate( $urls );
3315 * Move this page without authentication
3317 * @param $nt Title the new page Title
3318 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3320 public function moveNoAuth( &$nt ) {
3321 return $this->moveTo( $nt, false );
3325 * Check whether a given move operation would be valid.
3326 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3328 * @param $nt Title the new title
3329 * @param $auth Bool indicates whether $wgUser's permissions
3331 * @param $reason String is the log summary of the move, used for spam checking
3332 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
3334 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3339 // Normally we'd add this to $errors, but we'll get
3340 // lots of syntax errors if $nt is not an object
3341 return array( array( 'badtitletext' ) );
3343 if ( $this->equals( $nt ) ) {
3344 $errors[] = array( 'selfmove' );
3346 if ( !$this->isMovable() ) {
3347 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3349 if ( $nt->getInterwiki() != '' ) {
3350 $errors[] = array( 'immobile-target-namespace-iw' );
3352 if ( !$nt->isMovable() ) {
3353 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3356 $oldid = $this->getArticleID();
3357 $newid = $nt->getArticleID();
3359 if ( strlen( $nt->getDBkey() ) < 1 ) {
3360 $errors[] = array( 'articleexists' );
3362 if ( ( $this->getDBkey() == '' ) ||
3364 ( $nt->getDBkey() == '' ) ) {
3365 $errors[] = array( 'badarticleerror' );
3368 // Image-specific checks
3369 if ( $this->getNamespace() == NS_FILE
) {
3370 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3373 if ( $nt->getNamespace() == NS_FILE
&& $this->getNamespace() != NS_FILE
) {
3374 $errors[] = array( 'nonfile-cannot-move-to-file' );
3378 $errors = wfMergeErrorArrays( $errors,
3379 $this->getUserPermissionsErrors( 'move', $wgUser ),
3380 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3381 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3382 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3385 $match = EditPage
::matchSummarySpamRegex( $reason );
3386 if ( $match !== false ) {
3387 // This is kind of lame, won't display nice
3388 $errors[] = array( 'spamprotectiontext' );
3392 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3393 $errors[] = array( 'hookaborted', $err );
3396 # The move is allowed only if (1) the target doesn't exist, or
3397 # (2) the target is a redirect to the source, and has no history
3398 # (so we can undo bad moves right after they're done).
3400 if ( 0 != $newid ) { # Target exists; check for validity
3401 if ( !$this->isValidMoveTarget( $nt ) ) {
3402 $errors[] = array( 'articleexists' );
3405 $tp = $nt->getTitleProtection();
3406 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
3407 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3408 $errors[] = array( 'cantmove-titleprotected' );
3411 if ( empty( $errors ) ) {
3418 * Check if the requested move target is a valid file move target
3419 * @param Title $nt Target title
3420 * @return array List of errors
3422 protected function validateFileMoveOperation( $nt ) {
3427 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3429 $file = wfLocalFile( $this );
3430 if ( $file->exists() ) {
3431 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3432 $errors[] = array( 'imageinvalidfilename' );
3434 if ( !File
::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3435 $errors[] = array( 'imagetypemismatch' );
3439 if ( $nt->getNamespace() != NS_FILE
) {
3440 $errors[] = array( 'imagenocrossnamespace' );
3441 // From here we want to do checks on a file object, so if we can't
3442 // create one, we must return.
3446 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3448 $destFile = wfLocalFile( $nt );
3449 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3450 $errors[] = array( 'file-exists-sharedrepo' );
3457 * Move a title to a new location
3459 * @param $nt Title the new title
3460 * @param $auth Bool indicates whether $wgUser's permissions
3462 * @param $reason String the reason for the move
3463 * @param $createRedirect Bool Whether to create a redirect from the old title to the new title.
3464 * Ignored if the user doesn't have the suppressredirect right.
3465 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3467 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3469 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3470 if ( is_array( $err ) ) {
3471 // Auto-block user's IP if the account was "hard" blocked
3472 $wgUser->spreadAnyEditBlock();
3476 // If it is a file, move it first.
3477 // It is done before all other moving stuff is done because it's hard to revert.
3478 $dbw = wfGetDB( DB_MASTER
);
3479 if ( $this->getNamespace() == NS_FILE
) {
3480 $file = wfLocalFile( $this );
3481 if ( $file->exists() ) {
3482 $status = $file->move( $nt );
3483 if ( !$status->isOk() ) {
3484 return $status->getErrorsArray();
3487 // Clear RepoGroup process cache
3488 RepoGroup
::singleton()->clearCache( $this );
3489 RepoGroup
::singleton()->clearCache( $nt ); # clear false negative cache
3492 $dbw->begin(); # If $file was a LocalFile, its transaction would have closed our own.
3493 $pageid = $this->getArticleID( self
::GAID_FOR_UPDATE
);
3494 $protected = $this->isProtected();
3496 // Do the actual move
3497 $err = $this->moveToInternal( $nt, $reason, $createRedirect );
3498 if ( is_array( $err ) ) {
3499 # @todo FIXME: What about the File we have already moved?
3504 // Refresh the sortkey for this row. Be careful to avoid resetting
3505 // cl_timestamp, which may disturb time-based lists on some sites.
3506 $prefixes = $dbw->select(
3508 array( 'cl_sortkey_prefix', 'cl_to' ),
3509 array( 'cl_from' => $pageid ),
3512 foreach ( $prefixes as $prefixRow ) {
3513 $prefix = $prefixRow->cl_sortkey_prefix
;
3514 $catTo = $prefixRow->cl_to
;
3515 $dbw->update( 'categorylinks',
3517 'cl_sortkey' => Collation
::singleton()->getSortKey(
3518 $nt->getCategorySortkey( $prefix ) ),
3519 'cl_timestamp=cl_timestamp' ),
3521 'cl_from' => $pageid,
3522 'cl_to' => $catTo ),
3527 $redirid = $this->getArticleID();
3530 # Protect the redirect title as the title used to be...
3531 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3533 'pr_page' => $redirid,
3534 'pr_type' => 'pr_type',
3535 'pr_level' => 'pr_level',
3536 'pr_cascade' => 'pr_cascade',
3537 'pr_user' => 'pr_user',
3538 'pr_expiry' => 'pr_expiry'
3540 array( 'pr_page' => $pageid ),
3544 # Update the protection log
3545 $log = new LogPage( 'protect' );
3546 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3548 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3550 // @todo FIXME: $params?
3551 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) );
3555 $oldnamespace = $this->getNamespace() & ~
1;
3556 $newnamespace = $nt->getNamespace() & ~
1;
3557 $oldtitle = $this->getDBkey();
3558 $newtitle = $nt->getDBkey();
3560 if ( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
3561 WatchedItem
::duplicateEntries( $this, $nt );
3566 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3571 * Move page to a title which is either a redirect to the
3572 * source page or nonexistent
3574 * @param $nt Title the page to move to, which should be a redirect or nonexistent
3575 * @param $reason String The reason for the move
3576 * @param $createRedirect Bool Whether to leave a redirect at the old title. Ignored
3577 * if the user doesn't have the suppressredirect right
3579 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3580 global $wgUser, $wgContLang;
3582 if ( $nt->exists() ) {
3583 $moveOverRedirect = true;
3584 $logType = 'move_redir';
3586 $moveOverRedirect = false;
3590 $redirectSuppressed = !$createRedirect && $wgUser->isAllowed( 'suppressredirect' );
3592 $logEntry = new ManualLogEntry( 'move', $logType );
3593 $logEntry->setPerformer( $wgUser );
3594 $logEntry->setTarget( $this );
3595 $logEntry->setComment( $reason );
3596 $logEntry->setParameters( array(
3597 '4::target' => $nt->getPrefixedText(),
3598 '5::noredir' => $redirectSuppressed ?
'1': '0',
3601 $formatter = LogFormatter
::newFromEntry( $logEntry );
3602 $formatter->setContext( RequestContext
::newExtraneousContext( $this ) );
3603 $comment = $formatter->getPlainActionText();
3605 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3607 # Truncate for whole multibyte characters.
3608 $comment = $wgContLang->truncate( $comment, 255 );
3610 $oldid = $this->getArticleID();
3611 $latest = $this->getLatestRevID();
3613 $dbw = wfGetDB( DB_MASTER
);
3615 $newpage = WikiPage
::factory( $nt );
3617 if ( $moveOverRedirect ) {
3618 $newid = $nt->getArticleID();
3620 # Delete the old redirect. We don't save it to history since
3621 # by definition if we've got here it's rather uninteresting.
3622 # We have to remove it so that the next step doesn't trigger
3623 # a conflict on the unique namespace+title index...
3624 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__
);
3626 $newpage->doDeleteUpdates( $newid );
3629 # Save a null revision in the page's history notifying of the move
3630 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
3631 if ( !is_object( $nullRevision ) ) {
3632 throw new MWException( 'No valid null revision produced in ' . __METHOD__
);
3634 $nullRevId = $nullRevision->insertOn( $dbw );
3636 # Change the name of the target page:
3637 $dbw->update( 'page',
3639 'page_namespace' => $nt->getNamespace(),
3640 'page_title' => $nt->getDBkey(),
3642 /* WHERE */ array( 'page_id' => $oldid ),
3646 $this->resetArticleID( 0 );
3647 $nt->resetArticleID( $oldid );
3649 $newpage->updateRevisionOn( $dbw, $nullRevision );
3651 wfRunHooks( 'NewRevisionFromEditComplete',
3652 array( $newpage, $nullRevision, $latest, $wgUser ) );
3654 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3656 # Recreate the redirect, this time in the other direction.
3657 if ( $redirectSuppressed ) {
3658 WikiPage
::onArticleDelete( $this );
3660 $mwRedir = MagicWord
::get( 'redirect' );
3661 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3662 $redirectArticle = WikiPage
::factory( $this );
3663 $newid = $redirectArticle->insertOn( $dbw );
3664 if ( $newid ) { // sanity
3665 $redirectRevision = new Revision( array(
3667 'comment' => $comment,
3668 'text' => $redirectText ) );
3669 $redirectRevision->insertOn( $dbw );
3670 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3672 wfRunHooks( 'NewRevisionFromEditComplete',
3673 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3675 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3680 $logid = $logEntry->insert();
3681 $logEntry->publish( $logid );
3685 * Move this page's subpages to be subpages of $nt
3687 * @param $nt Title Move target
3688 * @param $auth bool Whether $wgUser's permissions should be checked
3689 * @param $reason string The reason for the move
3690 * @param $createRedirect bool Whether to create redirects from the old subpages to
3691 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3692 * @return mixed array with old page titles as keys, and strings (new page titles) or
3693 * arrays (errors) as values, or an error array with numeric indices if no pages
3696 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3697 global $wgMaximumMovedPages;
3698 // Check permissions
3699 if ( !$this->userCan( 'move-subpages' ) ) {
3700 return array( 'cant-move-subpages' );
3702 // Do the source and target namespaces support subpages?
3703 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3704 return array( 'namespace-nosubpages',
3705 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3707 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3708 return array( 'namespace-nosubpages',
3709 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3712 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3715 foreach ( $subpages as $oldSubpage ) {
3717 if ( $count > $wgMaximumMovedPages ) {
3718 $retval[$oldSubpage->getPrefixedTitle()] =
3719 array( 'movepage-max-pages',
3720 $wgMaximumMovedPages );
3724 // We don't know whether this function was called before
3725 // or after moving the root page, so check both
3727 if ( $oldSubpage->getArticleId() == $this->getArticleId() ||
3728 $oldSubpage->getArticleID() == $nt->getArticleId() )
3730 // When moving a page to a subpage of itself,
3731 // don't move it twice
3734 $newPageName = preg_replace(
3735 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3736 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3737 $oldSubpage->getDBkey() );
3738 if ( $oldSubpage->isTalkPage() ) {
3739 $newNs = $nt->getTalkPage()->getNamespace();
3741 $newNs = $nt->getSubjectPage()->getNamespace();
3743 # Bug 14385: we need makeTitleSafe because the new page names may
3744 # be longer than 255 characters.
3745 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3747 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3748 if ( $success === true ) {
3749 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3751 $retval[$oldSubpage->getPrefixedText()] = $success;
3758 * Checks if this page is just a one-rev redirect.
3759 * Adds lock, so don't use just for light purposes.
3763 public function isSingleRevRedirect() {
3764 $dbw = wfGetDB( DB_MASTER
);
3766 $row = $dbw->selectRow( 'page',
3767 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3770 array( 'FOR UPDATE' )
3772 # Cache some fields we may want
3773 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3774 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3775 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3776 if ( !$this->mRedirect
) {
3779 # Does the article have a history?
3780 $row = $dbw->selectField( array( 'page', 'revision' ),
3782 array( 'page_namespace' => $this->getNamespace(),
3783 'page_title' => $this->getDBkey(),
3785 'page_latest != rev_id'
3788 array( 'FOR UPDATE' )
3790 # Return true if there was no history
3791 return ( $row === false );
3795 * Checks if $this can be moved to a given Title
3796 * - Selects for update, so don't call it unless you mean business
3798 * @param $nt Title the new title to check
3801 public function isValidMoveTarget( $nt ) {
3802 # Is it an existing file?
3803 if ( $nt->getNamespace() == NS_FILE
) {
3804 $file = wfLocalFile( $nt );
3805 if ( $file->exists() ) {
3806 wfDebug( __METHOD__
. ": file exists\n" );
3810 # Is it a redirect with no history?
3811 if ( !$nt->isSingleRevRedirect() ) {
3812 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3815 # Get the article text
3816 $rev = Revision
::newFromTitle( $nt );
3817 if( !is_object( $rev ) ){
3820 $text = $rev->getText();
3821 # Does the redirect point to the source?
3822 # Or is it a broken self-redirect, usually caused by namespace collisions?
3824 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3825 $redirTitle = Title
::newFromText( $m[1] );
3826 if ( !is_object( $redirTitle ) ||
3827 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3828 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3829 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3834 wfDebug( __METHOD__
. ": failsafe\n" );
3841 * Get categories to which this Title belongs and return an array of
3842 * categories' names.
3844 * @return Array of parents in the form:
3845 * $parent => $currentarticle
3847 public function getParentCategories() {
3852 $titleKey = $this->getArticleId();
3854 if ( $titleKey === 0 ) {
3858 $dbr = wfGetDB( DB_SLAVE
);
3860 $res = $dbr->select( 'categorylinks', '*',
3862 'cl_from' => $titleKey,
3868 if ( $dbr->numRows( $res ) > 0 ) {
3869 foreach ( $res as $row ) {
3870 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3871 $data[$wgContLang->getNSText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3878 * Get a tree of parent categories
3880 * @param $children Array with the children in the keys, to check for circular refs
3881 * @return Array Tree of parent categories
3883 public function getParentCategoryTree( $children = array() ) {
3885 $parents = $this->getParentCategories();
3888 foreach ( $parents as $parent => $current ) {
3889 if ( array_key_exists( $parent, $children ) ) {
3890 # Circular reference
3891 $stack[$parent] = array();
3893 $nt = Title
::newFromText( $parent );
3895 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3905 * Get an associative array for selecting this title from
3908 * @return Array suitable for the $where parameter of DB::select()
3910 public function pageCond() {
3911 if ( $this->mArticleID
> 0 ) {
3912 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3913 return array( 'page_id' => $this->mArticleID
);
3915 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3920 * Get the revision ID of the previous revision
3922 * @param $revId Int Revision ID. Get the revision that was before this one.
3923 * @param $flags Int Title::GAID_FOR_UPDATE
3924 * @return Int|Bool Old revision ID, or FALSE if none exists
3926 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3927 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3928 return $db->selectField( 'revision', 'rev_id',
3930 'rev_page' => $this->getArticleId( $flags ),
3931 'rev_id < ' . intval( $revId )
3934 array( 'ORDER BY' => 'rev_id DESC' )
3939 * Get the revision ID of the next revision
3941 * @param $revId Int Revision ID. Get the revision that was after this one.
3942 * @param $flags Int Title::GAID_FOR_UPDATE
3943 * @return Int|Bool Next revision ID, or FALSE if none exists
3945 public function getNextRevisionID( $revId, $flags = 0 ) {
3946 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3947 return $db->selectField( 'revision', 'rev_id',
3949 'rev_page' => $this->getArticleId( $flags ),
3950 'rev_id > ' . intval( $revId )
3953 array( 'ORDER BY' => 'rev_id' )
3958 * Get the first revision of the page
3960 * @param $flags Int Title::GAID_FOR_UPDATE
3961 * @return Revision|Null if page doesn't exist
3963 public function getFirstRevision( $flags = 0 ) {
3964 $pageId = $this->getArticleId( $flags );
3966 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3967 $row = $db->selectRow( 'revision', '*',
3968 array( 'rev_page' => $pageId ),
3970 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3973 return new Revision( $row );
3980 * Get the oldest revision timestamp of this page
3982 * @param $flags Int Title::GAID_FOR_UPDATE
3983 * @return String: MW timestamp
3985 public function getEarliestRevTime( $flags = 0 ) {
3986 $rev = $this->getFirstRevision( $flags );
3987 return $rev ?
$rev->getTimestamp() : null;
3991 * Check if this is a new page
3995 public function isNewPage() {
3996 $dbr = wfGetDB( DB_SLAVE
);
3997 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4001 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4005 public function isBigDeletion() {
4006 global $wgDeleteRevisionsLimit;
4008 if ( !$wgDeleteRevisionsLimit ) {
4012 $revCount = $this->estimateRevisionCount();
4013 return $revCount > $wgDeleteRevisionsLimit;
4017 * Get the approximate revision count of this page.
4021 public function estimateRevisionCount() {
4022 if ( !$this->exists() ) {
4026 if ( $this->mEstimateRevisions
=== null ) {
4027 $dbr = wfGetDB( DB_SLAVE
);
4028 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4029 array( 'rev_page' => $this->getArticleId() ), __METHOD__
);
4032 return $this->mEstimateRevisions
;
4036 * Get the number of revisions between the given revision.
4037 * Used for diffs and other things that really need it.
4039 * @param $old int|Revision Old revision or rev ID (first before range)
4040 * @param $new int|Revision New revision or rev ID (first after range)
4041 * @return Int Number of revisions between these revisions.
4043 public function countRevisionsBetween( $old, $new ) {
4044 if ( !( $old instanceof Revision
) ) {
4045 $old = Revision
::newFromTitle( $this, (int)$old );
4047 if ( !( $new instanceof Revision
) ) {
4048 $new = Revision
::newFromTitle( $this, (int)$new );
4050 if ( !$old ||
!$new ) {
4051 return 0; // nothing to compare
4053 $dbr = wfGetDB( DB_SLAVE
);
4054 return (int)$dbr->selectField( 'revision', 'count(*)',
4056 'rev_page' => $this->getArticleId(),
4057 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4058 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4065 * Get the number of authors between the given revision IDs.
4066 * Used for diffs and other things that really need it.
4068 * @param $old int|Revision Old revision or rev ID (first before range)
4069 * @param $new int|Revision New revision or rev ID (first after range)
4070 * @param $limit Int Maximum number of authors
4071 * @return Int Number of revision authors between these revisions.
4073 public function countAuthorsBetween( $old, $new, $limit ) {
4074 if ( !( $old instanceof Revision
) ) {
4075 $old = Revision
::newFromTitle( $this, (int)$old );
4077 if ( !( $new instanceof Revision
) ) {
4078 $new = Revision
::newFromTitle( $this, (int)$new );
4080 if ( !$old ||
!$new ) {
4081 return 0; // nothing to compare
4083 $dbr = wfGetDB( DB_SLAVE
);
4084 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4086 'rev_page' => $this->getArticleID(),
4087 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4088 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4090 array( 'LIMIT' => $limit +
1 ) // add one so caller knows it was truncated
4092 return (int)$dbr->numRows( $res );
4096 * Compare with another title.
4098 * @param $title Title
4101 public function equals( Title
$title ) {
4102 // Note: === is necessary for proper matching of number-like titles.
4103 return $this->getInterwiki() === $title->getInterwiki()
4104 && $this->getNamespace() == $title->getNamespace()
4105 && $this->getDBkey() === $title->getDBkey();
4109 * Check if this title is a subpage of another title
4111 * @param $title Title
4114 public function isSubpageOf( Title
$title ) {
4115 return $this->getInterwiki() === $title->getInterwiki()
4116 && $this->getNamespace() == $title->getNamespace()
4117 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4121 * Check if page exists. For historical reasons, this function simply
4122 * checks for the existence of the title in the page table, and will
4123 * thus return false for interwiki links, special pages and the like.
4124 * If you want to know if a title can be meaningfully viewed, you should
4125 * probably call the isKnown() method instead.
4129 public function exists() {
4130 return $this->getArticleId() != 0;
4134 * Should links to this title be shown as potentially viewable (i.e. as
4135 * "bluelinks"), even if there's no record by this title in the page
4138 * This function is semi-deprecated for public use, as well as somewhat
4139 * misleadingly named. You probably just want to call isKnown(), which
4140 * calls this function internally.
4142 * (ISSUE: Most of these checks are cheap, but the file existence check
4143 * can potentially be quite expensive. Including it here fixes a lot of
4144 * existing code, but we might want to add an optional parameter to skip
4145 * it and any other expensive checks.)
4149 public function isAlwaysKnown() {
4150 if ( $this->mInterwiki
!= '' ) {
4151 return true; // any interwiki link might be viewable, for all we know
4153 switch( $this->mNamespace
) {
4156 // file exists, possibly in a foreign repo
4157 return (bool)wfFindFile( $this );
4159 // valid special page
4160 return SpecialPageFactory
::exists( $this->getDBkey() );
4162 // selflink, possibly with fragment
4163 return $this->mDbkeyform
== '';
4165 // known system message
4166 return $this->hasSourceText() !== false;
4173 * Does this title refer to a page that can (or might) be meaningfully
4174 * viewed? In particular, this function may be used to determine if
4175 * links to the title should be rendered as "bluelinks" (as opposed to
4176 * "redlinks" to non-existent pages).
4180 public function isKnown() {
4181 return $this->isAlwaysKnown() ||
$this->exists();
4185 * Does this page have source text?
4189 public function hasSourceText() {
4190 if ( $this->exists() ) {
4194 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4195 // If the page doesn't exist but is a known system message, default
4196 // message content will be displayed, same for language subpages-
4197 // Use always content language to avoid loading hundreds of languages
4198 // to get the link color.
4200 list( $name, $lang ) = MessageCache
::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4201 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4202 return $message->exists();
4209 * Get the default message text or false if the message doesn't exist
4211 * @return String or false
4213 public function getDefaultMessageText() {
4216 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
4220 list( $name, $lang ) = MessageCache
::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4221 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4223 if ( $message->exists() ) {
4224 return $message->plain();
4231 * Updates page_touched for this page; called from LinksUpdate.php
4233 * @return Bool true if the update succeded
4235 public function invalidateCache() {
4236 if ( wfReadOnly() ) {
4239 $dbw = wfGetDB( DB_MASTER
);
4240 $success = $dbw->update(
4242 array( 'page_touched' => $dbw->timestamp() ),
4246 HTMLFileCache
::clearFileCache( $this );
4251 * Update page_touched timestamps and send squid purge messages for
4252 * pages linking to this title. May be sent to the job queue depending
4253 * on the number of links. Typically called on create and delete.
4255 public function touchLinks() {
4256 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4259 if ( $this->getNamespace() == NS_CATEGORY
) {
4260 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4266 * Get the last touched timestamp
4268 * @param $db DatabaseBase: optional db
4269 * @return String last-touched timestamp
4271 public function getTouched( $db = null ) {
4272 $db = isset( $db ) ?
$db : wfGetDB( DB_SLAVE
);
4273 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4278 * Get the timestamp when this page was updated since the user last saw it.
4281 * @return String|Null
4283 public function getNotificationTimestamp( $user = null ) {
4284 global $wgUser, $wgShowUpdatedMarker;
4285 // Assume current user if none given
4289 // Check cache first
4290 $uid = $user->getId();
4291 // avoid isset here, as it'll return false for null entries
4292 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4293 return $this->mNotificationTimestamp
[$uid];
4295 if ( !$uid ||
!$wgShowUpdatedMarker ) {
4296 return $this->mNotificationTimestamp
[$uid] = false;
4298 // Don't cache too much!
4299 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4300 $this->mNotificationTimestamp
= array();
4302 $dbr = wfGetDB( DB_SLAVE
);
4303 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
4304 'wl_notificationtimestamp',
4305 array( 'wl_namespace' => $this->getNamespace(),
4306 'wl_title' => $this->getDBkey(),
4307 'wl_user' => $user->getId()
4311 return $this->mNotificationTimestamp
[$uid];
4315 * Generate strings used for xml 'id' names in monobook tabs
4317 * @param $prepend string defaults to 'nstab-'
4318 * @return String XML 'id' name
4320 public function getNamespaceKey( $prepend = 'nstab-' ) {
4322 // Gets the subject namespace if this title
4323 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4324 // Checks if cononical namespace name exists for namespace
4325 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4326 // Uses canonical namespace name
4327 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4329 // Uses text of namespace
4330 $namespaceKey = $this->getSubjectNsText();
4332 // Makes namespace key lowercase
4333 $namespaceKey = $wgContLang->lc( $namespaceKey );
4335 if ( $namespaceKey == '' ) {
4336 $namespaceKey = 'main';
4338 // Changes file to image for backwards compatibility
4339 if ( $namespaceKey == 'file' ) {
4340 $namespaceKey = 'image';
4342 return $prepend . $namespaceKey;
4346 * Get all extant redirects to this Title
4348 * @param $ns Int|Null Single namespace to consider; NULL to consider all namespaces
4349 * @return Array of Title redirects to this title
4351 public function getRedirectsHere( $ns = null ) {
4354 $dbr = wfGetDB( DB_SLAVE
);
4356 'rd_namespace' => $this->getNamespace(),
4357 'rd_title' => $this->getDBkey(),
4360 if ( !is_null( $ns ) ) {
4361 $where['page_namespace'] = $ns;
4364 $res = $dbr->select(
4365 array( 'redirect', 'page' ),
4366 array( 'page_namespace', 'page_title' ),
4371 foreach ( $res as $row ) {
4372 $redirs[] = self
::newFromRow( $row );
4378 * Check if this Title is a valid redirect target
4382 public function isValidRedirectTarget() {
4383 global $wgInvalidRedirectTargets;
4385 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4386 if ( $this->isSpecial( 'Userlogout' ) ) {
4390 foreach ( $wgInvalidRedirectTargets as $target ) {
4391 if ( $this->isSpecial( $target ) ) {
4400 * Get a backlink cache object
4402 * @return BacklinkCache
4404 function getBacklinkCache() {
4405 if ( is_null( $this->mBacklinkCache
) ) {
4406 $this->mBacklinkCache
= new BacklinkCache( $this );
4408 return $this->mBacklinkCache
;
4412 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4416 public function canUseNoindex() {
4417 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4419 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4420 ?
$wgContentNamespaces
4421 : $wgExemptFromUserRobotsControl;
4423 return !in_array( $this->mNamespace
, $bannedNamespaces );
4428 * Returns the raw sort key to be used for categories, with the specified
4429 * prefix. This will be fed to Collation::getSortKey() to get a
4430 * binary sortkey that can be used for actual sorting.
4432 * @param $prefix string The prefix to be used, specified using
4433 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4437 public function getCategorySortkey( $prefix = '' ) {
4438 $unprefixed = $this->getText();
4440 // Anything that uses this hook should only depend
4441 // on the Title object passed in, and should probably
4442 // tell the users to run updateCollations.php --force
4443 // in order to re-sort existing category relations.
4444 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4445 if ( $prefix !== '' ) {
4446 # Separate with a line feed, so the unprefixed part is only used as
4447 # a tiebreaker when two pages have the exact same prefix.
4448 # In UCA, tab is the only character that can sort above LF
4449 # so we strip both of them from the original prefix.
4450 $prefix = strtr( $prefix, "\n\t", ' ' );
4451 return "$prefix\n$unprefixed";
4457 * Get the language in which the content of this page is written.
4458 * Defaults to $wgContLang, but in certain cases it can be e.g.
4459 * $wgLang (such as special pages, which are in the user language).
4462 * @return object Language
4464 public function getPageLanguage() {
4466 if ( $this->isSpecialPage() ) {
4467 // special pages are in the user language
4469 } elseif ( $this->isCssOrJsPage() ) {
4470 // css/js should always be LTR and is, in fact, English
4471 return wfGetLangObj( 'en' );
4472 } elseif ( $this->getNamespace() == NS_MEDIAWIKI
) {
4473 // Parse mediawiki messages with correct target language
4474 list( /* $unused */, $lang ) = MessageCache
::singleton()->figureMessage( $this->getText() );
4475 return wfGetLangObj( $lang );
4478 // If nothing special, it should be in the wiki content language
4479 $pageLang = $wgContLang;
4480 // Hook at the end because we don't want to override the above stuff
4481 wfRunHooks( 'PageContentLanguage', array( $this, &$pageLang, $wgLang ) );
4482 return wfGetLangObj( $pageLang );