3 * Representation a title within %MediaWiki.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
26 * Represents a title within MediaWiki.
27 * Optionally may contain an interwiki designation or namespace.
28 * @note This class can fetch various kinds of data from the database;
29 * however, it does so inefficiently.
31 * @internal documentation reviewed 15 Mar 2010
34 /** @name Static cache variables */
36 static private $titleCache = array();
40 * Title::newFromText maintains a cache to avoid expensive re-normalization of
41 * commonly used titles. On a batch operation this can become a memory leak
42 * if not bounded. After hitting this many titles reset the cache.
44 const CACHE_MAX
= 1000;
47 * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends
48 * to use the master DB
50 const GAID_FOR_UPDATE
= 1;
53 * @name Private member variables
54 * Please use the accessor functions instead.
59 var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
60 var $mUrlform = ''; // /< URL-encoded form of the main part
61 var $mDbkeyform = ''; // /< Main part with underscores
62 var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
63 var $mNamespace = NS_MAIN
; // /< Namespace index, i.e. one of the NS_xxxx constants
64 var $mInterwiki = ''; // /< Interwiki prefix (or null string)
65 var $mFragment; // /< Title fragment (i.e. the bit after the #)
66 var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
67 var $mLatestID = false; // /< ID of most recent revision
68 private $mEstimateRevisions; // /< Estimated number of revisions; null of not loaded
69 var $mRestrictions = array(); // /< Array of groups allowed to edit this article
70 var $mOldRestrictions = false;
71 var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
72 var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
73 var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
74 var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
75 var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
76 var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
77 var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
78 var $mTitleProtection; ///< Cached value for getTitleProtection (create protection)
79 # Don't change the following default, NS_MAIN is hardcoded in several
80 # places. See bug 696.
81 var $mDefaultNamespace = NS_MAIN
; // /< Namespace index when there is no namespace
82 # Zero except in {{transclusion}} tags
83 var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
84 var $mLength = -1; // /< The page length, 0 for special pages
85 var $mRedirect = null; // /< Is the article at this title a redirect?
86 var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
87 var $mBacklinkCache = null; // /< Cache of links to this title
88 var $mHasSubpage; // /< Whether a page has any subpages
95 /*protected*/ function __construct() { }
98 * Create a new Title from a prefixed DB key
100 * @param $key String the database key, which has underscores
101 * instead of spaces, possibly including namespace and
103 * @return Title, or NULL on an error
105 public static function newFromDBkey( $key ) {
107 $t->mDbkeyform
= $key;
108 if ( $t->secureAndSplit() ) {
116 * Create a new Title from text, such as what one would find in a link. De-
117 * codes any HTML entities in the text.
119 * @param $text String the link text; spaces, prefixes, and an
120 * initial ':' indicating the main namespace are accepted.
121 * @param $defaultNamespace Int the namespace to use if none is speci-
122 * fied by a prefix. If you want to force a specific namespace even if
123 * $text might begin with a namespace prefix, use makeTitle() or
125 * @throws MWException
126 * @return Title|null - Title or null on an error.
128 public static function newFromText( $text, $defaultNamespace = NS_MAIN
) {
129 if ( is_object( $text ) ) {
130 throw new MWException( 'Title::newFromText given an object' );
134 * Wiki pages often contain multiple links to the same page.
135 * Title normalization and parsing can become expensive on
136 * pages with many links, so we can save a little time by
139 * In theory these are value objects and won't get changed...
141 if ( $defaultNamespace == NS_MAIN
&& isset( Title
::$titleCache[$text] ) ) {
142 return Title
::$titleCache[$text];
145 # Convert things like é ā or 〗 into normalized (bug 14952) text
146 $filteredText = Sanitizer
::decodeCharReferencesAndNormalize( $text );
149 $t->mDbkeyform
= str_replace( ' ', '_', $filteredText );
150 $t->mDefaultNamespace
= $defaultNamespace;
152 static $cachedcount = 0 ;
153 if ( $t->secureAndSplit() ) {
154 if ( $defaultNamespace == NS_MAIN
) {
155 if ( $cachedcount >= self
::CACHE_MAX
) {
156 # Avoid memory leaks on mass operations...
157 Title
::$titleCache = array();
161 Title
::$titleCache[$text] =& $t;
171 * THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
173 * Example of wrong and broken code:
174 * $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
176 * Example of right code:
177 * $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
179 * Create a new Title from URL-encoded text. Ensures that
180 * the given title's length does not exceed the maximum.
182 * @param $url String the title, as might be taken from a URL
183 * @return Title the new object, or NULL on an error
185 public static function newFromURL( $url ) {
188 # For compatibility with old buggy URLs. "+" is usually not valid in titles,
189 # but some URLs used it as a space replacement and they still come
190 # from some external search tools.
191 if ( strpos( self
::legalChars(), '+' ) === false ) {
192 $url = str_replace( '+', ' ', $url );
195 $t->mDbkeyform
= str_replace( ' ', '_', $url );
196 if ( $t->secureAndSplit() ) {
204 * Create a new Title from an article ID
206 * @param $id Int the page_id corresponding to the Title to create
207 * @param $flags Int use Title::GAID_FOR_UPDATE to use master
208 * @return Title the new object, or NULL on an error
210 public static function newFromID( $id, $flags = 0 ) {
211 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
212 $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__
);
213 if ( $row !== false ) {
214 $title = Title
::newFromRow( $row );
222 * Make an array of titles from an array of IDs
224 * @param $ids Array of Int Array of IDs
225 * @return Array of Titles
227 public static function newFromIDs( $ids ) {
228 if ( !count( $ids ) ) {
231 $dbr = wfGetDB( DB_SLAVE
);
236 'page_namespace', 'page_title', 'page_id',
237 'page_len', 'page_is_redirect', 'page_latest',
239 array( 'page_id' => $ids ),
244 foreach ( $res as $row ) {
245 $titles[] = Title
::newFromRow( $row );
251 * Make a Title object from a DB row
253 * @param $row Object database row (needs at least page_title,page_namespace)
254 * @return Title corresponding Title
256 public static function newFromRow( $row ) {
257 $t = self
::makeTitle( $row->page_namespace
, $row->page_title
);
258 $t->loadFromRow( $row );
263 * Load Title object fields from a DB row.
264 * If false is given, the title will be treated as non-existing.
266 * @param $row Object|bool database row
268 public function loadFromRow( $row ) {
269 if ( $row ) { // page found
270 if ( isset( $row->page_id
) )
271 $this->mArticleID
= (int)$row->page_id
;
272 if ( isset( $row->page_len
) )
273 $this->mLength
= (int)$row->page_len
;
274 if ( isset( $row->page_is_redirect
) )
275 $this->mRedirect
= (bool)$row->page_is_redirect
;
276 if ( isset( $row->page_latest
) )
277 $this->mLatestID
= (int)$row->page_latest
;
278 } else { // page not found
279 $this->mArticleID
= 0;
281 $this->mRedirect
= false;
282 $this->mLatestID
= 0;
287 * Create a new Title from a namespace index and a DB key.
288 * It's assumed that $ns and $title are *valid*, for instance when
289 * they came directly from the database or a special page name.
290 * For convenience, spaces are converted to underscores so that
291 * eg user_text fields can be used directly.
293 * @param $ns Int the namespace of the article
294 * @param $title String the unprefixed database key form
295 * @param $fragment String the link fragment (after the "#")
296 * @param $interwiki String the interwiki prefix
297 * @return Title the new object
299 public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) {
301 $t->mInterwiki
= $interwiki;
302 $t->mFragment
= $fragment;
303 $t->mNamespace
= $ns = intval( $ns );
304 $t->mDbkeyform
= str_replace( ' ', '_', $title );
305 $t->mArticleID
= ( $ns >= 0 ) ?
-1 : 0;
306 $t->mUrlform
= wfUrlencode( $t->mDbkeyform
);
307 $t->mTextform
= str_replace( '_', ' ', $title );
312 * Create a new Title from a namespace index and a DB key.
313 * The parameters will be checked for validity, which is a bit slower
314 * than makeTitle() but safer for user-provided data.
316 * @param $ns Int the namespace of the article
317 * @param $title String database key form
318 * @param $fragment String the link fragment (after the "#")
319 * @param $interwiki String interwiki prefix
320 * @return Title the new object, or NULL on an error
322 public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) {
323 if ( !MWNamespace
::exists( $ns ) ) {
328 $t->mDbkeyform
= Title
::makeName( $ns, $title, $fragment, $interwiki );
329 if ( $t->secureAndSplit() ) {
337 * Create a new Title for the Main Page
339 * @return Title the new object
341 public static function newMainPage() {
342 $title = Title
::newFromText( wfMsgForContent( 'mainpage' ) );
343 // Don't give fatal errors if the message is broken
345 $title = Title
::newFromText( 'Main Page' );
351 * Extract a redirect destination from a string and return the
352 * Title, or null if the text doesn't contain a valid redirect
353 * This will only return the very next target, useful for
354 * the redirect table and other checks that don't need full recursion
356 * @param $text String: Text with possible redirect
357 * @return Title: The corresponding Title
359 public static function newFromRedirect( $text ) {
360 return self
::newFromRedirectInternal( $text );
364 * Extract a redirect destination from a string and return the
365 * Title, or null if the text doesn't contain a valid redirect
366 * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit
367 * in order to provide (hopefully) the Title of the final destination instead of another redirect
369 * @param $text String Text with possible redirect
372 public static function newFromRedirectRecurse( $text ) {
373 $titles = self
::newFromRedirectArray( $text );
374 return $titles ?
array_pop( $titles ) : null;
378 * Extract a redirect destination from a string and return an
379 * array of Titles, or null if the text doesn't contain a valid redirect
380 * The last element in the array is the final destination after all redirects
381 * have been resolved (up to $wgMaxRedirects times)
383 * @param $text String Text with possible redirect
384 * @return Array of Titles, with the destination last
386 public static function newFromRedirectArray( $text ) {
387 global $wgMaxRedirects;
388 $title = self
::newFromRedirectInternal( $text );
389 if ( is_null( $title ) ) {
392 // recursive check to follow double redirects
393 $recurse = $wgMaxRedirects;
394 $titles = array( $title );
395 while ( --$recurse > 0 ) {
396 if ( $title->isRedirect() ) {
397 $page = WikiPage
::factory( $title );
398 $newtitle = $page->getRedirectTarget();
402 // Redirects to some special pages are not permitted
403 if ( $newtitle instanceOf Title
&& $newtitle->isValidRedirectTarget() ) {
404 // the new title passes the checks, so make that our current title so that further recursion can be checked
406 $titles[] = $newtitle;
415 * Really extract the redirect destination
416 * Do not call this function directly, use one of the newFromRedirect* functions above
418 * @param $text String Text with possible redirect
421 protected static function newFromRedirectInternal( $text ) {
422 global $wgMaxRedirects;
423 if ( $wgMaxRedirects < 1 ) {
424 //redirects are disabled, so quit early
427 $redir = MagicWord
::get( 'redirect' );
428 $text = trim( $text );
429 if ( $redir->matchStartAndRemove( $text ) ) {
430 // Extract the first link and see if it's usable
431 // Ensure that it really does come directly after #REDIRECT
432 // Some older redirects included a colon, so don't freak about that!
434 if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
435 // Strip preceding colon used to "escape" categories, etc.
436 // and URL-decode links
437 if ( strpos( $m[1], '%' ) !== false ) {
438 // Match behavior of inline link parsing here;
439 $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
441 $title = Title
::newFromText( $m[1] );
442 // If the title is a redirect to bad special pages or is invalid, return null
443 if ( !$title instanceof Title ||
!$title->isValidRedirectTarget() ) {
453 * Get the prefixed DB key associated with an ID
455 * @param $id Int the page_id of the article
456 * @return Title an object representing the article, or NULL if no such article was found
458 public static function nameOf( $id ) {
459 $dbr = wfGetDB( DB_SLAVE
);
461 $s = $dbr->selectRow(
463 array( 'page_namespace', 'page_title' ),
464 array( 'page_id' => $id ),
467 if ( $s === false ) {
471 $n = self
::makeName( $s->page_namespace
, $s->page_title
);
476 * Get a regex character class describing the legal characters in a link
478 * @return String the list of characters, not delimited
480 public static function legalChars() {
481 global $wgLegalTitleChars;
482 return $wgLegalTitleChars;
486 * Returns a simple regex that will match on characters and sequences invalid in titles.
487 * Note that this doesn't pick up many things that could be wrong with titles, but that
488 * replacing this regex with something valid will make many titles valid.
490 * @return String regex string
492 static function getTitleInvalidRegex() {
493 static $rxTc = false;
495 # Matching titles will be held as illegal.
497 # Any character not allowed is forbidden...
498 '[^' . self
::legalChars() . ']' .
499 # URL percent encoding sequences interfere with the ability
500 # to round-trip titles -- you can't link to them consistently.
502 # XML/HTML character references produce similar issues.
503 '|&[A-Za-z0-9\x80-\xff]+;' .
505 '|&#x[0-9A-Fa-f]+;' .
513 * Get a string representation of a title suitable for
514 * including in a search index
516 * @param $ns Int a namespace index
517 * @param $title String text-form main part
518 * @return String a stripped-down title string ready for the search index
520 public static function indexTitle( $ns, $title ) {
523 $lc = SearchEngine
::legalSearchChars() . '&#;';
524 $t = $wgContLang->normalizeForSearch( $title );
525 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
526 $t = $wgContLang->lc( $t );
529 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
530 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
532 $t = preg_replace( "/\\s+/", ' ', $t );
534 if ( $ns == NS_FILE
) {
535 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
541 * Make a prefixed DB key from a DB key and a namespace index
543 * @param $ns Int numerical representation of the namespace
544 * @param $title String the DB key form the title
545 * @param $fragment String The link fragment (after the "#")
546 * @param $interwiki String The interwiki prefix
547 * @return String the prefixed form of the title
549 public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) {
552 $namespace = $wgContLang->getNsText( $ns );
553 $name = $namespace == '' ?
$title : "$namespace:$title";
554 if ( strval( $interwiki ) != '' ) {
555 $name = "$interwiki:$name";
557 if ( strval( $fragment ) != '' ) {
558 $name .= '#' . $fragment;
564 * Escape a text fragment, say from a link, for a URL
566 * @param $fragment string containing a URL or link fragment (after the "#")
567 * @return String: escaped string
569 static function escapeFragmentForURL( $fragment ) {
570 # Note that we don't urlencode the fragment. urlencoded Unicode
571 # fragments appear not to work in IE (at least up to 7) or in at least
572 # one version of Opera 9.x. The W3C validator, for one, doesn't seem
573 # to care if they aren't encoded.
574 return Sanitizer
::escapeId( $fragment, 'noninitial' );
578 * Callback for usort() to do title sorts by (namespace, title)
583 * @return Integer: result of string comparison, or namespace comparison
585 public static function compare( $a, $b ) {
586 if ( $a->getNamespace() == $b->getNamespace() ) {
587 return strcmp( $a->getText(), $b->getText() );
589 return $a->getNamespace() - $b->getNamespace();
594 * Determine whether the object refers to a page within
597 * @return Bool TRUE if this is an in-project interwiki link or a wikilink, FALSE otherwise
599 public function isLocal() {
600 if ( $this->mInterwiki
!= '' ) {
601 return Interwiki
::fetch( $this->mInterwiki
)->isLocal();
608 * Is this Title interwiki?
612 public function isExternal() {
613 return ( $this->mInterwiki
!= '' );
617 * Get the interwiki prefix (or null string)
619 * @return String Interwiki prefix
621 public function getInterwiki() {
622 return $this->mInterwiki
;
626 * Determine whether the object refers to a page within
627 * this project and is transcludable.
629 * @return Bool TRUE if this is transcludable
631 public function isTrans() {
632 if ( $this->mInterwiki
== '' ) {
636 return Interwiki
::fetch( $this->mInterwiki
)->isTranscludable();
640 * Returns the DB name of the distant wiki which owns the object.
642 * @return String the DB name
644 public function getTransWikiID() {
645 if ( $this->mInterwiki
== '' ) {
649 return Interwiki
::fetch( $this->mInterwiki
)->getWikiID();
653 * Get the text form (spaces not underscores) of the main part
655 * @return String Main part of the title
657 public function getText() {
658 return $this->mTextform
;
662 * Get the URL-encoded form of the main part
664 * @return String Main part of the title, URL-encoded
666 public function getPartialURL() {
667 return $this->mUrlform
;
671 * Get the main part with underscores
673 * @return String: Main part of the title, with underscores
675 public function getDBkey() {
676 return $this->mDbkeyform
;
680 * Get the DB key with the initial letter case as specified by the user
682 * @return String DB key
684 function getUserCaseDBKey() {
685 return $this->mUserCaseDBKey
;
689 * Get the namespace index, i.e. one of the NS_xxxx constants.
691 * @return Integer: Namespace index
693 public function getNamespace() {
694 return $this->mNamespace
;
698 * Get the namespace text
700 * @return String: Namespace text
702 public function getNsText() {
705 if ( $this->mInterwiki
!= '' ) {
706 // This probably shouldn't even happen. ohh man, oh yuck.
707 // But for interwiki transclusion it sometimes does.
708 // Shit. Shit shit shit.
710 // Use the canonical namespaces if possible to try to
711 // resolve a foreign namespace.
712 if ( MWNamespace
::exists( $this->mNamespace
) ) {
713 return MWNamespace
::getCanonicalName( $this->mNamespace
);
717 if ( $wgContLang->needsGenderDistinction() &&
718 MWNamespace
::hasGenderDistinction( $this->mNamespace
) ) {
719 $gender = GenderCache
::singleton()->getGenderOf( $this->getText(), __METHOD__
);
720 return $wgContLang->getGenderNsText( $this->mNamespace
, $gender );
723 return $wgContLang->getNsText( $this->mNamespace
);
727 * Get the namespace text of the subject (rather than talk) page
729 * @return String Namespace text
731 public function getSubjectNsText() {
733 return $wgContLang->getNsText( MWNamespace
::getSubject( $this->mNamespace
) );
737 * Get the namespace text of the talk page
739 * @return String Namespace text
741 public function getTalkNsText() {
743 return( $wgContLang->getNsText( MWNamespace
::getTalk( $this->mNamespace
) ) );
747 * Could this title have a corresponding talk page?
749 * @return Bool TRUE or FALSE
751 public function canTalk() {
752 return( MWNamespace
::canTalk( $this->mNamespace
) );
756 * Is this in a namespace that allows actual pages?
759 * @internal note -- uses hardcoded namespace index instead of constants
761 public function canExist() {
762 return $this->mNamespace
>= NS_MAIN
;
766 * Can this title be added to a user's watchlist?
768 * @return Bool TRUE or FALSE
770 public function isWatchable() {
771 return !$this->isExternal() && MWNamespace
::isWatchable( $this->getNamespace() );
775 * Returns true if this is a special page.
779 public function isSpecialPage() {
780 return $this->getNamespace() == NS_SPECIAL
;
784 * Returns true if this title resolves to the named special page
786 * @param $name String The special page name
789 public function isSpecial( $name ) {
790 if ( $this->isSpecialPage() ) {
791 list( $thisName, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $this->getDBkey() );
792 if ( $name == $thisName ) {
800 * If the Title refers to a special page alias which is not the local default, resolve
801 * the alias, and localise the name as necessary. Otherwise, return $this
805 public function fixSpecialName() {
806 if ( $this->isSpecialPage() ) {
807 list( $canonicalName, $par ) = SpecialPageFactory
::resolveAlias( $this->mDbkeyform
);
808 if ( $canonicalName ) {
809 $localName = SpecialPageFactory
::getLocalNameFor( $canonicalName, $par );
810 if ( $localName != $this->mDbkeyform
) {
811 return Title
::makeTitle( NS_SPECIAL
, $localName );
819 * Returns true if the title is inside the specified namespace.
821 * Please make use of this instead of comparing to getNamespace()
822 * This function is much more resistant to changes we may make
823 * to namespaces than code that makes direct comparisons.
824 * @param $ns int The namespace
828 public function inNamespace( $ns ) {
829 return MWNamespace
::equals( $this->getNamespace(), $ns );
833 * Returns true if the title is inside one of the specified namespaces.
835 * @param ...$namespaces The namespaces to check for
839 public function inNamespaces( /* ... */ ) {
840 $namespaces = func_get_args();
841 if ( count( $namespaces ) > 0 && is_array( $namespaces[0] ) ) {
842 $namespaces = $namespaces[0];
845 foreach ( $namespaces as $ns ) {
846 if ( $this->inNamespace( $ns ) ) {
855 * Returns true if the title has the same subject namespace as the
856 * namespace specified.
857 * For example this method will take NS_USER and return true if namespace
858 * is either NS_USER or NS_USER_TALK since both of them have NS_USER
859 * as their subject namespace.
861 * This is MUCH simpler than individually testing for equivilance
862 * against both NS_USER and NS_USER_TALK, and is also forward compatible.
867 public function hasSubjectNamespace( $ns ) {
868 return MWNamespace
::subjectEquals( $this->getNamespace(), $ns );
872 * Is this Title in a namespace which contains content?
873 * In other words, is this a content page, for the purposes of calculating
878 public function isContentPage() {
879 return MWNamespace
::isContent( $this->getNamespace() );
883 * Would anybody with sufficient privileges be able to move this page?
884 * Some pages just aren't movable.
886 * @return Bool TRUE or FALSE
888 public function isMovable() {
889 if ( !MWNamespace
::isMovable( $this->getNamespace() ) ||
$this->getInterwiki() != '' ) {
890 // Interwiki title or immovable namespace. Hooks don't get to override here
895 wfRunHooks( 'TitleIsMovable', array( $this, &$result ) );
900 * Is this the mainpage?
901 * @note Title::newFromText seams to be sufficiently optimized by the title
902 * cache that we don't need to over-optimize by doing direct comparisons and
903 * acidentally creating new bugs where $title->equals( Title::newFromText() )
904 * ends up reporting something differently than $title->isMainPage();
909 public function isMainPage() {
910 return $this->equals( Title
::newMainPage() );
918 public function isSubpage() {
919 return MWNamespace
::hasSubpages( $this->mNamespace
)
920 ?
strpos( $this->getText(), '/' ) !== false
925 * Is this a conversion table for the LanguageConverter?
929 public function isConversionTable() {
930 return $this->getNamespace() == NS_MEDIAWIKI
&&
931 strpos( $this->getText(), 'Conversiontable' ) !== false;
935 * Does that page contain wikitext, or it is JS, CSS or whatever?
939 public function isWikitextPage() {
940 $retval = !$this->isCssOrJsPage() && !$this->isCssJsSubpage();
941 wfRunHooks( 'TitleIsWikitextPage', array( $this, &$retval ) );
946 * Could this page contain custom CSS or JavaScript, based
951 public function isCssOrJsPage() {
952 $retval = $this->mNamespace
== NS_MEDIAWIKI
953 && preg_match( '!\.(?:css|js)$!u', $this->mTextform
) > 0;
954 wfRunHooks( 'TitleIsCssOrJsPage', array( $this, &$retval ) );
959 * Is this a .css or .js subpage of a user page?
962 public function isCssJsSubpage() {
963 return ( NS_USER
== $this->mNamespace
and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform
) );
967 * Trim down a .css or .js subpage title to get the corresponding skin name
969 * @return string containing skin name from .css or .js subpage title
971 public function getSkinFromCssJsSubpage() {
972 $subpage = explode( '/', $this->mTextform
);
973 $subpage = $subpage[ count( $subpage ) - 1 ];
974 $lastdot = strrpos( $subpage, '.' );
975 if ( $lastdot === false )
976 return $subpage; # Never happens: only called for names ending in '.css' or '.js'
977 return substr( $subpage, 0, $lastdot );
981 * Is this a .css subpage of a user page?
985 public function isCssSubpage() {
986 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.css$/", $this->mTextform
) );
990 * Is this a .js subpage of a user page?
994 public function isJsSubpage() {
995 return ( NS_USER
== $this->mNamespace
&& preg_match( "/\\/.*\\.js$/", $this->mTextform
) );
999 * Is this a talk page of some sort?
1003 public function isTalkPage() {
1004 return MWNamespace
::isTalk( $this->getNamespace() );
1008 * Get a Title object associated with the talk page of this article
1010 * @return Title the object for the talk page
1012 public function getTalkPage() {
1013 return Title
::makeTitle( MWNamespace
::getTalk( $this->getNamespace() ), $this->getDBkey() );
1017 * Get a title object associated with the subject page of this
1020 * @return Title the object for the subject page
1022 public function getSubjectPage() {
1023 // Is this the same title?
1024 $subjectNS = MWNamespace
::getSubject( $this->getNamespace() );
1025 if ( $this->getNamespace() == $subjectNS ) {
1028 return Title
::makeTitle( $subjectNS, $this->getDBkey() );
1032 * Get the default namespace index, for when there is no namespace
1034 * @return Int Default namespace index
1036 public function getDefaultNamespace() {
1037 return $this->mDefaultNamespace
;
1041 * Get title for search index
1043 * @return String a stripped-down title string ready for the
1046 public function getIndexTitle() {
1047 return Title
::indexTitle( $this->mNamespace
, $this->mTextform
);
1051 * Get the Title fragment (i.e.\ the bit after the #) in text form
1053 * @return String Title fragment
1055 public function getFragment() {
1056 return $this->mFragment
;
1060 * Get the fragment in URL form, including the "#" character if there is one
1061 * @return String Fragment in URL form
1063 public function getFragmentForURL() {
1064 if ( $this->mFragment
== '' ) {
1067 return '#' . Title
::escapeFragmentForURL( $this->mFragment
);
1072 * Set the fragment for this title. Removes the first character from the
1073 * specified fragment before setting, so it assumes you're passing it with
1076 * Deprecated for public use, use Title::makeTitle() with fragment parameter.
1077 * Still in active use privately.
1079 * @param $fragment String text
1081 public function setFragment( $fragment ) {
1082 $this->mFragment
= str_replace( '_', ' ', substr( $fragment, 1 ) );
1086 * Prefix some arbitrary text with the namespace or interwiki prefix
1089 * @param $name String the text
1090 * @return String the prefixed text
1093 private function prefix( $name ) {
1095 if ( $this->mInterwiki
!= '' ) {
1096 $p = $this->mInterwiki
. ':';
1099 if ( 0 != $this->mNamespace
) {
1100 $p .= $this->getNsText() . ':';
1106 * Get the prefixed database key form
1108 * @return String the prefixed title, with underscores and
1109 * any interwiki and namespace prefixes
1111 public function getPrefixedDBkey() {
1112 $s = $this->prefix( $this->mDbkeyform
);
1113 $s = str_replace( ' ', '_', $s );
1118 * Get the prefixed title with spaces.
1119 * This is the form usually used for display
1121 * @return String the prefixed title, with spaces
1123 public function getPrefixedText() {
1124 // @todo FIXME: Bad usage of empty() ?
1125 if ( empty( $this->mPrefixedText
) ) {
1126 $s = $this->prefix( $this->mTextform
);
1127 $s = str_replace( '_', ' ', $s );
1128 $this->mPrefixedText
= $s;
1130 return $this->mPrefixedText
;
1134 * Return a string representation of this title
1136 * @return String representation of this title
1138 public function __toString() {
1139 return $this->getPrefixedText();
1143 * Get the prefixed title with spaces, plus any fragment
1144 * (part beginning with '#')
1146 * @return String the prefixed title, with spaces and the fragment, including '#'
1148 public function getFullText() {
1149 $text = $this->getPrefixedText();
1150 if ( $this->mFragment
!= '' ) {
1151 $text .= '#' . $this->mFragment
;
1157 * Get the base page name, i.e. the leftmost part before any slashes
1159 * @return String Base name
1161 public function getBaseText() {
1162 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1163 return $this->getText();
1166 $parts = explode( '/', $this->getText() );
1167 # Don't discard the real title if there's no subpage involved
1168 if ( count( $parts ) > 1 ) {
1169 unset( $parts[count( $parts ) - 1] );
1171 return implode( '/', $parts );
1175 * Get the lowest-level subpage name, i.e. the rightmost part after any slashes
1177 * @return String Subpage name
1179 public function getSubpageText() {
1180 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
1181 return( $this->mTextform
);
1183 $parts = explode( '/', $this->mTextform
);
1184 return( $parts[count( $parts ) - 1] );
1188 * Get the HTML-escaped displayable text form.
1189 * Used for the title field in <a> tags.
1191 * @return String the text, including any prefixes
1193 public function getEscapedText() {
1194 wfDeprecated( __METHOD__
, '1.19' );
1195 return htmlspecialchars( $this->getPrefixedText() );
1199 * Get a URL-encoded form of the subpage text
1201 * @return String URL-encoded subpage name
1203 public function getSubpageUrlForm() {
1204 $text = $this->getSubpageText();
1205 $text = wfUrlencode( str_replace( ' ', '_', $text ) );
1210 * Get a URL-encoded title (not an actual URL) including interwiki
1212 * @return String the URL-encoded form
1214 public function getPrefixedURL() {
1215 $s = $this->prefix( $this->mDbkeyform
);
1216 $s = wfUrlencode( str_replace( ' ', '_', $s ) );
1221 * Helper to fix up the get{Local,Full,Link,Canonical}URL args
1222 * get{Canonical,Full,Link,Local}URL methods accepted an optional
1223 * second argument named variant. This was deprecated in favor
1224 * of passing an array of option with a "variant" key
1225 * Once $query2 is removed for good, this helper can be dropped
1226 * andthe wfArrayToCGI moved to getLocalURL();
1228 * @since 1.19 (r105919)
1230 * @param $query2 bool
1233 private static function fixUrlQueryArgs( $query, $query2 = false ) {
1234 if( $query2 !== false ) {
1235 wfDeprecated( "Title::get{Canonical,Full,Link,Local} method called with a second parameter is deprecated. Add your parameter to an array passed as the first parameter.", "1.19" );
1237 if ( is_array( $query ) ) {
1238 $query = wfArrayToCGI( $query );
1241 if ( is_string( $query2 ) ) {
1242 // $query2 is a string, we will consider this to be
1243 // a deprecated $variant argument and add it to the query
1244 $query2 = wfArrayToCGI( array( 'variant' => $query2 ) );
1246 $query2 = wfArrayToCGI( $query2 );
1248 // If we have $query content add a & to it first
1252 // Now append the queries together
1259 * Get a real URL referring to this title, with interwiki link and
1262 * See getLocalURL for the arguments.
1264 * @see self::getLocalURL
1265 * @return String the URL
1267 public function getFullURL( $query = '', $query2 = false ) {
1268 $query = self
::fixUrlQueryArgs( $query, $query2 );
1270 # Hand off all the decisions on urls to getLocalURL
1271 $url = $this->getLocalURL( $query );
1273 # Expand the url to make it a full url. Note that getLocalURL has the
1274 # potential to output full urls for a variety of reasons, so we use
1275 # wfExpandUrl instead of simply prepending $wgServer
1276 $url = wfExpandUrl( $url, PROTO_RELATIVE
);
1278 # Finally, add the fragment.
1279 $url .= $this->getFragmentForURL();
1281 wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
1286 * Get a URL with no fragment or server name. If this page is generated
1287 * with action=render, $wgServer is prepended.
1290 * @param $query string|array an optional query string,
1291 * not used for interwiki links. Can be specified as an associative array as well,
1292 * e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
1293 * Some query patterns will trigger various shorturl path replacements.
1294 * @param $query2 Mixed: An optional secondary query array. This one MUST
1295 * be an array. If a string is passed it will be interpreted as a deprecated
1296 * variant argument and urlencoded into a variant= argument.
1297 * This second query argument will be added to the $query
1298 * The second parameter is deprecated since 1.19. Pass it as a key,value
1299 * pair in the first parameter array instead.
1301 * @return String the URL
1303 public function getLocalURL( $query = '', $query2 = false ) {
1304 global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
1306 $query = self
::fixUrlQueryArgs( $query, $query2 );
1308 $interwiki = Interwiki
::fetch( $this->mInterwiki
);
1310 $namespace = $this->getNsText();
1311 if ( $namespace != '' ) {
1312 # Can this actually happen? Interwikis shouldn't be parsed.
1313 # Yes! It can in interwiki transclusion. But... it probably shouldn't.
1316 $url = $interwiki->getURL( $namespace . $this->getDBkey() );
1317 $url = wfAppendQuery( $url, $query );
1319 $dbkey = wfUrlencode( $this->getPrefixedDBkey() );
1320 if ( $query == '' ) {
1321 $url = str_replace( '$1', $dbkey, $wgArticlePath );
1322 wfRunHooks( 'GetLocalURL::Article', array( &$this, &$url ) );
1324 global $wgVariantArticlePath, $wgActionPaths;
1328 if ( !empty( $wgActionPaths ) &&
1329 preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
1331 $action = urldecode( $matches[2] );
1332 if ( isset( $wgActionPaths[$action] ) ) {
1333 $query = $matches[1];
1334 if ( isset( $matches[4] ) ) {
1335 $query .= $matches[4];
1337 $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
1338 if ( $query != '' ) {
1339 $url = wfAppendQuery( $url, $query );
1344 if ( $url === false &&
1345 $wgVariantArticlePath &&
1346 $this->getPageLanguage()->hasVariants() &&
1347 preg_match( '/^variant=([^&]*)$/', $query, $matches ) )
1349 $variant = urldecode( $matches[1] );
1350 if ( $this->getPageLanguage()->hasVariant( $variant ) ) {
1351 // Only do the variant replacement if the given variant is a valid
1352 // variant for the page's language.
1353 $url = str_replace( '$2', urlencode( $variant ), $wgVariantArticlePath );
1354 $url = str_replace( '$1', $dbkey, $url );
1358 if ( $url === false ) {
1359 if ( $query == '-' ) {
1362 $url = "{$wgScript}?title={$dbkey}&{$query}";
1366 wfRunHooks( 'GetLocalURL::Internal', array( &$this, &$url, $query ) );
1368 // @todo FIXME: This causes breakage in various places when we
1369 // actually expected a local URL and end up with dupe prefixes.
1370 if ( $wgRequest->getVal( 'action' ) == 'render' ) {
1371 $url = $wgServer . $url;
1374 wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
1379 * Get a URL that's the simplest URL that will be valid to link, locally,
1380 * to the current Title. It includes the fragment, but does not include
1381 * the server unless action=render is used (or the link is external). If
1382 * there's a fragment but the prefixed text is empty, we just return a link
1385 * The result obviously should not be URL-escaped, but does need to be
1386 * HTML-escaped if it's being output in HTML.
1388 * See getLocalURL for the arguments.
1390 * @see self::getLocalURL
1391 * @return String the URL
1393 public function getLinkURL( $query = '', $query2 = false ) {
1394 wfProfileIn( __METHOD__
);
1395 if ( $this->isExternal() ) {
1396 $ret = $this->getFullURL( $query, $query2 );
1397 } elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
1398 $ret = $this->getFragmentForURL();
1400 $ret = $this->getLocalURL( $query, $query2 ) . $this->getFragmentForURL();
1402 wfProfileOut( __METHOD__
);
1407 * Get an HTML-escaped version of the URL form, suitable for
1408 * using in a link, without a server name or fragment
1410 * See getLocalURL for the arguments.
1412 * @see self::getLocalURL
1413 * @param $query string
1414 * @param $query2 bool|string
1415 * @return String the URL
1417 public function escapeLocalURL( $query = '', $query2 = false ) {
1418 wfDeprecated( __METHOD__
, '1.19' );
1419 return htmlspecialchars( $this->getLocalURL( $query, $query2 ) );
1423 * Get an HTML-escaped version of the URL form, suitable for
1424 * using in a link, including the server name and fragment
1426 * See getLocalURL for the arguments.
1428 * @see self::getLocalURL
1429 * @return String the URL
1431 public function escapeFullURL( $query = '', $query2 = false ) {
1432 wfDeprecated( __METHOD__
, '1.19' );
1433 return htmlspecialchars( $this->getFullURL( $query, $query2 ) );
1437 * Get the URL form for an internal link.
1438 * - Used in various Squid-related code, in case we have a different
1439 * internal hostname for the server from the exposed one.
1441 * This uses $wgInternalServer to qualify the path, or $wgServer
1442 * if $wgInternalServer is not set. If the server variable used is
1443 * protocol-relative, the URL will be expanded to http://
1445 * See getLocalURL for the arguments.
1447 * @see self::getLocalURL
1448 * @return String the URL
1450 public function getInternalURL( $query = '', $query2 = false ) {
1451 global $wgInternalServer, $wgServer;
1452 $query = self
::fixUrlQueryArgs( $query, $query2 );
1453 $server = $wgInternalServer !== false ?
$wgInternalServer : $wgServer;
1454 $url = wfExpandUrl( $server . $this->getLocalURL( $query ), PROTO_HTTP
);
1455 wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
1460 * Get the URL for a canonical link, for use in things like IRC and
1461 * e-mail notifications. Uses $wgCanonicalServer and the
1462 * GetCanonicalURL hook.
1464 * NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
1466 * See getLocalURL for the arguments.
1468 * @see self::getLocalURL
1469 * @return string The URL
1472 public function getCanonicalURL( $query = '', $query2 = false ) {
1473 $query = self
::fixUrlQueryArgs( $query, $query2 );
1474 $url = wfExpandUrl( $this->getLocalURL( $query ) . $this->getFragmentForURL(), PROTO_CANONICAL
);
1475 wfRunHooks( 'GetCanonicalURL', array( &$this, &$url, $query ) );
1480 * HTML-escaped version of getCanonicalURL()
1482 * See getLocalURL for the arguments.
1484 * @see self::getLocalURL
1488 public function escapeCanonicalURL( $query = '', $query2 = false ) {
1489 wfDeprecated( __METHOD__
, '1.19' );
1490 return htmlspecialchars( $this->getCanonicalURL( $query, $query2 ) );
1494 * Get the edit URL for this Title
1496 * @return String the URL, or a null string if this is an
1499 public function getEditURL() {
1500 if ( $this->mInterwiki
!= '' ) {
1503 $s = $this->getLocalURL( 'action=edit' );
1509 * Is $wgUser watching this page?
1513 public function userIsWatching() {
1516 if ( is_null( $this->mWatched
) ) {
1517 if ( NS_SPECIAL
== $this->mNamespace ||
!$wgUser->isLoggedIn() ) {
1518 $this->mWatched
= false;
1520 $this->mWatched
= $wgUser->isWatched( $this );
1523 return $this->mWatched
;
1527 * Can $wgUser read this page?
1529 * @deprecated in 1.19; use userCan(), quickUserCan() or getUserPermissionsErrors() instead
1531 * @todo fold these checks into userCan()
1533 public function userCanRead() {
1534 wfDeprecated( __METHOD__
, '1.19' );
1535 return $this->userCan( 'read' );
1539 * Can $user perform $action on this page?
1540 * This skips potentially expensive cascading permission checks
1541 * as well as avoids expensive error formatting
1543 * Suitable for use for nonessential UI controls in common cases, but
1544 * _not_ for functional access control.
1546 * May provide false positives, but should never provide a false negative.
1548 * @param $action String action that permission needs to be checked for
1549 * @param $user User to check (since 1.19); $wgUser will be used if not
1553 public function quickUserCan( $action, $user = null ) {
1554 return $this->userCan( $action, $user, false );
1558 * Can $user perform $action on this page?
1560 * @param $action String action that permission needs to be checked for
1561 * @param $user User to check (since 1.19); $wgUser will be used if not
1563 * @param $doExpensiveQueries Bool Set this to false to avoid doing
1564 * unnecessary queries.
1567 public function userCan( $action, $user = null, $doExpensiveQueries = true ) {
1568 if ( !$user instanceof User
) {
1572 return !count( $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries, true ) );
1576 * Can $user perform $action on this page?
1578 * @todo FIXME: This *does not* check throttles (User::pingLimiter()).
1580 * @param $action String action that permission needs to be checked for
1581 * @param $user User to check
1582 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary
1583 * queries by skipping checks for cascading protections and user blocks.
1584 * @param $ignoreErrors Array of Strings Set this to a list of message keys
1585 * whose corresponding errors may be ignored.
1586 * @return Array of arguments to wfMsg to explain permissions problems.
1588 public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) {
1589 $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries );
1591 // Remove the errors being ignored.
1592 foreach ( $errors as $index => $error ) {
1593 $error_key = is_array( $error ) ?
$error[0] : $error;
1595 if ( in_array( $error_key, $ignoreErrors ) ) {
1596 unset( $errors[$index] );
1604 * Permissions checks that fail most often, and which are easiest to test.
1606 * @param $action String the action to check
1607 * @param $user User user to check
1608 * @param $errors Array list of current errors
1609 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1610 * @param $short Boolean short circuit on first error
1612 * @return Array list of errors
1614 private function checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1615 if ( $action == 'create' ) {
1616 if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
1617 ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
1618 $errors[] = $user->isAnon() ?
array( 'nocreatetext' ) : array( 'nocreate-loggedin' );
1620 } elseif ( $action == 'move' ) {
1621 if ( !$user->isAllowed( 'move-rootuserpages' )
1622 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1623 // Show user page-specific message only if the user can move other pages
1624 $errors[] = array( 'cant-move-user-page' );
1627 // Check if user is allowed to move files if it's a file
1628 if ( $this->mNamespace
== NS_FILE
&& !$user->isAllowed( 'movefile' ) ) {
1629 $errors[] = array( 'movenotallowedfile' );
1632 if ( !$user->isAllowed( 'move' ) ) {
1633 // User can't move anything
1634 global $wgGroupPermissions;
1635 $userCanMove = false;
1636 if ( isset( $wgGroupPermissions['user']['move'] ) ) {
1637 $userCanMove = $wgGroupPermissions['user']['move'];
1639 $autoconfirmedCanMove = false;
1640 if ( isset( $wgGroupPermissions['autoconfirmed']['move'] ) ) {
1641 $autoconfirmedCanMove = $wgGroupPermissions['autoconfirmed']['move'];
1643 if ( $user->isAnon() && ( $userCanMove ||
$autoconfirmedCanMove ) ) {
1644 // custom message if logged-in users without any special rights can move
1645 $errors[] = array( 'movenologintext' );
1647 $errors[] = array( 'movenotallowed' );
1650 } elseif ( $action == 'move-target' ) {
1651 if ( !$user->isAllowed( 'move' ) ) {
1652 // User can't move anything
1653 $errors[] = array( 'movenotallowed' );
1654 } elseif ( !$user->isAllowed( 'move-rootuserpages' )
1655 && $this->mNamespace
== NS_USER
&& !$this->isSubpage() ) {
1656 // Show user page-specific message only if the user can move other pages
1657 $errors[] = array( 'cant-move-to-user-page' );
1659 } elseif ( !$user->isAllowed( $action ) ) {
1660 $errors[] = $this->missingPermissionError( $action, $short );
1667 * Add the resulting error code to the errors array
1669 * @param $errors Array list of current errors
1670 * @param $result Mixed result of errors
1672 * @return Array list of errors
1674 private function resultToError( $errors, $result ) {
1675 if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
1676 // A single array representing an error
1677 $errors[] = $result;
1678 } elseif ( is_array( $result ) && is_array( $result[0] ) ) {
1679 // A nested array representing multiple errors
1680 $errors = array_merge( $errors, $result );
1681 } elseif ( $result !== '' && is_string( $result ) ) {
1682 // A string representing a message-id
1683 $errors[] = array( $result );
1684 } elseif ( $result === false ) {
1685 // a generic "We don't want them to do that"
1686 $errors[] = array( 'badaccess-group0' );
1692 * Check various permission hooks
1694 * @param $action String the action to check
1695 * @param $user User user to check
1696 * @param $errors Array list of current errors
1697 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1698 * @param $short Boolean short circuit on first error
1700 * @return Array list of errors
1702 private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
1703 // Use getUserPermissionsErrors instead
1705 if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
1706 return $result ?
array() : array( array( 'badaccess-group0' ) );
1708 // Check getUserPermissionsErrors hook
1709 if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
1710 $errors = $this->resultToError( $errors, $result );
1712 // Check getUserPermissionsErrorsExpensive hook
1713 if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
1714 !wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
1715 $errors = $this->resultToError( $errors, $result );
1722 * Check permissions on special pages & namespaces
1724 * @param $action String the action to check
1725 * @param $user User user to check
1726 * @param $errors Array list of current errors
1727 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1728 * @param $short Boolean short circuit on first error
1730 * @return Array list of errors
1732 private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1733 # Only 'createaccount' and 'execute' can be performed on
1734 # special pages, which don't actually exist in the DB.
1735 $specialOKActions = array( 'createaccount', 'execute', 'read' );
1736 if ( NS_SPECIAL
== $this->mNamespace
&& !in_array( $action, $specialOKActions ) ) {
1737 $errors[] = array( 'ns-specialprotected' );
1740 # Check $wgNamespaceProtection for restricted namespaces
1741 if ( $this->isNamespaceProtected( $user ) ) {
1742 $ns = $this->mNamespace
== NS_MAIN ?
1743 wfMsg( 'nstab-main' ) : $this->getNsText();
1744 $errors[] = $this->mNamespace
== NS_MEDIAWIKI ?
1745 array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
1752 * Check CSS/JS sub-page permissions
1754 * @param $action String the action to check
1755 * @param $user User user to check
1756 * @param $errors Array list of current errors
1757 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1758 * @param $short Boolean short circuit on first error
1760 * @return Array list of errors
1762 private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1763 # Protect css/js subpages of user pages
1764 # XXX: this might be better using restrictions
1765 # XXX: right 'editusercssjs' is deprecated, for backward compatibility only
1766 if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
1767 && !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform
) ) {
1768 if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
1769 $errors[] = array( 'customcssprotected' );
1770 } elseif ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
1771 $errors[] = array( 'customjsprotected' );
1779 * Check against page_restrictions table requirements on this
1780 * page. The user must possess all required rights for this
1783 * @param $action String the action to check
1784 * @param $user User user to check
1785 * @param $errors Array list of current errors
1786 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1787 * @param $short Boolean short circuit on first error
1789 * @return Array list of errors
1791 private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1792 foreach ( $this->getRestrictions( $action ) as $right ) {
1793 // Backwards compatibility, rewrite sysop -> protect
1794 if ( $right == 'sysop' ) {
1797 if ( $right != '' && !$user->isAllowed( $right ) ) {
1798 // Users with 'editprotected' permission can edit protected pages
1799 // without cascading option turned on.
1800 if ( $action != 'edit' ||
!$user->isAllowed( 'editprotected' )
1801 ||
$this->mCascadeRestriction
)
1803 $errors[] = array( 'protectedpagetext', $right );
1812 * Check restrictions on cascading pages.
1814 * @param $action String the action to check
1815 * @param $user User to check
1816 * @param $errors Array list of current errors
1817 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1818 * @param $short Boolean short circuit on first error
1820 * @return Array list of errors
1822 private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1823 if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
1824 # We /could/ use the protection level on the source page, but it's
1825 # fairly ugly as we have to establish a precedence hierarchy for pages
1826 # included by multiple cascade-protected pages. So just restrict
1827 # it to people with 'protect' permission, as they could remove the
1828 # protection anyway.
1829 list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
1830 # Cascading protection depends on more than this page...
1831 # Several cascading protected pages may include this page...
1832 # Check each cascading level
1833 # This is only for protection restrictions, not for all actions
1834 if ( isset( $restrictions[$action] ) ) {
1835 foreach ( $restrictions[$action] as $right ) {
1836 $right = ( $right == 'sysop' ) ?
'protect' : $right;
1837 if ( $right != '' && !$user->isAllowed( $right ) ) {
1839 foreach ( $cascadingSources as $page )
1840 $pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
1841 $errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
1851 * Check action permissions not already checked in checkQuickPermissions
1853 * @param $action String the action to check
1854 * @param $user User to check
1855 * @param $errors Array list of current errors
1856 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1857 * @param $short Boolean short circuit on first error
1859 * @return Array list of errors
1861 private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1862 global $wgDeleteRevisionsLimit, $wgLang;
1864 if ( $action == 'protect' ) {
1865 if ( count( $this->getUserPermissionsErrorsInternal( 'edit', $user, $doExpensiveQueries, true ) ) ) {
1866 // If they can't edit, they shouldn't protect.
1867 $errors[] = array( 'protect-cantedit' );
1869 } elseif ( $action == 'create' ) {
1870 $title_protection = $this->getTitleProtection();
1871 if( $title_protection ) {
1872 if( $title_protection['pt_create_perm'] == 'sysop' ) {
1873 $title_protection['pt_create_perm'] = 'protect'; // B/C
1875 if( $title_protection['pt_create_perm'] == '' ||
1876 !$user->isAllowed( $title_protection['pt_create_perm'] ) )
1878 $errors[] = array( 'titleprotected', User
::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
1881 } elseif ( $action == 'move' ) {
1882 // Check for immobile pages
1883 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1884 // Specific message for this case
1885 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
1886 } elseif ( !$this->isMovable() ) {
1887 // Less specific message for rarer cases
1888 $errors[] = array( 'immobile-source-page' );
1890 } elseif ( $action == 'move-target' ) {
1891 if ( !MWNamespace
::isMovable( $this->mNamespace
) ) {
1892 $errors[] = array( 'immobile-target-namespace', $this->getNsText() );
1893 } elseif ( !$this->isMovable() ) {
1894 $errors[] = array( 'immobile-target-page' );
1896 } elseif ( $action == 'delete' ) {
1897 if ( $doExpensiveQueries && $wgDeleteRevisionsLimit
1898 && !$this->userCan( 'bigdelete', $user ) && $this->isBigDeletion() )
1900 $errors[] = array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) );
1907 * Check that the user isn't blocked from editting.
1909 * @param $action String the action to check
1910 * @param $user User to check
1911 * @param $errors Array list of current errors
1912 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1913 * @param $short Boolean short circuit on first error
1915 * @return Array list of errors
1917 private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
1918 // Account creation blocks handled at userlogin.
1919 // Unblocking handled in SpecialUnblock
1920 if( !$doExpensiveQueries ||
in_array( $action, array( 'createaccount', 'unblock' ) ) ) {
1924 global $wgContLang, $wgLang, $wgEmailConfirmToEdit;
1926 if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() ) {
1927 $errors[] = array( 'confirmedittext' );
1930 if ( ( $action == 'edit' ||
$action == 'create' ) && !$user->isBlockedFrom( $this ) ) {
1931 // Don't block the user from editing their own talk page unless they've been
1932 // explicitly blocked from that too.
1933 } elseif( $user->isBlocked() && $user->mBlock
->prevents( $action ) !== false ) {
1934 $block = $user->getBlock();
1936 // This is from OutputPage::blockedPage
1937 // Copied at r23888 by werdna
1939 $id = $user->blockedBy();
1940 $reason = $user->blockedFor();
1941 if ( $reason == '' ) {
1942 $reason = wfMsg( 'blockednoreason' );
1944 $ip = $user->getRequest()->getIP();
1946 if ( is_numeric( $id ) ) {
1947 $name = User
::whoIs( $id );
1952 $link = '[[' . $wgContLang->getNsText( NS_USER
) . ":{$name}|{$name}]]";
1953 $blockid = $block->getId();
1954 $blockExpiry = $block->getExpiry();
1955 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW
, $block->mTimestamp
), true );
1956 if ( $blockExpiry == 'infinity' ) {
1957 $blockExpiry = wfMessage( 'infiniteblock' )->text();
1959 $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW
, $blockExpiry ), true );
1962 $intended = strval( $block->getTarget() );
1964 $errors[] = array( ( $block->mAuto ?
'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
1965 $blockid, $blockExpiry, $intended, $blockTimestamp );
1972 * Check that the user is allowed to read this page.
1974 * @param $action String the action to check
1975 * @param $user User to check
1976 * @param $errors Array list of current errors
1977 * @param $doExpensiveQueries Boolean whether or not to perform expensive queries
1978 * @param $short Boolean short circuit on first error
1980 * @return Array list of errors
1982 private function checkReadPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
1983 global $wgWhitelistRead, $wgGroupPermissions, $wgRevokePermissions;
1984 static $useShortcut = null;
1986 # Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
1987 if ( is_null( $useShortcut ) ) {
1988 $useShortcut = true;
1989 if ( empty( $wgGroupPermissions['*']['read'] ) ) {
1990 # Not a public wiki, so no shortcut
1991 $useShortcut = false;
1992 } elseif ( !empty( $wgRevokePermissions ) ) {
1994 * Iterate through each group with permissions being revoked (key not included since we don't care
1995 * what the group name is), then check if the read permission is being revoked. If it is, then
1996 * we don't use the shortcut below since the user might not be able to read, even though anon
1997 * reading is allowed.
1999 foreach ( $wgRevokePermissions as $perms ) {
2000 if ( !empty( $perms['read'] ) ) {
2001 # We might be removing the read right from the user, so no shortcut
2002 $useShortcut = false;
2009 $whitelisted = false;
2010 if ( $useShortcut ) {
2011 # Shortcut for public wikis, allows skipping quite a bit of code
2012 $whitelisted = true;
2013 } elseif ( $user->isAllowed( 'read' ) ) {
2014 # If the user is allowed to read pages, he is allowed to read all pages
2015 $whitelisted = true;
2016 } elseif ( $this->isSpecial( 'Userlogin' )
2017 ||
$this->isSpecial( 'ChangePassword' )
2018 ||
$this->isSpecial( 'PasswordReset' )
2020 # Always grant access to the login page.
2021 # Even anons need to be able to log in.
2022 $whitelisted = true;
2023 } elseif ( is_array( $wgWhitelistRead ) && count( $wgWhitelistRead ) ) {
2024 # Time to check the whitelist
2025 # Only do these checks is there's something to check against
2026 $name = $this->getPrefixedText();
2027 $dbName = $this->getPrefixedDBKey();
2029 // Check for explicit whitelisting with and without underscores
2030 if ( in_array( $name, $wgWhitelistRead, true ) ||
in_array( $dbName, $wgWhitelistRead, true ) ) {
2031 $whitelisted = true;
2032 } elseif ( $this->getNamespace() == NS_MAIN
) {
2033 # Old settings might have the title prefixed with
2034 # a colon for main-namespace pages
2035 if ( in_array( ':' . $name, $wgWhitelistRead ) ) {
2036 $whitelisted = true;
2038 } elseif ( $this->isSpecialPage() ) {
2039 # If it's a special page, ditch the subpage bit and check again
2040 $name = $this->getDBkey();
2041 list( $name, /* $subpage */ ) = SpecialPageFactory
::resolveAlias( $name );
2042 if ( $name !== false ) {
2043 $pure = SpecialPage
::getTitleFor( $name )->getPrefixedText();
2044 if ( in_array( $pure, $wgWhitelistRead, true ) ) {
2045 $whitelisted = true;
2051 if ( !$whitelisted ) {
2052 # If the title is not whitelisted, give extensions a chance to do so...
2053 wfRunHooks( 'TitleReadWhitelist', array( $this, $user, &$whitelisted ) );
2054 if ( !$whitelisted ) {
2055 $errors[] = $this->missingPermissionError( $action, $short );
2063 * Get a description array when the user doesn't have the right to perform
2064 * $action (i.e. when User::isAllowed() returns false)
2066 * @param $action String the action to check
2067 * @param $short Boolean short circuit on first error
2068 * @return Array list of errors
2070 private function missingPermissionError( $action, $short ) {
2071 // We avoid expensive display logic for quickUserCan's and such
2073 return array( 'badaccess-group0' );
2076 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
2077 User
::getGroupsWithPermission( $action ) );
2079 if ( count( $groups ) ) {
2083 $wgLang->commaList( $groups ),
2087 return array( 'badaccess-group0' );
2092 * Can $user perform $action on this page? This is an internal function,
2093 * which checks ONLY that previously checked by userCan (i.e. it leaves out
2094 * checks on wfReadOnly() and blocks)
2096 * @param $action String action that permission needs to be checked for
2097 * @param $user User to check
2098 * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries.
2099 * @param $short Bool Set this to true to stop after the first permission error.
2100 * @return Array of arrays of the arguments to wfMsg to explain permissions problems.
2102 protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
2103 wfProfileIn( __METHOD__
);
2105 # Read has special handling
2106 if ( $action == 'read' ) {
2108 'checkPermissionHooks',
2109 'checkReadPermissions',
2113 'checkQuickPermissions',
2114 'checkPermissionHooks',
2115 'checkSpecialsAndNSPermissions',
2116 'checkCSSandJSPermissions',
2117 'checkPageRestrictions',
2118 'checkCascadingSourcesRestrictions',
2119 'checkActionPermissions',
2125 while( count( $checks ) > 0 &&
2126 !( $short && count( $errors ) > 0 ) ) {
2127 $method = array_shift( $checks );
2128 $errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
2131 wfProfileOut( __METHOD__
);
2136 * Protect css subpages of user pages: can $wgUser edit
2139 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2142 public function userCanEditCssSubpage() {
2144 wfDeprecated( __METHOD__
, '1.19' );
2145 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'editusercss' ) )
2146 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2150 * Protect js subpages of user pages: can $wgUser edit
2153 * @deprecated in 1.19; will be removed in 1.20. Use getUserPermissionsErrors() instead.
2156 public function userCanEditJsSubpage() {
2158 wfDeprecated( __METHOD__
, '1.19' );
2159 return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'edituserjs' ) )
2160 ||
preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform
) );
2164 * Get a filtered list of all restriction types supported by this wiki.
2165 * @param bool $exists True to get all restriction types that apply to
2166 * titles that do exist, False for all restriction types that apply to
2167 * titles that do not exist
2170 public static function getFilteredRestrictionTypes( $exists = true ) {
2171 global $wgRestrictionTypes;
2172 $types = $wgRestrictionTypes;
2174 # Remove the create restriction for existing titles
2175 $types = array_diff( $types, array( 'create' ) );
2177 # Only the create and upload restrictions apply to non-existing titles
2178 $types = array_intersect( $types, array( 'create', 'upload' ) );
2184 * Returns restriction types for the current Title
2186 * @return array applicable restriction types
2188 public function getRestrictionTypes() {
2189 if ( $this->isSpecialPage() ) {
2193 $types = self
::getFilteredRestrictionTypes( $this->exists() );
2195 if ( $this->getNamespace() != NS_FILE
) {
2196 # Remove the upload restriction for non-file titles
2197 $types = array_diff( $types, array( 'upload' ) );
2200 wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
2202 wfDebug( __METHOD__
. ': applicable restrictions to [[' .
2203 $this->getPrefixedText() . ']] are {' . implode( ',', $types ) . "}\n" );
2209 * Is this title subject to title protection?
2210 * Title protection is the one applied against creation of such title.
2212 * @return Mixed An associative array representing any existent title
2213 * protection, or false if there's none.
2215 private function getTitleProtection() {
2216 // Can't protect pages in special namespaces
2217 if ( $this->getNamespace() < 0 ) {
2221 // Can't protect pages that exist.
2222 if ( $this->exists() ) {
2226 if ( !isset( $this->mTitleProtection
) ) {
2227 $dbr = wfGetDB( DB_SLAVE
);
2228 $res = $dbr->select( 'protected_titles', '*',
2229 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2232 // fetchRow returns false if there are no rows.
2233 $this->mTitleProtection
= $dbr->fetchRow( $res );
2235 return $this->mTitleProtection
;
2239 * Update the title protection status
2241 * @deprecated in 1.19; will be removed in 1.20. Use WikiPage::doUpdateRestrictions() instead.
2242 * @param $create_perm String Permission required for creation
2243 * @param $reason String Reason for protection
2244 * @param $expiry String Expiry timestamp
2245 * @return boolean true
2247 public function updateTitleProtection( $create_perm, $reason, $expiry ) {
2248 wfDeprecated( __METHOD__
, '1.19' );
2252 $limit = array( 'create' => $create_perm );
2253 $expiry = array( 'create' => $expiry );
2255 $page = WikiPage
::factory( $this );
2256 $status = $page->doUpdateRestrictions( $limit, $expiry, false, $reason, $wgUser );
2258 return $status->isOK();
2262 * Remove any title protection due to page existing
2264 public function deleteTitleProtection() {
2265 $dbw = wfGetDB( DB_MASTER
);
2269 array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2272 $this->mTitleProtection
= false;
2276 * Is this page "semi-protected" - the *only* protection is autoconfirm?
2278 * @param $action String Action to check (default: edit)
2281 public function isSemiProtected( $action = 'edit' ) {
2282 if ( $this->exists() ) {
2283 $restrictions = $this->getRestrictions( $action );
2284 if ( count( $restrictions ) > 0 ) {
2285 foreach ( $restrictions as $restriction ) {
2286 if ( strtolower( $restriction ) != 'autoconfirmed' ) {
2296 # If it doesn't exist, it can't be protected
2302 * Does the title correspond to a protected article?
2304 * @param $action String the action the page is protected from,
2305 * by default checks all actions.
2308 public function isProtected( $action = '' ) {
2309 global $wgRestrictionLevels;
2311 $restrictionTypes = $this->getRestrictionTypes();
2313 # Special pages have inherent protection
2314 if( $this->isSpecialPage() ) {
2318 # Check regular protection levels
2319 foreach ( $restrictionTypes as $type ) {
2320 if ( $action == $type ||
$action == '' ) {
2321 $r = $this->getRestrictions( $type );
2322 foreach ( $wgRestrictionLevels as $level ) {
2323 if ( in_array( $level, $r ) && $level != '' ) {
2334 * Determines if $user is unable to edit this page because it has been protected
2335 * by $wgNamespaceProtection.
2337 * @param $user User object to check permissions
2340 public function isNamespaceProtected( User
$user ) {
2341 global $wgNamespaceProtection;
2343 if ( isset( $wgNamespaceProtection[$this->mNamespace
] ) ) {
2344 foreach ( (array)$wgNamespaceProtection[$this->mNamespace
] as $right ) {
2345 if ( $right != '' && !$user->isAllowed( $right ) ) {
2354 * Cascading protection: Return true if cascading restrictions apply to this page, false if not.
2356 * @return Bool If the page is subject to cascading restrictions.
2358 public function isCascadeProtected() {
2359 list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
2360 return ( $sources > 0 );
2364 * Cascading protection: Get the source of any cascading restrictions on this page.
2366 * @param $getPages Bool Whether or not to retrieve the actual pages
2367 * that the restrictions have come from.
2368 * @return Mixed Array of Title objects of the pages from which cascading restrictions
2369 * have come, false for none, or true if such restrictions exist, but $getPages
2370 * was not set. The restriction array is an array of each type, each of which
2371 * contains a array of unique groups.
2373 public function getCascadeProtectionSources( $getPages = true ) {
2375 $pagerestrictions = array();
2377 if ( isset( $this->mCascadeSources
) && $getPages ) {
2378 return array( $this->mCascadeSources
, $this->mCascadingRestrictions
);
2379 } elseif ( isset( $this->mHasCascadingRestrictions
) && !$getPages ) {
2380 return array( $this->mHasCascadingRestrictions
, $pagerestrictions );
2383 wfProfileIn( __METHOD__
);
2385 $dbr = wfGetDB( DB_SLAVE
);
2387 if ( $this->getNamespace() == NS_FILE
) {
2388 $tables = array( 'imagelinks', 'page_restrictions' );
2389 $where_clauses = array(
2390 'il_to' => $this->getDBkey(),
2395 $tables = array( 'templatelinks', 'page_restrictions' );
2396 $where_clauses = array(
2397 'tl_namespace' => $this->getNamespace(),
2398 'tl_title' => $this->getDBkey(),
2405 $cols = array( 'pr_page', 'page_namespace', 'page_title',
2406 'pr_expiry', 'pr_type', 'pr_level' );
2407 $where_clauses[] = 'page_id=pr_page';
2410 $cols = array( 'pr_expiry' );
2413 $res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__
);
2415 $sources = $getPages ?
array() : false;
2416 $now = wfTimestampNow();
2417 $purgeExpired = false;
2419 foreach ( $res as $row ) {
2420 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2421 if ( $expiry > $now ) {
2423 $page_id = $row->pr_page
;
2424 $page_ns = $row->page_namespace
;
2425 $page_title = $row->page_title
;
2426 $sources[$page_id] = Title
::makeTitle( $page_ns, $page_title );
2427 # Add groups needed for each restriction type if its not already there
2428 # Make sure this restriction type still exists
2430 if ( !isset( $pagerestrictions[$row->pr_type
] ) ) {
2431 $pagerestrictions[$row->pr_type
] = array();
2434 if ( isset( $pagerestrictions[$row->pr_type
] ) &&
2435 !in_array( $row->pr_level
, $pagerestrictions[$row->pr_type
] ) ) {
2436 $pagerestrictions[$row->pr_type
][] = $row->pr_level
;
2442 // Trigger lazy purge of expired restrictions from the db
2443 $purgeExpired = true;
2446 if ( $purgeExpired ) {
2447 Title
::purgeExpiredRestrictions();
2451 $this->mCascadeSources
= $sources;
2452 $this->mCascadingRestrictions
= $pagerestrictions;
2454 $this->mHasCascadingRestrictions
= $sources;
2457 wfProfileOut( __METHOD__
);
2458 return array( $sources, $pagerestrictions );
2462 * Accessor/initialisation for mRestrictions
2464 * @param $action String action that permission needs to be checked for
2465 * @return Array of Strings the array of groups allowed to edit this article
2467 public function getRestrictions( $action ) {
2468 if ( !$this->mRestrictionsLoaded
) {
2469 $this->loadRestrictions();
2471 return isset( $this->mRestrictions
[$action] )
2472 ?
$this->mRestrictions
[$action]
2477 * Get the expiry time for the restriction against a given action
2480 * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever
2481 * or not protected at all, or false if the action is not recognised.
2483 public function getRestrictionExpiry( $action ) {
2484 if ( !$this->mRestrictionsLoaded
) {
2485 $this->loadRestrictions();
2487 return isset( $this->mRestrictionsExpiry
[$action] ) ?
$this->mRestrictionsExpiry
[$action] : false;
2491 * Returns cascading restrictions for the current article
2495 function areRestrictionsCascading() {
2496 if ( !$this->mRestrictionsLoaded
) {
2497 $this->loadRestrictions();
2500 return $this->mCascadeRestriction
;
2504 * Loads a string into mRestrictions array
2506 * @param $res Resource restrictions as an SQL result.
2507 * @param $oldFashionedRestrictions String comma-separated list of page
2508 * restrictions from page table (pre 1.10)
2510 private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) {
2513 foreach ( $res as $row ) {
2517 $this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
2521 * Compiles list of active page restrictions from both page table (pre 1.10)
2522 * and page_restrictions table for this existing page.
2523 * Public for usage by LiquidThreads.
2525 * @param $rows array of db result objects
2526 * @param $oldFashionedRestrictions string comma-separated list of page
2527 * restrictions from page table (pre 1.10)
2529 public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
2531 $dbr = wfGetDB( DB_SLAVE
);
2533 $restrictionTypes = $this->getRestrictionTypes();
2535 foreach ( $restrictionTypes as $type ) {
2536 $this->mRestrictions
[$type] = array();
2537 $this->mRestrictionsExpiry
[$type] = $wgContLang->formatExpiry( '', TS_MW
);
2540 $this->mCascadeRestriction
= false;
2542 # Backwards-compatibility: also load the restrictions from the page record (old format).
2544 if ( $oldFashionedRestrictions === null ) {
2545 $oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2546 array( 'page_id' => $this->getArticleID() ), __METHOD__
);
2549 if ( $oldFashionedRestrictions != '' ) {
2551 foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
2552 $temp = explode( '=', trim( $restrict ) );
2553 if ( count( $temp ) == 1 ) {
2554 // old old format should be treated as edit/move restriction
2555 $this->mRestrictions
['edit'] = explode( ',', trim( $temp[0] ) );
2556 $this->mRestrictions
['move'] = explode( ',', trim( $temp[0] ) );
2558 $restriction = trim( $temp[1] );
2559 if( $restriction != '' ) { //some old entries are empty
2560 $this->mRestrictions
[$temp[0]] = explode( ',', $restriction );
2565 $this->mOldRestrictions
= true;
2569 if ( count( $rows ) ) {
2570 # Current system - load second to make them override.
2571 $now = wfTimestampNow();
2572 $purgeExpired = false;
2574 # Cycle through all the restrictions.
2575 foreach ( $rows as $row ) {
2577 // Don't take care of restrictions types that aren't allowed
2578 if ( !in_array( $row->pr_type
, $restrictionTypes ) )
2581 // This code should be refactored, now that it's being used more generally,
2582 // But I don't really see any harm in leaving it in Block for now -werdna
2583 $expiry = $wgContLang->formatExpiry( $row->pr_expiry
, TS_MW
);
2585 // Only apply the restrictions if they haven't expired!
2586 if ( !$expiry ||
$expiry > $now ) {
2587 $this->mRestrictionsExpiry
[$row->pr_type
] = $expiry;
2588 $this->mRestrictions
[$row->pr_type
] = explode( ',', trim( $row->pr_level
) );
2590 $this->mCascadeRestriction |
= $row->pr_cascade
;
2592 // Trigger a lazy purge of expired restrictions
2593 $purgeExpired = true;
2597 if ( $purgeExpired ) {
2598 Title
::purgeExpiredRestrictions();
2602 $this->mRestrictionsLoaded
= true;
2606 * Load restrictions from the page_restrictions table
2608 * @param $oldFashionedRestrictions String comma-separated list of page
2609 * restrictions from page table (pre 1.10)
2611 public function loadRestrictions( $oldFashionedRestrictions = null ) {
2613 if ( !$this->mRestrictionsLoaded
) {
2614 if ( $this->exists() ) {
2615 $dbr = wfGetDB( DB_SLAVE
);
2617 $res = $dbr->select(
2618 'page_restrictions',
2620 array( 'pr_page' => $this->getArticleID() ),
2624 $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
2626 $title_protection = $this->getTitleProtection();
2628 if ( $title_protection ) {
2629 $now = wfTimestampNow();
2630 $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW
);
2632 if ( !$expiry ||
$expiry > $now ) {
2633 // Apply the restrictions
2634 $this->mRestrictionsExpiry
['create'] = $expiry;
2635 $this->mRestrictions
['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
2636 } else { // Get rid of the old restrictions
2637 Title
::purgeExpiredRestrictions();
2638 $this->mTitleProtection
= false;
2641 $this->mRestrictionsExpiry
['create'] = $wgContLang->formatExpiry( '', TS_MW
);
2643 $this->mRestrictionsLoaded
= true;
2649 * Flush the protection cache in this object and force reload from the database.
2650 * This is used when updating protection from WikiPage::doUpdateRestrictions().
2652 public function flushRestrictions() {
2653 $this->mRestrictionsLoaded
= false;
2654 $this->mTitleProtection
= null;
2658 * Purge expired restrictions from the page_restrictions table
2660 static function purgeExpiredRestrictions() {
2661 $dbw = wfGetDB( DB_MASTER
);
2663 'page_restrictions',
2664 array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2670 array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
2676 * Does this have subpages? (Warning, usually requires an extra DB query.)
2680 public function hasSubpages() {
2681 if ( !MWNamespace
::hasSubpages( $this->mNamespace
) ) {
2686 # We dynamically add a member variable for the purpose of this method
2687 # alone to cache the result. There's no point in having it hanging
2688 # around uninitialized in every Title object; therefore we only add it
2689 # if needed and don't declare it statically.
2690 if ( isset( $this->mHasSubpages
) ) {
2691 return $this->mHasSubpages
;
2694 $subpages = $this->getSubpages( 1 );
2695 if ( $subpages instanceof TitleArray
) {
2696 return $this->mHasSubpages
= (bool)$subpages->count();
2698 return $this->mHasSubpages
= false;
2702 * Get all subpages of this page.
2704 * @param $limit Int maximum number of subpages to fetch; -1 for no limit
2705 * @return mixed TitleArray, or empty array if this page's namespace
2706 * doesn't allow subpages
2708 public function getSubpages( $limit = -1 ) {
2709 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
2713 $dbr = wfGetDB( DB_SLAVE
);
2714 $conds['page_namespace'] = $this->getNamespace();
2715 $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() );
2717 if ( $limit > -1 ) {
2718 $options['LIMIT'] = $limit;
2720 return $this->mSubpages
= TitleArray
::newFromResult(
2721 $dbr->select( 'page',
2722 array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
2731 * Is there a version of this page in the deletion archive?
2733 * @return Int the number of archived revisions
2735 public function isDeleted() {
2736 if ( $this->getNamespace() < 0 ) {
2739 $dbr = wfGetDB( DB_SLAVE
);
2741 $n = $dbr->selectField( 'archive', 'COUNT(*)',
2742 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2745 if ( $this->getNamespace() == NS_FILE
) {
2746 $n +
= $dbr->selectField( 'filearchive', 'COUNT(*)',
2747 array( 'fa_name' => $this->getDBkey() ),
2756 * Is there a version of this page in the deletion archive?
2760 public function isDeletedQuick() {
2761 if ( $this->getNamespace() < 0 ) {
2764 $dbr = wfGetDB( DB_SLAVE
);
2765 $deleted = (bool)$dbr->selectField( 'archive', '1',
2766 array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
2769 if ( !$deleted && $this->getNamespace() == NS_FILE
) {
2770 $deleted = (bool)$dbr->selectField( 'filearchive', '1',
2771 array( 'fa_name' => $this->getDBkey() ),
2779 * Get the article ID for this Title from the link cache,
2780 * adding it if necessary
2782 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select
2784 * @return Int the ID
2786 public function getArticleID( $flags = 0 ) {
2787 if ( $this->getNamespace() < 0 ) {
2788 return $this->mArticleID
= 0;
2790 $linkCache = LinkCache
::singleton();
2791 if ( $flags & self
::GAID_FOR_UPDATE
) {
2792 $oldUpdate = $linkCache->forUpdate( true );
2793 $linkCache->clearLink( $this );
2794 $this->mArticleID
= $linkCache->addLinkObj( $this );
2795 $linkCache->forUpdate( $oldUpdate );
2797 if ( -1 == $this->mArticleID
) {
2798 $this->mArticleID
= $linkCache->addLinkObj( $this );
2801 return $this->mArticleID
;
2805 * Is this an article that is a redirect page?
2806 * Uses link cache, adding it if necessary
2808 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2811 public function isRedirect( $flags = 0 ) {
2812 if ( !is_null( $this->mRedirect
) ) {
2813 return $this->mRedirect
;
2815 # Calling getArticleID() loads the field from cache as needed
2816 if ( !$this->getArticleID( $flags ) ) {
2817 return $this->mRedirect
= false;
2819 $linkCache = LinkCache
::singleton();
2820 $this->mRedirect
= (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2822 return $this->mRedirect
;
2826 * What is the length of this page?
2827 * Uses link cache, adding it if necessary
2829 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2832 public function getLength( $flags = 0 ) {
2833 if ( $this->mLength
!= -1 ) {
2834 return $this->mLength
;
2836 # Calling getArticleID() loads the field from cache as needed
2837 if ( !$this->getArticleID( $flags ) ) {
2838 return $this->mLength
= 0;
2840 $linkCache = LinkCache
::singleton();
2841 $this->mLength
= intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2843 return $this->mLength
;
2847 * What is the page_latest field for this page?
2849 * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update
2850 * @return Int or 0 if the page doesn't exist
2852 public function getLatestRevID( $flags = 0 ) {
2853 if ( $this->mLatestID
!== false ) {
2854 return intval( $this->mLatestID
);
2856 # Calling getArticleID() loads the field from cache as needed
2857 if ( !$this->getArticleID( $flags ) ) {
2858 return $this->mLatestID
= 0;
2860 $linkCache = LinkCache
::singleton();
2861 $this->mLatestID
= intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2863 return $this->mLatestID
;
2867 * This clears some fields in this object, and clears any associated
2868 * keys in the "bad links" section of the link cache.
2870 * - This is called from WikiPage::doEdit() and WikiPage::insertOn() to allow
2871 * loading of the new page_id. It's also called from
2872 * WikiPage::doDeleteArticle()
2874 * @param $newid Int the new Article ID
2876 public function resetArticleID( $newid ) {
2877 $linkCache = LinkCache
::singleton();
2878 $linkCache->clearLink( $this );
2880 if ( $newid === false ) {
2881 $this->mArticleID
= -1;
2883 $this->mArticleID
= intval( $newid );
2885 $this->mRestrictionsLoaded
= false;
2886 $this->mRestrictions
= array();
2887 $this->mRedirect
= null;
2888 $this->mLength
= -1;
2889 $this->mLatestID
= false;
2890 $this->mEstimateRevisions
= null;
2894 * Capitalize a text string for a title if it belongs to a namespace that capitalizes
2896 * @param $text String containing title to capitalize
2897 * @param $ns int namespace index, defaults to NS_MAIN
2898 * @return String containing capitalized title
2900 public static function capitalize( $text, $ns = NS_MAIN
) {
2903 if ( MWNamespace
::isCapitalized( $ns ) ) {
2904 return $wgContLang->ucfirst( $text );
2911 * Secure and split - main initialisation function for this object
2913 * Assumes that mDbkeyform has been set, and is urldecoded
2914 * and uses underscores, but not otherwise munged. This function
2915 * removes illegal characters, splits off the interwiki and
2916 * namespace prefixes, sets the other forms, and canonicalizes
2919 * @return Bool true on success
2921 private function secureAndSplit() {
2922 global $wgContLang, $wgLocalInterwiki;
2925 $this->mInterwiki
= $this->mFragment
= '';
2926 $this->mNamespace
= $this->mDefaultNamespace
; # Usually NS_MAIN
2928 $dbkey = $this->mDbkeyform
;
2930 # Strip Unicode bidi override characters.
2931 # Sometimes they slip into cut-n-pasted page titles, where the
2932 # override chars get included in list displays.
2933 $dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
2935 # Clean up whitespace
2936 # Note: use of the /u option on preg_replace here will cause
2937 # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
2938 # conveniently disabling them.
2939 $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
2940 $dbkey = trim( $dbkey, '_' );
2942 if ( $dbkey == '' ) {
2946 if ( false !== strpos( $dbkey, UTF8_REPLACEMENT
) ) {
2947 # Contained illegal UTF-8 sequences or forbidden Unicode chars.
2951 $this->mDbkeyform
= $dbkey;
2953 # Initial colon indicates main namespace rather than specified default
2954 # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
2955 if ( ':' == $dbkey[0] ) {
2956 $this->mNamespace
= NS_MAIN
;
2957 $dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
2958 $dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
2961 # Namespace or interwiki prefix
2963 $prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
2966 if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
2968 if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
2969 # Ordinary namespace
2971 $this->mNamespace
= $ns;
2972 # For Talk:X pages, check if X has a "namespace" prefix
2973 if ( $ns == NS_TALK
&& preg_match( $prefixRegexp, $dbkey, $x ) ) {
2974 if ( $wgContLang->getNsIndex( $x[1] ) ) {
2975 # Disallow Talk:File:x type titles...
2977 } elseif ( Interwiki
::isValidInterwiki( $x[1] ) ) {
2978 # Disallow Talk:Interwiki:x type titles...
2982 } elseif ( Interwiki
::isValidInterwiki( $p ) ) {
2983 if ( !$firstPass ) {
2984 # Can't make a local interwiki link to an interwiki link.
2985 # That's just crazy!
2991 $this->mInterwiki
= $wgContLang->lc( $p );
2993 # Redundant interwiki prefix to the local wiki
2994 if ( $wgLocalInterwiki !== false
2995 && 0 == strcasecmp( $this->mInterwiki
, $wgLocalInterwiki ) )
2997 if ( $dbkey == '' ) {
2998 # Can't have an empty self-link
3001 $this->mInterwiki
= '';
3003 # Do another namespace split...
3007 # If there's an initial colon after the interwiki, that also
3008 # resets the default namespace
3009 if ( $dbkey !== '' && $dbkey[0] == ':' ) {
3010 $this->mNamespace
= NS_MAIN
;
3011 $dbkey = substr( $dbkey, 1 );
3014 # If there's no recognized interwiki or namespace,
3015 # then let the colon expression be part of the title.
3020 # We already know that some pages won't be in the database!
3021 if ( $this->mInterwiki
!= '' || NS_SPECIAL
== $this->mNamespace
) {
3022 $this->mArticleID
= 0;
3024 $fragment = strstr( $dbkey, '#' );
3025 if ( false !== $fragment ) {
3026 $this->setFragment( $fragment );
3027 $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
3028 # remove whitespace again: prevents "Foo_bar_#"
3029 # becoming "Foo_bar_"
3030 $dbkey = preg_replace( '/_*$/', '', $dbkey );
3033 # Reject illegal characters.
3034 $rxTc = self
::getTitleInvalidRegex();
3035 if ( preg_match( $rxTc, $dbkey ) ) {
3039 # Pages with "/./" or "/../" appearing in the URLs will often be un-
3040 # reachable due to the way web browsers deal with 'relative' URLs.
3041 # Also, they conflict with subpage syntax. Forbid them explicitly.
3042 if ( strpos( $dbkey, '.' ) !== false &&
3043 ( $dbkey === '.' ||
$dbkey === '..' ||
3044 strpos( $dbkey, './' ) === 0 ||
3045 strpos( $dbkey, '../' ) === 0 ||
3046 strpos( $dbkey, '/./' ) !== false ||
3047 strpos( $dbkey, '/../' ) !== false ||
3048 substr( $dbkey, -2 ) == '/.' ||
3049 substr( $dbkey, -3 ) == '/..' ) )
3054 # Magic tilde sequences? Nu-uh!
3055 if ( strpos( $dbkey, '~~~' ) !== false ) {
3059 # Limit the size of titles to 255 bytes. This is typically the size of the
3060 # underlying database field. We make an exception for special pages, which
3061 # don't need to be stored in the database, and may edge over 255 bytes due
3062 # to subpage syntax for long titles, e.g. [[Special:Block/Long name]]
3063 if ( ( $this->mNamespace
!= NS_SPECIAL
&& strlen( $dbkey ) > 255 ) ||
3064 strlen( $dbkey ) > 512 )
3069 # Normally, all wiki links are forced to have an initial capital letter so [[foo]]
3070 # and [[Foo]] point to the same place. Don't force it for interwikis, since the
3071 # other site might be case-sensitive.
3072 $this->mUserCaseDBKey
= $dbkey;
3073 if ( $this->mInterwiki
== '' ) {
3074 $dbkey = self
::capitalize( $dbkey, $this->mNamespace
);
3077 # Can't make a link to a namespace alone... "empty" local links can only be
3078 # self-links with a fragment identifier.
3079 if ( $dbkey == '' && $this->mInterwiki
== '' && $this->mNamespace
!= NS_MAIN
) {
3083 // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
3084 // IP names are not allowed for accounts, and can only be referring to
3085 // edits from the IP. Given '::' abbreviations and caps/lowercaps,
3086 // there are numerous ways to present the same IP. Having sp:contribs scan
3087 // them all is silly and having some show the edits and others not is
3088 // inconsistent. Same for talk/userpages. Keep them normalized instead.
3089 $dbkey = ( $this->mNamespace
== NS_USER ||
$this->mNamespace
== NS_USER_TALK
)
3090 ? IP
::sanitizeIP( $dbkey )
3093 // Any remaining initial :s are illegal.
3094 if ( $dbkey !== '' && ':' == $dbkey[0] ) {
3099 $this->mDbkeyform
= $dbkey;
3100 $this->mUrlform
= wfUrlencode( $dbkey );
3102 $this->mTextform
= str_replace( '_', ' ', $dbkey );
3108 * Get an array of Title objects linking to this Title
3109 * Also stores the IDs in the link cache.
3111 * WARNING: do not use this function on arbitrary user-supplied titles!
3112 * On heavily-used templates it will max out the memory.
3114 * @param $options Array: may be FOR UPDATE
3115 * @param $table String: table name
3116 * @param $prefix String: fields prefix
3117 * @return Array of Title objects linking here
3119 public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3120 if ( count( $options ) > 0 ) {
3121 $db = wfGetDB( DB_MASTER
);
3123 $db = wfGetDB( DB_SLAVE
);
3127 array( 'page', $table ),
3128 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
3130 "{$prefix}_from=page_id",
3131 "{$prefix}_namespace" => $this->getNamespace(),
3132 "{$prefix}_title" => $this->getDBkey() ),
3138 if ( $res->numRows() ) {
3139 $linkCache = LinkCache
::singleton();
3140 foreach ( $res as $row ) {
3141 $titleObj = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
3143 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3144 $retVal[] = $titleObj;
3152 * Get an array of Title objects using this Title as a template
3153 * Also stores the IDs in the link cache.
3155 * WARNING: do not use this function on arbitrary user-supplied titles!
3156 * On heavily-used templates it will max out the memory.
3158 * @param $options Array: may be FOR UPDATE
3159 * @return Array of Title the Title objects linking here
3161 public function getTemplateLinksTo( $options = array() ) {
3162 return $this->getLinksTo( $options, 'templatelinks', 'tl' );
3166 * Get an array of Title objects linked from this Title
3167 * Also stores the IDs in the link cache.
3169 * WARNING: do not use this function on arbitrary user-supplied titles!
3170 * On heavily-used templates it will max out the memory.
3172 * @param $options Array: may be FOR UPDATE
3173 * @param $table String: table name
3174 * @param $prefix String: fields prefix
3175 * @return Array of Title objects linking here
3177 public function getLinksFrom( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
3178 $id = $this->getArticleID();
3180 # If the page doesn't exist; there can't be any link from this page
3185 if ( count( $options ) > 0 ) {
3186 $db = wfGetDB( DB_MASTER
);
3188 $db = wfGetDB( DB_SLAVE
);
3191 $namespaceFiled = "{$prefix}_namespace";
3192 $titleField = "{$prefix}_title";
3195 array( $table, 'page' ),
3196 array( $namespaceFiled, $titleField, 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
3197 array( "{$prefix}_from" => $id ),
3200 array( 'page' => array( 'LEFT JOIN', array( "page_namespace=$namespaceFiled", "page_title=$titleField" ) ) )
3204 if ( $res->numRows() ) {
3205 $linkCache = LinkCache
::singleton();
3206 foreach ( $res as $row ) {
3207 $titleObj = Title
::makeTitle( $row->$namespaceFiled, $row->$titleField );
3209 if ( $row->page_id
) {
3210 $linkCache->addGoodLinkObjFromRow( $titleObj, $row );
3212 $linkCache->addBadLinkObj( $titleObj );
3214 $retVal[] = $titleObj;
3222 * Get an array of Title objects used on this Title as a template
3223 * Also stores the IDs in the link cache.
3225 * WARNING: do not use this function on arbitrary user-supplied titles!
3226 * On heavily-used templates it will max out the memory.
3228 * @param $options Array: may be FOR UPDATE
3229 * @return Array of Title the Title objects used here
3231 public function getTemplateLinksFrom( $options = array() ) {
3232 return $this->getLinksFrom( $options, 'templatelinks', 'tl' );
3236 * Get an array of Title objects referring to non-existent articles linked from this page
3238 * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
3239 * @return Array of Title the Title objects
3241 public function getBrokenLinksFrom() {
3242 if ( $this->getArticleID() == 0 ) {
3243 # All links from article ID 0 are false positives
3247 $dbr = wfGetDB( DB_SLAVE
);
3248 $res = $dbr->select(
3249 array( 'page', 'pagelinks' ),
3250 array( 'pl_namespace', 'pl_title' ),
3252 'pl_from' => $this->getArticleID(),
3253 'page_namespace IS NULL'
3255 __METHOD__
, array(),
3259 array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
3265 foreach ( $res as $row ) {
3266 $retVal[] = Title
::makeTitle( $row->pl_namespace
, $row->pl_title
);
3273 * Get a list of URLs to purge from the Squid cache when this
3276 * @return Array of String the URLs
3278 public function getSquidURLs() {
3282 $this->getInternalURL(),
3283 $this->getInternalURL( 'action=history' )
3286 // purge variant urls as well
3287 if ( $wgContLang->hasVariants() ) {
3288 $variants = $wgContLang->getVariants();
3289 foreach ( $variants as $vCode ) {
3290 $urls[] = $this->getInternalURL( '', $vCode );
3298 * Purge all applicable Squid URLs
3300 public function purgeSquid() {
3302 if ( $wgUseSquid ) {
3303 $urls = $this->getSquidURLs();
3304 $u = new SquidUpdate( $urls );
3310 * Move this page without authentication
3312 * @param $nt Title the new page Title
3313 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3315 public function moveNoAuth( &$nt ) {
3316 return $this->moveTo( $nt, false );
3320 * Check whether a given move operation would be valid.
3321 * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise
3323 * @param $nt Title the new title
3324 * @param $auth Bool indicates whether $wgUser's permissions
3326 * @param $reason String is the log summary of the move, used for spam checking
3327 * @return Mixed True on success, getUserPermissionsErrors()-like array on failure
3329 public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
3334 // Normally we'd add this to $errors, but we'll get
3335 // lots of syntax errors if $nt is not an object
3336 return array( array( 'badtitletext' ) );
3338 if ( $this->equals( $nt ) ) {
3339 $errors[] = array( 'selfmove' );
3341 if ( !$this->isMovable() ) {
3342 $errors[] = array( 'immobile-source-namespace', $this->getNsText() );
3344 if ( $nt->getInterwiki() != '' ) {
3345 $errors[] = array( 'immobile-target-namespace-iw' );
3347 if ( !$nt->isMovable() ) {
3348 $errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
3351 $oldid = $this->getArticleID();
3352 $newid = $nt->getArticleID();
3354 if ( strlen( $nt->getDBkey() ) < 1 ) {
3355 $errors[] = array( 'articleexists' );
3357 if ( ( $this->getDBkey() == '' ) ||
3359 ( $nt->getDBkey() == '' ) ) {
3360 $errors[] = array( 'badarticleerror' );
3363 // Image-specific checks
3364 if ( $this->getNamespace() == NS_FILE
) {
3365 $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) );
3368 if ( $nt->getNamespace() == NS_FILE
&& $this->getNamespace() != NS_FILE
) {
3369 $errors[] = array( 'nonfile-cannot-move-to-file' );
3373 $errors = wfMergeErrorArrays( $errors,
3374 $this->getUserPermissionsErrors( 'move', $wgUser ),
3375 $this->getUserPermissionsErrors( 'edit', $wgUser ),
3376 $nt->getUserPermissionsErrors( 'move-target', $wgUser ),
3377 $nt->getUserPermissionsErrors( 'edit', $wgUser ) );
3380 $match = EditPage
::matchSummarySpamRegex( $reason );
3381 if ( $match !== false ) {
3382 // This is kind of lame, won't display nice
3383 $errors[] = array( 'spamprotectiontext' );
3387 if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
3388 $errors[] = array( 'hookaborted', $err );
3391 # The move is allowed only if (1) the target doesn't exist, or
3392 # (2) the target is a redirect to the source, and has no history
3393 # (so we can undo bad moves right after they're done).
3395 if ( 0 != $newid ) { # Target exists; check for validity
3396 if ( !$this->isValidMoveTarget( $nt ) ) {
3397 $errors[] = array( 'articleexists' );
3400 $tp = $nt->getTitleProtection();
3401 $right = ( $tp['pt_create_perm'] == 'sysop' ) ?
'protect' : $tp['pt_create_perm'];
3402 if ( $tp and !$wgUser->isAllowed( $right ) ) {
3403 $errors[] = array( 'cantmove-titleprotected' );
3406 if ( empty( $errors ) ) {
3413 * Check if the requested move target is a valid file move target
3414 * @param Title $nt Target title
3415 * @return array List of errors
3417 protected function validateFileMoveOperation( $nt ) {
3422 // wfFindFile( $nt ) / wfLocalFile( $nt ) is not allowed until below
3424 $file = wfLocalFile( $this );
3425 if ( $file->exists() ) {
3426 if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
3427 $errors[] = array( 'imageinvalidfilename' );
3429 if ( !File
::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
3430 $errors[] = array( 'imagetypemismatch' );
3434 if ( $nt->getNamespace() != NS_FILE
) {
3435 $errors[] = array( 'imagenocrossnamespace' );
3436 // From here we want to do checks on a file object, so if we can't
3437 // create one, we must return.
3441 // wfFindFile( $nt ) / wfLocalFile( $nt ) is allowed below here
3443 $destFile = wfLocalFile( $nt );
3444 if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) {
3445 $errors[] = array( 'file-exists-sharedrepo' );
3452 * Move a title to a new location
3454 * @param $nt Title the new title
3455 * @param $auth Bool indicates whether $wgUser's permissions
3457 * @param $reason String the reason for the move
3458 * @param $createRedirect Bool Whether to create a redirect from the old title to the new title.
3459 * Ignored if the user doesn't have the suppressredirect right.
3460 * @return Mixed true on success, getUserPermissionsErrors()-like array on failure
3462 public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
3464 $err = $this->isValidMoveOperation( $nt, $auth, $reason );
3465 if ( is_array( $err ) ) {
3466 // Auto-block user's IP if the account was "hard" blocked
3467 $wgUser->spreadAnyEditBlock();
3471 // If it is a file, move it first.
3472 // It is done before all other moving stuff is done because it's hard to revert.
3473 $dbw = wfGetDB( DB_MASTER
);
3474 if ( $this->getNamespace() == NS_FILE
) {
3475 $file = wfLocalFile( $this );
3476 if ( $file->exists() ) {
3477 $status = $file->move( $nt );
3478 if ( !$status->isOk() ) {
3479 return $status->getErrorsArray();
3482 // Clear RepoGroup process cache
3483 RepoGroup
::singleton()->clearCache( $this );
3484 RepoGroup
::singleton()->clearCache( $nt ); # clear false negative cache
3487 $dbw->begin( __METHOD__
); # If $file was a LocalFile, its transaction would have closed our own.
3488 $pageid = $this->getArticleID( self
::GAID_FOR_UPDATE
);
3489 $protected = $this->isProtected();
3491 // Do the actual move
3492 $this->moveToInternal( $nt, $reason, $createRedirect );
3494 // Refresh the sortkey for this row. Be careful to avoid resetting
3495 // cl_timestamp, which may disturb time-based lists on some sites.
3496 $prefixes = $dbw->select(
3498 array( 'cl_sortkey_prefix', 'cl_to' ),
3499 array( 'cl_from' => $pageid ),
3502 foreach ( $prefixes as $prefixRow ) {
3503 $prefix = $prefixRow->cl_sortkey_prefix
;
3504 $catTo = $prefixRow->cl_to
;
3505 $dbw->update( 'categorylinks',
3507 'cl_sortkey' => Collation
::singleton()->getSortKey(
3508 $nt->getCategorySortkey( $prefix ) ),
3509 'cl_timestamp=cl_timestamp' ),
3511 'cl_from' => $pageid,
3512 'cl_to' => $catTo ),
3517 $redirid = $this->getArticleID();
3520 # Protect the redirect title as the title used to be...
3521 $dbw->insertSelect( 'page_restrictions', 'page_restrictions',
3523 'pr_page' => $redirid,
3524 'pr_type' => 'pr_type',
3525 'pr_level' => 'pr_level',
3526 'pr_cascade' => 'pr_cascade',
3527 'pr_user' => 'pr_user',
3528 'pr_expiry' => 'pr_expiry'
3530 array( 'pr_page' => $pageid ),
3534 # Update the protection log
3535 $log = new LogPage( 'protect' );
3536 $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
3538 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3540 // @todo FIXME: $params?
3541 $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) );
3545 $oldnamespace = $this->getNamespace() & ~
1;
3546 $newnamespace = $nt->getNamespace() & ~
1;
3547 $oldtitle = $this->getDBkey();
3548 $newtitle = $nt->getDBkey();
3550 if ( $oldnamespace != $newnamespace ||
$oldtitle != $newtitle ) {
3551 WatchedItem
::duplicateEntries( $this, $nt );
3554 $dbw->commit( __METHOD__
);
3556 wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
3561 * Move page to a title which is either a redirect to the
3562 * source page or nonexistent
3564 * @param $nt Title the page to move to, which should be a redirect or nonexistent
3565 * @param $reason String The reason for the move
3566 * @param $createRedirect Bool Whether to leave a redirect at the old title. Ignored
3567 * if the user doesn't have the suppressredirect right
3568 * @throws MWException
3570 private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) {
3571 global $wgUser, $wgContLang;
3573 if ( $nt->exists() ) {
3574 $moveOverRedirect = true;
3575 $logType = 'move_redir';
3577 $moveOverRedirect = false;
3581 $redirectSuppressed = !$createRedirect && $wgUser->isAllowed( 'suppressredirect' );
3583 $logEntry = new ManualLogEntry( 'move', $logType );
3584 $logEntry->setPerformer( $wgUser );
3585 $logEntry->setTarget( $this );
3586 $logEntry->setComment( $reason );
3587 $logEntry->setParameters( array(
3588 '4::target' => $nt->getPrefixedText(),
3589 '5::noredir' => $redirectSuppressed ?
'1': '0',
3592 $formatter = LogFormatter
::newFromEntry( $logEntry );
3593 $formatter->setContext( RequestContext
::newExtraneousContext( $this ) );
3594 $comment = $formatter->getPlainActionText();
3596 $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
3598 # Truncate for whole multibyte characters.
3599 $comment = $wgContLang->truncate( $comment, 255 );
3601 $oldid = $this->getArticleID();
3603 $dbw = wfGetDB( DB_MASTER
);
3605 $newpage = WikiPage
::factory( $nt );
3607 if ( $moveOverRedirect ) {
3608 $newid = $nt->getArticleID();
3610 # Delete the old redirect. We don't save it to history since
3611 # by definition if we've got here it's rather uninteresting.
3612 # We have to remove it so that the next step doesn't trigger
3613 # a conflict on the unique namespace+title index...
3614 $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__
);
3616 $newpage->doDeleteUpdates( $newid );
3619 # Save a null revision in the page's history notifying of the move
3620 $nullRevision = Revision
::newNullRevision( $dbw, $oldid, $comment, true );
3621 if ( !is_object( $nullRevision ) ) {
3622 throw new MWException( 'No valid null revision produced in ' . __METHOD__
);
3624 $nullRevId = $nullRevision->insertOn( $dbw );
3626 # Change the name of the target page:
3627 $dbw->update( 'page',
3629 'page_namespace' => $nt->getNamespace(),
3630 'page_title' => $nt->getDBkey(),
3632 /* WHERE */ array( 'page_id' => $oldid ),
3636 $this->resetArticleID( 0 );
3637 $nt->resetArticleID( $oldid );
3639 $newpage->updateRevisionOn( $dbw, $nullRevision );
3641 wfRunHooks( 'NewRevisionFromEditComplete',
3642 array( $newpage, $nullRevision, $nullRevision->getParentId(), $wgUser ) );
3644 $newpage->doEditUpdates( $nullRevision, $wgUser, array( 'changed' => false ) );
3646 if ( !$moveOverRedirect ) {
3647 WikiPage
::onArticleCreate( $nt );
3650 # Recreate the redirect, this time in the other direction.
3651 if ( $redirectSuppressed ) {
3652 WikiPage
::onArticleDelete( $this );
3654 $mwRedir = MagicWord
::get( 'redirect' );
3655 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n";
3656 $redirectArticle = WikiPage
::factory( $this );
3657 $newid = $redirectArticle->insertOn( $dbw );
3658 if ( $newid ) { // sanity
3659 $redirectRevision = new Revision( array(
3661 'comment' => $comment,
3662 'text' => $redirectText ) );
3663 $redirectRevision->insertOn( $dbw );
3664 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );
3666 wfRunHooks( 'NewRevisionFromEditComplete',
3667 array( $redirectArticle, $redirectRevision, false, $wgUser ) );
3669 $redirectArticle->doEditUpdates( $redirectRevision, $wgUser, array( 'created' => true ) );
3674 $logid = $logEntry->insert();
3675 $logEntry->publish( $logid );
3679 * Move this page's subpages to be subpages of $nt
3681 * @param $nt Title Move target
3682 * @param $auth bool Whether $wgUser's permissions should be checked
3683 * @param $reason string The reason for the move
3684 * @param $createRedirect bool Whether to create redirects from the old subpages to
3685 * the new ones Ignored if the user doesn't have the 'suppressredirect' right
3686 * @return mixed array with old page titles as keys, and strings (new page titles) or
3687 * arrays (errors) as values, or an error array with numeric indices if no pages
3690 public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
3691 global $wgMaximumMovedPages;
3692 // Check permissions
3693 if ( !$this->userCan( 'move-subpages' ) ) {
3694 return array( 'cant-move-subpages' );
3696 // Do the source and target namespaces support subpages?
3697 if ( !MWNamespace
::hasSubpages( $this->getNamespace() ) ) {
3698 return array( 'namespace-nosubpages',
3699 MWNamespace
::getCanonicalName( $this->getNamespace() ) );
3701 if ( !MWNamespace
::hasSubpages( $nt->getNamespace() ) ) {
3702 return array( 'namespace-nosubpages',
3703 MWNamespace
::getCanonicalName( $nt->getNamespace() ) );
3706 $subpages = $this->getSubpages( $wgMaximumMovedPages +
1 );
3709 foreach ( $subpages as $oldSubpage ) {
3711 if ( $count > $wgMaximumMovedPages ) {
3712 $retval[$oldSubpage->getPrefixedTitle()] =
3713 array( 'movepage-max-pages',
3714 $wgMaximumMovedPages );
3718 // We don't know whether this function was called before
3719 // or after moving the root page, so check both
3721 if ( $oldSubpage->getArticleID() == $this->getArticleID() ||
3722 $oldSubpage->getArticleID() == $nt->getArticleID() )
3724 // When moving a page to a subpage of itself,
3725 // don't move it twice
3728 $newPageName = preg_replace(
3729 '#^' . preg_quote( $this->getDBkey(), '#' ) . '#',
3730 StringUtils
::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234
3731 $oldSubpage->getDBkey() );
3732 if ( $oldSubpage->isTalkPage() ) {
3733 $newNs = $nt->getTalkPage()->getNamespace();
3735 $newNs = $nt->getSubjectPage()->getNamespace();
3737 # Bug 14385: we need makeTitleSafe because the new page names may
3738 # be longer than 255 characters.
3739 $newSubpage = Title
::makeTitleSafe( $newNs, $newPageName );
3741 $success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
3742 if ( $success === true ) {
3743 $retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
3745 $retval[$oldSubpage->getPrefixedText()] = $success;
3752 * Checks if this page is just a one-rev redirect.
3753 * Adds lock, so don't use just for light purposes.
3757 public function isSingleRevRedirect() {
3758 $dbw = wfGetDB( DB_MASTER
);
3760 $row = $dbw->selectRow( 'page',
3761 array( 'page_is_redirect', 'page_latest', 'page_id' ),
3764 array( 'FOR UPDATE' )
3766 # Cache some fields we may want
3767 $this->mArticleID
= $row ?
intval( $row->page_id
) : 0;
3768 $this->mRedirect
= $row ?
(bool)$row->page_is_redirect
: false;
3769 $this->mLatestID
= $row ?
intval( $row->page_latest
) : false;
3770 if ( !$this->mRedirect
) {
3773 # Does the article have a history?
3774 $row = $dbw->selectField( array( 'page', 'revision' ),
3776 array( 'page_namespace' => $this->getNamespace(),
3777 'page_title' => $this->getDBkey(),
3779 'page_latest != rev_id'
3782 array( 'FOR UPDATE' )
3784 # Return true if there was no history
3785 return ( $row === false );
3789 * Checks if $this can be moved to a given Title
3790 * - Selects for update, so don't call it unless you mean business
3792 * @param $nt Title the new title to check
3795 public function isValidMoveTarget( $nt ) {
3796 # Is it an existing file?
3797 if ( $nt->getNamespace() == NS_FILE
) {
3798 $file = wfLocalFile( $nt );
3799 if ( $file->exists() ) {
3800 wfDebug( __METHOD__
. ": file exists\n" );
3804 # Is it a redirect with no history?
3805 if ( !$nt->isSingleRevRedirect() ) {
3806 wfDebug( __METHOD__
. ": not a one-rev redirect\n" );
3809 # Get the article text
3810 $rev = Revision
::newFromTitle( $nt );
3811 if( !is_object( $rev ) ){
3814 $text = $rev->getText();
3815 # Does the redirect point to the source?
3816 # Or is it a broken self-redirect, usually caused by namespace collisions?
3818 if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
3819 $redirTitle = Title
::newFromText( $m[1] );
3820 if ( !is_object( $redirTitle ) ||
3821 ( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
3822 $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
3823 wfDebug( __METHOD__
. ": redirect points to other page\n" );
3828 wfDebug( __METHOD__
. ": failsafe\n" );
3835 * Get categories to which this Title belongs and return an array of
3836 * categories' names.
3838 * @return Array of parents in the form:
3839 * $parent => $currentarticle
3841 public function getParentCategories() {
3846 $titleKey = $this->getArticleID();
3848 if ( $titleKey === 0 ) {
3852 $dbr = wfGetDB( DB_SLAVE
);
3854 $res = $dbr->select( 'categorylinks', '*',
3856 'cl_from' => $titleKey,
3862 if ( $dbr->numRows( $res ) > 0 ) {
3863 foreach ( $res as $row ) {
3864 // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
3865 $data[$wgContLang->getNSText( NS_CATEGORY
) . ':' . $row->cl_to
] = $this->getFullText();
3872 * Get a tree of parent categories
3874 * @param $children Array with the children in the keys, to check for circular refs
3875 * @return Array Tree of parent categories
3877 public function getParentCategoryTree( $children = array() ) {
3879 $parents = $this->getParentCategories();
3882 foreach ( $parents as $parent => $current ) {
3883 if ( array_key_exists( $parent, $children ) ) {
3884 # Circular reference
3885 $stack[$parent] = array();
3887 $nt = Title
::newFromText( $parent );
3889 $stack[$parent] = $nt->getParentCategoryTree( $children +
array( $parent => 1 ) );
3899 * Get an associative array for selecting this title from
3902 * @return Array suitable for the $where parameter of DB::select()
3904 public function pageCond() {
3905 if ( $this->mArticleID
> 0 ) {
3906 // PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
3907 return array( 'page_id' => $this->mArticleID
);
3909 return array( 'page_namespace' => $this->mNamespace
, 'page_title' => $this->mDbkeyform
);
3914 * Get the revision ID of the previous revision
3916 * @param $revId Int Revision ID. Get the revision that was before this one.
3917 * @param $flags Int Title::GAID_FOR_UPDATE
3918 * @return Int|Bool Old revision ID, or FALSE if none exists
3920 public function getPreviousRevisionID( $revId, $flags = 0 ) {
3921 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3922 $revId = $db->selectField( 'revision', 'rev_id',
3924 'rev_page' => $this->getArticleID( $flags ),
3925 'rev_id < ' . intval( $revId )
3928 array( 'ORDER BY' => 'rev_id DESC' )
3931 if ( $revId === false ) {
3934 return intval( $revId );
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 $revId = $db->selectField( 'revision', 'rev_id',
3949 'rev_page' => $this->getArticleID( $flags ),
3950 'rev_id > ' . intval( $revId )
3953 array( 'ORDER BY' => 'rev_id' )
3956 if ( $revId === false ) {
3959 return intval( $revId );
3964 * Get the first revision of the page
3966 * @param $flags Int Title::GAID_FOR_UPDATE
3967 * @return Revision|Null if page doesn't exist
3969 public function getFirstRevision( $flags = 0 ) {
3970 $pageId = $this->getArticleID( $flags );
3972 $db = ( $flags & self
::GAID_FOR_UPDATE
) ?
wfGetDB( DB_MASTER
) : wfGetDB( DB_SLAVE
);
3973 $row = $db->selectRow( 'revision', '*',
3974 array( 'rev_page' => $pageId ),
3976 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
3979 return new Revision( $row );
3986 * Get the oldest revision timestamp of this page
3988 * @param $flags Int Title::GAID_FOR_UPDATE
3989 * @return String: MW timestamp
3991 public function getEarliestRevTime( $flags = 0 ) {
3992 $rev = $this->getFirstRevision( $flags );
3993 return $rev ?
$rev->getTimestamp() : null;
3997 * Check if this is a new page
4001 public function isNewPage() {
4002 $dbr = wfGetDB( DB_SLAVE
);
4003 return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__
);
4007 * Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit
4011 public function isBigDeletion() {
4012 global $wgDeleteRevisionsLimit;
4014 if ( !$wgDeleteRevisionsLimit ) {
4018 $revCount = $this->estimateRevisionCount();
4019 return $revCount > $wgDeleteRevisionsLimit;
4023 * Get the approximate revision count of this page.
4027 public function estimateRevisionCount() {
4028 if ( !$this->exists() ) {
4032 if ( $this->mEstimateRevisions
=== null ) {
4033 $dbr = wfGetDB( DB_SLAVE
);
4034 $this->mEstimateRevisions
= $dbr->estimateRowCount( 'revision', '*',
4035 array( 'rev_page' => $this->getArticleID() ), __METHOD__
);
4038 return $this->mEstimateRevisions
;
4042 * Get the number of revisions between the given revision.
4043 * Used for diffs and other things that really need it.
4045 * @param $old int|Revision Old revision or rev ID (first before range)
4046 * @param $new int|Revision New revision or rev ID (first after range)
4047 * @return Int Number of revisions between these revisions.
4049 public function countRevisionsBetween( $old, $new ) {
4050 if ( !( $old instanceof Revision
) ) {
4051 $old = Revision
::newFromTitle( $this, (int)$old );
4053 if ( !( $new instanceof Revision
) ) {
4054 $new = Revision
::newFromTitle( $this, (int)$new );
4056 if ( !$old ||
!$new ) {
4057 return 0; // nothing to compare
4059 $dbr = wfGetDB( DB_SLAVE
);
4060 return (int)$dbr->selectField( 'revision', 'count(*)',
4062 'rev_page' => $this->getArticleID(),
4063 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4064 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4071 * Get the number of authors between the given revision IDs.
4072 * Used for diffs and other things that really need it.
4074 * @param $old int|Revision Old revision or rev ID (first before range)
4075 * @param $new int|Revision New revision or rev ID (first after range)
4076 * @param $limit Int Maximum number of authors
4077 * @return Int Number of revision authors between these revisions.
4079 public function countAuthorsBetween( $old, $new, $limit ) {
4080 if ( !( $old instanceof Revision
) ) {
4081 $old = Revision
::newFromTitle( $this, (int)$old );
4083 if ( !( $new instanceof Revision
) ) {
4084 $new = Revision
::newFromTitle( $this, (int)$new );
4086 if ( !$old ||
!$new ) {
4087 return 0; // nothing to compare
4089 $dbr = wfGetDB( DB_SLAVE
);
4090 $res = $dbr->select( 'revision', 'DISTINCT rev_user_text',
4092 'rev_page' => $this->getArticleID(),
4093 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ),
4094 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) )
4096 array( 'LIMIT' => $limit +
1 ) // add one so caller knows it was truncated
4098 return (int)$dbr->numRows( $res );
4102 * Compare with another title.
4104 * @param $title Title
4107 public function equals( Title
$title ) {
4108 // Note: === is necessary for proper matching of number-like titles.
4109 return $this->getInterwiki() === $title->getInterwiki()
4110 && $this->getNamespace() == $title->getNamespace()
4111 && $this->getDBkey() === $title->getDBkey();
4115 * Check if this title is a subpage of another title
4117 * @param $title Title
4120 public function isSubpageOf( Title
$title ) {
4121 return $this->getInterwiki() === $title->getInterwiki()
4122 && $this->getNamespace() == $title->getNamespace()
4123 && strpos( $this->getDBkey(), $title->getDBkey() . '/' ) === 0;
4127 * Check if page exists. For historical reasons, this function simply
4128 * checks for the existence of the title in the page table, and will
4129 * thus return false for interwiki links, special pages and the like.
4130 * If you want to know if a title can be meaningfully viewed, you should
4131 * probably call the isKnown() method instead.
4135 public function exists() {
4136 return $this->getArticleID() != 0;
4140 * Should links to this title be shown as potentially viewable (i.e. as
4141 * "bluelinks"), even if there's no record by this title in the page
4144 * This function is semi-deprecated for public use, as well as somewhat
4145 * misleadingly named. You probably just want to call isKnown(), which
4146 * calls this function internally.
4148 * (ISSUE: Most of these checks are cheap, but the file existence check
4149 * can potentially be quite expensive. Including it here fixes a lot of
4150 * existing code, but we might want to add an optional parameter to skip
4151 * it and any other expensive checks.)
4155 public function isAlwaysKnown() {
4159 * Allows overriding default behaviour for determining if a page exists.
4160 * If $isKnown is kept as null, regular checks happen. If it's
4161 * a boolean, this value is returned by the isKnown method.
4165 * @param Title $title
4166 * @param boolean|null $isKnown
4168 wfRunHooks( 'TitleIsAlwaysKnown', array( $this, &$isKnown ) );
4170 if ( !is_null( $isKnown ) ) {
4174 if ( $this->mInterwiki
!= '' ) {
4175 return true; // any interwiki link might be viewable, for all we know
4178 switch( $this->mNamespace
) {
4181 // file exists, possibly in a foreign repo
4182 return (bool)wfFindFile( $this );
4184 // valid special page
4185 return SpecialPageFactory
::exists( $this->getDBkey() );
4187 // selflink, possibly with fragment
4188 return $this->mDbkeyform
== '';
4190 // known system message
4191 return $this->hasSourceText() !== false;
4198 * Does this title refer to a page that can (or might) be meaningfully
4199 * viewed? In particular, this function may be used to determine if
4200 * links to the title should be rendered as "bluelinks" (as opposed to
4201 * "redlinks" to non-existent pages).
4202 * Adding something else to this function will cause inconsistency
4203 * since LinkHolderArray calls isAlwaysKnown() and does its own
4204 * page existence check.
4208 public function isKnown() {
4209 return $this->isAlwaysKnown() ||
$this->exists();
4213 * Does this page have source text?
4217 public function hasSourceText() {
4218 if ( $this->exists() ) {
4222 if ( $this->mNamespace
== NS_MEDIAWIKI
) {
4223 // If the page doesn't exist but is a known system message, default
4224 // message content will be displayed, same for language subpages-
4225 // Use always content language to avoid loading hundreds of languages
4226 // to get the link color.
4228 list( $name, $lang ) = MessageCache
::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4229 $message = wfMessage( $name )->inLanguage( $wgContLang )->useDatabase( false );
4230 return $message->exists();
4237 * Get the default message text or false if the message doesn't exist
4239 * @return String or false
4241 public function getDefaultMessageText() {
4244 if ( $this->getNamespace() != NS_MEDIAWIKI
) { // Just in case
4248 list( $name, $lang ) = MessageCache
::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) );
4249 $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false );
4251 if ( $message->exists() ) {
4252 return $message->plain();
4259 * Updates page_touched for this page; called from LinksUpdate.php
4261 * @return Bool true if the update succeded
4263 public function invalidateCache() {
4264 if ( wfReadOnly() ) {
4267 $dbw = wfGetDB( DB_MASTER
);
4268 $success = $dbw->update(
4270 array( 'page_touched' => $dbw->timestamp() ),
4274 HTMLFileCache
::clearFileCache( $this );
4279 * Update page_touched timestamps and send squid purge messages for
4280 * pages linking to this title. May be sent to the job queue depending
4281 * on the number of links. Typically called on create and delete.
4283 public function touchLinks() {
4284 $u = new HTMLCacheUpdate( $this, 'pagelinks' );
4287 if ( $this->getNamespace() == NS_CATEGORY
) {
4288 $u = new HTMLCacheUpdate( $this, 'categorylinks' );
4294 * Get the last touched timestamp
4296 * @param $db DatabaseBase: optional db
4297 * @return String last-touched timestamp
4299 public function getTouched( $db = null ) {
4300 $db = isset( $db ) ?
$db : wfGetDB( DB_SLAVE
);
4301 $touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__
);
4306 * Get the timestamp when this page was updated since the user last saw it.
4309 * @return String|Null
4311 public function getNotificationTimestamp( $user = null ) {
4312 global $wgUser, $wgShowUpdatedMarker;
4313 // Assume current user if none given
4317 // Check cache first
4318 $uid = $user->getId();
4319 // avoid isset here, as it'll return false for null entries
4320 if ( array_key_exists( $uid, $this->mNotificationTimestamp
) ) {
4321 return $this->mNotificationTimestamp
[$uid];
4323 if ( !$uid ||
!$wgShowUpdatedMarker ) {
4324 return $this->mNotificationTimestamp
[$uid] = false;
4326 // Don't cache too much!
4327 if ( count( $this->mNotificationTimestamp
) >= self
::CACHE_MAX
) {
4328 $this->mNotificationTimestamp
= array();
4330 $dbr = wfGetDB( DB_SLAVE
);
4331 $this->mNotificationTimestamp
[$uid] = $dbr->selectField( 'watchlist',
4332 'wl_notificationtimestamp',
4334 'wl_user' => $user->getId(),
4335 'wl_namespace' => $this->getNamespace(),
4336 'wl_title' => $this->getDBkey(),
4340 return $this->mNotificationTimestamp
[$uid];
4344 * Generate strings used for xml 'id' names in monobook tabs
4346 * @param $prepend string defaults to 'nstab-'
4347 * @return String XML 'id' name
4349 public function getNamespaceKey( $prepend = 'nstab-' ) {
4351 // Gets the subject namespace if this title
4352 $namespace = MWNamespace
::getSubject( $this->getNamespace() );
4353 // Checks if cononical namespace name exists for namespace
4354 if ( MWNamespace
::exists( $this->getNamespace() ) ) {
4355 // Uses canonical namespace name
4356 $namespaceKey = MWNamespace
::getCanonicalName( $namespace );
4358 // Uses text of namespace
4359 $namespaceKey = $this->getSubjectNsText();
4361 // Makes namespace key lowercase
4362 $namespaceKey = $wgContLang->lc( $namespaceKey );
4364 if ( $namespaceKey == '' ) {
4365 $namespaceKey = 'main';
4367 // Changes file to image for backwards compatibility
4368 if ( $namespaceKey == 'file' ) {
4369 $namespaceKey = 'image';
4371 return $prepend . $namespaceKey;
4375 * Get all extant redirects to this Title
4377 * @param $ns Int|Null Single namespace to consider; NULL to consider all namespaces
4378 * @return Array of Title redirects to this title
4380 public function getRedirectsHere( $ns = null ) {
4383 $dbr = wfGetDB( DB_SLAVE
);
4385 'rd_namespace' => $this->getNamespace(),
4386 'rd_title' => $this->getDBkey(),
4389 if ( !is_null( $ns ) ) {
4390 $where['page_namespace'] = $ns;
4393 $res = $dbr->select(
4394 array( 'redirect', 'page' ),
4395 array( 'page_namespace', 'page_title' ),
4400 foreach ( $res as $row ) {
4401 $redirs[] = self
::newFromRow( $row );
4407 * Check if this Title is a valid redirect target
4411 public function isValidRedirectTarget() {
4412 global $wgInvalidRedirectTargets;
4414 // invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
4415 if ( $this->isSpecial( 'Userlogout' ) ) {
4419 foreach ( $wgInvalidRedirectTargets as $target ) {
4420 if ( $this->isSpecial( $target ) ) {
4429 * Get a backlink cache object
4431 * @return BacklinkCache
4433 function getBacklinkCache() {
4434 if ( is_null( $this->mBacklinkCache
) ) {
4435 $this->mBacklinkCache
= new BacklinkCache( $this );
4437 return $this->mBacklinkCache
;
4441 * Whether the magic words __INDEX__ and __NOINDEX__ function for this page.
4445 public function canUseNoindex() {
4446 global $wgContentNamespaces, $wgExemptFromUserRobotsControl;
4448 $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
4449 ?
$wgContentNamespaces
4450 : $wgExemptFromUserRobotsControl;
4452 return !in_array( $this->mNamespace
, $bannedNamespaces );
4457 * Returns the raw sort key to be used for categories, with the specified
4458 * prefix. This will be fed to Collation::getSortKey() to get a
4459 * binary sortkey that can be used for actual sorting.
4461 * @param $prefix string The prefix to be used, specified using
4462 * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no
4466 public function getCategorySortkey( $prefix = '' ) {
4467 $unprefixed = $this->getText();
4469 // Anything that uses this hook should only depend
4470 // on the Title object passed in, and should probably
4471 // tell the users to run updateCollations.php --force
4472 // in order to re-sort existing category relations.
4473 wfRunHooks( 'GetDefaultSortkey', array( $this, &$unprefixed ) );
4474 if ( $prefix !== '' ) {
4475 # Separate with a line feed, so the unprefixed part is only used as
4476 # a tiebreaker when two pages have the exact same prefix.
4477 # In UCA, tab is the only character that can sort above LF
4478 # so we strip both of them from the original prefix.
4479 $prefix = strtr( $prefix, "\n\t", ' ' );
4480 return "$prefix\n$unprefixed";
4486 * Get the language in which the content of this page is written.
4487 * Defaults to $wgContLang, but in certain cases it can be e.g.
4488 * $wgLang (such as special pages, which are in the user language).
4493 public function getPageLanguage() {
4495 if ( $this->isSpecialPage() ) {
4496 // special pages are in the user language
4498 } elseif ( $this->isCssOrJsPage() ||
$this->isCssJsSubpage() ) {
4499 // css/js should always be LTR and is, in fact, English
4500 return wfGetLangObj( 'en' );
4501 } elseif ( $this->getNamespace() == NS_MEDIAWIKI
) {
4502 // Parse mediawiki messages with correct target language
4503 list( /* $unused */, $lang ) = MessageCache
::singleton()->figureMessage( $this->getText() );
4504 return wfGetLangObj( $lang );
4507 // If nothing special, it should be in the wiki content language
4508 $pageLang = $wgContLang;
4509 // Hook at the end because we don't want to override the above stuff
4510 wfRunHooks( 'PageContentLanguage', array( $this, &$pageLang, $wgLang ) );
4511 return wfGetLangObj( $pageLang );